go-admin框架分析（2）—简化到最简单的框架

代码：https://gitee.com/lsjWeiYi/go-admin/tree/basic/

在go-admin的源码上，删除了几乎全部能删的，保留了最基本的web功能和go-admin的结构。目的是让框架变得好理解，否则一个刚接触框架的人上来，真的很难理解框架各个部分都在干什么。用着很蒙蔽，后期一旦想改，无从下手。

PS：再怎么样，也需要对go有基本的了解，才好交流

该框架剩下的功能有：

1. http监听，这是web框架的基础，肯定得有
2. go-admin的日志系统，写的很死，不知道怎么关掉。
3. swagger文档

简化后的目录还和原来的差不多，但是内容少了非常多。我们还是从main入手：

可以看到，main函数里很简单，就调用了cmd，因为本框架采用cmd的命令行方式启动，依赖cobra实现。那么接下来就从入口cmd讲起：

cmd

其实这里才是程序启动的入口，通常我们启动程序的方式是：

go build
go-admin.exe server 

"cobra.go"是这一插件配置的规范，有兴趣可以去了解下，其实就是生成一些命令，可以使用命令行的方式执行。业务真正的入口是“server.go”，所以可以去看该文件，里面每一步都有详细的注释。该文件和源代码还是有比较大的区别，我改动了比较多，但是核心内容都是一样的。

"router.go"文件也是我新增的，其实它唯一的作用就是实现了init方法：

func init() {
	//注册路由 fixme 其他应用的路由，在本目录新建文件放在init方法
	AppRouters = append(AppRouters, router.InitRouter)
}

它是把业务的api路由的方法添加到AppRouters 中，然后server.go中会将AppRouters 调用了。以后业务添加了什么路由，都是按照这样模式把路由添加到这个文件中，然后路由就生效了。

不熟悉go的同学可能会纳闷，这个init方法谁都没有引用，它怎么就用上了，这是因为在cobra.go中import了"go-admin/cmd/api"，意味着这个包下得所有文件的init方法都是被调用。可以去了解下go的基础知识。

剩下的细节可以看代码，都有注释的

配置文件

配置文件在“config/settings.yml”文件，多余的都先删掉了，就剩两部分，web的相关配置和日志的配置。都是最基本的配置了。

日志系统

go-admin实现了自己的日志模块，可以拿来即用，它支持设置输出到控制台和文件，通过参数stdout控制，参数是“file”，即输出到文件，其他都是输出到控制台。

import log "github.com/go-admin-team/go-admin-core/logger"

log.Info("test")

后续在需要日志的地方import这个依赖，就可以直接使用。除了“cmd”中的文件，因为日志模块在这里初始化，而且初始化在后面，所以这里的日志记录依赖go自带的log模块。这里的日志只会输出到控制台。

它具体的初始化是在“cmd/api/server.go”：

	//1. 读取配置
	config.Setup(
		file.NewSource(file.WithPath(configYml)), // 读取配置文件
	)

在这里，它读取了配置文件的内容，里面就默认加载启动log模块了。有兴趣可以去看源码

日志系统是一套完善系统的基本，所以还是得有的，go-admin既然实现了，应该比我们自己写的好用。拿来用就是了。

common

这个目录放一些公共的文件，原框架中这个目录文件真的多，让人难受，然后我能删的都删了，就剩一些最基本的：

init.go是加载中间件的入口，它被“server.go”调用了，而header.go实现了一些最基本的中间件，一个是解决跨域问题，一个是web的基础安全问题。
中间件是啥？可以理解成http请求和业务中间加的一些校验，检查模块，这些严格叫做全局中间件，所有的http请求都要经过他们，然后才到业务模块手上。当然，也有局部中间件，只有满足条件的http请求才会调用这些中间件。具体的可以去查资料了解。

app

这个就是业务实现的地方了，它包含两个最基本的模块：“api 接口层”和“router 路由层”。我在里面实现了一个health接口，用于检测程序是否正常启动。是否能够通过http访问到。可以直接访问http://localhost:10001/health。

然后我们看router，从名字可以看到，有个叫init_router的，一看他就是入口，原框架这里分好多个文件，我把他整合了一下，毕竟我们的业务也没复杂到要分那么多个文件。然后health就是对应接口health层的，还有swagger是swagger接口文档的，待会介绍。

从这个init_router下手：

// 可以设置多个版本的路由
var (
	v1RouterGroup = make([]func(*gin.RouterGroup), 0)
)

// InitRouter 路由初始化，不要怀疑，这里用到了
func InitRouter() {
		.....
	registerSysHealthRouter(r) // 注册健康接口

	// 注册swagger 路由，不需要可以注释
	registerSwaggerRouter(r)

	// 注册业务路由
	// TODO: 这里可存放业务路由，里边并无实际路由只有演示代码
	v1Router(r)
}

// 不同版本的路由初始化
func v1Router(r *gin.Engine) *gin.Engine {
	....
}

为节省篇幅，就不拿全部代码了。可以看到，它定义了一个（可以有多个）变量用来接受各接口层的路由实现。比如，我可以分版本，可以分权限，分类整合。
然后，它被方法v1Router调用，其实就是循环执行，将其分组添加到router中，同理，这样的方法可以有多个。
最后就是InitRouter了，它是这个模块路由的组织与初始化。当然，他需要被调用了才会生效，而它是被“cmd/api/router.go”调用的。他们层层调用，最终在gin初始化的时候注册好了这些路由。

路由本身实现很简单，但是为了应对复杂业务下的路由管理，必须得分层次，分类别管理起来，否则业务增长后将无法维护。

为了逐步拆解，我在分支basic-2添加了post请求及多版本接口的路由演示代码，需要了解这块的可以到该分支看代码。

swagger

做过web开发的应该都知道这玩意，这个是在线生成接口文档的。就不介绍它是什么玩意了，介绍在go中他的使用。
其实就是在接口层，按照他的规范，描述好接口。然后，看到，main方法那张图，我框起来那部分，vs code里可以直接点击按钮执行文档生成命令，这个过程需要几分钟。然后，启动程序后，访问：http://localhost:10001/swagger/index.html就可以看到。

执行swagger生成文档命令还依赖插件：go get -u github.com/swaggo/swag/cmd/swag
具体可查看：https://www.jianshu.com/p/1837b37e03f8

还有就是它也需要添加路由，就是刚才我跳过的那个swagger.go，它没什么特别的，照抄就好了。

那个“docs”目录就是它生成的接口文件，不用管他。放着就好。

其他文件

“temp”，目录是日志存放的地方，在配置文件中有体现。
其他就不用介绍了。