Template Modification

    ① 实际相应数据

    We go ahead and write a Response method in the response package under the project with module as greet, with a directory tree similar to the following.

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

    The code is as follows

    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.Data = resp
    22.     }
    23.     httpx.OkJson(w, body)
    24. }
    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. }

    ① Replace with your real response package name, for reference only

    ② Customized template content

    [!TIP]

    1.If there is no local file, you can initialize it with the template initialization command goctl template init

      1. func GreetHandler(ctx *svc.ServiceContext) http.HandlerFunc {
      2.   return func(w http.ResponseWriter, r *http.Request) {
      3.       if err := httpx.Parse(r, &req); err != nil {
      4.           httpx.Error(w, err)
      5.           return
      6.       }
      8.       l := logic.NewGreetLogic(r.Context(), ctx)
      9.       resp, err := l.Greet(req)
      10.       // The following content will be replaced by custom templates
      11.       if err != nil {
      12.           httpx.Error(w, err)
      13.       } else {
      14.           httpx.OkJson(w, resp)
      15.       }
      16.   }
      17. }

    • After

    • Before

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

    • After

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

    Summary

    This document only describes the process of customizing the template for the corresponding example of http, in addition to the following scenarios of customizing the template.

    • model layer adds kmq
    • model layer to generate the model instance of the option to be valid