微服务应用框架
Esim专注解决业务问题:业务复杂度,如何测试,代码组织,扩展等问题。不会提供微服务整套技术体系,服务治理、服务注册、服务发现等都不是它专注解决的问题,这部分问题我们交给了Service Mesh。
做为业务框架,Esim默认集成了gin和grpc两个技术框架,但吸收了业务和技术分离思想,所以为集成其他技术框架提供了接口,只要实现Transports接口,再把实例注册到
App.trans
就可以很轻松的集成其他技术框架。
type Transports interface {
// start server
Start()
// graceful shutdown server
GracefulShutDown()
}
func (app *App) RegisterTran(tran transports.Transports) {
app.trans = append(app.trans, tran)
}
环境 go 1.3 及以上
使用 module 包管理工具
go get github.com/jukylin/esim
cd github.com/jukylin/esim
go build -o esim ./tool && mv ./esim $GOPATH/bin
esim new -s test
cd test
go run main.go
cd test/internal/transports/http/component-test/
go test
Esim的架构来源于《实现领域驱动设计》的六边形架构和阿里的COLA架构,这2个架构有一个共同点:业务与技术分离。这点很好的解决了由于微服务架构增加的网络通讯和事件导致开发效率越来越慢的问题。所以才决定由原来的三层架构转为四层架构。
Esim使用松散的分层架构,上层可以任意调用下层。使用松散的分层架构的原因,是因为我们在使用四层架构的过程中发现:一些简单的场景,app层的service只是增加了一层调用,并没有起到协调的作用,反而增加了一些不必要的工作,所以使用松散的架构,让controller直接调用domain的逻辑。
不能因为使用松散的架构,把原有app层的service职责都放到了controller里面!!!
目录 | 职责 |
---|---|
controller | 负责显示信息和解析、校验请求,适配不同终端 |
application | 不包含业务规则,为下一层领域模型协调任务,分配工作 |
domain | 负责表达业务概念,业务状态信息和业务规则,是业务软件的核心 |
infrastructure | 为各层提供技术支持,持久化,领域事件等 |
函数第一个参数是ctx!函数第一个参数是ctx!函数第一个参数是ctx!
禁止在defer内做逻辑运算
业务代码形参、实参、返回值的类型不允许使用interface
命名
Jaeger | |
---|---|
目录名 | 小写/中横线 |
函数名 | 驼峰 |
文件名 | 下划线 |
变量 | 驼峰 |
常量 | 驼峰 |
包名 | 当前目录名 |
请求地址 | *小写 |
请求参数 | 小驼峰 |
返回参数 | 小驼峰 |
目录 | 定义 | 文件 | 类 | 接口 |
---|---|---|---|---|
application/service | 应用层 | index_service.go | IndexService | 无 |
domain/service | 领域服务 | index_service.go | IndexService | 无 |
domain/entity | 实体 | index_entity.go | IndexEntity | 无 |
infra/event | 领域事件 | index_event.go | PubIndexEvent | IndexEvent |
infra/repo | 资源库 | index_repo.go | DBIndexRepo | IndexRepo |
infra/dao | 数据访问对象 | index_dao.go | IndexDao | 无 |
目录 | 定义 | 文件 | 类 | 接口 |
---|---|---|---|---|
application/service | 应用层 | index.go | IndexService | 无 |
domain/service | 领域服务 | index.go | IndexService | 无 |
domain/entity | 实体 | index.go | IndexEntity | 无 |
infra/event | 领域事件 | index.go | PubIndexEvent | IndexEvent |
infra/repo | 资源库 | index.go | DBIndexRepo | IndexRepo |
infra/dao | 数据访问对象 | index.go | IndexDao | 无 |
`create_time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`last_update_time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
`is_deleted` TINYINT(1) UNSIGNED NOT NULL DEFAULT '0' COMMENT '删除标识',
Esim 使用wire实现编译时的依赖注入,它有以下优点:
Esim将wire用于业务与基础设施之间。将基础设施的初始化从业务抽离出来,集中管理。
基础设施的依赖和初始化都在
infra/infra.go
文件下。wire的使用主要分2步,以增加mysqlClient为例:
type Infra struct {
*container.Esim
}
var infraSet = wire.NewSet(
wire.Struct(new(Infra), "*"),
provideEsim,
)
type Infra struct {
*container.Esim
DB mysql.MysqlClient
}
var infraSet = wire.NewSet(
wire.Struct(new(Infra), "*"),
provideEsim,
provideDb,
)
func provideDb(esim *container.Esim) mysql.MysqlClient {
......
return mysqlClent
}
在当前目录下执行:
wire
命令,看到:
wire: projectPath/internal/infra: wrote projectPath/internal/infra/wire_gen.go
说明执行成功,就可以在项目中使用了。
infra.NewInfra().DB
依赖倒置和依赖注入一样,主要应用于业务与基础设施之间。主要的作用是让业务与技术实现分离。在实际的使用中我们把涉及io操作都放到了基础设施的资源库上。这样做的好处:
前置条件:
- 在项目根目录下
- 配置环境变量
export ESIM_DB_HOST=127.0.0.1
export ESIM_DB_PORT=3306
export ESIM_DB_USER=root
export ESIM_DB_PASSWORD=123456
由于DDD开发方式多了很多目录、文件,导致这部分工作变得很繁琐,所以
db2entity
从mysql数据库的表开始,自动建立实体,生成简单的CRUD语句和资源库的接口与实现,并把生成的资源库注入到基础设施。一气呵成。
前置条件:
- 在模型目录下
- 开启 module,
export GO111MODULE=on
factory
命令可以自动对结构体进行初始化,内存对齐,生成临时对象池,reset和释放资源等操作,减少一些繁杂操作。
前置条件:
- 在接口目录下
ifacer
命令根据接口的定义生成空实例
前置条件:
- 项目目录下
- 推荐使用gotests
test
命令监听项目被修改文件,并在文件目录下执行go test
自动运行单元测试。当然为了减轻一些繁杂的工作,esim test
还会执行wire, mockery等命令
esim 默认为 dev 环境,esim主要由 dev 和 pro 环境
export ENV=pro
配置文件在项目的conf目录下
conf/conf.yaml
func provideConf(){
options := config.ViperConfOptions{}
file := []string{"conf/monitoring.yaml", "conf/conf.yaml"}
conf := config.NewViperConfig(options.WithConfigType("yaml"),
options.WithConfFile(file))
return conf
}
service_name := infra.NewInfra().Conf.GetString("appname")
日志会根据不同环境打印日志,开发和测试环境会把所有日志打印到终端,生产只会打印warn及以上的日志。 2套日志接口,一套没有上下文,一套有。使用上下文是为了把分布式环境下的日志通过tracer_id串起来。
func provideLogger(conf config.Config) log.Logger {
var loggerOptions log.LoggerOptions
logger := log.NewLogger(
loggerOptions.WithDebug(conf.GetBool("debug")),
)
return logger}
infra.NewInfra().Logger.Infof("info %s", "test")
infra.NewInfra().Logger.Infoc(ctx, "info %s", "test")
比官方接口多了(ctx)参数
func provideHttp(esim *container.Esim) *http.HttpClient {
clientOptions := http.ClientOptions{}
httpClent := http.NewHttpClient(
clientOptions.WithTimeOut(esim.Conf.GetDuration("http_client_time_out")),
clientOptions.WithProxy(
func() interface {} {
monitorProxyOptions := http.MonitorProxyOptions{}
return http.NewMonitorProxy(
monitorProxyOptions.WithConf(esim.Conf),
monitorProxyOptions.WithLogger(esim.Logger))
}),
)
return httpClent
}
resp, err := infra.NewInfra().Http.GetCtx(ctx, "http://www.baidu.com")
defer resp.Body.Close()
func provideMongodb(esim *container.Esim) mongodb.MgoClient {
options := mongodb.MgoClientOptions{}
mongo := mongodb.NewMongo(
mgoClientOptions.WithLogger(esim.logger),
mgoClientOptions.WithConf(esim.conf),
mgoClientOptions.WithMonitorEvent(
func() MonitorEvent {
monitorEventOptions := MonitorEventOptions{}
return NewMonitorEvent(
monitorEventOptions.WithConf(esim.conf),
monitorEventOptions.WithLogger(esim.logger),
)
},
)
)
return mongo
}
import "go.mongodb.org/mongo-driver/bson"
type Info struct{
Title string
}
info := Info{}
coll := infra.NewInfra().Mgo.GetColl("database", "coll")
filter := bson.M{"phone": "123456"}
res := coll.FindOne(inf.Mgo.GetCtx(c.Request.Context()), filter).Decode(&info)
func provideGrpcClient(esim *container.Esim) *grpc.GrpcClient {
clientOptional := grpc.ClientOptionals{}
clientOptions := grpc.NewClientOptions(
clientOptional.WithLogger(esim.Logger),
clientOptional.WithConf(esim.Conf),
)
grpcClient := grpc.NewClient(clientOptions)
return grpcClient
}
import (
"pathto/protobuf/passport"
)
conn := infra.NewInfra().GrpcClient.DialContext(ctx, ":60080")
defer conn.Close()
client := passport.NewUserInfoClient(conn)
getUserByUserNameRequest := &passport.GetUserByUserNameRequest{}
getUserByUserNameRequest.Username = "123456"
replyData, err = client.GetUserByUserName(ctx, getUserByUserNameRequest)
func provideRedis(esim *container.Esim) *redis.RedisClient {
redisClientOptions := redis.RedisClientOptions{}
redisClent := redis.NewRedisClient(
redisClientOptions.WithConf(esim.Conf),
redisClientOptions.WithLogger(esim.Logger),
redisClientOptions.WithProxy(
func() interface{} {
monitorProxyOptions := redis.MonitorProxyOptions{}
return redis.NewMonitorProxy(
monitorProxyOptions.WithConf(esim.Conf),
monitorProxyOptions.WithLogger(esim.Logger),
monitorProxyOptions.WithTracer(esim.Tracer),
)
},
),
)
return redisClent
}
conn := infra.NewInfra().Redis.GetCtxRedisConn()
defer conn.Close()
key := "username:"+username
exists, err := redis.Bool(conn.Do(ctx, "exists", key))
func provideDb(esim *container.Esim) *mysql.MysqlClient {
mysqlClientOptions := mysql.MysqlClientOptions{}
mysqlClent := mysql.NewMysqlClient(
mysqlClientOptions.WithConf(esim.Conf),
mysqlClientOptions.WithLogger(esim.Logger),
mysqlClientOptions.WithProxy(
func() interface{} {
monitorProxyOptions := mysql.MonitorProxyOptions{}
return mysql.NewMonitorProxy(
monitorProxyOptions.WithLogger(esim.Logger),
monitorProxyOptions.WithConf(esim.Conf),
monitorProxyOptions.WithTracer(esim.Tracer),
)
},
),
)
return mysqlClent
}
var user model.User
infra.NewInfra().DB.GetDb(ctx, "db").Table("table").Where("username = ?", username).
Select([]string{"id"}).First(&user)