模板修改

场景

实现统一格式的body相应，格式如下：

  1. {
  2.   "code": 0,
  3.   "msg": "OK",
  4.   "data": {} // ①
  5. }

① 实际相应数据

[!TIP] go-zero生成的代码没有对其进行处理

准备工作

我们提前在module为greet的工程下的response包中写一个Response方法，目录树类似如下：

  1. greet
  2. ├── reponse
  3. │   └── response.go
  4. └── xxx...

代码如下

  1. package reponse
  3. import (
  4.     "net/http"
  6.     "github.com/tal-tech/go-zero/rest/httpx"
  7. )
  9. type Body struct {
  10.     Code int         `json:"code"`
  11.     Msg  string      `json:"msg"`
  12.     Data interface{} `json:"data,omitempty"`
  13. }
  15. func Response(w http.ResponseWriter, resp interface{}, err error) {
  16.     var body Body
  17.     if err != nil {
  18.         body.Code = -1
  19.         body.Msg = err.Error()
  20.     } else {
  21.         body.Msg = "OK"
  22.         body.Data = resp
  23.     }
  24.     httpx.OkJson(w, body)
  25. }

修改handler模板

  1. $ vim ~/.goctl/api/handler.tpl

将模板替换为以下内容

  1. package handler
  3. import (
  4.     "net/http"
  5.     "greet/response"// ①
  7.     {{.ImportPackages}}
  8. )
  10. func {{.HandlerName}}(ctx *svc.ServiceContext) http.HandlerFunc {
  11.     return func(w http.ResponseWriter, r *http.Request) {
  12.         {{if .HasRequest}}var req types.{{.RequestType}}
  13.         if err := httpx.Parse(r, &req); err != nil {
  14.             httpx.Error(w, err)
  15.             return
  16.         }{{end}}
  18.         l := logic.New{{.LogicType}}(r.Context(), ctx)
  19.         {{if .HasResp}}resp, {{end}}err := l.{{.Call}}({{if .HasRequest}}req{{end}})
  20.         {{if .HasResp}}reponse.Response(w, resp, err){{else}}reponse.Response(w, nil, err){{end}}//②
  22.     }
  23. }

① 替换为你真实的response包名，仅供参考

② 自定义模板内容

[!TIP]

1.如果本地没有~/.goctl/api/handler.tpl文件，可以通过模板初始化命令goctl template init进行初始化

修改模板前后对比

  • 修改前

    1. func GreetHandler(ctx *svc.ServiceContext) http.HandlerFunc {
    2.   return func(w http.ResponseWriter, r *http.Request) {
    3.       var req types.Request
    4.       if err := httpx.Parse(r, &req); err != nil {
    5.           httpx.Error(w, err)
    6.           return
    7.       }
    9.       l := logic.NewGreetLogic(r.Context(), ctx)
    10.       resp, err := l.Greet(req)
    11.       // 以下内容将被自定义模板替换
    12.       if err != nil {
    13.           httpx.Error(w, err)
    14.       } else {
    15.           httpx.OkJson(w, resp)
    16.       }
    17.   }
    18. }

  • 修改后

    1. func GreetHandler(ctx *svc.ServiceContext) http.HandlerFunc {
    2.   return func(w http.ResponseWriter, r *http.Request) {
    3.       var req types.Request
    4.       if err := httpx.Parse(r, &req); err != nil {
    5.           httpx.Error(w, err)
    6.           return
    7.       }
    9.       l := logic.NewGreetLogic(r.Context(), ctx)
    10.       resp, err := l.Greet(req)
    11.       reponse.Response(w, resp, err)
    12.   }
    13. }

修改模板前后响应体对比

  • 修改前

    1. {
    2.   "message": "Hello go-zero!"
    3. }

  • 修改后

    1. {
    2.   "code": 0,
    3.   "msg": "OK",
    4.   "data": {
    5.       "message": "Hello go-zero!"
    6.   }
    7. }

总结

本文档仅对http相应为例讲述了自定义模板的流程，除此之外，自定义模板的场景还有：

  • model 层添加kmq
  • model 层生成待有效期option的model实例
  • http自定义相应格式 …