feat: cwgo hex

.licenserc.yaml

@@ -7,4 +7,7 @@ header:
     - '**/*.go'
     - '**/*.s'
 
+  paths-ignore:
+    - "example/**"
+
   comment: on-failure

_typos.toml

@@ -2,3 +2,8 @@
 
 [files]
 extend-exclude = ["go.sum", "check_branch_name.sh"]
+
+[default.extend-identifiers]
+# *sigh* this just isn't worth the cost of fixing
+O_WRONLY = "O_WRONLY"
+WRONLY = "WRONLY"

cmd/static/server_flags.go

@@ -28,11 +28,12 @@ func serverFlags() []cli.Flag {
 		&cli.StringFlag{Name: config.ServiceType, Usage: "Specify the generate type. (RPC or HTTP)", Value: config.RPC},
 		&cli.StringFlag{Name: config.Module, Aliases: []string{"mod"}, Usage: "Specify the Go module name to generate go.mod.", Destination: &globalArgs.ServerArgument.GoMod},
 		&cli.StringFlag{Name: config.IDLPath, Usage: "Specify the IDL file path. (.thrift or .proto)", Destination: &globalArgs.ServerArgument.IdlPath},
-		&cli.StringFlag{Name: config.OutDir, Value: ".", Aliases: []string{"o"}, Usage: "Specify the output path. Currently cwgo supports git templates, such as `--template https://github.com/***/cwgo_template.git`", Destination: &globalArgs.ServerArgument.OutDir},
+		&cli.StringFlag{Name: config.OutDir, Value: ".", Aliases: []string{"o"}, Usage: "Specify the output path. Currently cwgo supports git templates, such as `--template https://github.com/***/cwgo_template.git`.", Destination: &globalArgs.ServerArgument.OutDir},
 		&cli.StringFlag{Name: config.Template, Usage: "Specify the layout template.", Destination: &globalArgs.ServerArgument.Template},
-		&cli.StringFlag{Name: config.Registry, Usage: "Specify the registry, default is None"},
-		&cli.StringSliceFlag{Name: config.ProtoSearchPath, Aliases: []string{"I"}, Usage: "Add an IDL search path for includes. (Valid only if idl is protobuf)"},
-		&cli.StringSliceFlag{Name: config.Pass, Usage: "pass param to hz or kitex"},
+		&cli.StringFlag{Name: config.Registry, Usage: "Specify the registry, default is None."},
+		&cli.StringSliceFlag{Name: config.ProtoSearchPath, Aliases: []string{"I"}, Usage: "Add an IDL search path for includes."},
+		&cli.StringSliceFlag{Name: config.Pass, Usage: "Pass param to hz or Kitex."},
 		&cli.BoolFlag{Name: config.Verbose, Usage: "Turn on verbose mode."},
+		&cli.BoolFlag{Name: config.HexTag, Usage: "Add HTTP listen for Kitex.", Destination: &globalArgs.Hex},
 	}
 }

config/argument.go

@@ -113,4 +113,5 @@ const (
 	Signable     = "signable"
 	IndexTag     = "index_tag"
 	TypeTag      = "type_tag"
+	HexTag       = "hex"
 )

config/server.go

@@ -29,6 +29,7 @@ type ServerArgument struct {
 	Template   string
 	SliceParam *SliceParam
 	Verbose    bool
+	Hex        bool // add http listen for kitex
 
 	Cwd    string
 	GoSrc  string

example/hex/.gitignore

@@ -0,0 +1,35 @@
+*.o
+*.a
+*.so
+_obj
+_test
+*.[568vq]
+[568vq].out
+*.cgo1.go
+*.cgo2.c
+_cgo_defun.c
+_cgo_gotypes.go
+_cgo_export.*
+_testmain.go
+*.exe
+*.exe~
+*.test
+*.prof
+*.rar
+*.zip
+*.gz
+*.psd
+*.bmd
+*.cfg
+*.pptx
+*.log
+*nohup.out
+*settings.pyc
+*.sublime-project
+*.sublime-workspace
+!.gitkeep
+.DS_Store
+/.idea
+/.vscode
+/output
+*.local.yml

example/hex/Makefile

@@ -0,0 +1,6 @@
+mod_init:
+	go mod init cwgo/example/hex
+hex:
+	cwgo  server --type RPC  --idl idl/hello.thrift --service p.s.m --hex
+mod_tidy:
+	go mod tidy

example/hex/README.md

@@ -0,0 +1,24 @@
+# CWGO Hex Usage
+
+## Introduce
+The main power of `cwgo hex` is to allow hertz and kitex to listen on the same port and use protocol sniffing to distribute requests to kitex and hertz for processing
+## Install
+```
+# Go 1.15 and earlier version
+GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get github.com/cloudwego/cwgo@latest
+
+# Go 1.16 and later version
+GOPROXY=https://goproxy.cn/,direct go install github.com/cloudwego/cwgo@latest
+```
+## Usage
+- init go.mod `go mod init cwgo/example/hex`
+- generate code `cwgo  server --type RPC  --idl idl/hello.thrift --service p.s.m --hex`
+- mod tidy `go mod tidy`
+
+## Test
+- `cd /cwgo/example/hex`
+- start server: `go run .`
+- test rpc: `go run client/main.go`
+  - `HelloResp({RespBody:[KITEX] hello, hex})`
+- test http: `curl 127.0.0.1:8888/hello?name=hex`
+  - `{"RespBody":"[HERTZ] hello, hex"}`

example/hex/biz/dal/init.go

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2023 CloudWeGo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package dal
+
+import (
+	"cwgo/example/hex/biz/dal/mysql"
+	"cwgo/example/hex/biz/dal/redis"
+)
+
+func Init() {
+	redis.Init()
+	mysql.Init()
+}

example/hex/biz/dal/mysql/init.go

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2023 CloudWeGo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package mysql
+
+import (
+	"cwgo/example/hex/conf"
+
+	"gorm.io/driver/mysql"
+	"gorm.io/gorm"
+)
+
+var (
+	DB  *gorm.DB
+	err error
+)
+
+func Init() {
+	DB, err = gorm.Open(mysql.Open(conf.GetConf().MySQL.DSN),
+		&gorm.Config{
+			PrepareStmt:            true,
+			SkipDefaultTransaction: true,
+		},
+	)
+	if err != nil {
+		panic(err)
+	}
+}

example/hex/biz/dal/redis/init.go

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2023 CloudWeGo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package redis
+
+import (
+	"context"
+
+	"cwgo/example/hex/conf"
+	"github.com/redis/go-redis/v9"
+)
+
+var (
+	RedisClient *redis.Client
+)
+
+func Init() {
+	RedisClient = redis.NewClient(&redis.Options{
+		Addr:     conf.GetConf().Redis.Address,
+		Username: conf.GetConf().Redis.Username,
+		Password: conf.GetConf().Redis.Password,
+		DB:       conf.GetConf().Redis.DB,
+	})
+	if err := RedisClient.Ping(context.Background()).Err(); err != nil {
+		panic(err)
+	}
+}