将命令行参数解析功能放到cmd package

Author: liuguangw

cmd/app_command.go

@@ -0,0 +1,28 @@
+package cmd
+
+import (
+	"github.com/urfave/cli/v2"
+)
+
+var runFlags = []cli.Flag{
+	&cli.StringFlag{
+		Name:  "log-path",
+		Usage: "billing log file path",
+	},
+}
+
+//AppCommand 项目命令根节点
+func AppCommand() *cli.App {
+	return &cli.App{
+		Name:                 "billing",
+		Usage:                "billing server command line tool",
+		EnableBashCompletion: true,
+		Flags:                runFlags,
+		Action:               runUpCommand,
+		Commands: []*cli.Command{
+			UpCommand(),
+			StopCommand(),
+			ShowUsersCommand(),
+		},
+	}
+}

cmd/doc.go

@@ -0,0 +1,2 @@
+// Package cmd 包含了所有的命令行相关功能
+package cmd

cmd/show_users.go

@@ -0,0 +1,27 @@
+package cmd
+
+import (
+	"fmt"
+	"github.com/liuguangw/billing_go/services/billing"
+	"github.com/urfave/cli/v2"
+)
+
+// ShowUsersCommand 打印用户列表状态的命令
+func ShowUsersCommand() *cli.Command {
+	return &cli.Command{
+		Name:   "show_users",
+		Usage:  "show users list status",
+		Action: runShowUsersCommand,
+	}
+}
+
+//runShowUsersCommand 打印用户列表状态
+func runShowUsersCommand(c *cli.Context) error {
+	//初始化server
+	server, err := billing.NewServer()
+	if err != nil {
+		return err
+	}
+	fmt.Println("show users log ...")
+	return server.ShowUsers()
+}

cmd/stop.go

@@ -0,0 +1,31 @@
+package cmd
+
+import (
+	"fmt"
+	"github.com/liuguangw/billing_go/services/billing"
+	"github.com/urfave/cli/v2"
+)
+
+// StopCommand 停止server的命令
+func StopCommand() *cli.Command {
+	return &cli.Command{
+		Name:   "stop",
+		Usage:  "stop the billing server",
+		Action: runStopCommand,
+	}
+}
+
+//runStopCommand 停止billing服务
+func runStopCommand(c *cli.Context) error {
+	//初始化server
+	server, err := billing.NewServer()
+	if err != nil {
+		return err
+	}
+	fmt.Println("stoping billing server ...")
+	if err := server.Stop(); err != nil {
+		return err
+	}
+	fmt.Println("stop command sent successfully")
+	return nil
+}

cmd/up.go

@@ -0,0 +1,45 @@
+package cmd
+
+import (
+	"errors"
+	"github.com/liuguangw/billing_go/services"
+	"github.com/liuguangw/billing_go/services/billing"
+	"github.com/urfave/cli/v2"
+	"os"
+	"runtime"
+)
+
+// UpCommand 运行server的命令
+func UpCommand() *cli.Command {
+	upFlags := append(runFlags, &cli.BoolFlag{
+		Name:    "daemon",
+		Aliases: []string{"d"},
+		Usage:   "daemon mode, run server at background",
+	})
+	return &cli.Command{
+		Name:   "up",
+		Usage:  "run the billing server",
+		Flags:  upFlags,
+		Action: runUpCommand,
+	}
+}
+
+//runUpCommand 运行billing服务
+func runUpCommand(c *cli.Context) error {
+	isDaemon := c.IsSet("daemon")
+	logPath := c.String("log-path")
+	//后台模式
+	if isDaemon {
+		if runtime.GOOS == "windows" {
+			return errors.New("daemon mode is not supported on windows")
+		}
+		return services.RunBillingAtBackground(os.Args[0], logPath)
+	}
+	//初始化server
+	server, err := billing.NewServer()
+	if err != nil {
+		return err
+	}
+	server.Run(logPath)
+	return nil
+}

go.mod

@@ -5,13 +5,16 @@ go 1.17
 require (
 	github.com/go-sql-driver/mysql v1.6.0
 	github.com/mattn/go-colorable v0.1.12
+	github.com/urfave/cli/v2 v2.3.0
 	go.uber.org/zap v1.19.1
 	golang.org/x/text v0.3.7
 	gopkg.in/yaml.v2 v2.4.0
 )
 
 require (
+	github.com/cpuguy83/go-md2man/v2 v2.0.1 // indirect
 	github.com/mattn/go-isatty v0.0.14 // indirect
+	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	go.uber.org/atomic v1.9.0 // indirect
 	go.uber.org/multierr v1.7.0 // indirect
 	golang.org/x/sys v0.0.0-20211124211545-fe61309f8881 // indirect

go.sum

@@ -1,5 +1,9 @@
+github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8=
 github.com/benbjohnson/clock v1.1.0/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA=
+github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
+github.com/cpuguy83/go-md2man/v2 v2.0.1 h1:r/myEWzV9lfsM1tFLgDyu0atFtJ1fXn261LKYj/3DxU=
+github.com/cpuguy83/go-md2man/v2 v2.0.1/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -10,8 +14,6 @@ github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORN
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/mattn/go-colorable v0.1.11 h1:nQ+aFkoE2TMGc0b68U2OKSexC+eq46+XwZzWXHRmPYs=
-github.com/mattn/go-colorable v0.1.11/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
 github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
 github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
 github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
@@ -20,10 +22,16 @@ github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
 github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/urfave/cli/v2 v2.3.0 h1:qph92Y649prgesehzOrQjdWyxFOp/QVM+6imKHad91M=
+github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI=
 github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
 go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
 go.uber.org/atomic v1.9.0 h1:ECmE8Bn/WFTYwEW/bpKD3M8VtR/zQVbavAoalC1PYyE=
@@ -52,8 +60,6 @@ golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20211117180635-dee7805ff2e1 h1:kwrAHlwJ0DUBZwQ238v+Uod/3eZ8B2K5rYsUHBQvzmI=
-golang.org/x/sys v0.0.0-20211117180635-dee7805ff2e1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211124211545-fe61309f8881 h1:TyHqChC80pFkXWraUUf6RuB5IqFdQieMLwwCJokV2pc=
 golang.org/x/sys v0.0.0-20211124211545-fe61309f8881/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
@@ -71,6 +77,7 @@ golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8T
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=

main.go

@@ -1,51 +1,14 @@
 package main
 
 import (
-	"fmt"
-	"github.com/liuguangw/billing_go/services"
-	"github.com/liuguangw/billing_go/services/billing"
+	"github.com/liuguangw/billing_go/cmd"
 	"log"
 	"os"
-	"runtime"
 )
 
 func main() {
-	// ./billing up -d
-	// 使用上面的命令时, 程序会在后台运行(支持类unix系统, 不支持windows)
-	if len(os.Args) > 2 {
-		if os.Args[1] == "up" && os.Args[2] == "-d" && runtime.GOOS != "windows" {
-			if err := services.RunBillingAtBackground(os.Args[0]); err != nil {
-				log.Fatalln(err)
-			}
-			return
-		}
-	}
-	//初始化server
-	server, err := billing.NewServer()
-	if err != nil {
+	appCommand := cmd.AppCommand()
+	if err := appCommand.Run(os.Args); err != nil {
 		log.Fatalln(err)
 	}
-	//命令
-	if len(os.Args) > 1 {
-		commandStr := os.Args[1]
-		//处理./billing stop
-		if commandStr == "stop" {
-			fmt.Println("stoping billing server ...")
-			if err := server.Stop(); err != nil {
-				log.Fatalln(err)
-			}
-			fmt.Println("stop command sent successfully")
-			return
-		}
-		//./billing show_users
-		if commandStr == "show_users" {
-			fmt.Println("show users log ...")
-			if err := server.ShowUsers(); err != nil {
-				log.Fatalln(err)
-			}
-			return
-		}
-	}
-	//启动
-	server.Run()
 }

services/billing/init_logger.go

@@ -10,16 +10,15 @@ import (
 )
 
 // initLogger 初始化日志系统
-func (s *Server) initLogger() error {
-	//当前程序文件的绝对路径
-	mainAppPath, err := filepath.Abs(os.Args[0])
-	if err != nil {
-		return err
+func (s *Server) initLogger(logFilePath string) error {
+	if logFilePath == "" {
+		//使用默认日志路径
+		defaultPath, err := defaultLogFilePath()
+		if err != nil {
+			return err
+		}
+		logFilePath = defaultPath
 	}
-	//程序目录
-	appDir := filepath.Dir(mainAppPath)
-	//打开日志文件
-	logFilePath := filepath.Join(appDir, "billing.log")
 	fileFlag := os.O_APPEND | os.O_CREATE | os.O_WRONLY
 	logFile, err := os.OpenFile(logFilePath, fileFlag, 0644)
 	if err != nil {
@@ -61,3 +60,17 @@ func (s *Server) initLogger() error {
 	s.logger = zap.New(core, zap.AddStacktrace(zapcore.WarnLevel))
 	return nil
 }
+
+//默认的日志文件路径
+func defaultLogFilePath() (string, error) {
+	//当前程序文件的绝对路径
+	mainAppPath, err := filepath.Abs(os.Args[0])
+	if err != nil {
+		return "", err
+	}
+	//程序目录
+	appDir := filepath.Dir(mainAppPath)
+	//日志文件
+	logFilePath := filepath.Join(appDir, "billing.log")
+	return logFilePath, nil
+}

services/billing/run.go

@@ -10,15 +10,16 @@ import (
 )
 
 // Run 运行billing
-func (s *Server) Run() {
+func (s *Server) Run(logFilePath string) {
 	//初始化日志系统
-	if err := s.initLogger(); err != nil {
+	if err := s.initLogger(logFilePath); err != nil {
 		log.Fatalln("init logger failed: " + err.Error())
 	}
 	//退出前,执行清理任务
 	defer s.clean()
 	//输出build信息
 	services.ShowVersionInfo(s.logger)
+	s.logger.Info("log file: " + s.logFile.Name())
 	//初始化tcp Listener
 	if err := s.initListener(); err != nil {
 		s.logger.Fatal("init listener failed: " + err.Error())

services/run_background.go

@@ -7,8 +7,11 @@ import (
 )
 
 // RunBillingAtBackground 在后台运行程序
-func RunBillingAtBackground(billingPath string) error {
+func RunBillingAtBackground(billingPath, logFilePath string) error {
 	cmd := exec.Command(billingPath)
+	if logFilePath != "" {
+		cmd.Args = append(cmd.Args, "--log-path", logFilePath)
+	}
 	// 重定向输出文件
 	outFile, err := os.OpenFile(os.DevNull, os.O_WRONLY, 0644)
 	if err != nil {