这章开始,我们将会接触到数据库的相关内容,使用了gorm这个库,gorm中文文档这里查看中文文档。
进行之前,要保证电脑安装了mysql,可以看我这篇文章安装mysql,安装完成后,要创建数据库和配置文件当中的保持一致,比如app.ini
中配置的数据库名称为api
。
使用gorm依赖
终端执行下载gorm
go get -u github.com/jinzhu/gorm
创建models/models.go
文件,在这个文件中创建初始化方法
models/models.go
package models
import (
"api/pkg/logging"
"api/pkg/setting"
"fmt"
"github.com/jinzhu/gorm"
_ "github.com/jinzhu/gorm/dialects/mysql"
)
var db *gorm.DB //数据库实例,定义为了全局变量
func SetUp() {
var (
err error
databaseType = setting.DatabaseSetting.Type //数据库类型
user = setting.DatabaseSetting.User //数据库的用户
pass = setting.DatabaseSetting.Password //数据库的密码
host = setting.DatabaseSetting.Host //数据库地址
name = setting.DatabaseSetting.Name //数据库名称
)
//使用gorm链接数据库
db , err = gorm.Open(databaseType,fmt.Sprintf("%s:%s@tcp(%s)/%s?charset=utf8&parseTime=True",user,pass,host,name))
if err != nil {
logging.Fatal("数据库链接失败",err) //数据库链接失败是致命的错误,链接失败后可以关闭程序了,所以使用logging.Fatal方法
}
//设置表名称的前缀
gorm.DefaultTableNameHandler = func(db *gorm.DB, defaultTableName string) string {
return setting.DatabaseSetting.TablePrefix + defaultTableName
}
db.SingularTable(true) //设置禁用表名的复数形式
db.LogMode(true) //打印日志,本地调试的时候可以打开看执行的sql语句
db.DB().SetMaxIdleConns(10) //设置空闲时的最大连接数
db.DB().SetMaxOpenConns(100) //设置数据库的最大打开连接数
}
注意一点,在使用gorm操作mysql数据库的时候,不要漏掉import _ "github.com/jinzhu/gorm/dialects/mysql"
,否则运行的时候会报错
在main.go
文件中初始化
...
setting.SetUp() //初始化配置文件
logging.SetUp() //设置日志文件
models.SetUp() //设置数据库
...
可以在终端执行go run main.go
,查看下是否链接mysql成功。
用户数据库模型
项目把用户的登录和注册做成了一个接口,整个流程如下:
根据上述流程,设计一个简单的user表。如下
用户表
字段名 | 类型 | 描述 | 备注 |
---|---|---|---|
id | int | 自增长 ID | 主键 |
create_at | date | 创建时间 | gorm自带 |
update_at | date | 更新时间 | gorm自带 |
deleted_at | date | 删除时间 | gorm自带 |
mobile | char(11) | 手机号 | 手机号,因为是固定的11位格式,使用char格式,加索引,唯一且不为nil |
id
,create_at
,update_at
,deleted_at
使用的是gorm.model
结构体自动创建的。以后不会在文章中说明这4个字段,但我们要知道。
先简单的创建了一个mobile
供我们使用,后续会添加例如name
...字段,使用gorm的自动维护。
在models/user.go
文件中创建用户模型
package models
import "github.com/jinzhu/gorm"
type User struct {
gorm.Model //会自动添加id,created_at,updated_at,deleted_at四个字段,可以进入看下类型
Mobile string `gorm:"type:char(11);index;unique;not null;" json:"mobile,omitempty"` //手机号,加索引,唯一,不为空
}
这样的话,就定义了一个简单的user模型。然后就交给gorm,让它来根据模型创建数据表。
models/models.go
...
db.LogMode(true) //打印日志,本地调试的时候可以打开看执行的sql语句
db.AutoMigrate(&User{}) //自动检查 Tag 结构是否变化,变化则进行迁移,需要的参数为数据库模型结构体
...
使用AutoMigrate
方法,可以自动维护,只要把定义好的结构体传入即可。然后重新执行go run main.go
可以看到成功的创建了用户表。
后期需要在user表中添加新的字段,比如name,age等,就可以直接在结构体中添加,重新run一下,gorm就会自动帮我们维护数据表了。
根据项目的需求,整理了一下user表所需要的字段:
用户表
字段名 | 类型 | 描述 | 备注 |
---|---|---|---|
id | int | 自增长 ID | 主键 |
mobile | char(11) | 手机号 | 手机号,因为是固定的11位格式,使用char格式,加索引,唯一且不为nil |
name | varchar(12) | 昵称 | 唯一 |
desc | varchar(100) | 个人简介 | 简介 |
sex | tinyint(1) | 性别 | 性别,1=man,2=woman,使用tinyint格式,默认为0未知 |
age | int | 年龄 | 用户年龄,存储的是时间戳,注意要用int64,因为flutter只有13位的时间戳 |
avator | varchar(255) | 头像 | 头像 |
follow_num | int | 关注数 | 用户关注他人的数量 |
fans_num | int | 粉丝数 | 用户的粉丝数 |
state | tinyint(1) | 状态 | 用户状态,比如=1账号冻结,=2不允许聊天之类的,默认=0 |
weixin_openid | varchar | 微信授权用户唯一标示 | 唯一 |
weixin_unionid | varchar | 微信授权用户唯一标示 | 唯一 |
qq_openid | varchar | QQ授权用户唯一标示 | 唯一 |
那么结构体User的格式如下:
package models
import (
"database/sql"
"github.com/jinzhu/gorm"
)
type User struct {
gorm.Model //会自动添加id,created_at,updated_at,deleted_at四个字段,可以进入看下类型
Mobile string `gorm:"type:char(11);index;unique;not null;" json:"mobile,omitempty"` //手机号,加索引,唯一,不为空
Name string `gorm:"type:varchar(12);"` //用户昵称,3-12个字符
Desc string `gorm:"type:varchar(100);"`
Sex int `gorm:"type:tinyint(1);default:0;"`
Age string `gorm:"type:char(13);"` //用户年龄,存储的是时间戳字符串
Avatar string `gorm:"type:varchar(255);"`
FollowNum int `gorm:"default:0;"`
FansNum int `gorm:"default:0;"`
State int `gorm:"type:tinyint(1);default:0;" json:"-"` //用户状态,比如=1账号冻结,=2不允许聊天之类的,默认=0,为json时不返回
WeixinOpenid sql.NullString `gorm:"unique;index;" json:"-"` //微信openeid,唯一,加索引,json不返回,注意类型使用sql.NullString。因为设置了唯一,而string默认为"",所以会有冲突,一下同理
WeixinUnionid sql.NullString `gorm:"unique;" json:"-"` //微信unionid,唯一,json不返回
QqOpenid sql.NullString `gorm:"unique;index;" json:"-"` //QQopenid,唯一,加索引,json不返回
}
可以对应上面的表格,看下gorm是如何定义的。
注释中也有详细的解释,注意看下,比如为什么用sql.NullString类型。
最后重新执行run命令
点关注,不迷路