go-zero 实战之 blog 系统

// 声明版本，可忽略syntax = "v1"
// 声明一些项目信息，可忽略info(   title: // TODO: add title   desc: // TODO: add description   author: "zhao.zhang"   email: "zhao.zhang@upai.com")
// 重要配置// request 是结构体的名称，可以使用 type 关键词定义新的结构体type request {   // TODO: add members here and delete this comment   // 与 golang 语言一致，这里声明结构体的成员}
// 语法同上，只是业务含义不同。response 一般用来声明返回值。type response {   // TODO: add members here and delete this comment}
// 重要配置// blog-api 是 service 的名称.service blog-api {   // GetUser 是处理请求的视图函数   @handler GetUser // TODO: set handler name and delete this comment   // get 声明了该请求使用 GET 方法   // /users/id/:userId 是 url，:userId 表明是一个变量   // request 就是上面 type 定义的那个 request, 是该请求的入参   // response 就是上面 type 定义的那个 response, 是该请求的返回值。   get /users/id/:userId(request) returns(response)
   @handler CreateUser // TODO: set handler name and delete this comment   post /users/create(request)}

├── blog.api # api 文件├── blog.go # 程序入口文件├── etc│   └── blog-api.yaml # api 网关层配置文件├── go.mod├── go.sum└── internal    ├── config    │   └── config.go # 配置文件    ├── handler # 视图函数层, handler 文件与下面的 logic 文件一一对应    │   ├── adduserhandler.go    │   ├── deleteuserhandler.go    │   ├── getusershandler.go    │   ├── loginhandler.go    │   ├── routes.go    │   └── updateuserhandler.go    ├── logic # 需要手动填充代码的地方    │   ├── adduserlogic.go    │   ├── deleteuserlogic.go    │   ├── getuserslogic.go    │   ├── loginlogic.go    │   └── updateuserlogic.go    ├── svc # 封装 rpc 对象的地方，后面会将    │   └── servicecontext.go    └── types # 把 blog.api 中定义的结构体映射为真正的 golang 结构体        └── types.go

Name: blog-apiHost: 0.0.0.0Port: 8888# 新增 user rpc 服务.User:  Etcd:    #  Hosts 是 user.rpc 服务在 etcd 中的 value 值      Hosts:      - localhost:2379    # Key 是 user.rpc 服务在 etcd 中的 key 值    Key: user.rpc

type Config struct {   rest.RestConf   // 手动添加   // RpcClientConf 是 rpc 客户端的配置, 用来解析在 blog-api.yaml 中的配置   User zrpc.RpcClientConf}

type ServiceContext struct {   Config config.Config   // 手动添加   // users.Users 是 user rpc 服务对外暴露的接口   User   users.Users}
func NewServiceContext(c config.Config) *ServiceContext {   return &ServiceContext{      Config: c,      // 手动添加      //  zrpc.MustNewClient(c.User) 创建了一个 grpc 客户端      User:   users.NewUsers(zrpc.MustNewClient(c.User)),   }}

func (l *LoginLogic) Login(req types.ReqUser) (*types.RespLogin, error) {   // 调用 user rpc 的 login 方法   resp, err := l.svcCtx.User.Login(l.ctx, &users.ReqUser{Username: req.Username, Password: req.Password})   if err != nil {      return nil, err   }   return &types.RespLogin{Token: resp.Token}, nil}

CREATE TABLE `user`(  `id` int NOT NULL AUTO_INCREMENT COMMENT 'id',  `username` varchar(255) NOT NULL UNIQUE COMMENT 'username',  `password` varchar(255) NOT NULL COMMENT 'password',  PRIMARY KEY(`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4

├── user.sql # 手写├── usermodel.go # 自动生成└── vars.go # 自动生成

├── etc│   └── user.yaml # 配置文件，数据库的配置写在这├── internal│   ├── config│   │   └── config.go # config.go 是 yaml 对应的结构体│   ├── logic # 填充业务逻辑的地方│   │   ├── createlogic.go│   │   ├── deletelogic.go│   │   ├── getalllogic.go│   │   ├── getlogic.go│   │   ├── loginlogic.go│   │   └── updatelogic.go│   ├── server│   │   └── usersserver.go│   └── svc│       └── servicecontext.go # 封装各种依赖├── user│   └── user.pb.go├── user.go├── user.proto└── users    └── users.go

Name: user.rpcListenOn: 127.0.0.1:8080Etcd:  Hosts:  - 127.0.0.1:2379  Key: user.rpc# 以下为手动添加的配置# mysql 配置DataSource: root:1234@tcp(localhost:3306)/gozero# 对应的表Table: user# redis 作为换存储Cache:  - Host: localhost:6379

type Config struct {   // zrpc.RpcServerConf 表明继承了 rpc 服务端的配置   zrpc.RpcServerConf   DataSource string          // 手动代码   Cache      cache.CacheConf // 手动代码}

type ServiceContext struct {   Config config.Config   Model  model.UserModel // 手动代码}
func NewServiceContext(c config.Config) *ServiceContext {   return &ServiceContext{      Config: c,      Model:  model.NewUserModel(sqlx.NewMysql(c.DataSource), c.Cache), // 手动代码   }}

func (l *LoginLogic) Login(in *user.ReqUser) (*user.RespLogin, error) {   // todo: add your logic here and delete this line   one, err := l.svcCtx.Model.FindByName(in.Username)   if err != nil {      return nil, errors.Wrapf(err, "FindUser %s", in.Username)   }
   if one.Password != in.Password {      return nil, fmt.Errorf("user or password is invalid")   }
   token := GenTokenByHmac(one.Username, secretKey)   return &user.RespLogin{Token: token}, nil}