- Created by 郭强, last modified on Jan 07, 2021
配置文件
推荐使用配置文件及单例对象来管理和使用数据库操作。
如果我们使用g
对象管理模块中的g.DB("数据库分组名称")
方法获取数据库操作对象,数据库对象将会自动读取config.toml
配置文件中的相应配置项(通过配置管理模块),并自动初始化该数据库操作的单例对象。
数据库配置管理功能使用的是配置管理模块实现,因此同样支持多种数据格式如:toml
, yaml
, json
, xml
。默认并且推荐的配置文件数据格式为toml
。
完整配置
完整的config.toml
数据库配置项的数据格式形如下:
[database]
[[database.分组名称]]
Host = "地址"
Port = "端口"
User = "账号"
Pass = "密码"
Name = "数据库名称"
Type = "数据库类型(mysql/pgsql/mssql/sqlite/oracle)"
Role = "(可选)数据库主从角色(master/slave),不使用应用层的主从机制请均设置为master"
Debug = "(可选)开启调试模式"
Prefix = "(可选)表名前缀"
DryRun = "(可选)ORM空跑(只读不写)"
Charset = "(可选)数据库编码(如: utf8/gbk/gb2312),一般设置为utf8"
Weight = "(可选)负载均衡权重,用于负载均衡控制,不使用应用层的负载均衡机制请置空"
Linkinfo = "(可选)自定义数据库链接信息,当该字段被设置值时,以上链接字段(Host,Port,User,Pass,Name)将失效,但是type必须有值"
MaxIdle = "(可选)连接池最大闲置的连接数"
MaxOpen = "(可选)连接池最大打开的连接数"
MaxLifetime = "(可选,单位秒)连接对象可重复使用的时间长度"
CreatedAt = "(可选)自动创建时间字段名称"
UpdatedAt = "(可选)自动更新时间字段名称"
DeletedAt = "(可选)软删除时间字段名称"
完整的数据库配置项示例(TOML):
[database]
[[database.default]]
host = "127.0.0.1"
port = "3306"
user = "root"
pass = "12345678"
name = "test"
type = "mysql"
role = "master"
debug = "true"
dryrun = 1
weight = "100"
prefix = "gf_"
charset = "utf8"
linkinfo = ""
maxIdle = "10"
maxOpen = "100"
maxLifetime = "30"
篇幅有限,这里仅展示了推荐的
toml
格式的文件示例格式,其他配置文件的数据格式请自行研究。
简化配置(推荐)
为兼容不同的数据库类型,gdb
将数据库的各个字段拆分出来单独配置,这样对于各种数据库的对接来说兼容性会很好。但是对于开发者来说看起来配置比较多。针对于项目中使用的已确定的数据库类型的配置,我们可以使用linkinfo
属性(名称也可以简化为link
)进行配置。如:
[database]
[[database.default]]
type = "mysql"
link = "root:12345678@tcp(127.0.0.1:3306)/test"
[[database.user]]
type = "mysql"
link = "mysql:root:12345678@tcp(127.0.0.1:3306)/user"
也可以简化为:
[database]
[[database.default]]
link = "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
[[database.user]]
link = "mysql:root:12345678@tcp(127.0.0.1:3306)/user"
注意以上每一项分组配置均可以是多个节点,支持负载均衡权重策略。如果不使用多节点负载均衡特性,仅使用配置分组特性,也可以简化为如下格式:
[database]
[database.default]
link = "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
[database.user]
link = "mysql:root:12345678@tcp(127.0.0.1:3306)/user"
如果仅仅是单数据库节点,不使用配置分组特性,那么也可以简化为如下格式:
[database]
link = "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
不同数据类型对应的link
如下:
类型 | link配置 | 更多参数 |
---|---|---|
mysql | mysql: 账号:密码@tcp(地址:端口)/数据库名称 | mysql |
pgsql | pgsql: user=账号 password=密码 host=地址 port=端口 dbname=数据库名称 | pq |
mssql | mssql: user id=账号;password=密码;server=地址;port=端口;database=数据库名称;encrypt=disable | go-mssqldb |
sqlite | sqlite: 文件绝对路径 (如: /var/lib/db.sqlite3 ) | go-sqlite3 |
oracle | oracle: 账号/密码@地址:端口/数据库名称 | go-oci8 |
各数据库类型更详细的linkinfo
参数信息请查看对应引擎官网,参考 数据库ORM 章节
日志输出配置
gdb
支持日志输出,内部使用的是glog.Logger
对象实现日志管理,并且可以通过配置文件对日志对象进行配置。默认情况下gdb
关闭了DEBUG
日志输出,如果需要打开DEBUG
信息需要将数据库的debug
参数设置为true
。以下是为一个配置文件示例:
[database]
[database.logger]
Path = "/var/log/gf-app/sql"
Level = "all"
Stdout = true
[database.primary]
link = "mysql:root:12345678@tcp(127.0.0.1:3306)/user_center"
debug = true
其中database.logger
即为gdb
的日志配置,当该配置不存在时,将会使用日志组件的默认配置,具体请参考 日志组件 章节。
原生配置(高阶,可选)
以下为数据库底层管理配置介绍,如果您对数据库的底层配置管理比较感兴趣,可了解一下。
数据结构
gdb
数据库管理模块的内部配置管理数据结构如下:
type Config map[string]ConfigGroup // 数据库配置对象
type ConfigGroup []ConfigNode // 数据库分组配置
// 数据库配置项(一个分组配置对应多个配置项)
type ConfigNode struct {
Host string // 地址
Port string // 端口
User string // 账号
Pass string // 密码
Name string // 数据库名称
Type string // 数据库类型:mysql, sqlite, mssql, pgsql, oracle
Role string // (可选,默认为master)数据库的角色,用于主从操作分离,至少需要有一个master,参数值:master, slave
Debug bool // (可选)开启调试模式
Charset string // (可选,默认为 utf8)编码,默认为 utf8
Prefix string // (可选)表名前缀
Weight int // (可选)用于负载均衡的权重计算,当集群中只有一个节点时,权重没有任何意义
Linkinfo string // (可选)自定义链接信息,当该字段被设置值时,以上链接字段(Host,Port,User,Pass,Name)将失效(该字段是一个扩展功能)
MaxIdleConnCount int // (可选)连接池最大闲置的连接数
MaxOpenConnCount int // (可选)连接池最大打开的连接数
MaxConnLifetime int // (可选,单位秒)连接对象可重复使用的时间长度
}
ConfigNode
用于存储一个数据库节点信息;ConfigGroup
用于管理多个数据库节点组成的配置分组(一般一个分组对应一个业务数据库集群);Config
用于管理多个ConfigGroup配置分组。
配置管理特点:
- 支持多节点数据库集群管理;
- 每个节点可以单独配置连接属性;
- 采用单例模式管理数据库实例化对象;
- 支持对数据库集群分组管理,按照分组名称获取实例化的数据库操作对象;
- 支持多种关系型数据库管理,可通过
ConfigNode.Type
属性进行配置; - 支持
Master-Slave
读写分离,可通过ConfigNode.Role
属性进行配置; - 支持客户端的负载均衡管理,可通过
ConfigNode.Priority
属性进行配置,值越大,优先级越高;
特别说明,gdb
的配置管理最大的特点是,(同一进程中)所有的数据库集群信息都使用同一个配置管理模块进行统一维护,不同业务的数据库集群配置使用不同的分组名称进行配置和获取。
配置方法
这是原生调用gdb
模块来配置管理数据库。如果开发者想要自行控制数据库配置管理可以参考以下方法。若无需要可忽略该章节。
接口文档: https://godoc.org/github.com/gogf/gf/database/gdb
// 添加一个数据库节点到指定的分组中
func AddConfigNode(group string, node ConfigNode)
// 添加一个配置分组到数据库配置管理中(同名覆盖)
func AddConfigGroup(group string, nodes ConfigGroup)
// 添加一个数据库节点到默认的分组中(默认为default,可修改)
func AddDefaultConfigNode(node ConfigNode)
// 添加一个配置分组到数据库配置管理中(默认分组为default,可修改)
func AddDefaultConfigGroup(nodes ConfigGroup)
// 设置默认的分组名称,获取默认数据库对象时将会自动读取该分组配置
func SetDefaultGroup(groupName string)
// 设置数据库配置为定义的配置信息,会将原有配置覆盖
func SetConfig(c Config)
默认分组表示,如果获取数据库对象时不指定配置分组名称,那么gdb默认读取的配置分组。例如:gdb.New()
可获取一个默认分组的数据库对象。
简单的做法,我们可以通过gdb包的SetConfig
配置管理方法进行自定义的数据库全局配置,例如:
gdb.SetConfig(gdb.Config {
"default" : gdb.ConfigGroup {
gdb.ConfigNode {
Host : "192.168.1.100",
Port : "3306",
User : "root",
Pass : "123456",
Name : "test",
Type : "mysql",
Role : "master",
Weight : 100,
},
gdb.ConfigNode {
Host : "192.168.1.101",
Port : "3306",
User : "root",
Pass : "123456",
Name : "test",
Type : "mysql",
Role : "slave",
Weight : 100,
},
},
"user-center" : gdb.ConfigGroup {
gdb.ConfigNode {
Host : "192.168.1.110",
Port : "3306",
User : "root",
Pass : "123456",
Name : "test",
Type : "mysql",
Role : "master",
Weight : 100,
},
},
})
随后,我们可以使用gdb.New("数据库分组名称")
来获取一个数据库操作对象。该对象用于后续的数据库一系列方法/链式操作。
- No labels
4 Comments
扶程星云
andrew
我觉得上一章说的,获取数据库单例的时候,指定你配置的分组名字就可以获取对应的库了
LZC
[[database.mssql2000]]
link = "mssql:user id=sa;password=12345;server=192.168.10.1;port=1433;database=MES;encrypt=disable"
连接sqlserver2000数据库,出错:
Invalid TDS stream: unknown token type returned: token(0), SELECT * FROM 班组人员清单 WHERE 姓名='王一'
[[database.mssql2008]
link = "mssql:user id=sa;password=12345;server=192.168.10.19;port=1888;database=MES_KanbanPj;encrypt=disable"
连接sqlserver2008数据库,正常
[map[ID:15 NAMP:ZLY 姓名:赵龙玉 姓名1: 姓名2: 岗位: 更新人:管欣宇 更新时间:2021-12-24 09:23:02 更新状态:自动 班组:下料3 设备编号:]]
LZC
现有业务系统大部分是sqlserver2000数据库,一小部分是sqlserver2008数据库,如何解决