github/go-gin-api
4
0
Fork 0
mirror of https://github.com/xinliangnote/go-gin-api.git synced 2024-04-21 12:31:46 +00:00
Code Issues Releases Wiki Activity

#11 code generator

Browse Source
This commit is contained in:
新亮
2021-02-27 09:29:34 +08:00
parent 0b6b9dd69f
commit 3823eee2ca
36 changed files with 1261 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/api/controller/user_handler/func_create.go
+1 -1
View File
@@ -18,7 +18,7 @@ type createRequest struct {
}
type createResponse struct {
Id uint `json:"id"` // 主键ID
Id int32 `json:"id"` // 主键ID
}
// 创建用户
internal/api/controller/user_handler/func_delete.go
+5 -5
View File
@@ -9,16 +9,16 @@ import (
)
type deleteRequest struct {
Id uint `uri:"id"` // 用户ID
Id int32 `uri:"id"` // 用户ID
}
type deleteResponse struct {
Id uint `json:"id"` // 用户主键ID
Id int32 `json:"id"` // 用户主键ID
}
// 删除用户 - 更新 is_deleted = 1
// @Summary 删除用户 - 更新 is_deleted = 1
// @Description 删除用户 - 更新 is_deleted = 1
// 删除用户
// @Summary 删除用户
// @Description 删除用户
// @Tags User
// @Accept json
// @Produce json
internal/api/controller/user_handler/func_detail.go
+1 -1
View File
@@ -14,7 +14,7 @@ type detailRequest struct {
}
type detailResponse struct {
Id uint `json:"id"` // 用户主键ID
Id int32 `json:"id"` // 用户主键ID
UserName string `json:"user_name"` // 用户名
NickName string `json:"nick_name"` // 昵称
Mobile ddm.Mobile `json:"mobile"` // 手机号（脱敏）
internal/api/controller/user_handler/func_updatenicknamebyid.go
+2 -2
View File
@@ -9,12 +9,12 @@ import (
)
type updateNickNameByIDRequest struct {
Id uint `json:"id"` // 用户主键ID
Id int32 `json:"id"` // 用户主键ID
NickName string `json:"nick_name"` // 昵称
}
type updateNickNameByIDResponse struct {
Id uint `json:"id"` // 用户主键ID
Id int32 `json:"id"` // 用户主键ID
}
// 编辑用户 - 通过用户主键ID更新用户昵称
internal/api/controller/user_handler/handler.go
+1 -1
View File
@@ -18,7 +18,7 @@ type Handler interface {
Create() core.HandlerFunc
// UpdateNickNameByID 编辑用户 - 通过主键ID更新用户昵称
UpdateNickNameByID() core.HandlerFunc
// Delete 删除用户 - 通过主键ID更新 is_deleted = 1
// Delete 删除用户
Delete() core.HandlerFunc
// Detail 用户详情
Detail() core.HandlerFunc
internal/api/repository/README.md
+13 -10
View File
@@ -1,16 +1,12 @@
## repository
数据访问层。
#### 数据访问层。
- `./db_repo` 访问 DB 数据
- `./cache_repo` 访问 Cache 数据
- `./third_party_request` 访问外部 HTTP 接口数据。
SQL 建议：
- 禁止使用 SQL k v 拼接，好处是避免 SQL 注入；
- 禁止使用连表查询，好处是易扩展，比如分库分表；
- 禁止使用万能方法，好处是便于后期维护，比如字段调整；
- 禁止使用删除方法，好处是避免数据丢失；
#### SQL 建议：
- 建议每张表需包含字段：主键(id)、标记删除(is_deteled)、创建时间(created_at)、更新时间(updated_at)
```mysql
@@ -19,11 +15,18 @@ SQL 建议：
`created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
```
什么是万能方法？
指的是特别灵活的查询，比如通过非固定的参数返回全部字段，建议做到需要什么返回什么，不要返回大而全的数据，更新时也不能传递什么参数更新什么参数，更新字段要提前约定好。
命名规范：
#### 命名规范：
- 包名应以 `_repo` 结尾；
- `./db_repo` 目录下的包名以 `数据表名`+ `_repo` 命名；
#### 脚本生成 MySQL CURD
1. 定义生成的表，设置 config 中 cmd.genTables，可以自定义设置多张表，为空表示生成库中所有的表，如果设置多个表可用','分割；
1. 在根目录下执行脚本文件：`./scripts/gormgen.sh`；
以用户表（user_demo）为例：
- 结构体文件：user_demo_repo/gen_model.go；
- CURD 方法文件：user_demo_repo/gen_user_demo.go；
- 表结构 MD 文件：user_demo_repo/gen_table.md；
internal/api/repository/db_repo/db.go
+14
View File
@@ -0,0 +1,14 @@
package db_repo
// Predicate is a string that acts as a condition in the where clause
type Predicate string
var (
EqualPredicate = Predicate("=")
NotEqualPredicate = Predicate("<>")
GreaterThanPredicate = Predicate(">")
GreaterThanOrEqualPredicate = Predicate(">=")
SmallerThanPredicate = Predicate("<")
SmallerThanOrEqualPredicate = Predicate("<=")
LikePredicate = Predicate("LIKE")
)
internal/api/repository/db_repo/user_demo_repo/gen_model.go
Executable
+15
View File
@@ -0,0 +1,15 @@
package user_demo_repo
import "time"
// 用户Demo表
//go:generate gormgen -structs UserDemo -input .
type UserDemo struct {
Id int32 // 主键
UserName string // 用户名
NickName string // 昵称
Mobile string // 手机号
IsDeleted int32 // 是否删除 1:是 -1:否
CreatedAt time.Time `gorm:"time"` // 创建时间
UpdatedAt time.Time `gorm:"time"` // 更新时间
}
internal/api/repository/db_repo/user_demo_repo/gen_table.md
Executable
+12
View File
@@ -0,0 +1,12 @@
#### xin_ceshi.user_demo
用户Demo表
| 序号 | 名称 | 描述 | 类型 | 键 | 为空 | 额外 | 默认值 |
| :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: |
| 1 | id | 主键 | int(11) unsigned | PRI | NO | auto_increment | |
| 2 | user_name | 用户名 | varchar(32) | | NO | | |
| 3 | nick_name | 昵称 | varchar(100) | | NO | | |
| 4 | mobile | 手机号 | varchar(20) | | NO | | |
| 5 | is_deleted | 是否删除 1:是 -1:否 | tinyint(1) | | NO | | -1 |
| 6 | created_at | 创建时间 | timestamp | | NO | | CURRENT_TIMESTAMP |
| 7 | updated_at | 更新时间 | timestamp | | NO | on update CURRENT_TIMESTAMP | CURRENT_TIMESTAMP |
internal/api/repository/db_repo/user_demo_repo/gen_user_demo.go
Executable
+257
View File
@@ -0,0 +1,257 @@
///////////////////////////////////////////////////////////
// THIS FILE IS AUTO GENERATED by gormgen, DON'T EDIT IT //
// ANY CHANGES DONE HERE WILL BE LOST //
///////////////////////////////////////////////////////////
package user_demo_repo
import (
"fmt"
"time"
"github.com/xinliangnote/go-gin-api/internal/api/repository/db_repo"
"github.com/pkg/errors"
"gorm.io/gorm"
)
func NewModel() *UserDemo {
return new(UserDemo)
}
func NewQueryBuilder() *userDemoRepoQueryBuilder {
return new(userDemoRepoQueryBuilder)
}
func (t *UserDemo) Create(db *gorm.DB) (id int32, err error) {
if err = db.Create(t).Error; err != nil {
return 0, errors.Wrap(err, "create err")
}
return t.Id, nil
}
func (t *UserDemo) Delete(db *gorm.DB) (err error) {
if err = db.Delete(t).Error; err != nil {
return errors.Wrap(err, "delete err")
}
return nil
}
func (t *UserDemo) Updates(db *gorm.DB, m map[string]interface{}) (err error) {
if err = db.Model(&UserDemo{}).Where("id = ?", t.Id).Updates(m).Error; err != nil {
return errors.Wrap(err, "updates err")
}
return nil
}
type userDemoRepoQueryBuilder struct {
order []string
where []struct {
prefix string
value interface{}
}
limit int
offset int
}
func (qb *userDemoRepoQueryBuilder) buildQuery(db *gorm.DB) *gorm.DB {
ret := db
for _, where := range qb.where {
ret = ret.Where(where.prefix, where.value)
}
for _, order := range qb.order {
ret = ret.Order(order)
}
ret = ret.Limit(qb.limit).Offset(qb.offset)
return ret
}
func (qb *userDemoRepoQueryBuilder) Count(db *gorm.DB) (int64, error) {
var c int64
res := qb.buildQuery(db).Model(&UserDemo{}).Count(&c)
if res.Error != nil && res.Error == gorm.ErrRecordNotFound {
c = 0
}
return c, res.Error
}
func (qb *userDemoRepoQueryBuilder) First(db *gorm.DB) (*UserDemo, error) {
ret := &UserDemo{}
res := qb.buildQuery(db).First(ret)
if res.Error != nil && res.Error == gorm.ErrRecordNotFound {
ret = nil
}
return ret, res.Error
}
func (qb *userDemoRepoQueryBuilder) QueryOne(db *gorm.DB) (*UserDemo, error) {
qb.limit = 1
ret, err := qb.QueryAll(db)
if len(ret) > 0 {
return ret[0], err
}
return nil, err
}
func (qb *userDemoRepoQueryBuilder) QueryAll(db *gorm.DB) ([]*UserDemo, error) {
var ret []*UserDemo
err := qb.buildQuery(db).Find(&ret).Error
return ret, err
}
func (qb *userDemoRepoQueryBuilder) Limit(limit int) *userDemoRepoQueryBuilder {
qb.limit = limit
return qb
}
func (qb *userDemoRepoQueryBuilder) Offset(offset int) *userDemoRepoQueryBuilder {
qb.offset = offset
return qb
}
func (qb *userDemoRepoQueryBuilder) WhereId(p db_repo.Predicate, value int32) *userDemoRepoQueryBuilder {
qb.where = append(qb.where, struct {
prefix string
value interface{}
}{
fmt.Sprintf("%v %v ?", "id", p),
value,
})
return qb
}
func (qb *userDemoRepoQueryBuilder) OrderById(asc bool) *userDemoRepoQueryBuilder {
order := "DESC"
if asc {
order = "ASC"
}
qb.order = append(qb.order, "id "+order)
return qb
}
func (qb *userDemoRepoQueryBuilder) WhereUserName(p db_repo.Predicate, value string) *userDemoRepoQueryBuilder {
qb.where = append(qb.where, struct {
prefix string
value interface{}
}{
fmt.Sprintf("%v %v ?", "user_name", p),
value,
})
return qb
}
func (qb *userDemoRepoQueryBuilder) OrderByUserName(asc bool) *userDemoRepoQueryBuilder {
order := "DESC"
if asc {
order = "ASC"
}
qb.order = append(qb.order, "user_name "+order)
return qb
}
func (qb *userDemoRepoQueryBuilder) WhereNickName(p db_repo.Predicate, value string) *userDemoRepoQueryBuilder {
qb.where = append(qb.where, struct {
prefix string
value interface{}
}{
fmt.Sprintf("%v %v ?", "nick_name", p),
value,
})
return qb
}
func (qb *userDemoRepoQueryBuilder) OrderByNickName(asc bool) *userDemoRepoQueryBuilder {
order := "DESC"
if asc {
order = "ASC"
}
qb.order = append(qb.order, "nick_name "+order)
return qb
}
func (qb *userDemoRepoQueryBuilder) WhereMobile(p db_repo.Predicate, value string) *userDemoRepoQueryBuilder {
qb.where = append(qb.where, struct {
prefix string
value interface{}
}{
fmt.Sprintf("%v %v ?", "mobile", p),
value,
})
return qb
}
func (qb *userDemoRepoQueryBuilder) OrderByMobile(asc bool) *userDemoRepoQueryBuilder {
order := "DESC"
if asc {
order = "ASC"
}
qb.order = append(qb.order, "mobile "+order)
return qb
}
func (qb *userDemoRepoQueryBuilder) WhereIsDeleted(p db_repo.Predicate, value int32) *userDemoRepoQueryBuilder {
qb.where = append(qb.where, struct {
prefix string
value interface{}
}{
fmt.Sprintf("%v %v ?", "is_deleted", p),
value,
})
return qb
}
func (qb *userDemoRepoQueryBuilder) OrderByIsDeleted(asc bool) *userDemoRepoQueryBuilder {
order := "DESC"
if asc {
order = "ASC"
}
qb.order = append(qb.order, "is_deleted "+order)
return qb
}
func (qb *userDemoRepoQueryBuilder) WhereCreatedAt(p db_repo.Predicate, value time.Time) *userDemoRepoQueryBuilder {
qb.where = append(qb.where, struct {
prefix string
value interface{}
}{
fmt.Sprintf("%v %v ?", "created_at", p),
value,
})
return qb
}
func (qb *userDemoRepoQueryBuilder) OrderByCreatedAt(asc bool) *userDemoRepoQueryBuilder {
order := "DESC"
if asc {
order = "ASC"
}
qb.order = append(qb.order, "created_at "+order)
return qb
}
func (qb *userDemoRepoQueryBuilder) WhereUpdatedAt(p db_repo.Predicate, value time.Time) *userDemoRepoQueryBuilder {
qb.where = append(qb.where, struct {
prefix string
value interface{}
}{
fmt.Sprintf("%v %v ?", "updated_at", p),
value,
})
return qb
}
func (qb *userDemoRepoQueryBuilder) OrderByUpdatedAt(asc bool) *userDemoRepoQueryBuilder {
order := "DESC"
if asc {
order = "ASC"
}
qb.order = append(qb.order, "updated_at "+order)
return qb
}
internal/api/repository/db_repo/user_demo_repo/model.go
-20
View File
@@ -1,20 +0,0 @@
package user_demo_repo
import (
"time"
)
// 用户Demo表
type UserDemo struct {
Id uint `gorm:"column:id;primary_key;AUTO_INCREMENT"` // 主键
UserName string `gorm:"column:user_name;NOT NULL"` // 用户名
NickName string `gorm:"column:nick_name;NOT NULL"` // 昵称
Mobile string `gorm:"column:mobile;NOT NULL"` // 手机号
IsDeleted int `gorm:"column:is_deleted;default:-1;NOT NULL"` // 是否删除 1:是 -1:否
CreatedAt time.Time `gorm:"column:created_at;default:CURRENT_TIMESTAMP;NOT NULL"` // 创建时间
UpdatedAt time.Time `gorm:"column:updated_at;default:CURRENT_TIMESTAMP;NOT NULL"` // 更新时间
}
func (m *UserDemo) TableName() string {
return "user_demo"
}
internal/api/repository/db_repo/user_demo_repo/user_demo.go
-80
View File
@@ -1,80 +0,0 @@
package user_demo_repo
import (
"github.com/xinliangnote/go-gin-api/internal/pkg/core"
"github.com/xinliangnote/go-gin-api/internal/pkg/db"
"github.com/pkg/errors"
"gorm.io/gorm"
)
var _ UserRepo = (*userRepo)(nil)
type UserRepo interface {
// i 为了避免被其他包实现
i()
Create(ctx core.Context, user UserDemo) (id uint, err error)
UpdateNickNameByID(ctx core.Context, id uint, username string) (err error)
GetUserByUserName(ctx core.Context, username string) (*UserDemo, error)
Delete(ctx core.Context, id uint) (err error)
getUserByID(ctx core.Context, id uint) (*UserDemo, error)
}
type userRepo struct {
db db.Repo
}
func NewUserRepo(db db.Repo) UserRepo {
return &userRepo{
db: db,
}
}
func (u *userRepo) i() {}
func (u *userRepo) Create(ctx core.Context, user UserDemo) (id uint, err error) {
err = u.db.GetDbW().WithContext(ctx.RequestContext()).Create(&user).Error
if err != nil {
return 0, errors.Wrap(err, "[user_repo] create user err")
}
return user.Id, nil
}
func (u *userRepo) getUserByID(ctx core.Context, id uint) (*UserDemo, error) {
data := new(UserDemo)
err := u.db.GetDbR().
WithContext(ctx.RequestContext()).First(data, id).Where("is_deleted = ?", -1).Error
if err != nil && err != gorm.ErrRecordNotFound {
return nil, errors.Wrap(err, "[user_demo] get user data err")
}
return data, nil
}
func (u *userRepo) UpdateNickNameByID(ctx core.Context, id uint, nickname string) (err error) {
user, err := u.getUserByID(ctx, id)
if err != nil {
return errors.Wrap(err, "[user_demo] get user data err")
}
return u.db.GetDbW().WithContext(ctx.RequestContext()).Model(user).Update("nick_name", nickname).Error
}
func (u *userRepo) Delete(ctx core.Context, id uint) (err error) {
user, err := u.getUserByID(ctx, id)
if err != nil {
return errors.Wrap(err, "[user_demo] get user data err")
}
return u.db.GetDbW().WithContext(ctx.RequestContext()).Model(user).Update("is_deleted", 1).Error
}
func (u *userRepo) GetUserByUserName(ctx core.Context, username string) (*UserDemo, error) {
data := new(UserDemo)
err := u.db.GetDbR().
WithContext(ctx.RequestContext()).
Select([]string{"id", "user_name", "nick_name", "mobile"}).
Where("user_name = ? and is_deleted = ?", username, -1).
First(data).Error
if err != nil && err != gorm.ErrRecordNotFound {
return nil, errors.Wrap(err, "[user_demo] get user data err")
}
return data, nil
}
internal/api/service/user_service/func_create.go
+6 -7
View File
@@ -11,14 +11,13 @@ type CreateUserInfo struct {
Mobile string `json:"mobile"` // 手机号
}
func (u *userSer) Create(ctx core.Context, user *CreateUserInfo) (id uint, err error) {
create := user_demo_repo.UserDemo{
UserName: user.UserName,
NickName: user.NickName,
Mobile: user.Mobile,
}
func (u *userSer) Create(ctx core.Context, user *CreateUserInfo) (id int32, err error) {
model := user_demo_repo.NewModel()
model.UserName = user.UserName
model.NickName = user.NickName
model.Mobile = user.Mobile
id, err = u.userRepo.Create(ctx, create)
id, err = model.Create(u.db.GetDbW().WithContext(ctx.RequestContext()))
if err != nil {
return 0, err
}
internal/api/service/user_service/func_delete.go
+8 -3
View File
@@ -1,9 +1,14 @@
package user_service
import "github.com/xinliangnote/go-gin-api/internal/pkg/core"
import (
"github.com/xinliangnote/go-gin-api/internal/api/repository/db_repo/user_demo_repo"
"github.com/xinliangnote/go-gin-api/internal/pkg/core"
)
func (u *userSer) Delete(ctx core.Context, id uint) (err error) {
err = u.userRepo.Delete(ctx, id)
func (u *userSer) Delete(ctx core.Context, id int32) (err error) {
model := user_demo_repo.NewModel()
model.Id = id
err = model.Delete(u.db.GetDbW().WithContext(ctx.RequestContext()))
if err != nil {
return nil
}
internal/api/service/user_service/func_getuserbyusername.go
+11 -2
View File
@@ -1,14 +1,23 @@
package user_service
import (
"github.com/xinliangnote/go-gin-api/internal/api/repository/db_repo"
"github.com/xinliangnote/go-gin-api/internal/api/repository/db_repo/user_demo_repo"
"github.com/xinliangnote/go-gin-api/internal/pkg/core"
)
func (u *userSer) GetUserByUserName(ctx core.Context, username string) (user *user_demo_repo.UserDemo, err error) {
user, err = u.userRepo.GetUserByUserName(ctx, username)
user, err = user_demo_repo.NewQueryBuilder().
WhereUserName(db_repo.EqualPredicate, username).
QueryOne(u.db.GetDbR().WithContext(ctx.RequestContext()))
if err != nil {
return nil, err
return user, err
}
if user == nil {
user = user_demo_repo.NewModel()
}
return user, nil
}
internal/api/service/user_service/func_updatenicknamebyid.go
+16 -5
View File
@@ -1,11 +1,22 @@
package user_service
import "github.com/xinliangnote/go-gin-api/internal/pkg/core"
import (
"github.com/xinliangnote/go-gin-api/internal/api/repository/db_repo/user_demo_repo"
"github.com/xinliangnote/go-gin-api/internal/pkg/core"
)
func (u *userSer) UpdateNickNameByID(ctx core.Context, id uint, username string) (err error) {
err = u.userRepo.UpdateNickNameByID(ctx, id, username)
if err != nil {
return nil
func (u *userSer) UpdateNickNameByID(ctx core.Context, id int32, nickname string) (err error) {
model := user_demo_repo.NewModel()
model.Id = id
data := map[string]interface{}{
"nick_name": nickname,
}
err = model.Updates(u.db.GetDbW().WithContext(ctx.RequestContext()), data)
if err != nil {
return err
}
return nil
}
internal/api/service/user_service/service.go
+7 -10
View File
@@ -13,24 +13,21 @@ type UserService interface {
// i 为了避免被其他包实现
i()
Create(ctx core.Context, user *CreateUserInfo) (id uint, err error)
UpdateNickNameByID(ctx core.Context, id uint, username string) (err error)
Create(ctx core.Context, user *CreateUserInfo) (id int32, err error)
UpdateNickNameByID(ctx core.Context, id int32, username string) (err error)
GetUserByUserName(ctx core.Context, username string) (user *user_demo_repo.UserDemo, err error)
Delete(ctx core.Context, id uint) (err error)
Delete(ctx core.Context, id int32) (err error)
}
type userSer struct {
db db.Repo
cache cache.Repo
userRepo user_demo_repo.UserRepo
db db.Repo
cache cache.Repo
}
func NewUserService(db db.Repo, cache cache.Repo) UserService {
userRepo := user_demo_repo.NewUserRepo(db)
return &userSer{
db: db,
cache: cache,
userRepo: userRepo,
db: db,
cache: cache,
}
}
internal/pkg/db/mysql.go
+4
View File
@@ -9,6 +9,7 @@ import (
"github.com/pkg/errors"
"gorm.io/driver/mysql"
"gorm.io/gorm"
"gorm.io/gorm/schema"
)
var _ Repo = (*dbRepo)(nil)
@@ -80,6 +81,9 @@ func dbConnect(user, pass, addr, dbName string) (*gorm.DB, error) {
"Local")
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{
NamingStrategy: schema.NamingStrategy{
SingularTable: true,
},
//Logger: logger.Default.LogMode(logger.Info), // 日志配置
})