go-mir v5.0.1 发布，用 Go 结构体标签定义 handler 路由信息的辅助库

go-mir v5.0.1 发布了，v5 版本带来全新的 RESTful API 开发方式，提供媲美 gRPC 服务开发的体验，方便快捷，欢迎使用。

​Mir 是一套提供类似 gRPC 服务开发体验的快速开发 RESTful API 后端开发脚手架，适配多种 HTTP 框架，包括 Gin, Chi, Hertz, Echo, Iris, Fiber, Macaron, Mux, httprouter。

 

使用说明

• 生成样板项目

  % go install github.com/alimy/mir/mirc/v5@latest
  % mirc new -h
  create template project
  
  Usage:
    mirc new [flags]
  
  Flags:
    -d, --dst string     genereted destination target directory (default ".")
    -h, --help           help for new
        --mir string     mir replace package name or place
    -p, --pkg string     project's package name (default "github.com/alimy/mir-example")
    -s, --style string   generated engine style eg: gin,chi,mux,hertz,echo,iris,fiber,fiber-v2,macaron,httprouter (default "gin")
  
  % mirc new -d example 
  % tree example
  example
  .
  |-- Makefile
  |-- README.md
  |-- go.mod
  |-- go.sum
  |-- main.go
  |-- mirc
  |   |-- auto
  |   |   `-- api
  |   |       |-- site.go
  |   |       |-- v1
  |   |       |   `-- site.go
  |   |       `-- v2
  |   |           `-- site.go
  |   |-- gen.go
  |   `-- routes
  |       |-- site.go
  |       |-- v1
  |       |   `-- site.go
  |       `-- v2
  |           `-- site.go
  `-- servants
      |-- core.go
      |-- servants.go
      |-- site.go
      |-- site_v1.go
      `-- site_v2.go
  
  % cd example
  % make generate
  % make run

• RESTful API 接口定义

  // file: mirc/routes.go
  
  package routes
  
  import (
  	. "github.com/alimy/mir/v5"
  )
  
  type LoginReq struct {
  	Name   string `json:"name"`
  	Passwd string `json:"passwd"`
  }
  
  type LoginResp struct {
  	JwtToken string `json:"jwt_token"`
  }
  
  // User user interface info
  type User struct {
  	// 标示为 API Entry, group为v1, 带有中间件接口
  	Schema      `mir:"v1,chain"`
  	Login  func(Post, LoginReq) LoginResp `mir:"login"`
  	Logout func(Post)                     `mir:"logout"`
  }

• 代码生成

  // file: mirc/auto/api/routes/v1.go
  
  // Code generated by go-mir. DO NOT EDIT.
  // versions:
  // - mir v5.0.0
  
  package v1
  
  import (
  	"net/http"
  
  	"github.com/alimy/mir/v5"
  	"github.com/gin-gonic/gin"
  )
  
  type _binding_ interface {
  	Bind(*gin.Context) mir.Error
  }
  
  type _render_ interface {
  	Render(*gin.Context)
  }
  
  type _default_ interface {
  	Bind(*gin.Context, any) mir.Error
  	Render(*gin.Context, any, mir.Error)
  }
  
  type LoginReq struct {
  	Name   string `json:"name"`
  	Passwd string `json:"passwd"`
  }
  
  type LoginResp struct {
  	JwtToken string `json:"jwt_token"`
  }
  
  type User interface {
  	_default_
  
  	// Chain provide handlers chain for gin
  	Chain() gin.HandlersChain
  
  	Login(*gin.Context, *LoginReq) (*LoginResp, mir.Error)
  	Logout(*gin.Context) mir.Error
  
  	mustEmbedUnimplementedUserServant()
  }
  
  // RegisterUserServant register User servant to gin
  func RegisterUserServant(e *gin.Engine, s User) {
  	router := e.Group("v1")
  	// use chain for router
  	middlewares := s.Chain()
  	router.Use(middlewares...)
  
  	// register routes info to router
  	router.Handle("POST", "login", func(c *gin.Context) {
  		select {
  		case <-c.Request.Context().Done():
  			return
  		default:
  		}
  		req := new(LoginReq)
  		if err := s.Bind(c, req); err != nil {
  			s.Render(c, nil, err)
  			return
  		}
  		resp, err := s.Login(req)
  		s.Render(c, resp, err)
  	})
  	router.Handle("POST", "logout", func(c *gin.Context) {
  		select {
  		case <-c.Request.Context().Done():
  			return
  		default:
  		}
  		
  		s.Render(c, nil, s.Logout(c))
  	})
  }
  
  func (UnimplementedUserServant) Chain() gin.HandlersChain {
  	return nil
  }
  
  func (UnimplementedUserServant) Login(c *gin.Context, req *LoginReq) (*LoginResp, mir.Error) {
  	return nil, mir.Errorln(http.StatusNotImplemented, http.StatusText(http.StatusNotImplemented))
  }
  
  func (UnimplementedUserServant) Logout(c *gin.Context) mir.Error {
  	return mir.Errorln(http.StatusNotImplemented, http.StatusText(http.StatusNotImplemented))
  }
  
  func (UnimplementedUserServant) mustEmbedUnimplementedUserServant() {}

• 接口实现

  // file: servants/user.go
  
  package servants
  
  import (
  	api "github.com/alimy/mir-example/v5/mirc/auto/api/v1"
  	"github.com/alimy/mir/v5"
  	"github.com/gin-gonic/gin"
  )
  
  type baseSrv struct{}
  
  func (baseSrv) Bind(c *gin.Context, obj any) mir.Error {
  	if err := c.ShouldBind(obj); err != nil {
  		mir.NewError(http.StatusBadRequest, err)
  	}
  	return nil
  }
  
  func (baseSrv) Render(c *gin.Context, data any, err mir.Error) {
  	if err == nil {
  		c.JSON(http.StatusOK, data)
  	} else {
  		c.JSON(err.StatusCode(), err.Error())
  	}
  }
  
  type userSrv struct {
  	baseSrv
  	api.UnimplementedUserServant
  	// TODO: add other fields
  }
  
  func newUserSrv() api.User {
  	return &userSrv{}
  }

• 服务注册

  // file: servants/servants.go
  
  package servants
  
  import (
  	api "github.com/alimy/mir-example/v5/mirc/auto/api/v1"
  	"github.com/gin-gonic/gin"
  )
  
  // RegisterServants register all the servants to gin.Engine
  func RegisterServants(e *gin.Engine) {
  	api.RegisterUserServant(e, newUserSrv())
  	
  	// TODO: some other servant to register
  }

•  paopao-ce - 一个清新文艺的微社区，提供类似 Twiter / 微博的推文分享服务；

paopao-ce 通过使用 go-mir 更好、更便捷的开发 RESTful API 服务与 gRPC 服务。