Vermonth 是一个基于 Gin 的增强工具，提供了一系列增强工具来帮助 Gin 的开发。
使用Tag进行书写路由和请求参数。
type TestController struct {
// 定义该控制器的总路径
_ interface{} `path:"/api"`
// 方法
// 使用Tag描述请求的类型、路径，以及需要参数注入的参数名
TestMethod func(a int, b int) interface{} `method:"GET" path:"/test" params:"a,b"`
}
// 例如
// 访问 /api/test 则调用 TestMethod 方法
// 以下为控制器实现
// 定义控制器
func TestMethod(a int, b int) interface{} {
return "Hello, Gin! " + strconv.Itoa(a) + strconv.Itoa(b)
}
func NewTestController() *TestController {
return &TestController{
TestMethod: TestMethod,
}
}
// 注册控制器
r := gin.Default()
vermonth.RegisterController(r, NewTestController())
// 访问 /api/test- vermonth会自动将请求参数注入到控制器方法中，无需再通过gin获取，只要书写和Tag中相同的参数名即可。
- 参数获取遵循gin的规范，你仍可以使用gin的全部功能。
type TestController struct {
TestMethod func(a int, b int) interface{} `method:"GET" path:"/test" params:"a,b"`
TestMethod2 func(req *Request) interface{} `method:"GET" path:"/test" params:"req"`
}
type Request struct {
A int `json:"a"`
B int `json:"b"`
}
func TestMethod(a int, b int) interface{} {
return gin.H{
"message": "Hello, Gin!" + strconv.Itoa(a+b),
}
}
func TestMethod2(req *Request) interface{} {
return gin.H{
"message": "Hello, Gin!" + strconv.Itoa(req.A+req.B),
}
}- 当多个控制器需要使用相同的参数时，可以通过公共参数注入来实现。
- 例如获得当前登录的用户
// 公共参数注入
RegisterParamsFunc("/**", func() map[string]interface{} {
return map[string]interface{}{
"token": "123",
}
})
func DoTestParams(token string) interface{} {
return gin.H{
"token": token,
}
} - 遵循gin的规范，通过
binding:"xxx"来校验参数 - 对校验进行增强，在定义了
binding:"xxx"的参数时，可以再使用message=来定义校验失败时的返回信息。
type TestParams struct {
Name string `json:"name" binding:"required" message:"required=姓名不能为空"` // 如果只有一个校验的话，required=可以不写
Age int `json:"age" binding:",gt=18" message:"年龄必须大于18"` // 如果只有一个校验的话，required=可以不写
}
type TestController struct {
//params=query 表示参数从query中获取，params=json 表示参数从json中获取，可以不写，默认情况下，POST请求会从json中获取参数，GET请求会从query中获取参数
TestParams func(params *TestParams) interface{} `method:"GET" path:"/test" params:"params=query" `
}- 因为vermouth基于Gin做增强，并不侵入Gin，所以可以依然沿用gin的校验方式，注册自定义校验器。
- 除此之外，vermonth还提供了单独的校验器，用于一些复杂的校验。
type TestParams struct {
Name string `json:"name" binding:"required" message:"required=姓名不能为空"` // 如果只有一个校验的话，required=可以不写
Age int `json:"age" binding:",gt=18" message:"年龄必须大于18"` // 如果只有一个校验的话，required=可以不写
}
// 该结构体内所有以Test开头的方法，都会被认为是自定义校验方法，vermouth会自动调用
func(t *TestParams) TestA() error {
// 例如某些数据在插入时，需要检查数据库中是否有同名数据
count := db.QueryRow("SELECT * FROM user WHERE name = ?", t.Name)
if count > 0 {
return errors.New("姓名不能重复")
}
return nil
}
// 自定义校验方法，可以传入ctx参数，ctx参数中包含了当前请求的所有信息
func(t *TestParams) TestB(ctx *vermouth.Context) error {
if t.Age < 18 {
return errors.New("年龄必须大于18")
}
return nil
}- 在实际工作中，我们往往需要对参数进行变形，而根据单一原则，这类代码不适用写入service，所以vermouth支持自定义参数解析。
- 待开发
- 在重构过往接口的时候，我们希望可以渐进式而不是一次性暴力替换，暴力替换往往是生产事故的根源。
- 重构后的接口应当和之前保持幂等，即调用两个接口应得到相同的结果（排除write类接口造成实际变动影响后）。
type TestController struct {
_ interface{} `path:"/api" `
// 当访问/api/test2时，会自动转发一份相同的到/api/test
TestMethod func(a int, b int) interface{} `method:"GET" path:"/test" params:"a,b" cover_url:"/api/test2"`
}
var r = gin.Default()
r.Use(vermonth.CoverUrl("../日志地址"))
// 当访问/api/test2时，会自动转发一份相同的到/api/test
// 如果二者得到的结果不一致，则会在日志目录下写入日志vermouth支持AOP，可以通过正则表达式来匹配方法，并执行相应的AOP函数。
- AOP的生效在Gin的middleware之后，Gin本身不会受到任何影响，vermouth只管理自己的控制器。
- 利用切面可以实现许多通用的特性，例如，框架应当帮开发者抹平差异，使开发者专注于业务。
// 控制器定义的时候，可以用 _ 为控制器附加名字，如果不附加，则控制器自动使用控制器类型名作为名字
type TestController struct {
_ interface{} `path:"/api" `
TestMethod func(a int, b int) interface{} `method:"GET" path:"/test" params:"a,b"`
}
// 注册切面
// 第二个参数为切面优先级，越大的切面会越后面调用
// 例如同时有0和1两个切面，则调用顺序为 0 -> 1
// 请求可以使用*和**来进行匹配，例如/api/test*
vermonth.RegisterAop("/**", 0, func(aopContext *vermouth.Context) {
fmt.Println("aop called")
// 在控制器启动前，你可以随意修改参数
aopContext.Arguments[0] = 2
// 调用方法
aopContext.Call()
// 修改返回值，例如你可以定义所有接口的通用返回
aopContext.Result[0] = map[string]interface{}{
"success": true,
"data": aopContext.Result[0],
}
})- 利用切面，可以轻松完成全局错误的捕获和处理，并返回统一的错误结构。
// 自定义异常处理类
// 定义一个结构体来表示自定义错误
type MyError struct {
Message string
Code int
}
func NewMyError(code int, message string) *MyError {
return &MyError{
Message: message,
Code: code,
}
}
// 实现error接口的Error方法
func (e *MyError) Error() string {
return fmt.Sprintf("Error %d: %s", e.Code, e.Message)
}
// 注册全局错误处理器
vermouth.RegisterAop("/**", 0, func(aopContext *vermouth.Context) {
defer func() {
if err := recover(); err != nil {
// 判断是否是自定义错误
if myErr, ok := err.(*MyError); ok {
aopContext.GinContext.JSON(myErr.Code, myErr.Message)
return
}
// 不是我的异常，抛回给中间件处理
panic(err)
}
}()
aopContext.Call()
})
// 控制器中抛出异常
func DoTestError() interface{} {
err := NewMyError(400, "test error")
if true {
panic(err)
}
// 正常的业务逻辑
return "ok"
}- 利用切面，你可以轻松管理事务。
- 只需要在控制器定义上添加```transaction:"true"``即可。
type TestController struct {
_ interface{} `path:"/api" `
// 事务
TestTransaction func(tx *sql.Tx) interface{} `method:"GET" path:"/test4" params:"tx" transaction:"true"`
}
func DoTestTransaction(tx *sql.Tx) interface{} {
tx.Exec("INSERT INTO user (name, age) VALUES (?, ?)", "John", 20)
// do something...
if true {
// 当需要回滚事务的时候，只要抛出异常即可
panic("xxx")
}
return nil
}- 你可以通过自定义增强来实现更多的功能，例如日志、缓存、权限控制等。
vermouth.RegisterAop("/**", 0, func(aopContext *vermouth.Context) {
// 获取控制器中的自定义属性
logConfig,ok := aopContext.ControllerInformation.Attributes["log"]
if ok {
// do something...
fmt.Println("logConfig:", logConfig)
}
aopContext.Call()
})- 协程上下文，可以让你在协程中获取当前的上下文信息。
- 例如，你可以通过协程上下文来获取当前的请求信息，或者在协程中传递一些上下文信息。
- 多适用于在controller和service调用中传递上下文信息，例如不适合入参的当前登录用户。
tl := vermouth.NewThreadLocal()
func a(){
tl.Set("test")
}
func b(){
s := tl.Get()
fmt.Println(s) // test
}
func main(){
a()
b()
}- 你可以在子协程中，通过tl.Go(func(){})来创建子协程，子协程会继承父协程的上下文。
- 子协程可以有独立的上下文环境，不会覆盖父协程的上下文。
tl.Go(func(){
fmt.Println(tl.Get()) // test
tl.Set("test2")
fmt.Println(tl.Get()) // test2
})
fmt.Println(tl.Get()) // test- 利用converter，可以轻松将一个结构体转换为另一个结构体。
- 使用go generate自动生成转换器代码，避免了调用反射的开销。
- 开发中
- 利用vermouth的反射，可以轻松获取结构体中的字段信息，并进行操作。
user := &User{Name: "test", Age: 18}
info := vermouth.GetTypeInfo(reflect.TypeOf(*user))
fieldInfo, _ := info.Fields["Name"]
fieldInfo.Set(user, "newName")
// fieldPtr := fieldInfo.GetPointer(user)
// vermouth.SetFieldByPtr(fieldPtr, "newName")- 性能和GO原始的反射，以及直接赋值的基准测试。
直接赋值: 0.371 ns/op
vermouth/reflect赋值: 1.050 ns/op
普通反射赋值: 129.951 ns/op
比普通反射快了 111.89 倍