go-zero微服务框架代码生成神器goctl原理分析(一)

简介: go-zero微服务框架代码生成神器goctl原理分析(一)

推荐下go-zero 微服务框架,也是最近很火很有人气的框架,致力于打造国内最简单好用的框架。


火在哪?几分钟搞定个接口和微服务,还不用担心稳定性和高并发,这不香吗?


作者的理念很好,工具大于约定和文档的理念,编码自动化,让精力更多的放在业务和创新上,大幅度的提高效率和生产力,这会是个趋势。


golang圈子不大,微服务框架框架屈指可数:除了go-micro、go-kit,几乎没有其他选择。go-zero为此提供第三个可能。


说起go-zero提高生产力的地方,就不得不说goctl。


goctl是go-zero配套的代码生成器。


简直是神器,只需要定义好服务接口和请求体,应答体,一键自动生成整套框架和代码。

对goctl是如何生成模板框架和代码感觉很好奇,于是就打算对goctl的实现做个分析。或许哪天也想搞个这么个代码生成器,可以参考下go-zero作者的思路和方法,也来提高提高效率,自动生成框架或模板代码多好。


分析之前先来看看goctl是怎么用的吧。


首先得先安装goctl了,


git clone https://github.com/tal-tech/go-zero
cd go-zero/tools/goctl
go build goctl.go


最后生成goctl.exe 复制到Go的安装目录bin下 。


简单的使用方法:


goctl api    go    -api       hello.api   -dir    .


#代码说明如下
goctl  api      go       -api             open.api            -dir                     .
 |      |        |         |                 |                  |                      | 
      生成api  go语言     指定api模板文件   模板文件名称         指定生成代码存放路径     当前文件夹


创建项目


生成go.mod文件


输入如下指令,创建项目


  1. mkdir hello


  1. cd hello


  1. go mod init hello


定义hello.api


type (
  UserOptReq struct {
    mobile string `json:"mobile" form:"mobile"`
    passwd string `json:"passwd" form:"passwd"`
    code   string `json:"code" form:"code"`
  }
  UserOptResp struct {
    id    uint   `json:"id"`
    token string `json:"token"`
  }
  //图片验证码支持
  VerifyReq struct {
    ticket string `json:"ticket" form:"ticket"`
  }
  //图片验证码支持
  VerifyResp struct {
    data string `json:"data"`
  }
)
service open-api {
  @doc(
        summary: 公开的api函数
        desc: >
        register 用户注册,
        authorization 用户登录,
        verify 图片验证码接口
    )
  @server(
    handler: registerHandler
    folder: open
  )
  post /open/register(UserOptReq) returns(UserOptResp)
  @server(
    handler: authorizationHandler
    folder: open
  )
  post /open/authorization(UserOptReq) returns(UserOptResp)
  @server(
    handler: verifyHandler
    folder: open
  )
  post /open/verify(VerifyReq) returns(VerifyResp)
}


生成代码


采用如下指令生成代码:


goctl api    go    -api       hello.api   -dir    .




运行一下


go run open.go


测试一下:


curl http://127.0.0.1:8888/open/register -X POST -H "Content-Type: application/json" -d {\"mobile\":\"15367151352\",\"passwd\":\"testpwd\",\"code\":\"asdf\"}
{"id":0,"token":""}


熟练的话几分钟时间就搞定一个接口的大致框架剩下就剩添加业务了,这效率,还能更快吗?简单的接口分钟搞定。


接下来揭开goctl的神秘面纱,看下是如何实现这么强大的功能的,从中汲取点儿营养。跟着上面的指令流程,goctl api    go    -api       hello.api   -dir    .走一遍吧,看看经历了什么。


打开源码目录里,进入github.com\tal-tech\go-zero\tools\goctl,


打开goctl.go,这里应该是应用的入口了。goctl.go这个文件的源码不多,使用了一个外部库github.com/urfave/cli


先来看下这个cli库,这个库使用还是挺简单的,用来生成命令行应用的神器。


简单的命令行,直接用go内置的flag包实现了命令行参数的解析就可以了。但若是造成一个工具,得方便使用吧,有一些命令行的使用说明吧,使用urfave/cli这个库就简单了。


一个简单示例:


package main
import (
  "fmt"
  "github.com/urfave/cli"
  "os"
)
var (
  Version = "1.0.0"
)
type Commands struct {
}
func (this *Commands) Test(cli *cli.Context) {
  fmt.Println("this is Test cmd proc")
  uid := cli.Int("uid")
  username := cli.String("name")
  fmt.Println(uid, username)
}
//模拟子命令
func (this *Commands) Test1(cli *cli.Context) {
  fmt.Println("this is Test1 cmd proc")
  u := cli.Int("u")
  n := cli.String("n")
  fmt.Println(u, n)
}
func main() {
  app := cli.NewApp()
  app.Usage = "this is a cli tool to do someting"
  app.Version = Version
  app.Commands = []cli.Command{
    {
      Name:   "test",
      Usage:  "this is a test cmd,for example:test -uid=x -name=y",
      Action: (&Commands{}).Test,
      Flags: []cli.Flag{
        cli.IntFlag{Name: "uid,ud", Usage: "this is a flag,-uid"},
        cli.StringFlag{Name: "name,ne", Usage: "this is a flag,-name"},
      },
      //以下子命令,根据需要有,非必须
      Subcommands: []cli.Command{
        {
          Name:   "test1",
          Usage:  "this is a sub cmd test1",
          Action: (&Commands{}).Test1,
          Flags: []cli.Flag{
            cli.IntFlag{Name: "u", Usage: "this is a flag,n"},
            cli.StringFlag{Name: "n", Usage: "this is a flag,usage:-n"},
          },
        },
      },
    },
  }
  err := app.Run(os.Args)
  if err != nil {
    fmt.Print("command error :" + err.Error())
  }
}





或者这样,注意参数输入可以为-u,或者--u都行,或者-u 后面跟等号或者省略=号直接写内容都可以。



了解完cli内容,那么可知上面的goctl命令的执行顺序了,goctl api    go    -api       hello.api   -dir    .


就是执行了api命令的子命令go的那项,参数输入是-api,内容为hello.api,另一项参数输入为-dir,内容为当前目录。


Action: gogen.GoCommand,


接下来就进入gogen.GoCommand里面看看吧,代码在github.com\tal-tech\go-zero\tools\goctl\api\gogen的gen.go里面。


const tmpFile = "%s-%d"
var tmpDir = path.Join(os.TempDir(), "goctl")
func GoCommand(c *cli.Context) error {
  apiFile := c.String("api")
  dir := c.String("dir")
  if len(apiFile) == 0 {
    return errors.New("missing -api")
  }
  if len(dir) == 0 {
    return errors.New("missing -dir")
  }
  p, err := parser.NewParser(apiFile)
  if err != nil {
    return err
  }
  api, err := p.Parse()
  if err != nil {
    return err
  }
  logx.Must(util.MkdirIfNotExist(dir))
  logx.Must(genEtc(dir, api))
  logx.Must(genConfig(dir))
  logx.Must(genMain(dir, api))
  logx.Must(genServiceContext(dir, api))
  logx.Must(genTypes(dir, api))
  logx.Must(genHandlers(dir, api))
  logx.Must(genRoutes(dir, api))
  logx.Must(genLogic(dir, api))
  // it does not work
  format(dir)
  createGoModFileIfNeed(dir)
  if err := backupAndSweep(apiFile); err != nil {
    return err
  }
  if err = apiformat.ApiFormat(apiFile, false); err != nil {
    return err
  }
  fmt.Println(aurora.Green("Done."))
  return nil
}


从这段代码里,可以看到,从命令行取出了hello.api这个文件,先经过parser.NewParser(apiFile)这一处关键处理,这应是goctl的神秘地方之一,后面会单独分析。


然后依次是如果目录不存在,创建目录,logx.Must用意就是must里面的必须执行成功,不成功的话就中断退出了,并输出日志。


接下来流程依次是


genEtc生成etc配置文件目录和内容。


genConfig-> genMain,genServiceContext,genTypes,genHandlers,genRoutes,genLogic


然后执行go fmt指令格式化一下代码format(dir)


func format(dir string) {
  cmd := exec.Command("go", "fmt", "./"+dir+"...")
  _, err := cmd.CombinedOutput()
  if err != nil {
    fmt.Println(err.Error())
  }
}


createGoModFileIfNeed 创建下go.mod如果需要的话。


backupAndSweep,备份和清理处理。


最后是apiformat.ApiFormat(apiFile, false)是干嘛的,先记下来,后面再看。既然是分析原理嘛,起初没必要每个点都扣那么细,讲究方法,先整体后局部,先易后难。


以上仅仅是冰山一角,一个大致的流程。


难点和精华应该是那个parser.NewParser()处理和后面genEtc和genMain等里面的text/template模板解析和作者实现的获取注解的方法实现上。


下面接着分析parser,这块儿是重点,涉及go/parser和go/ast库的使用。


相关文章
|
1月前
|
开发框架 Go 计算机视觉
纯Go语言开发人脸检测、瞳孔/眼睛定位与面部特征检测插件-助力GoFly快速开发框架
开发纯go插件的原因是因为目前 Go 生态系统中几乎所有现有的人脸检测解决方案都是纯粹绑定到一些 C/C++ 库,如 OpenCV 或 dlib,但通过 cgo 调用 C 程序会引入巨大的延迟,并在性能方面产生显著的权衡。此外,在许多情况下,在各种平台上安装 OpenCV 是很麻烦的。使用纯Go开发的插件不仅在开发时方便,在项目部署和项目维护也能省很多时间精力。
|
2月前
|
Go API 数据库
Go 语言中常用的 ORM 框架,如 GORM、XORM 和 BeeORM,分析了它们的特点、优势及不足,并从功能特性、性能表现、易用性和社区活跃度等方面进行了比较,旨在帮助开发者根据项目需求选择合适的 ORM 框架。
本文介绍了 Go 语言中常用的 ORM 框架,如 GORM、XORM 和 BeeORM,分析了它们的特点、优势及不足,并从功能特性、性能表现、易用性和社区活跃度等方面进行了比较,旨在帮助开发者根据项目需求选择合适的 ORM 框架。
173 4
|
2月前
|
中间件 Go API
Go语言中几种流行的Web框架,如Beego、Gin和Echo,分析了它们的特点、性能及适用场景,并讨论了如何根据项目需求、性能要求、团队经验和社区支持等因素选择最合适的框架
本文概述了Go语言中几种流行的Web框架,如Beego、Gin和Echo,分析了它们的特点、性能及适用场景,并讨论了如何根据项目需求、性能要求、团队经验和社区支持等因素选择最合适的框架。
179 1
|
2月前
|
运维 NoSQL Java
后端架构演进:微服务架构的优缺点与实战案例分析
【10月更文挑战第28天】本文探讨了微服务架构与单体架构的优缺点,并通过实战案例分析了微服务架构在实际应用中的表现。微服务架构具有高内聚、低耦合、独立部署等优势,但也面临分布式系统的复杂性和较高的运维成本。通过某电商平台的实际案例,展示了微服务架构在提升系统性能和团队协作效率方面的显著效果,同时也指出了其带来的挑战。
110 4
|
2月前
|
安全 Go 开发者
代码之美:Go语言并发编程的优雅实现与案例分析
【10月更文挑战第28天】Go语言自2009年发布以来,凭借简洁的语法、高效的性能和原生的并发支持,赢得了众多开发者的青睐。本文通过两个案例,分别展示了如何使用goroutine和channel实现并发下载网页和构建并发Web服务器,深入探讨了Go语言并发编程的优雅实现。
43 2
|
2月前
|
分布式计算 Java 持续交付
如何选择合适的微服务框架
如何选择合适的微服务框架
50 0
|
3月前
|
Dubbo Java 应用服务中间件
Dubbo学习圣经:从入门到精通 Dubbo3.0 + SpringCloud Alibaba 微服务基础框架
尼恩团队的15大技术圣经,旨在帮助开发者系统化、体系化地掌握核心技术,提升技术实力,从而在面试和工作中脱颖而出。本文介绍了如何使用Dubbo3.0与Spring Cloud Gateway进行整合,解决传统Dubbo架构缺乏HTTP入口的问题,实现高性能的微服务网关。
|
3月前
|
算法 Java 编译器
你为什么不应该过度关注go语言的逃逸分析
【10月更文挑战第21天】逃逸分析是 Go 语言编译器的一项功能,用于确定变量的内存分配位置。变量在栈上分配时,函数返回后内存自动回收;在堆上分配时,则需垃圾回收管理。编译器会根据变量的使用情况自动进行逃逸分析。然而,过度关注逃逸分析可能导致开发效率降低、代码复杂度增加,并且对性能的影响相对较小。编译器优化通常比人工干预更准确,因此开发者应更多关注业务逻辑和整体性能优化。
|
1月前
|
存储 监控 算法
员工上网行为监控中的Go语言算法:布隆过滤器的应用
在信息化高速发展的时代,企业上网行为监管至关重要。布隆过滤器作为一种高效、节省空间的概率性数据结构,适用于大规模URL查询与匹配,是实现精准上网行为管理的理想选择。本文探讨了布隆过滤器的原理及其优缺点,并展示了如何使用Go语言实现该算法,以提升企业网络管理效率和安全性。尽管存在误报等局限性,但合理配置下,布隆过滤器为企业提供了经济有效的解决方案。
82 8
员工上网行为监控中的Go语言算法:布隆过滤器的应用