refactor(项目): 基于Builder模式构建

Author: storezhang

README.md

@@ -130,4 +130,4 @@ func init() {
 ## 感谢Jetbrains
 
 本项目通过`Jetbrains开源许可IDE`编写源代码，特此感谢
-[![Jetbrains图标](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png)](https://www.jetbrains.com/?from=pangum/pangu)
+[![Jetbrains图标](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=pangum/pangu)

bootstrap.go

@@ -1,11 +1,8 @@
 package pangu
 
-type Bootstrap struct{}
+import (
+	"github.com/pangum/pangu/internal/runtime"
+)
 
-func (b *Bootstrap) Before() (err error) {
-	return
-}
-
-func (b *Bootstrap) After() (err error) {
-	return
-}
+// Bootstrap 启动接口
+type Bootstrap = runtime.Bootstrap

bootstrapper.go

@@ -0,0 +1,12 @@
+package pangu
+
+// Bootstrapper 基础启动器
+type Bootstrapper struct{}
+
+func (b *Bootstrapper) Before() (err error) {
+	return
+}
+
+func (b *Bootstrapper) After() (err error) {
+	return
+}

config.go

@@ -0,0 +1,8 @@
+package pangu
+
+import (
+	"github.com/pangum/pangu/internal/core"
+)
+
+// Config 配置
+type Config = core.Config

get.go

@@ -4,4 +4,5 @@ import (
 	"github.com/pangum/pangu/internal/runtime"
 )
 
+// Get 用于向框架获取一系列依赖
 type Get = runtime.Get

go.mod

@@ -24,17 +24,18 @@ require (
 )
 
 require (
-	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.3 // indirect
 	github.com/fsnotify/fsnotify v1.6.0 // indirect
-	github.com/go-playground/locales v0.14.0 // indirect
-	github.com/go-playground/universal-translator v0.18.0 // indirect
-	github.com/go-playground/validator/v10 v10.11.1 // indirect
-	github.com/go-resty/resty/v2 v2.9.1 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.3 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/go-playground/validator/v10 v10.15.5 // indirect
+	github.com/go-resty/resty/v2 v2.10.0 // indirect
 	github.com/goexl/baozheng v0.0.1 // indirect
-	github.com/goexl/http v0.0.5 // indirect
-	github.com/google/uuid v1.3.0 // indirect
-	github.com/leodido/go-urn v1.2.1 // indirect
-	github.com/rs/xid v1.4.0 // indirect
+	github.com/goexl/http v0.0.6 // indirect
+	github.com/google/uuid v1.3.1 // indirect
+	github.com/leodido/go-urn v1.2.4 // indirect
+	github.com/rs/xid v1.5.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect

internal/app/logger.go

@@ -4,4 +4,6 @@ import (
 	"github.com/goexl/simaqian"
 )
 
-type Logger simaqian.Logger
+type Logger interface {
+	simaqian.Logger
+}

internal/builder/application.go

@@ -1,7 +1,7 @@
 package builder
 
 import (
-	"github.com/pangum/pangu/internal/core"
+	internal2 "github.com/pangum/pangu/internal/core"
 	"github.com/pangum/pangu/internal/internal"
 	"github.com/pangum/pangu/internal/param"
 )
@@ -63,6 +63,6 @@ func (a *Application) Help() *Help {
 	return NewHelp(a)
 }
 
-func (a *Application) Get() *core.Application {
-	return core.New(a.params)
+func (a *Application) Get() *internal2.Application {
+	return internal2.New(a.params)
 }

internal/builder/banner.go

@@ -10,11 +10,12 @@ type Banner struct {
 	application *Application
 }
 
-func NewBanner(application *Application) *Banner {
-	return &Banner{
-		params:      param.NewBanner(),
-		application: application,
-	}
+func NewBanner(application *Application) (banner *Banner) {
+	banner = new(Banner)
+	banner.params = application.params.Banner
+	banner.application = application
+
+	return
 }
 
 func (b *Banner) Ascii(ascii string) (ban *Banner) {

internal/builder/code.go

@@ -0,0 +1,46 @@
+package builder
+
+import (
+	"github.com/pangum/pangu/internal/param"
+)
+
+type Code struct {
+	params      *param.Code
+	application *Application
+}
+
+func NewCode(application *Application) (code *Code) {
+	code = new(Code)
+	code.params = application.params.Code
+	code.application = application
+
+	return
+}
+
+func (c *Code) Success(success int) (code *Code) {
+	c.params.Success = success
+	code = c
+
+	return
+}
+
+func (c *Code) Failed(failed int) (code *Code) {
+	c.params.Failed = failed
+	code = c
+
+	return
+}
+
+func (c *Code) Panic(panic int) (code *Code) {
+	c.params.Panic = panic
+	code = c
+
+	return
+}
+
+func (c *Code) Build() (application *Application) {
+	c.application.params.Code = c.params
+	application = c.application
+
+	return
+}

internal/builder/config.go

@@ -1,58 +1,30 @@
 package builder
 
 import (
-	"github.com/pangum/pangu/internal/internal"
+	"github.com/pangum/pangu/internal/internal/builder"
 	"github.com/pangum/pangu/internal/param"
 )
 
 type Config struct {
-	param *param.Config
-}
-
-func NewConfig(param *param.Config) *Config {
-	return &Config{
-		param: param,
-	}
-}
+	*builder.Config
 
-func (c *Config) Nullable() (config *Config) {
-	c.param.Nullable = true
-	config = c
-
-	return
-}
-
-func (c *Config) Required() (config *Config) {
-	c.param.Nullable = false
-	config = c
-
-	return
-}
-
-func (c *Config) Path(path string) (config *Config) {
-	c.param.Paths = append(c.param.Paths, path)
-	config = c
-
-	return
-}
-
-func (c *Config) Extension(extension string) (config *Config) {
-	c.param.Extensions = append(c.param.Extensions, extension)
-	config = c
-
-	return
+	params      *param.Config
+	application *Application
 }
 
-func (c *Config) Default() (config *Config) {
-	c.param.Default = true
-	config = c
+func NewConfig(application *Application) (config *Config) {
+	params := application.params.Config
+	config = new(Config)
+	config.Config = builder.NewConfig(params)
+	config.params = params
+	config.application = application
 
 	return
 }
 
-func (c *Config) Environment(key string, value string) (config *Config) {
-	c.param.Environments = append(c.param.Environments, internal.NewEnvironment(key, value))
-	config = c
+func (c *Config) Build() (application *Application) {
+	application.params.Config = c.params
+	application = c.application
 
 	return
 }

internal/builder/help.go

@@ -9,11 +9,12 @@ type Help struct {
 	application *Application
 }
 
-func NewHelp(application *Application) *Help {
-	return &Help{
-		params:      param.NewHelp(),
-		application: application,
-	}
+func NewHelp(application *Application) (help *Help) {
+	help = new(Help)
+	help.params = application.params.Help
+	help.application = application
+
+	return
 }
 
 func (h *Help) App(tooltip string) (help *Help) {

internal/command/all.go

@@ -16,7 +16,7 @@ type Info struct {
 	*Base
 }
 
-func newInfo() *Info {
+func NewInfo() *Info {
 	return &Info{
 		Base: New("info").Usage(`打印应用程序信息`).Aliases(`i`, `information`).Build(),
 	}

internal/command/info.go

@@ -22,7 +22,7 @@ type Serve struct {
 	logger app.Logger
 }
 
-func newServe(logger app.Logger) *Serve {
+func NewServe(logger app.Logger) *Serve {
 	return &Serve{
 		Base: New("serve").Usage("启动服务").Aliases("s").Build(),
 

internal/command/serve.go

@@ -16,7 +16,7 @@ type Version struct {
 	*Base
 }
 
-func newVersion() *Version {
+func NewVersion() *Version {
 	return &Version{
 		Base: New("version").Usage("打印应用程序版本").Aliases("v", "ver").Build(),
 	}

internal/command/version.go

@@ -1,3 +1,11 @@
 package constant
 
-const ApplicationName = "application"
+const (
+	ApplicationName        = "application"
+	ApplicationStacktrace  = 10
+	ApplicationSkip        = 1
+	ApplicationCodeSuccess = 0
+	ApplicationCodeFailed  = 1
+	ApplicationCodePanic   = -1
+	ApplicationDefaultName = `没有设置，请使用-ldflags "-s -X 'github.com/pangum/pangu.Name=$NAME"来注入值`
+)

internal/constant/application.go

@@ -1,7 +1,12 @@
 package constant
 
 const (
-	ConfigDir              = "config"
-	ConfigConfDir          = "conf"
-	ConfigConfigurationDir = "configuration"
+	ConfigDir                = "config"
+	ConfigConfDir            = "conf"
+	ConfigConfigurationDir   = "configuration"
+	ConfigName               = "config"
+	ConfigAliasC             = "c"
+	ConfigAliasConf          = "conf"
+	ConfigAliasConfiguration = "configuration"
+	ConfigDefaultFilepath    = "./conf/application.yaml"
 )

internal/constant/config.go

@@ -1,6 +1,5 @@
 package constant
 
 const (
-	DefaultName = `没有设置，请使用-ldflags "-s -X 'github.com/pangum/pangu.Name=$NAME"来注入值`
-	DefaultTag  = "default"
+	DefaultTag = "default"
 )