之前用过go语言的反射来做一些代码生成,参考这篇

但是这种方式,入侵太强,需要执行对应的申明调用, 所以对GOA框架的自动生成非常感兴趣,于是仔细研究了一下,发现用的比较巧妙, 这里先卖个关子,先看看生成的代码目录结构。

这里使用adder的desgin文件来生成:

package design

import (
. "github.com/goadesign/goa/design"
. "github.com/goadesign/goa/design/apidsl"
) var _ = API("adder", func() {
Title("The adder API")
Description("A teaser for goa")
Host("localhost:8080")
Scheme("http")
}) var _ = Resource("operands", func() {
Action("add", func() {
Routing(GET("add/:left/:right"))
Description("add returns the sum of the left and right parameters in the response body")
Params(func() {
Param("left", Integer, "Left operand")
Param("right", Integer, "Right operand")
})
Response(OK, "text/plain")
}) })

然后生成对应的目录结构如下(如果不知道怎么生成,参考第一篇):

qpzhang@qpzhang:~/gocode/src/goa-adder $tree
.
├── app
│   ├── contexts.go
│   ├── controllers.go
│   ├── hrefs.go
│   ├── media_types.go
│   ├── test
│   │   └── operands.go
│   └── user_types.go
├── client
│   ├── adder-cli
│   │   ├── commands.go
│   │   └── main.go
│   ├── client.go
│   ├── datatypes.go
│   └── operands.go
├── design
│   └── design.go
├── main.go
├── operands.go
└── swagger
├── swagger.json
└── swagger.yaml
  • APP目录,生成的框架相关代码,包含HTTP的路由
  • client目录,生成是go原生请求server的client测试程序,方便测试
  • swagger目录, 生成的swagger文件,可以用swagger来进行API的描述,这样不用自己写API接口文档了(cool)
  • 然后是main.go  , 程序的主入口
  • operands.go 业务逻辑代码,你需要在这里进行修改
//operands.go

package main

import (
"github.com/goadesign/goa"
"goa-adder/app"
) // OperandsController implements the operands resource.
type OperandsController struct {
*goa.Controller
} // NewOperandsController creates a operands controller.
func NewOperandsController(service *goa.Service) *OperandsController {
return &OperandsController{Controller: service.NewController("OperandsController")}
} // Add runs the add action.
func (c *OperandsController) Add(ctx *app.AddOperandsContext) error {
// TBD: implement 在这里写对应的函数逻辑
return nil
}

非常棒,不用再重复写框架低层那些代码了(路由、编解码等等)。

虽然之前也用过前公司的框架(那个是利用java的反射自动生成代码),但遇到自动生成代码这事儿,还是止不住兴奋。

这里先不研究生成的框架代码,先研究一下利用go语言是如何自动生成的吧。

一般自动生成可以分三个步骤:

1)通过自描述语言来定义服务和接口(IDL,DSL都OK)

2)解析描述语言,获取元数据(服务名称,接口名称,接口参数神马的)

3)根据元数据,以及框架对应的模板,生成重复的代码部分

我们来看GOA怎么做的,在goagen中加上 --debug 选项,可以保留中间文件。

//使用命令
goagen --debug bootstrap -d goa-adder/design //生成目录
qpzhang@qpzhang:~/gocode/src/goa-adder $tree -L 1
.
├── app
├── client
├── design
├── goagen009966755
├── goagen174102868
├── goagen511141286
├── goagen585483469

├── main.go
├── operands.go
└── swagger
├── goagen009966755
│   ├── goagen
│   └── main.go
├── goagen174102868
│   ├── goagen
│   └── main.go
├── goagen511141286
│   ├── goagen
│   └── main.go
├── goagen585483469
│   ├── goagen
│   └── main.go

我们看到,多出几个目录来,而且每个目录,都包含一个main.go和生成的可执行程序,我们随便进入一个目录看看:

//************************************************************************//
// Code Generator
//
// Generated with goagen v0.0.1, command line:
// $ goagen
// --debug bootstrap -d goa-adder/design
//
// The content of this file is auto-generated, DO NOT MODIFY
//************************************************************************// package main import (
"github.com/goadesign/goa/goagen/gen_main"
"fmt"
"strings"
"github.com/goadesign/goa/dslengine"
_ "goa-adder/design"

) func main() {
// Check if there were errors while running the first DSL pass
dslengine.FailOnError(dslengine.Errors) // Now run the secondary DSLs
dslengine.FailOnError(dslengine.Run()) files, err := genmain.Generate()
dslengine.FailOnError(err) // We're done
fmt.Println(strings.Join(files, "\n"))
}

然后看出一些端倪,它先把我们design目录整个包含进来,然后调用引擎里面的函数,进行代码的生成。

这里再回到我们的DSL语言写的文件 design.go

package design

import (
. "github.com/goadesign/goa/design"
. "github.com/goadesign/goa/design/apidsl"
) var _ = API("adder", func() {
Title("The adder API")
Description("A teaser for goa")
Host("localhost:8080")
Scheme("http")
})

这里的API,其实就是在调用引擎里预先定义好的函数,在那里定义的呢?看源码

func API(name string, dsl func()) *design.APIDefinition {
if design.Design.Name != "" {
dslengine.ReportError("multiple API definitions, only one is allowed")
return nil
}
if !dslengine.IsTopLevelDefinition() {
dslengine.IncompatibleDSL()
return nil
} if name == "" {
dslengine.ReportError("API name cannot be empty")
}
design.Design.Name = name
design.Design.DSLFunc = dsl
return design.Design
}

API函数的调用,生成了对应的Design实例,然后把元数据(这里是Name 和一个匿名函数) 都保存到内存里面了。

design对象是在程序初始化的时候(源码这里)就定义好了,并把实例注册到生成引擎中去(其实就是把对象实例传过去,方便后续调用)。

后面调用Generate函数来进行代码的自动生成。

大概就是这个意思,确实很巧妙,DSL定义的都是匿名全局变量,全局变量又是对已经定义好的元数据函数的调用(例如:API等),然后通过包引用把DSL文件包含进来,这样元数据都存在对应的实例内存中去了。

然后就可以随便怎么玩了,通过元数据的类型,来生成对应的文件,妙哉!

但是由于要支持各种嵌套、不同类型以及容错等等,所以实现写起来的代码非常多。

不过,我们可以按照这个思路,来实现一个简单的例子:

//main.go

package main

import "fmt"

//定义DSL语言描述的结构体,用于保存DSL里面的数据
type APIDefinition struct {
// Name of API
Name string
// Title of API
Title string
// Description of API
Desc string // DSLFunc contains the DSL used to create this definition if any
DSLFunc func()
} //实现DSL对应的API,用于实例化
func API(name string, dsl func()) *APIDefinition {
api := new(APIDefinition)
api.Name = name
api.DSLFunc = dsl //偷偷赋值
g_api = api return api
} //对应的Title赋值
func Title(val string) {
if g_api != nil {
g_api.Title = val
}
} func Description(d string) {
if g_api != nil {
g_api.Desc = d
}
} //当前design的实例,这里用全局变量示意
var g_api *APIDefinition //根据内存中的存储数据来进行代码生成
func generateTest() {
//这里需要执行一下对应的DSLFunc
g_api.DSLFunc()
fmt.Println("get Name: ", g_api.Name)
fmt.Println("get Title: ", g_api.Title)
fmt.Println("get Desc: ", g_api.Desc)
} //这里是DSL申明
var _ = API("adder", func() {
Title("The adder API")
Description("A teaser for goa")
}) func main() {
generateTest()
}

最后运行一下执行的结果:

qpzhang@qpzhang:~/gocode/auto-gen $go run main.go
get Name: adder
get Title: The adder API
get Desc: A teaser for goa

我们已经拿到用户在DSL里面定义的数据了(当然,这里DSL描述是直接写到同一个文件里面,省去了合并引入的过程)。

OK,代码的自动生成原理已经知道了,后面就要分析框架整体的架构和代码了。

GO --微服务框架(二) goa的更多相关文章

  1. GO --微服务框架(一) goa

    当项目逐渐变大之后,服务增多,开发人员增加,单纯的使用go来写服务会遇到风格不统一,开发效率上的问题. 之前研究go的微服务架构go-kit最让人头疼的就是定义服务之后,还要写很多重复的框架代码,一直 ...

  2. [goa]golang微服务框架学习--安装使用

      当项目逐渐变大之后,服务增多,开发人员增加,单纯的使用go来写服务会遇到风格不统一,开发效率上的问题. 之前研究go的微服务架构go-kit最让人头疼的就是定义服务之后,还要写很多重复的框架代码, ...

  3. springcolud 的学习(二).SpringCloud微服务框架

    为什么选择SpringCloud因为SpringCloud出现,对微服务技术提供了非常大的帮助,因为SpringCloud 提供了一套完整的微服务解决方案,不像其他框架只是解决了微服务中某个问题. 服 ...

  4. 基于thrift的微服务框架

    前一阵开源过一个基于spring-boot的rest微服务框架,今天再来一篇基于thrift的微服务加框,thrift是啥就不多了,大家自行百度或参考我之前介绍thrift的文章, thrift不仅支 ...

  5. 基于.NET CORE微服务框架 -surging的介绍和简单示例 (开源)

    一.前言 至今为止编程开发已经11个年头,从 VB6.0,ASP时代到ASP.NET再到MVC, 从中见证了.NET技术发展,从无畏无知的懵懂少年,到现在的中年大叔,从中的酸甜苦辣也只有本人自知.随着 ...

  6. 基于.NET CORE微服务框架 -谈谈surging API网关

    1.前言 对于最近surging更新的API 网关大家也有所关注,也收到了不少反馈提出是否能介绍下Api网关,那么我们将在此篇文章中剥析下surging的Api 网关 开源地址:https://git ...

  7. MicroService.Core简易微服务框架《一、简介》

    MicroService.Core MicroService.Core 的初衷是为了方便的创建一个微服务, 可作为 Windows Service 或者控制台模式启动. 它底层使用了 OWin 自托管 ...

  8. 【非官方】Surging 微服务框架使用入门

    前言 本文非 Surging 官方教程,只是自己学习的总结.如有哪里不对,还望指正. 我对 surging 的看法 我目前所在的公司采用架构就是类似与Surging的RPC框架,在.NET 4.0框架 ...

  9. 浅谈现公司的Spring Cloud微服务框架

    目录 说在前面 服务注册与发现 服务网关及熔断 配置中心 消息中心.服务链路追踪 小言 说在前面 本文偏小白,大佬慎入,若有错误或者质疑,欢迎留言提问,谢谢,祝大家新年快乐. spring cloud ...

随机推荐

  1. ReportViewer部分使用总结

    最近winform上使用ReportViewer做报表,因为之前没弄过,所以遇到了很多问题,现在总结一下. 一.运行环境 .net环境:4.0 开发工具:vs2010 二.开发步骤 第一步,在winf ...

  2. SPOJ 375 树链剖分 QTREE - Query on a tree

    人生第一道树链剖分的题目,其实树链剖分并不是特别难. 思想就是把树剖成一些轻链和重链,轻链比较少可以直接修改,重链比较长,用线段树去维护. 貌似大家都是从这篇博客上学的. #include <c ...

  3. CornerStone使用教程(配置SVN,HTTP及svn简单使用)

    1.SVN配置 假设你公司svn地址为:svn://192.168.1.111/svn/ios,用户名:svnserver,密码:123456 1:填写主机地址 2:如果你的主机地址中有端口号,如为1 ...

  4. 对于运用git将本地文件上传到coding总结

    首先需要在你的本地磁盘下建立一个目录,并且进入该目录. 前几次课程上有讲到&的用法,&&表示并且. 命令 ”makir 文件名 && cd 文件名”,cd指进入 ...

  5. 一步一步,完成sparkMLlib对日志文件的处理(1)

    https://blog.csdn.net/u012834750/article/details/81014997    初学第一天,当然是完成helloWorld啦,有点艰难,2个小时,在idea, ...

  6. 【bzoj1954】Pku3764 The xor-longest Path Trie树

    题目描述  给定一棵n个点的带权树,求树上最长的异或和路径 输入 The input contains several test cases. The first line of each test ...

  7. [luoguP2774] 方格取数问题(最大点权独立集)

    传送门 引入两个概念: 最小点权覆盖集:满足每一条边的两个端点至少选一个的最小权点集. 最大点权独立集:满足每一条边的两个端点最多选一个的最大权点集. 现在对网格染色,使得相邻两点颜色不同,之后把两个 ...

  8. 《快速开发》通过Maven创建WebService项目Hello World!

    有多快? 整个过程3分钟.不用下载jar包,不用一步一步创建Web Project... 你需要的就是在Maven库里选一个archetype,然后一路Next~ 先看结果: 准备好了吗?我们起飞: ...

  9. Eclipse + Apache Axis2 发布RESTful WebService(一)基础知识

    1.什么是WebService 学习 WebService 第一步:体系结构.三元素SOAP/WSDL/UDDI 2.什么是Axis2 Axis2是Apache一套崭新的WebService引擎(框架 ...

  10. java面试题之死锁产生的条件,以及如何避免死锁,银行家算法,产生死锁后如何解决(阿里面试题)

    死锁产生的四个必要条件: 互斥:一个资源每次只能被一个进程使用(资源独立) 请求与保持:一个进程因请求资源而阻塞时,对已获得的资源保持不放(不释放锁) 不剥夺:进程已获得的资源,在未使用之前,不能强行 ...