feat: add http rest service function, update README.md, add gin logic includes middlewares, add admin http rest service example

Author: coderi421

README.md

@@ -28,17 +28,17 @@ Microservice framework implemented based on Golang.
 │  └─user
 │      └─v1
 ├─app 具体服务相关的实现
-│  ├─shop
-│  │  └─admin
-│  │      ├─config
-│  │      └─controller
+│  ├─shop 举例 shop http 服务 同级的还可以创建其他文件夹
+│  │  └─admin shop 下的 admin 侧 http 服务 同级的还可以创建其他文件夹
+│  │      ├─config 配置文件
+│  │      └─controller 表示层
 │  ├─pkg 服务共通的包
 │  │  ├─code 服务的错误码
 │  │  ├─options
 │  │  └─translator
 │  │      └─gin
-│  └─user 举例 user 服务
-│      ├─client 用于本地测试 user 服务的客户端 rpc 服务
+│  └─user 举例 user gRPC 服务，可以同时建立 http 服务，参考 shop
+│      ├─client 用于本地测试 user rpc 服务的客户端
 │      └─srv
 │          ├─config 服务的配置项，Log error 等子服务的相关逻辑全部注册到配置中
 │          ├─controller 表示层

app/shop/admin/app.go

@@ -0,0 +1,68 @@
+package admin
+
+import (
+	"github.com/CoderI421/gframework/app/pkg/options"
+	"github.com/CoderI421/gframework/app/shop/admin/config"
+	gapp "github.com/CoderI421/gframework/gmicro/app"
+	"github.com/CoderI421/gframework/gmicro/registry"
+	"github.com/CoderI421/gframework/gmicro/registry/consul"
+	"github.com/CoderI421/gframework/pkg/app"
+	"github.com/CoderI421/gframework/pkg/log"
+	"github.com/hashicorp/consul/api"
+)
+
+func NewApp(basename string) *app.App {
+	cfg := config.New()
+	appl := app.NewApp("admin",
+		"shop",
+		app.WithOptions(cfg),
+		app.WithRunFunc(run(cfg)),
+		//不读配置 使用命令行参数时使用
+		//app.WithNoConfig(),
+	)
+	return appl
+}
+func NewRegistrar(registry *options.RegistryOptions) registry.Registrar {
+	c := api.DefaultConfig()
+	c.Address = registry.Address
+	c.Scheme = registry.Scheme
+	cli, err := api.NewClient(c)
+	if err != nil {
+		panic(err)
+	}
+	r := consul.New(cli, consul.WithHealthCheck(true))
+	return r
+}
+func NewUserApp(cfg *config.Config) (*gapp.App, error) {
+	//初始化log
+	log.Init(cfg.Log)
+	defer log.Flush()
+	//服务注册
+	register := NewRegistrar(cfg.Registry)
+	//生成http服务
+	restServer, err := NewUserHTTPServer(cfg)
+	if err != nil {
+		return nil, err
+	}
+	return gapp.New(
+		gapp.WithName(cfg.Server.Name),
+		gapp.WithRestServer(restServer),
+		gapp.WithRegistrar(register),
+	), nil
+
+}
+
+// controller(参数校验) ->service(具体的业务逻辑)->(数据库的接口)
+func run(cfg *config.Config) app.RunFunc {
+	return func(baseName string) error {
+		userApp, err := NewUserApp(cfg)
+		if err != nil {
+			return err
+		}
+		//启动
+		if err := userApp.Run(); err != nil {
+			log.Errorf("run user app error: %s", err)
+		}
+		return nil
+	}
+}

app/shop/admin/config/config.go

@@ -0,0 +1,44 @@
+package config
+
+import (
+	"github.com/CoderI421/gframework/app/pkg/options"
+	"github.com/CoderI421/gframework/pkg/app"
+	cliflag "github.com/CoderI421/gframework/pkg/common/cli/flag"
+	"github.com/CoderI421/gframework/pkg/log"
+)
+
+var _ app.CliOptions = &Config{}
+
+func New() *Config {
+	return &Config{
+		Log:      log.NewOptions(),
+		Server:   options.NewServerOptions(),
+		Registry: options.NewRegistryOptions(),
+	}
+}
+
+type Config struct {
+	Log *log.Options `json:"log" mapstructure:"log"`
+	// 服务发现
+	Server *options.ServerOptions `json:"server" mapstructure:"server"`
+	// 注册中心
+	Registry *options.RegistryOptions `json:"registry" mapstructure:"registry"`
+}
+
+// Flags implements app.CliOptions interface.Add flags to the specified FlagSet object.
+func (c *Config) Flags() (fss cliflag.NamedFlagSets) {
+	// fss.FlagSet("logs") -> 创建一个FlagSet对象，命名为logs，做为专属的 logs 传递给 Config.Log
+	c.Log.AddFlags(fss.FlagSet("logs"))
+	c.Server.AddFlags(fss.FlagSet("server"))
+	c.Registry.AddFlags(fss.FlagSet("registry"))
+	return fss
+}
+
+// Validate 将配置中的所有校验子逻辑 注册到当前实例的校验中
+func (c *Config) Validate() (errors []error) {
+	// 将 Log 中的校验，注册到 user 服务的，校验逻辑中
+	errors = append(errors, c.Log.Validate()...)
+	errors = append(errors, c.Server.Validate()...)
+	errors = append(errors, c.Registry.Validate()...)
+	return
+}

app/shop/admin/controller/list.go

@@ -0,0 +1,11 @@
+package controller
+
+import (
+	"github.com/CoderI421/gframework/pkg/log"
+
+	"github.com/gin-gonic/gin"
+)
+
+func (us *userServer) List(ctx *gin.Context) {
+	log.Info("GetUserList is called")
+}

app/shop/admin/controller/user.go

@@ -0,0 +1,8 @@
+package controller
+
+type userServer struct {
+}
+
+func NewUserController() *userServer {
+	return &userServer{}
+}

app/shop/admin/http.go

@@ -0,0 +1,19 @@
+package admin
+
+import (
+	"github.com/CoderI421/gframework/app/shop/admin/config"
+	"github.com/CoderI421/gframework/gmicro/server/restserver"
+)
+
+// NewUserHTTPServer 创建一个http server
+func NewUserHTTPServer(conf *config.Config) (*restserver.Server, error) {
+	uRestServer := restserver.NewServer(
+		restserver.WithPort(conf.Server.HttpPort),
+		restserver.WithEnableProfiling(true),
+		restserver.WithMiddlewares(conf.Server.Middlewares),
+	)
+
+	//	配置好路由
+	initRouter(uRestServer)
+	return uRestServer, nil
+}

app/shop/admin/router.go

@@ -0,0 +1,13 @@
+package admin
+
+import (
+	"github.com/CoderI421/gframework/app/shop/admin/controller"
+	"github.com/CoderI421/gframework/gmicro/server/restserver"
+)
+
+func initRouter(g *restserver.Server) {
+	v1 := g.Group("/v1")
+	ugroup := v1.Group("/user")
+	ucontroller := controller.NewUserController()
+	ugroup.GET("list", ucontroller.List)
+}

app/user/srv/config/config.go

@@ -36,7 +36,7 @@ func (c *Config) Flags() (fss cliflag.NamedFlagSets) {
 
 // Validate 将配置中的所有校验子逻辑 注册到当前实例的校验中
 func (c *Config) Validate() (errors []error) {
-	// 将 Log 中的校验，注册到 user 服务的，校验逻辑中
+	// 将 Log 中的校验，注册到 admin 服务的，校验逻辑中
 	errors = append(errors, c.Log.Validate()...)
 	errors = append(errors, c.Server.Validate()...)
 	errors = append(errors, c.Registry.Validate()...)

cmd/shop/admin/admin.go

@@ -0,0 +1,20 @@
+package main
+
+import (
+	"math/rand"
+	"os"
+	"runtime"
+	"time"
+
+	"github.com/CoderI421/gframework/app/shop/admin"
+)
+
+func main() {
+	randSrc := rand.NewSource(time.Now().UnixNano())
+	rand.New(randSrc)
+
+	if len(os.Getenv("GOMAXPROCS")) == 0 {
+		runtime.GOMAXPROCS(runtime.NumCPU())
+	}
+	admin.NewApp("admin-server").Run()
+}

configs/admin/admin.yaml

@@ -0,0 +1,26 @@
+log:
+  name: shop-admin #logger的名称
+  development: true # 是否开启开发模式，开发模式下会打印调试信息，默认 false
+  level: debug # 日志级别，优先级从低到高依次为：debug, info, warn, error, dpanic, panic, fatal。
+  format: console # 支持的日志输出格式，目前支持console和json两种。console其实就是text格式。
+  enable-color: true # 是否开启颜色输出，true:是，false:否
+  disable-caller: false # 是否开启 caller，如果开启会在日志中显示调用日志所在的文件、函数和行号
+  disable-stacktrace: false # 是否再panic及以上级别禁止打印堆栈信息
+  output-paths: logs/shop-admin.log,stdout # 支持输出到多个输出，逗号分开。支持输出到标准输出（stdout）和文件。
+  error-output-paths: logs/shop-admin.error.log # zap内部(非业务)错误日志输出路径，多个输出，逗号分开
+
+registry:
+  address: 127.0.0.1:8500
+  scheme: http
+
+server:
+  name: shop-admin #服务名，注册到consul使用的名称
+  host: "127.0.0.1" #host, 默认使用 0.0.0.0
+  port: 8016 # grpc 安全模式的端口号，默认 8081
+  http-port: 8050
+  healthz: true # 是否开启健康检查，如果开启会安装 /healthz 路由，默认 true
+  enable-metrics: true # 开启 metrics, router:  /metrics
+  profiling: true # 开启性能分析, 可以通过 <host>:<port>/debug/pprof/地址查看程序栈、线程等系统信息，默认值为 true
+  middlewares: # 中间件
+    - recovery # panic 恢复
+    - cors # 跨域