go-admin在线开发平台学习-2[程序结构分析]

紧接着上一篇,本文我们对go-admin下载后的源码进行分析。

首先对项目所使用的第三方库进行分析,了解作者使用的库是否是通用的官方库可以有助于我们更快地阅读程序。接着对项目的main()方法进行分析,因为程序使用cli的方式启动,对cli不同的命令进行分析。基于此俩点开始工作。

go-admin中使用的第三方库

cobra

强大的cli封装,支持命令嵌套

cast

简单安全的类型转换

casbin

轻量级开源访问控制框架,采用了元模型的设计思想,支持多种经典的访问控制方案,如基于角色的访问控制 RBAC、基于属性的访问控制 ABAC 等

gorm

一个神奇的,对开发人员友好的 Golang ORM 库

sentinel-golang

随着微服务的流行,服务和服务之间的稳定性变得越来越重要。Sentinel 是面向分布式服务架构的流量控制组件,主要以流量为切入点,从流量控制、熔断降级、系统自适应保护等多个维度来帮助您保障微服务的稳定性。

opentracing-go

分布式追踪库

cron

定时任务库,支持cron表达式

启动分析

main.go作为程序第一个入口文件,main()方法作为程序入口

使用corboa命令行的方式进行启动,有多个不同的命令,如下所示

  • 查看系统版本

go-admin version

  • 查看系统配置

go-admin config

  • 服务启动

go-admin server

  • 数据库迁移

go-admin migrate

不同的命令有不同的参数进行配置

命令的代码在根目录cmd下分文件保存,通过cobra.go作为统一入口

image-20210205093239267

corbora的使用遵循一个通用的规则。首先创建一个cmd文件夹,在其中定义一个分支命令即是定义一个新的go文件。本项目所使用的方式也类似,每一个命令都 定义一个文件夹,分别管理自己命令的内容,最后通过 cobra.go 这个上层入口暴露出来。

go-admin version 命令

<img src=”https://gitee.com/happlyfox/img/raw/master/image-20210218141425364.png” />

定义指令 version ,runE执行调用 run 方法,控制台打印版本号

go-admin config 命令

<img src=”https://gitee.com/happlyfox/img/raw/master/image-20210218141705707.png” />

与上一个 version 指令类似,只是多一个输入参数,用来指定路径。

init初始化方法定义输入的flag参数,当执行go-admin config -c 路径,进入 run() 方法。

run方法中

1、config.Setup(configYml),将yml配置文件转为不同的实体类

2、打印不同的分类内容

go-admin migrate 命令

数据库迁移指令

基于gorm的migrate方法,定义自己的initdata内容,执行指令完成数据库迁移工具。

有点类似.net core中的code first模式

go-admin server命令

重点!!!

我们直接进行 server 命令的分析

api文件夹下的server.go文件,对应服务启动指令

Init方法

init() 方法中是对 命令行参数的解析和初始化路由方法的绑定

image-20210205094215618

以上代码分为俩部门看

1、对server 指令的参数绑定

2、route.InitRouter方法添加到AppRouters中,等待后续执行

router.InitRouter方法来源于 /admin/router/initrouter.go 文件

initrouter.go中包含多项内容

1、通过配置获取程序所用引擎,当前只支持gin,后续作者可能会进行添加。

2、通过配置判断是否使用ssl加密,如果使用””注册tls处理中间件”

3、读取配置获取数据库类型,连接字符串获取gorm具体数据库的接口实现,自定义中间件设置数据库上下文,集成到gin使用

4、配置Sentinel限流规则

阿里开源的一套东西,需要研究研究

5、通用的系统中间件载入

中间件的业务逻辑包含在 /admin/middleware中

日志处理 logger.go

作者自己生态的日志封装,基于logrus和zap的实现,具体没看

逻辑是获取request的请求信息写入文件日志,如果包含特定请求写入数据库(后期可能会废弃)

全局异常处理

当出现全局异常的时候捕获异常,避免程序直接挂掉

缓存

NoCache是一个附加头的中间件函数。防止客户端缓存HTTP响应。

意思是客户端不进行缓存,每次都要的请求向服务器发起

跨域

增加跨域请求头信息,允许所有请求的跨域

这块之后应该集成第三方,实现满足特定需要的跨域

安全

Secure是附加了security的中间件功能

链路追踪

链路追踪是实现每请求的时间线展示吗还是什么,这块还需要研究

6、 jwt认证方式实现

7、注册业务路由

区分俩种

需要认证的路由,基于上述jwt

不需要认证的路由

命令定义

image-20210205093727158

我感觉这有点像是web core中的依赖注入的概念,首先进行各服务的注册注入然后启动服务的某些功能,当然实际上还是有很多不同的,只是突然这么想到了而已

PreRun

启动前的初始化配置

读取配置文件,配置三种全局日志,分别为

  • Logger 日志
  • JobLogger 定时任务日志
  • RequestLogger 请求日志

初始化数据库链接,通过配置文件得到不同的数据库,并执行不同的数据库驱动

驱动位于/go-admin/common/database/_driver后缀

已集成mysql,pgsql,sqlites的驱动

配置接口控制全局,基于casbin

RunE

启动配置

判断是否为开发环境,增加环境监控

将初始化配置的路由中间件载入

定义服务端口,ssl等信息

启动定时服务

打印启动日志

启动服务

srv := &http.Server{
Addr:    config.ApplicationConfig.Host + ":" + config.ApplicationConfig.Port,
Handler: global.Cfg.GetEngine(),
}

定义启动服务的host+port

定义启动服务的句柄,当前支持的方式是 gin

srv.ListenAndServe 启动服务,打印启动时的日志

命令的解析大体如下,接下来针对框架中的细节的进行描述,请等待作者的更新。

有疑问加站长微信联系(非本文作者)

Go语言中文网
我还没有学会写个人说明!
上一篇

2021年头部区块链开发框架总结

下一篇

“匆公子”月增粉431.9W,2021开年榜有哪些信号放出?

你也可能喜欢

评论已经被关闭。

插入图片