From 269794456a0443f14b37f411f1aff641152251fa Mon Sep 17 00:00:00 2001 From: Gordon <46924906+FGadvancer@users.noreply.github.com> Date: Mon, 18 Mar 2024 16:34:03 +0800 Subject: [PATCH] refactor: unified naming for module startup functions. --- cmd/openim-api/main.go | 2 +- cmd/openim-crontask/main.go | 2 +- cmd/openim-msggateway/main.go | 2 +- cmd/openim-msgtransfer/main.go | 2 +- internal/msggateway/init.go | 4 ++-- internal/msgtransfer/init.go | 2 +- pkg/common/cmd/api.go | 8 +++----- pkg/common/cmd/constant.go | 4 ++++ pkg/common/cmd/cron_task.go | 4 ++-- pkg/common/cmd/msg_gateway.go | 6 +++--- pkg/common/cmd/msg_transfer.go | 6 +++--- 11 files changed, 22 insertions(+), 20 deletions(-) diff --git a/cmd/openim-api/main.go b/cmd/openim-api/main.go index ee19a5c60..3a101f620 100644 --- a/cmd/openim-api/main.go +++ b/cmd/openim-api/main.go @@ -22,7 +22,7 @@ import ( ) func main() { - apiCmd := cmd.NewApiCmd() + apiCmd := cmd.NewApiCmd(cmd.ApiServer) apiCmd.AddPortFlag() apiCmd.AddPrometheusPortFlag() if err := apiCmd.Execute(); err != nil { diff --git a/cmd/openim-crontask/main.go b/cmd/openim-crontask/main.go index b52029c64..cd6fae999 100644 --- a/cmd/openim-crontask/main.go +++ b/cmd/openim-crontask/main.go @@ -20,7 +20,7 @@ import ( ) func main() { - cronTaskCmd := cmd.NewCronTaskCmd() + cronTaskCmd := cmd.NewCronTaskCmd(cmd.CronTaskServer) if err := cronTaskCmd.Exec(); err != nil { util.ExitWithError(err) } diff --git a/cmd/openim-msggateway/main.go b/cmd/openim-msggateway/main.go index 01b13560d..a295ed612 100644 --- a/cmd/openim-msggateway/main.go +++ b/cmd/openim-msggateway/main.go @@ -20,7 +20,7 @@ import ( ) func main() { - msgGatewayCmd := cmd.NewMsgGatewayCmd() + msgGatewayCmd := cmd.NewMsgGatewayCmd(cmd.MsgGatewayServer) msgGatewayCmd.AddWsPortFlag() msgGatewayCmd.AddPortFlag() msgGatewayCmd.AddPrometheusPortFlag() diff --git a/cmd/openim-msgtransfer/main.go b/cmd/openim-msgtransfer/main.go index 84fbbd2ea..2b3a274f1 100644 --- a/cmd/openim-msgtransfer/main.go +++ b/cmd/openim-msgtransfer/main.go @@ -20,7 +20,7 @@ import ( ) func main() { - msgTransferCmd := cmd.NewMsgTransferCmd() + msgTransferCmd := cmd.NewMsgTransferCmd(cmd.MsgTransferServer) msgTransferCmd.AddPrometheusPortFlag() msgTransferCmd.AddTransferProgressFlag() if err := msgTransferCmd.Exec(); err != nil { diff --git a/internal/msggateway/init.go b/internal/msggateway/init.go index 4efbb7cdf..17281ecbf 100644 --- a/internal/msggateway/init.go +++ b/internal/msggateway/init.go @@ -21,8 +21,8 @@ import ( "github.com/openimsdk/open-im-server/v3/pkg/common/config" ) -// RunWsAndServer run ws server. -func RunWsAndServer(conf *config.GlobalConfig, rpcPort, wsPort, prometheusPort int) error { +// Start run ws server. +func Start(conf *config.GlobalConfig, rpcPort, wsPort, prometheusPort int) error { fmt.Println("start rpc/msg_gateway server, port: ", rpcPort, wsPort, prometheusPort, ", OpenIM version: ", config.Version) longServer, err := NewWsServer( conf, diff --git a/internal/msgtransfer/init.go b/internal/msgtransfer/init.go index 2b1e057d1..0e0c2ba8c 100644 --- a/internal/msgtransfer/init.go +++ b/internal/msgtransfer/init.go @@ -53,7 +53,7 @@ type MsgTransfer struct { cancel context.CancelFunc } -func StartTransfer(config *config.GlobalConfig, prometheusPort int) error { +func Start(config *config.GlobalConfig, prometheusPort int) error { rdb, err := cache.NewRedis(&config.Redis) if err != nil { return err diff --git a/pkg/common/cmd/api.go b/pkg/common/cmd/api.go index e94dc0372..24d647ec8 100644 --- a/pkg/common/cmd/api.go +++ b/pkg/common/cmd/api.go @@ -19,16 +19,14 @@ import ( "github.com/spf13/cobra" "github.com/openimsdk/open-im-server/v3/internal/api" - "github.com/openimsdk/open-im-server/v3/pkg/common/config" ) type ApiCmd struct { *RootCmd - initFunc func(config *config.GlobalConfig, port int, promPort int) error } -func NewApiCmd() *ApiCmd { - ret := &ApiCmd{RootCmd: NewRootCmd("api"), initFunc: api.Start} +func NewApiCmd(name string) *ApiCmd { + ret := &ApiCmd{RootCmd: NewRootCmd(name)} ret.SetRootCmdPt(ret) ret.addPreRun() ret.addRunE() @@ -44,7 +42,7 @@ func (a *ApiCmd) addPreRun() { func (a *ApiCmd) addRunE() { a.Command.RunE = func(cmd *cobra.Command, args []string) error { - return a.initFunc(a.config, a.port, a.prometheusPort) + return api.Start(a.config, a.port, a.prometheusPort) } } diff --git a/pkg/common/cmd/constant.go b/pkg/common/cmd/constant.go index c332ce3a6..0281b4f14 100644 --- a/pkg/common/cmd/constant.go +++ b/pkg/common/cmd/constant.go @@ -23,4 +23,8 @@ const ( RpcMsgServer = "msg" RpcThirdServer = "third" RpcUserServer = "user" + ApiServer = "api" + CronTaskServer = "cronTask" + MsgGatewayServer = "msgGateway" + MsgTransferServer = "msgTransfer" ) diff --git a/pkg/common/cmd/cron_task.go b/pkg/common/cmd/cron_task.go index 79eb37e8f..81bb80437 100644 --- a/pkg/common/cmd/cron_task.go +++ b/pkg/common/cmd/cron_task.go @@ -26,8 +26,8 @@ type CronTaskCmd struct { initFunc func(config *config.GlobalConfig) error } -func NewCronTaskCmd() *CronTaskCmd { - ret := &CronTaskCmd{RootCmd: NewRootCmd("cronTask", WithCronTaskLogName()), +func NewCronTaskCmd(name string) *CronTaskCmd { + ret := &CronTaskCmd{RootCmd: NewRootCmd(name, WithCronTaskLogName()), initFunc: tools.StartTask} ret.addRunE() ret.SetRootCmdPt(ret) diff --git a/pkg/common/cmd/msg_gateway.go b/pkg/common/cmd/msg_gateway.go index adae1ce0d..186ae3748 100644 --- a/pkg/common/cmd/msg_gateway.go +++ b/pkg/common/cmd/msg_gateway.go @@ -27,8 +27,8 @@ type MsgGatewayCmd struct { *RootCmd } -func NewMsgGatewayCmd() *MsgGatewayCmd { - ret := &MsgGatewayCmd{NewRootCmd("msgGateway")} +func NewMsgGatewayCmd(name string) *MsgGatewayCmd { + ret := &MsgGatewayCmd{NewRootCmd(name)} ret.addRunE() ret.SetRootCmdPt(ret) return ret @@ -51,7 +51,7 @@ func (m *MsgGatewayCmd) getWsPortFlag(cmd *cobra.Command) int { func (m *MsgGatewayCmd) addRunE() { m.Command.RunE = func(cmd *cobra.Command, args []string) error { - return msggateway.RunWsAndServer(m.config, m.getPortFlag(cmd), m.getWsPortFlag(cmd), m.getPrometheusPortFlag(cmd)) + return msggateway.Start(m.config, m.getPortFlag(cmd), m.getWsPortFlag(cmd), m.getPrometheusPortFlag(cmd)) } } diff --git a/pkg/common/cmd/msg_transfer.go b/pkg/common/cmd/msg_transfer.go index 75ef087c1..56c270e58 100644 --- a/pkg/common/cmd/msg_transfer.go +++ b/pkg/common/cmd/msg_transfer.go @@ -27,8 +27,8 @@ type MsgTransferCmd struct { *RootCmd } -func NewMsgTransferCmd() *MsgTransferCmd { - ret := &MsgTransferCmd{NewRootCmd("msgTransfer")} +func NewMsgTransferCmd(name string) *MsgTransferCmd { + ret := &MsgTransferCmd{NewRootCmd(name)} ret.addRunE() ret.SetRootCmdPt(ret) return ret @@ -36,7 +36,7 @@ func NewMsgTransferCmd() *MsgTransferCmd { func (m *MsgTransferCmd) addRunE() { m.Command.RunE = func(cmd *cobra.Command, args []string) error { - return msgtransfer.StartTransfer(m.config, m.getPrometheusPortFlag(cmd)) + return msgtransfer.Start(m.config, m.getPrometheusPortFlag(cmd)) } }