Git仓库:https://gitee.com/xiaoyinhui/golang-code/tree/develop/go-admin-demo/go-admin
1、首先我们需要找到程序的入口,根据 main.go
可以看到,程序的入口是从命令行开始的
// 关于 cobra 具体是啥可以自己查一下,这个的作用就是可以使用命令行操作更加的方便解耦
// var rootCmd = &cobra.Command{
func init() {
// 为 rootCmd 添加子命令
rootCmd.AddCommand(api.StartCmd)
rootCmd.AddCommand(migrate.StartCmd)
rootCmd.AddCommand(version.StartCmd)
rootCmd.AddCommand(config.StartCmd)
rootCmd.AddCommand(app.StartCmd)
}
// Execute : apply commands
func Execute() {
err := rootCmd.Execute()
if err != nil {
os.Exit(-1)
}
}
// 按照我目前的理解,程序编译完毕后,生成的程序。
// 我们使用命令行或者IDE进行运行的时候,是从这里开始进入的,然后这里根据调用的命令,开始从这个命令树中查找,找到与命令相匹配的命令,然后执行相对应的代码
2、这里就介绍一个非常简单的例子:获取版本号的命令
通过 rootCmd.AddCommand(version.StartCmd)
添加子命令,我们可以进去看看这个子命令里面实现了什么
func preRunFunc(cmd *cobra.Command, args []string) {
}
func runEFunc(cmd *cobra.Command, args []string) error {
return run()
}
var (
StartCmd = &cobra.Command{
Use: "version", // 单行使用消息【命令】
Short: "Get version info", // “帮助”输出中显示的简短描述
Example: "go-admin version", // 如何使用命令的示例
PreRun: preRunFunc, // PreRun:此命令的子级不会继承
RunE: runEFunc, // RunE:命令运行的方法
}
)
func run() error {
fmt.Println(global.Version)
return nil
}
可以看到当前单元也声明了一个 cobra.Command
既然我们知道了这个执行的命令是go-admin version
那就试试看,执行这个命令会发生什么事情
PS D:\go-admin> .\go-admin version
2.1.0
看到这里是不是好像明白了什么,run()
我们执行的应该就是这个方法吧,既然如此我们就改一下代码,看看是不是执行的这个方法
从上面的执行结果来看,不就是按照我们所想的来的么
3、既然知道是咋回事,也模仿的写一个简单的示例看看
- 3.1 首先是需要弄个文件,其实这个文件放在哪里都可以,但是为了规范,我们跟紧大部队,就放在
cmd\xiaoyin
路径下面,作为这示例的路径 - 3.2 文件有了,里面的内容要怎么写呢,根据获取版本的例子,先需要声明
cobra.Command
,然后将这个命令添加为主命令的子命令 - 3.3 其实到上面一步,我们就已经完成了,然后我们重新编译一下程序,就可以执行
go-admin xiaoyin
这个命令
package xiaoyin
import (
"fmt"
"github.com/spf13/cobra"
)
func preRunFunc(cmd *cobra.Command, args []string) {
}
func runEFunc(cmd *cobra.Command, args []string) error {
return run()
}
var (
StartCmd = &cobra.Command{
Use: "xiaoyin", // 单行使用消息【命令】
Short: "This is XiaoYin Demo", // “帮助”输出中显示的简短描述
Example: "go-admin xiaoyin", // 如何使用命令的示例
PreRun: preRunFunc, // PreRun:此命令的子级不会继承
RunE: runEFunc, // RunE:命令运行的方法
}
)
func run() error {
fmt.Println("这是 xiaoyin 的示例")
return nil
}
// 这一段是不是很熟悉,没错就是开头的那个添加子命令的地方
func init() {
// 为 rootCmd 添加子命令
rootCmd.AddCommand(api.StartCmd)
rootCmd.AddCommand(migrate.StartCmd)
rootCmd.AddCommand(version.StartCmd)
rootCmd.AddCommand(config.StartCmd)
rootCmd.AddCommand(app.StartCmd)
// 示例
rootCmd.AddCommand(xiaoyin.StartCmd)
}
一点点笔记,以便以后翻阅。