/gin_auto_template_layout

Primary LanguageGo

merchant

初始化项目工具

  • 请使用linux环境
  • 安装mysqldump
  • 将./scripts/exec/sql2struct 执行文件拷贝至环境变量目录下
  • 安装swag: 
    go get -u github.com/swaggo/swag/cmd/swag
// 引入依赖
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files

项目结构

.
├── bin         //执行文件目录
│   └── configs
├── cmd                    //项目启动目录
│   └── api
├── configs               //配置文件目录，打包命令会拷贝至bin目录
├── internal              //逻辑层目录
│   ├── config             //逻辑配置目录
│   ├── data               //数据层目录
│   │   ├── conn     //数据层链接目录
│   │   └── po       //持久化结构目录，PO:用于持久化数据到数据库
│   ├── logic              //业务逻辑目录
│   │   ├── dto      //传输数据结构目录，DTO: 用于在不同的应用程序组件之间传输数据
│   │   └── nsq      //NSQ消息队列方法实现
│   ├── router             //路由目录
│   │   └── middleware   //中间件目录
│   └── server                    //服务目录
├── log
├── pkg                                 //内部包目录
│   ├── auth
│   ├── bootstrap
│   ├── ginx
│   ├── statusx
│   └── util
└── scripts                           //执行脚本相关目录
├── exec
├── sql
└── template

参考 : 领域驱动系列-浅析VO、DTO、DO、PO

使用说明

项目集成内容

  • Gin
  • Gorm
  • Redis
  • NSQ
  • ClickHouse
  • ./stop.sh 支持优雅关闭http服务
  • 参数校验: [validator] 直接在参数中配置TAG binding:"required"
  • swag swag init可以生成swagger文档，http://localhost:8099/swagger/index.html#/ 访问接口文档

中间件集成内容

  • Oauth2
  • 跨域，与nginx配置的跨域冲突
  • Casbin鉴权

Casbin鉴权相关介绍

  • ./configs/rbac_model.conf 存放Casbin校验规则
  • ./configs/perm_config.json 存放当前目录下所有用户组path及method列表

相关命令

注 : make执行需要的执行程序详见scripts/exec目录

  • 通过传参导出.sql文件: make sql2file DATABASE=log TABLES=user TABLES=sys_roles
    • WARNING : 重复生成会覆盖。TABLES需要传入数据库对应表名，数据库地址及密码在根目录makefile文件中修改
  • 生成po目录文件: make sql2po TABLES=user TABLES=sys_roles
    • WARNING : 重复生成会覆盖
  • 生成dto目录文件: make sql2dto TABLES=user TABLES=sys_roles
    • WARNING : 重复生成会覆盖
  • 生成增删改查文件: 具体查看logic/template逻辑,请求接口传入对应参数
    • 请求参数请查看 ./internal/logic/system/template.go
    • 开发注意: 生成完增删改查文件后，需要手动修改po目录中struct统一命名
    • 请求结构例: type User struct { -> type UserReq struct {
    • 返回结构例: type User struct { -> type UserResp struct {
  • 编译文件: make build
  • 打包文件: make package
  • 启动服务: 拷贝bin目录至任何位置，或直接进入bin目录。测试环境执行 ./start.sh config.test.yml
  • 停止服务: 线上环境 请务使用 ./stop.sh 关闭服务