update hade framework

Author: jianfengye

LICENSE

@@ -1,6 +1,6 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2017-present PanJiaChen
+Copyright (c) 2021 jianfengye
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,4 +1,29 @@
-hade框架文件
+# 官方网站
 
+http://hade.funaio.cn/
 
-目前还处于alpha版本，请使用go get -u hade 实时更新
+# 框架特色：
+
+## 基于协议
+
+服务与服务间的协议是基于协议进行交互的。
+
+## 前后端协同
+
+前后端协同开发
+
+## 命令行
+
+有充分的命令行工具
+
+## 集成定时服务
+
+如果你需要启动定时服务，提供命令进行定时服务的启动
+
+## 文档丰富
+
+提供丰富的文档说明，提供丰富的文档说明
+
+## 开发模式
+
+在开发模式下进行前后端开发，极大提高了开发效率和开发体验

app/console/command/demo.go

@@ -0,0 +1,46 @@
+package demo
+
+import (
+	"fmt"
+	"github.com/gohade/hade/framework/cobra"
+	"github.com/gohade/hade/framework/contract"
+	"log"
+)
+
+// InitFoo 初始化Foo命令
+func InitFoo() *cobra.Command {
+	FooCommand.AddCommand(Foo1Command)
+	return FooCommand
+}
+
+// FooCommand 代表Foo命令
+var FooCommand = &cobra.Command{
+	Use:     "foo",
+	Short:   "foo的简要说明",
+	Long:    "foo的长说明",
+	Aliases: []string{"fo", "f"},
+	Example: "foo命令的例子",
+	RunE: func(c *cobra.Command, args []string) error {
+		configService := c.GetContainer().MustMake(contract.ConfigKey).(contract.Config)
+		envService := c.GetContainer().MustMake(contract.EnvKey).(contract.Env)
+		fmt.Println("APP_ENV: ", envService.Get("APP_ENV"))
+		fmt.Println("FOO_ENV: ", envService.Get("FOO_ENV"))
+
+		fmt.Println("config url:", configService.GetString("app.url"))
+		return nil
+	},
+}
+
+// Foo1Command 代表Foo命令的子命令Foo1
+var Foo1Command = &cobra.Command{
+	Use:     "foo1",
+	Short:   "foo1的简要说明",
+	Long:    "foo1的长说明",
+	Aliases: []string{"fo1", "f1"},
+	Example: "foo1命令的例子",
+	RunE: func(c *cobra.Command, args []string) error {
+		container := c.GetContainer()
+		log.Println(container)
+		return nil
+	},
+}

app/console/command/demo/foo.go

@@ -0,0 +1,18 @@
+package command
+
+import (
+	"fmt"
+
+	"github.com/gohade/hade/framework/cobra"
+)
+
+var Demo2Command = &cobra.Command{
+	Use:   "demo2",
+	Short: "demo2",
+	RunE: func(c *cobra.Command, args []string) error {
+        container := c.GetContainer()
+		fmt.Println(container)
+		return nil
+	},
+}
+

app/console/command/demo2.go

@@ -1,25 +1,49 @@
 package console
 
 import (
+	"github.com/gohade/hade/app/console/command/demo"
 	"github.com/gohade/hade/framework"
 	"github.com/gohade/hade/framework/cobra"
-	hadeCommand "github.com/gohade/hade/framework/command"
-	commandUtil "github.com/gohade/hade/framework/command/util"
+	"github.com/gohade/hade/framework/command"
 )
 
-// RunCommand is command
+// RunCommand  初始化根Command并运行
 func RunCommand(container framework.Container) error {
+	// 根Command
 	var rootCmd = &cobra.Command{
-		Use:   "hade",
-		Short: "main",
-		Long:  "hade commands",
+		// 定义根命令的关键字
+		Use: "hade",
+		// 简短介绍
+		Short: "hade 命令",
+		// 根命令的详细介绍
+		Long: "hade 框架提供的命令行工具，使用这个命令行工具能很方便执行框架自带命令，也能很方便编写业务命令",
+		// 根命令的执行函数
+		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.InitDefaultHelpFlag()
+			return cmd.Help()
+		},
+		// 不需要出现cobra默认的completion子命令
+		CompletionOptions: cobra.CompletionOptions{DisableDefaultCmd: true},
 	}
 
-	ctx := commandUtil.RegiestContainer(container, rootCmd)
+	// 为根Command设置服务容器
+	rootCmd.SetContainer(container)
+	// 绑定框架的命令
+	command.AddKernelCommands(rootCmd)
+	// 绑定业务的命令
+	AddAppCommand(rootCmd)
 
-	hadeCommand.AddKernelCommands(rootCmd)
+	// 执行RootCommand
+	return rootCmd.Execute()
+}
+
+// 绑定业务的命令
+func AddAppCommand(rootCmd *cobra.Command) {
+	rootCmd.AddCommand(demo.FooCommand)
 
-	// rootCmd.AddCronCommand("* * * * *", command.DemoCommand)
+	// 每秒调用一次Foo命令
+	//rootCmd.AddCronCommand("* * * * * *", demo.FooCommand)
 
-	return rootCmd.ExecuteContext(ctx)
+	// 启动一个分布式任务调度，调度的服务名称为init_func_for_test，每个节点每5s调用一次Foo命令，抢占到了调度任务的节点将抢占锁持续挂载2s才释放
+	//rootCmd.AddDistributedCronCommand("foo_func_for_test", "*/5 * * * * *", demo.FooCommand, 2*time.Second)
 }

app/console/kernel.go

@@ -4,11 +4,16 @@ import (
 	"github.com/gohade/hade/framework/gin"
 )
 
-// NewHttpEngine is command
+// NewHttpEngine 创建了一个绑定了路由的Web引擎
 func NewHttpEngine() (*gin.Engine, error) {
+	// 设置为Release，为的是默认在启动中不输出调试信息
 	gin.SetMode(gin.ReleaseMode)
-	r := gin.Default()
+	// 默认启动一个Web引擎
+	r := gin.New()
+	r.Use(gin.Recovery())
 
+	// 业务绑定路由操作
 	Routes(r)
+	// 返回绑定路由后的Web引擎
 	return r, nil
 }

app/http/kernel.go

@@ -0,0 +1,67 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup go
+        uses: actions/setup-go@v2
+        with:
+          go-version: '^1.16'
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Setup golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: v1.42.1
+          args: --verbose
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        go: [1.13, 1.14, 1.15, 1.16, 1.17]
+        include:
+          - os: ubuntu-latest
+            go-build: ~/.cache/go-build
+          - os: macos-latest
+            go-build: ~/Library/Caches/go-build
+    name: ${{ matrix.os }} @ Go ${{ matrix.go }}
+    runs-on: ${{ matrix.os }}
+    env:
+      GO111MODULE: on
+      GOPROXY: https://proxy.golang.org
+    steps:
+      - name: Set up Go ${{ matrix.go }}
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go }}
+
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.ref }}
+
+      - uses: actions/cache@v2
+        with:
+          path: |
+            ${{ matrix.go-build }}
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Run Tests
+        run: |
+          go test -v -covermode=atomic -coverprofile=coverage.out
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          flags: ${{ matrix.os }},go-${{ matrix.go }}

app/http/middleware/cors/.github/workflows/go.yml

@@ -0,0 +1,23 @@
+*.o
+*.a
+*.so
+
+_obj
+_test
+
+*.[568vq]
+[568vq].out
+
+*.cgo1.go
+*.cgo2.c
+_cgo_defun.c
+_cgo_gotypes.go
+_cgo_export.*
+
+_testmain.go
+
+*.exe
+*.test
+*.prof
+
+coverage.out

app/http/middleware/cors/.gitignore

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Swaggo
+Copyright (c) 2016 Gin-Gonic
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal