api 模板的修改

goctl_template/api/config.tpl

@@ -0,0 +1,9 @@
+package config
+
+import {{.authImport}}
+
+type Config struct {
+	rest.RestConf
+	{{.auth}}
+	{{.jwtTrans}}
+}

goctl_template/api/context.tpl

@@ -0,0 +1,20 @@
+package svc
+
+import (
+	{{.configImport}}
+	"github.com/zeromicro/go-zero/core/stores/sqlx"
+)
+
+type ServiceContext struct {
+	Config {{.config}}
+	{{.middleware}}
+	MysqlConn sqlx.SqlConn
+}
+
+func NewServiceContext(c {{.config}}) *ServiceContext {
+	return &ServiceContext{
+		Config: c,
+		MysqlConn: sqlx.NewMysql(c.SourceMysql),
+		{{.middlewareAssignment}}
+	}
+}

goctl_template/api/etc.tpl

@@ -0,0 +1,4 @@
+Name: {{.serviceName}}
+Host: {{.host}}
+Port: {{.port}}
+SourceMysql: ""

goctl_template/api/handler.tpl

@@ -0,0 +1,35 @@
+package {{.PkgName}}
+
+import (
+	"net/http"
+	"errors"
+
+	"github.com/zeromicro/go-zero/core/logx"
+	"github.com/zeromicro/go-zero/rest/httpx"
+
+	{{.ImportPackages}}
+)
+
+func {{.HandlerName}}(svcCtx *svc.ServiceContext) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		{{if .HasRequest}}var req types.{{.RequestType}}
+		if err := httpx.Parse(r, &req); err != nil {
+			httpx.OkJsonCtx(r.Context(), w, &types.Response{
+				Code:    510,
+				Message: "parameter error",
+			})
+			logx.Info(err)
+			return
+		}
+
+		{{end}}l := {{.LogicName}}.New{{.LogicType}}(r.Context(), svcCtx)
+		{{if .HasResp}}resp{{end}} := l.{{.Call}}({{if .HasRequest}}&req{{end}})
+		if resp != nil {
+			{{if .HasResp}}httpx.OkJsonCtx(r.Context(), w, resp){{else}}httpx.Ok(w){{end}}
+		} else {
+			err := errors.New("server logic is error, resp must not be nil")
+			httpx.ErrorCtx(r.Context(), w, err)
+			logx.Error(err)
+		}
+	}
+}

goctl_template/api/logic.tpl

@@ -0,0 +1,26 @@
+package {{.pkgName}}
+
+import (
+	{{.imports}}
+)
+
+type {{.logic}} struct {
+	logx.Logger
+	ctx    context.Context
+	svcCtx *svc.ServiceContext
+}
+
+func New{{.logic}}(ctx context.Context, svcCtx *svc.ServiceContext) *{{.logic}} {
+	return &{{.logic}}{
+		Logger: logx.WithContext(ctx),
+		ctx:    ctx,
+		svcCtx: svcCtx,
+	}
+}
+
+func (l *{{.logic}}) {{.function}}({{.request}}) (resp *types.Response) {
+	// 必须返回response, 前端需要的是内部约定的Code码, 处理相关的逻辑. 例子(eg): resp.Set(501, "error")
+	resp = &types.Response{}
+
+	{{.returnString}} resp
+}

goctl_template/api/main.tpl

@@ -0,0 +1,26 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+
+	{{.importPackages}}
+)
+
+var configFile = flag.String("f", "etc/{{.serviceName}}.yaml", "the config file")
+
+func main() {
+	flag.Parse()
+
+	var c config.Config
+	conf.MustLoad(*configFile, &c)
+
+	server := rest.MustNewServer(c.RestConf)
+	defer server.Stop()
+
+	ctx := svc.NewServiceContext(c)
+	handler.RegisterHandlers(server, ctx)
+
+	fmt.Printf("Starting server at %s:%d...\n", c.Host, c.Port)
+	server.Start()
+}

goctl_template/api/middleware.tpl

@@ -0,0 +1,19 @@
+package middleware
+
+import "net/http"
+
+type {{.name}} struct {
+}
+
+func New{{.name}}() *{{.name}} {
+	return &{{.name}}{}
+}
+
+func (m *{{.name}})Handle(next http.HandlerFunc) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		// TODO generate middleware implement function, delete after code implementation
+
+		// Passthrough to next handler if need
+		next(w, r)
+	}
+}

goctl_template/api/route-addition.tpl

@@ -0,0 +1,4 @@
+
+	server.AddRoutes(
+		{{.routes}} {{.jwt}}{{.signature}} {{.prefix}} {{.timeout}} {{.maxBytes}}
+	)

goctl_template/api/routes.tpl

@@ -0,0 +1,13 @@
+// Code generated by goctl. DO NOT EDIT.
+package handler
+
+import (
+	"net/http"{{if .hasTimeout}}
+	"time"{{end}}
+
+	{{.importPackages}}
+)
+
+func RegisterHandlers(server *rest.Server, serverCtx *svc.ServiceContext) {
+	{{.routesAdditions}}
+}

goctl_template/api/template.tpl

@@ -0,0 +1,24 @@
+syntax = "v1"
+
+info (
+	title: // TODO: add title
+	desc: // TODO: add description
+	author: "{{.gitUser}}"
+	email: "{{.gitEmail}}"
+)
+
+type request {
+	// TODO: add members here and delete this comment
+}
+
+type response {
+	// TODO: add members here and delete this comment
+}
+
+service {{.serviceName}} {
+	@handler GetUser // TODO: set handler name and delete this comment
+	get /users/id/:userId(request) returns(response)
+
+	@handler CreateUser // TODO: set handler name and delete this comment
+	post /users/create(request)
+}

goctl_template/api/types.tpl

@@ -0,0 +1,55 @@
+// Code generated by goctl. DO NOT EDIT.
+package types
+import (
+	{{if .containsTime}}"time"{{end}}
+
+	"fusenapi/utils/basic"
+)
+{{.types}}
+
+// Set 设置Response的Code和Message值
+func (resp *Response) Set(Code int, Message string) {
+	resp.Code = Code
+	resp.Message = Message
+}
+
+// Set 设置整个Response
+func (resp *Response) SetWithData(Code int, Message string, Data interface{}) {
+	resp.Code = Code
+	resp.Message = Message
+	resp.Data = Data
+}
+
+// SetMessage 设置Response的Message
+func (resp *Response) SetMessage(msg string) {
+	resp.Message = msg
+}
+
+// SetWithData 设置Data
+func (resp *Response) SetData(Data interface{}) {
+	resp.Data = Data
+}
+
+// SetWithData 设置Response的Code和Message值 带Data入参数
+func (resp *Response) SetCode(Code int) {
+	resp.Code = Code
+}
+
+
+// SetStatus 设置默认StatusResponse(内部自定义) 默认msg, 可以带data, data只使用一个参数
+func (resp *Response) SetStatus(sr *basic.StatusResponse, data ...interface{}) {
+	resp.Code = sr.Code
+	resp.Message = sr.Message
+	if len(data) == 1 {
+		resp.Data = data[0]
+	} 
+}
+
+// SetStatusWithMessage 设置默认StatusResponse(内部自定义) 非默认msg, 可以带data, data只使用一个参数
+func (resp *Response) SetStatusWithMessage(sr *basic.StatusResponse, msg string, data ...interface{}) {
+	resp.Code = sr.Code
+	resp.Message = msg
+	if len(data) == 1 {
+		resp.Data = data[0]
+	} 
+}