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


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


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

 

使用说明

  • 生成样板项目
    % go install 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 {
    	ChainChain`mir:"-"`
    	GroupGroup`mir:"v1"`
    	Loginfunc(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 {
    }
    
    // UnimplementedUserBinding can be embedded to have forward compatible implementations.
    type UnimplementedUserBinding struct {
    	BindAny func(*gin.Context, any) mir.Error
    }
    
    // UnimplementedUserRender can be embedded to have forward compatible implementations.
    type UnimplementedUserRender 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/微博的推文分享服务;

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


相關推薦

2023-01-19

日志输出,使用error错误级别,便于开发者在自定义日志Handler中识别日志类型。 goai 新增对security标签的支持,用以配置OpenAPIv3安全密钥。 改进对带有json标签带有,符号时结构体属性的名称获取。 gtcp SetSendDeadline

2023-05-04

【基础版】    🚨 Breaking Changes 重构 SearchBar 组件 重构接口请求,统一管理接口请求模块 移除 BatchActionBar 组件    🐞 Bug Fixes 修复主页无法引入请求 api 并使用的问题

2024-09-25

添加 solon-data DsUtils.observeDs 方法 添加 solon-cloud CloudEventHandlerPlus 原型代理支持 添加 solon-cloud CloudConfigHandler 原型代理支持 添加 solon-cloud CloudEventHandler 原型代理支持 添加 solon-cloud-gateway X_Forwarded_Host 和 https 转发支持 添加

2022-09-15

hash 库 path 库 文件系统操作(fs) 系统操作(os) 本次发布的版本,直接从 v2.0.3 跳到了 v3.0.0,跨度非常之大,它在性能、易用性、稳定性等方面均有全面的提升。 性能优化 内存分配器 v3.0 中实现了一个新的内存分配器(co/

2023-06-04

Paozhu C++ web框架 1.4.1 版本发布 Paozhu C++ web框架 自带c++ ORM 支持HTTP/1 HTTP/2,支持复杂结构体和JSON互换 框架提供开箱即用 admin 管理后台 这版主要是修改大并发问题,如果用户线程忙不过来,就添加用户线程,这样保持网站畅

2023-02-03

新增重要功能 增加时光回溯功能 所谓时光回溯功能,就是加大视频流在服务器的缓存,可以通过配置publish下的buffertime来控制缓存多久。例如可以缓存7秒视频,那么服务器就会至少缓存7秒音视频数据,当我们需要

2023-09-28

carbon 是一个轻量级、语义化、对开发者友好的 Golang 时间处理库,支持链式调用、农历和 gorm、xorm 等主流 orm 目前已被 awesome-go-cn 收录,如果您觉得不错,请给个 star 吧 github.com/golang-module/carbon gitee.com/golang-module/carbon

2024-03-18

ents.bcrypt.verify($self.get(.password).presents))password: String include handler identity.signIninclude handler identity.identity} middlewares [identity.identityFromJwt(secret: ENV["JWT_SECRET"]!)] 我们增加了一些修饰符,指定了token的encode方式,这里采用业内最流行的JWT

2023-12-15

统的烦恼。 - 支持 HTTP1, HTTP2 and HTTP3; - 统一的中间件和 Handler 接口,无需任何复杂语言只是,轻松实现中间件。灵活高效。 - 内置表单处理,强大的提取器,轻松反序列请求数据到结构体。 - 支持 WebSocket, WebTransport - 对 OpenAP

2024-06-12

参数填充的bug. 支持扫描SpringBoot ControllerAdvice全局异常Handler生成 OpenAPI HTTP 错误状态(如 404、500 等)的描述 优化 ExampleBody 样例构建代码,以去除重复代码(ps: 一个来自在飞机上写下的PR) 泛型替换错误导致的解析 bug,例

2023-12-14

统的烦恼。 - 支持 HTTP1, HTTP2 and HTTP3; - 统一的中间件和 Handler 接口,无需任何复杂语言只是,轻松实现中间件。灵活高效。 - 内置表单处理,强大的提取器,轻松反序列请求数据到结构体。 - 支持 WebSocket, WebTransport - 对 OpenAP

2023-10-17

与统一维护管理的模块。 通知公告:系统通知公告信息发布维护。 代码生成:一键生成模块CRUD的功能,包括后端和前端等相关代码。 案例演示:常规代码生成器一键生成后的演示案例。 软件信息 软件名称:JavaWeb 敏

2022-12-13

Go 1.20 首个 RC 已发布,正式版计划明年 2 月推出。 下载地址:https://go.dev/dl/#go1.20rc1 值得注意的是,Go 1.20 是最后一个支持在 macOS 10.13 High Sierra 或 10.14 Mojave 上运行的版本。Go 1.21 将需要 macOS 10.15 Catalina 或更高版本。 此外

2023-09-22

局变量、没有未定义的值、边界检测、默认使用 Immutable 结构体 支持 C/C++ 转换 方便使用的交叉编译 提供跨平台 UI 库 内置图形库 内置 ORM 内置 Web 框架 …… 根据V语言仓库的 PR 合并信息,目前已添加对短 lambda 表