feat(jzero): refactor frame

feat(jzero): refactor frame

Author: jaronnie

.github/workflows/upload.yaml

@@ -92,6 +92,22 @@ jobs:
           
           cd ..
           
+          rm -rf simplegateway-with-model-redis
+          jzero new simplegateway-with-model-redis --frame gateway --features model,redis
+          cd simplegateway-with-model-redis
+          go mod tidy
+          jzero gen swagger
+          jzero gen sdk
+          jzero gen zrpcclient
+          jzero format --git-change=false
+          go mod tidy && go mod download
+          go run main.go version
+          git add .
+          git diff-index --quiet HEAD || git commit -m "chore(simplegateway-with-model-redis): update simplegateway-with-model-redis"
+          git push -f
+          
+          cd ..
+          
           rm -rf simplerpc
           jzero new simplerpc --frame rpc
           cd simplerpc
@@ -110,4 +126,17 @@ jobs:
           git diff-index --quiet HEAD || git commit -m "chore(simplerpc): update simplerpc"
           git push -f
           
-          cd ..
+          cd ..
+          
+          rm -rf simplerpc-with-model-redis
+          jzero new simplerpc-with-model-redis --frame rpc --features model,redis
+          cd simplerpc-with-model-redis
+          go mod tidy
+          jzero gen swagger
+          jzero gen zrpcclient
+          jzero format --git-change=false
+          go mod tidy && go mod download
+          go run main.go version
+          git add .
+          git diff-index --quiet HEAD || git commit -m "chore(simplerpc-with-model-redis): update simplerpc-with-model-redis"
+          git push -f

cmd/jzero/.template/frame/api/app/cmd/root.go.tpl

@@ -6,8 +6,6 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var cfgFile string
-
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "{{ .APP }}",
@@ -28,5 +26,5 @@ func Execute() {
 }
 
 func init() {
-	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "etc/etc.yaml", "config file (default is project root dir etc/etc.yaml")
+	rootCmd.PersistentFlags().String("config", "etc/etc.yaml", "config file (default is project root dir etc/etc.yaml")
 }

cmd/jzero/.template/frame/api/app/cmd/server.go.tpl

@@ -1,16 +1,13 @@
 package cmd
 
 import (
-	"net/http"
-
 	"github.com/common-nighthawk/go-figure"
+	"github.com/jzero-io/jzero/core/configcenter"
 	"github.com/jzero-io/jzero/core/configcenter/subscriber"
 	"github.com/spf13/cobra"
-	configurator "github.com/zeromicro/go-zero/core/configcenter"
 	"github.com/zeromicro/go-zero/core/logx"
 	"github.com/zeromicro/go-zero/core/service"
 	"github.com/zeromicro/go-zero/rest"
-	"github.com/zeromicro/go-zero/rest/httpx"
 
 	"{{ .Module }}/internal/config"
 	"{{ .Module }}/internal/custom"
@@ -26,51 +23,39 @@ var serverCmd = &cobra.Command{
 	Short: "{{ .APP }} server",
 	Long:  "{{ .APP }} server",
 	Run: func(cmd *cobra.Command, args []string) {
-		cc := configurator.MustNewConfigCenter[config.Config](configurator.Config{
+		cc := configcenter.MustNewConfigCenter[config.Config](configcenter.Config{
 			Type: "yaml",
-		}, subscriber.MustNewFsnotifySubscriber(cfgFile, subscriber.WithUseEnv(true)))
-
-		c, err := cc.GetConfig()
-		logx.Must(err)
+		}, subscriber.MustNewFsnotifySubscriber(cmd.Flag("config").Value.String(), subscriber.WithUseEnv(true)))
 
 		// set up logger
-		if err = logx.SetUp(c.Log.LogConf); err != nil {
-			logx.Must(err)
-		}
+		logx.Must(logx.SetUp(cc.MustGetConfig().Log.LogConf))
 
 		// print banner
-		printBanner(c)
+		printBanner(cc.MustGetConfig().Banner)
 		// print version
 		printVersion()
 
 		svcCtx := svc.NewServiceContext(cc)
-		svcCtx.Middleware = middleware.NewMiddleware()
-		global.ServiceContext = *svcCtx
-		run(svcCtx)
-	},
-}
-
-func run(svcCtx *svc.ServiceContext) {
-    server := rest.MustNewServer(svcCtx.MustGetConfig().Rest.RestConf)
 
-	ctm := custom.New(server)
-	ctm.Init()
+		restServer := rest.MustNewServer(svcCtx.ConfigCenter.MustGetConfig().Rest.RestConf)
+		customServer := custom.New()
 
-	handler.RegisterHandlers(server, svcCtx)
-	middleware.Register(server)
+		handler.RegisterHandlers(restServer, svcCtx)
+		middleware.Register(restServer)
 
-	{{ if not .Serverless }}// load plugins
-	plugins.LoadPlugins(server, svcCtx){{end}}
+	    {{ if not .Serverless }}// load plugins
+	    plugins.LoadPlugins(restServer, svcCtx){{end}}
 
-	group := service.NewServiceGroup()
-	group.Add(server)
-	group.Add(ctm)
+		group := service.NewServiceGroup()
+		group.Add(restServer)
+		group.Add(customServer)
 
-	group.Start()
+		group.Start()
+	},
 }
 
-func printBanner(c config.Config) {
-	figure.NewColorFigure(c.Banner.Text, c.Banner.FontName, c.Banner.Color, true).Print()
+func printBanner(c config.BannerConf) {
+	figure.NewColorFigure(c.Text, c.FontName, c.Color, true).Print()
 }
 
 func init() {

…rame/api/app/desc/api/v1/version.api.tpl …e/frame/api/app/desc/api/builtin.api.tplcmd/jzero/.template/frame/api/app/desc/api/v1/version.api.tpl renamed to cmd/jzero/.template/frame/api/app/desc/api/builtin.api.tpl cmd/jzero/.template/frame/api/app/desc/api/v1/version.api.tpl renamed to cmd/jzero/.template/frame/api/app/desc/api/builtin.api.tpl

@@ -1,8 +1,7 @@
 {{ if .Serverless }}{{else}}syntax = "v1"
 
 info (
-    go_package: "version"
-    version: "v1"
+    go_package: "builtin"
     WrapCodeMsg: true
 )
 
@@ -16,10 +15,14 @@ type VersionResponse {
 }
 
 @server(
-    prefix: /api/v1
-    group: version
+    group: builtin
+    compact_handler: true
+    compact_logic: true
 )
 service {{ .APP | ToCamel }} {
     @handler Version
     get /version (VersionRequest) returns (VersionResponse)
+
+    @handler Swagger
+    get /swagger
 }{{end}}

cmd/jzero/.template/frame/api/app/internal/custom/custom.go.tpl

@@ -1,22 +1,9 @@
 package custom
 
-import (
-	"github.com/zeromicro/go-zero/rest"
-)
+type Custom struct{}
 
-type Custom struct {
-	Server *rest.Server
-}
-
-func New(server *rest.Server) *Custom {
-	return &Custom{
-		Server: server,
-	}
-}
-
-// Init Please add custom logic here.
-func (c *Custom) Init() {
-	c.AddRoutes(c.Server)
+func New() *Custom {
+	return &Custom{}
 }
 
 // Start Please add custom logic here.

cmd/jzero/.template/frame/api/app/internal/custom/routes.go.tpl

@@ -0,0 +1,61 @@
+package builtin
+
+import (
+	"context"
+	"net/http"
+
+    "github.com/jzero-io/jzero/core/swaggerv2"
+	"github.com/zeromicro/go-zero/core/logx"
+
+	"{{.Module}}/internal/svc"
+	types "{{.Module}}/internal/types/builtin"
+)
+
+type Swagger struct {
+	logx.Logger
+	ctx    context.Context
+	svcCtx *svc.ServiceContext
+	r      *http.Request
+	w      http.ResponseWriter
+}
+
+func NewSwagger(ctx context.Context, svcCtx *svc.ServiceContext, r *http.Request, w http.ResponseWriter) *Swagger {
+	return &Swagger{
+		Logger: logx.WithContext(ctx),
+		ctx:    ctx,
+		svcCtx: svcCtx,
+		r:      r,
+		w:      w,
+	}
+}
+
+func (l *Swagger) Swagger() error {
+    opts := new(swaggerv2.Swaggerv2Opts).DefaultOptions()
+	swaggerv2.SwaggerHandler(opts, l.w, l.r)
+	return nil
+}
+
+type Version struct {
+	logx.Logger
+	ctx    context.Context
+	svcCtx *svc.ServiceContext
+	r      *http.Request
+}
+
+func NewVersion(ctx context.Context, svcCtx *svc.ServiceContext, r *http.Request) *Version {
+	return &Version{
+		Logger: logx.WithContext(ctx),
+		ctx:    ctx,
+		svcCtx: svcCtx,
+		r:      r,
+	}
+}
+
+func (l *Version) Version(req *types.VersionRequest) (resp *types.VersionResponse, err error) {
+    return &types.VersionResponse{
+    	Version:   os.Getenv("VERSION"),
+    	GoVersion: runtime.Version(),
+    	Commit:    os.Getenv("COMMIT"),
+    	Date:      os.Getenv("DATE"),
+    }, nil
+}