go-mir

用 go 结构体标签定义 handler 路由信息的辅助库
授权协议 Apache
开发语言 Google Go
所属分类 程序开发、 其他开发相关
软件类型 开源软件
地区 国产
投 递 者 饶德本
操作系统 跨平台
开源组织
适用人群 未知
 软件概览
Mir 是一套提供类似gRPC服务开发体验的快速开发RESTful API后端开发脚手架,适配多种HTTP框架,包括 Gin , Chi , Hertz , Echo , Iris , Fiber, Macaron, Mux, httprouter
 

使用说明

  • 生成样板项目
    % go get github.com/alimy/mir/mirc/v3@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
    |   |-- main.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 build
  • RESTful接口定义
    // file: mirc/routes.go
    
    package routes
    
    import (
    	. "github.com/alimy/mir/v3"
    	. "github.com/alimy/mir/v3/engine"
    )
    
    func init() {
    	AddEntry(new(User))
    }
    
    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 {
    	Chain  Chain                          `mir:"-"`
    	Group  Group                          `mir:"v1"`
    	Login  func(Post, LoginReq) LoginResp `mir:"/login/"`
    	Logout func(Post)                     `mir:"/logout/"`
    }
  • 代码生成
    // file: mirc/auto/api/routes.go
    
    // Code generated by go-mir. DO NOT EDIT.
    package routes
    
    import (
    	"net/http"
    
    	"github.com/alimy/mir/v3"
    	"github.com/gin-gonic/gin"
    )
    
    type LoginReq struct {
    	Name   string `json:"name"`
    	Passwd string `json:"passwd"`
    }
    
    type LoginResp struct {
    	JwtToken string `json:"jwt_token"`
    }
    
    type User interface {
    	// Chain provide handlers chain for gin
    	Chain() gin.HandlersChain
    
    	Login(c *gin.Context, req *LoginReq) (*LoginResp, mir.Error)
    	Logout(c *gin.Context) mir.Error
    
    	mustEmbedUnimplementedUserServant()
    }
    
    type UserBinding interface {
    	BindLogin(c *gin.Context) (*LoginReq, mir.Error)
    
    	mustEmbedUnimplementedUserBinding()
    }
    
    type UserRender interface {
    	RenderLogin(c *gin.Context, data *LoginResp, err mir.Error)
    	RenderLogout(c *gin.Context, err mir.Error)
    
    	mustEmbedUnimplementedUserRender()
    }
    
    // UnimplementedUserServant can be embedded to have forward compatible implementations.
    type UnimplementedUserServant struct {
    }
    
    // UnimplementedSiteBinding can be embedded to have forward compatible implementations.
    type UnimplementedSiteBinding struct {
    	BindAny func(*gin.Context, any) mir.Error
    }
    
    // UnimplementedSiteRender can be embedded to have forward compatible implementations.
    type UnimplementedSiteRender struct {
    	RenderAny func(*gin.Context, any, mir.Error)
    }
    
    // RegisterUserServant register User servant to gin
    func RegisterUserServant(e *gin.Engine, s User, b UserBinding, r UserRender) {
    	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, err := b.BindLogin(c)
    		if err != nil {
    			r.RenderLogin(c, nil, err)
    		}
    		resp, err := s.Login(c, req)
    		r.RenderLogin(c, resp, err)
    	})
    	router.Handle("POST", "/logout/", func(c *gin.Context) {
    		select {
    		case <-c.Request.Context().Done():
    			return
    		default:
    		}
    		
    		r.RenderLogout(c, 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() {}
    
    func (b UnimplementedUserBinding) BindLogin(c *gin.Context) (*LoginReq, mir.Error) {
    	obj := new(LoginReq)
    	err := b.BindAny(c, obj)
    	return obj, err
    }
    
    func (b UnimplementedUserBinding) mustEmbedUnimplementedUserBinding() {}
    
    func (r UnimplementedUserRender) RenderLogin(c *gin.Context, data *LoginResp, err mir.Error) {
    	r.RenderAny(c, data, err)
    }
    
    func (r UnimplementedUserRender) RenderLogout(c *gin.Context, err mir.Error) {
    	r.RenderAny(c, nil, err)
    }
    
    func (r UnimplementedUserRender) mustEmbedUnimplementedUserRender() {}
  •  接口实现
    // file: servants/user.go
    
    package servants
    
    import (
    	"github.com/alimy/mir-example/v3/mirc/auto/api"
    )
    
    type userSrv struct {
    	api.UnimplementedUserServant
    }
    
    type userBinding struct {
    	*api.UnimplementedUserBinding
    }
    
    type userRender struct {
    	*api.UnimplementedUserRender
    }
    
    func newUserSrv() api.Site {
    	return &userSrv{}
    }
    
    func newUserBinding() api.SiteBinding {
    	return &siteBinding{
    		UnimplementedSiteBinding: &api.UnimplementedSiteBinding{
    			BindAny: bindAny,
    		},
    	}
    }
    
    func newUserRender() api.SiteRender {
    	return &siteRender{
    		UnimplementedSiteRender: &api.UnimplementedSiteRender{
    			RenderAny: renderAny,
    		},
    	}
    }
    
    func bindAny(c *gin.Context, obj any) mir.Error {
    	if err != c.ShouldBind(obj); err != nil {
    		return mir.NewError(http.StatusBadRequest, err)
    	}
    	return nil
    }
    
    func renderAny(c *gin.Context, data any, err mir.Error) {
    	if err == nil {
    		c.JSON(http.StatusOK, data)
    	} else {
    		c.JSON(err.StatusCode(), err.Error())
    	}
    }
  •  服务注册
    // file: servants/servants.go
    
    package servants
    
    import (
    	"github.com/alimy/mir-example/v3/mirc/auto/api"
    	"github.com/gin-gonic/gin"
    )
    
    // RegisterServants register all the servants to gin.Engine
    func RegisterServants(e *gin.Engine) {
    	api.RegisterUserServant(e, newUserSrv(), newUserBinding(), newUserRender())
    	
    	// TODO: some other servant to register
    }
  • 程序启动

    // file: main.go
    
    package main
    
    import (
    	"log"
    
    	"github.com/alimy/mir-example/v3/servants"
    	"github.com/gin-gonic/gin"
    )
    
    func main() {
    	e := gin.Default()
    
    	// register servants to gin
    	servants.RegisterServants(e)
    
    	// start servant service
    	if err := e.Run(); err != nil {
    		log.Fatal(err)
    	}
    }

使用go-mir的项目

  • examples - go-mir自带的demo,主要演示了如何使用Mir快速进行RESTful API的后端开
    发;
  •  paopao-ce - 一个清新文艺的微社区,提供类似Twiter/微博的推文分享服务;
  • 本来准备直接yum install golang或者yum install go, 执行命名后,发现没有这个包。于是只能先添加源,然后在使用命令行安装了。Install on CentOS: Current version: 1.11 rpm --import https://mirror.go-repo.io/centos/RPM-GPG-KEY-GO-REPO curl -s https://

 相关资料
  • 主要内容:结构体标签的格式,从结构体标签中获取值,结构体标签格式错误导致的问题通过 reflect.Type 获取结构体成员信息 reflect.StructField 结构中的 Tag 被称为结构体标签(Struct Tag)。结构体标签是对结构体字段的额外信息标签。 JSON、BSON 等格式进行序列化及对象关系映射(Object Relational Mapping,简称 ORM)系统都会用到结构体标签,这些系统使用标签设定字段在处理时应该具备的特殊属性和可能发生的行

  • Go语言可以通过自定义的方式形成新的类型,结构体就是这些类型中的一种复合类型,结构体是由零个或多个任意类型的值聚合成的实体,每个值都可以称为结构体的成员。 结构体成员也可以称为“字段”,这些字段有以下特性: 字段拥有自己的类型和值; 字段名必须唯一; 字段的类型也可以是结构体,甚至是字段所在结构体的类型。 使用关键字  type 可以将各种基本类型定义为自定义类型,基本类型包括整型、字符串、布尔等

  • Go语言结构体数据类是将各个类型的变量定义的集合,通常用来表示记录。 package main import "fmt" // 这个person结构体有name和age成员 type person struct { name string age int } func main() { // 这个语法创建一个新结构体变量 fmt.Println(person{"B

  • 为了定义辅助路由,我们必须首先添加一个命名的路由出口,其中要呈现辅助路由的内容。 接下来,我们必须定义到应用程序的辅助路由的链接,以导航和呈现内容。 每个辅助路由是独立的路由,可以拥有: 自己的辅助路由 自己的浏览器历史记录栈

  • Go 语言中数组可以存储同一类型的数据,但在结构体中我们可以为不同项定义不同的数据类型。 结构体是由一系列具有相同类型或不同类型的数据构成的数据集合。 结构体表示一项记录,比如保存图书馆的书籍记录,每本书有以下属性: Title :标题 Author : 作者 Subject:学科 ID:书籍ID 定义结构体 结构体定义需要使用 type 和 struct 语句。struct 语句定义一个新的数据

  • 在Go语言规范中,提到了对标签的简要概述: 字段声明之后可能会有一个可选的字符串文字标记,该标记将成为相应字段声明中所有字段的属性。标记通过反射界面可见,但在其他情况下被忽略。 这是一个非常简短的解释,我想知道是否有人能给我提供这些标签的用途?