feat: add the auth and context middleware

doc: update readme and license

Author: coderi421

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright [2023-2033] [Tianyi Zheng]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -138,5 +138,10 @@ Microservice framework implemented based on Golang.
     └─codegen errorCode 代码生成工具 
 ```
 
+## 命令行工具
+```shell
+# 查看帮助信息
+go run .\cmd\***\***.go --help
+```
 
 

app/pkg/code/db.go

@@ -1,6 +1,6 @@
 package code
 
-//go:generate codeg -type=int -doc -output ./error_code_generated.md
+//go:generate codeg -type=int
 const (
 	// ErrConnectDB - 500: Init db error.
 	ErrConnectDB int = iota + 100601

app/pkg/code/doc.go

@@ -0,0 +1,3 @@
+package code
+
+//go:generate codeg -type=int -doc -output ./error_code_generated.md

configs/admin/admin.yaml

@@ -23,4 +23,5 @@ server:
   profiling: true # 开启性能分析, 可以通过 <host>:<port>/debug/pprof/地址查看程序栈、线程等系统信息，默认值为 true
   middlewares: # 中间件
     - recovery # panic 恢复
-    - cors # 跨域
+    - cors # 跨域
+    - context

gmicro/code/base.go

@@ -0,0 +1,83 @@
+package code
+
+//go:generate codeg -type=int
+//go:generate codeg -type=int -doc -output ./error_code_generated.md
+
+// Common: basic errors.
+// Code must start with 1xxxxx.
+const (
+	// ErrSuccess - 200: OK.
+	ErrSuccess = iota + 100001
+
+	// ErrUnknown - 500: Internal server error.
+	ErrUnknown
+
+	// ErrBind - 400: Error occurred while binding the request body to the struct.
+	ErrBind
+
+	// ErrValidation - 400: Validation failed.
+	ErrValidation
+
+	// ErrTokenInvalid - 401: Token invalid.
+	ErrTokenInvalid
+
+	// ErrPageNotFound - 404: Page not found.
+	ErrPageNotFound
+)
+
+// common: database errors.
+const (
+	// ErrDatabase - 500: Database error.
+	ErrDatabase int = iota + 100101
+)
+
+// common: authorization and authentication errors.
+const (
+	// ErrEncrypt - 401: Error occurred while encrypting the user password.
+	ErrEncrypt int = iota + 100201
+
+	// ErrSignatureInvalid - 401: Signature is invalid.
+	ErrSignatureInvalid
+
+	// ErrExpired - 401: Token expired.
+	ErrExpired
+
+	// ErrInvalidAuthHeader - 401: Invalid authorization header.
+	ErrInvalidAuthHeader
+
+	// ErrMissingHeader - 401: The `Authorization` header was empty.
+	ErrMissingHeader
+
+	// ErrPasswordIncorrect - 401: Password was incorrect.
+	ErrPasswordIncorrect
+
+	// PermissionDenied - 403: Permission denied.
+	ErrPermissionDenied
+)
+
+// common: encode/decode errors.
+const (
+	// ErrEncodingFailed - 500: Encoding failed due to an error with the data.
+	ErrEncodingFailed int = iota + 100301
+
+	// ErrDecodingFailed - 500: Decoding failed due to an error with the data.
+	ErrDecodingFailed
+
+	// ErrInvalidJSON - 500: Data is not valid JSON.
+	ErrInvalidJSON
+
+	// ErrEncodingJSON - 500: JSON data could not be encoded.
+	ErrEncodingJSON
+
+	// ErrDecodingJSON - 500: JSON data could not be decoded.
+	ErrDecodingJSON
+
+	// ErrInvalidYaml - 500: Data is not valid Yaml.
+	ErrInvalidYaml
+
+	// ErrEncodingYaml - 500: Yaml data could not be encoded.
+	ErrEncodingYaml
+
+	// ErrDecodingYaml - 500: Yaml data could not be decoded.
+	ErrDecodingYaml
+)

gmicro/code/code.go

@@ -0,0 +1,62 @@
+package code
+
+import (
+	"net/http"
+
+	"github.com/CoderI421/gframework/pkg/common/util/sliceutil"
+	"github.com/CoderI421/gframework/pkg/errors"
+)
+
+type ErrCode struct {
+	//错误码
+	C int
+
+	//http的状态码
+	HTTP int
+
+	//扩展字段
+	Ext string
+
+	//引用文档
+	Ref string
+}
+
+func (e ErrCode) HTTPStatus() int {
+	return e.HTTP
+}
+
+func (e ErrCode) String() string {
+	return e.Ext
+}
+
+func (e ErrCode) Reference() string {
+	return e.Ref
+}
+
+func (e ErrCode) Code() int {
+	if e.C == 0 {
+		return http.StatusInternalServerError
+	}
+	return e.C
+}
+
+func register(code int, httpStatus int, message string, refs ...string) {
+	found := sliceutil.Find([]int{200, 400, 401, 403, 404, 500}, httpStatus)
+
+	if !found {
+		panic("http code not in `200,400,401,403,404,500`")
+	}
+	var ref string
+	if len(refs) > 0 {
+		ref = refs[0]
+	}
+	coder := ErrCode{
+		C:    code,
+		HTTP: httpStatus,
+		Ext:  message,
+		Ref:  ref,
+	}
+	errors.MustRegister(coder)
+}
+
+var _ errors.Coder = (*ErrCode)(nil)

gmicro/code/code_generated.go

@@ -0,0 +1,40 @@
+# 错误码
+
+！！系统错误码列表，由 `codegen -type=int -doc` 命令生成，不要对此文件做任何更改。
+
+## 功能说明
+
+如果返回结果中存在 `code` 字段，则表示调用 API 接口失败。例如：
+
+```json
+{
+  "code": 100101,
+  "message": "Database error"
+}
+```
+
+上述返回中 `code` 表示错误码，`message` 表示该错误的具体信息。每个错误同时也对应一个 HTTP 状态码，比如上述错误码对应了 HTTP 状态码 500(Internal Server Error)。
+
+## 错误码列表
+
+系统支持的错误码列表如下：
+
+| Identifier | Code | HTTP Code | Description |
+| ---------- | ---- | --------- | ----------- |
+| ErrDatabase | 100101 | 500 | Database error |
+| ErrEncrypt | 100201 | 401 | Error occurred while encrypting the user password |
+| ErrSignatureInvalid | 100202 | 401 | Signature is invalid |
+| ErrExpired | 100203 | 401 | Token expired |
+| ErrInvalidAuthHeader | 100204 | 401 | Invalid authorization header |
+| ErrMissingHeader | 100205 | 401 | The `Authorization` header was empty |
+| ErrPasswordIncorrect | 100206 | 401 | Password was incorrect |
+| ErrPermissionDenied | 100207 | 403 | Permission denied |
+| ErrEncodingFailed | 100301 | 500 | Encoding failed due to an error with the data |
+| ErrDecodingFailed | 100302 | 500 | Decoding failed due to an error with the data |
+| ErrInvalidJSON | 100303 | 500 | Data is not valid JSON |
+| ErrEncodingJSON | 100304 | 500 | JSON data could not be encoded |
+| ErrDecodingJSON | 100305 | 500 | JSON data could not be decoded |
+| ErrInvalidYaml | 100306 | 500 | Data is not valid Yaml |
+| ErrEncodingYaml | 100307 | 500 | Yaml data could not be encoded |
+| ErrDecodingYaml | 100308 | 500 | Yaml data could not be decoded |
+

gmicro/code/error_code_generated.md

@@ -0,0 +1,23 @@
+package middlewares
+
+import "github.com/gin-gonic/gin"
+
+// AuthStrategy 认证策略
+type AuthStrategy interface {
+	// AuthFunc 相当于是实现了一个名为 AuthFunc 的中间件
+	AuthFunc() gin.HandlerFunc
+}
+
+// AuthOperator 认证实体工厂类
+type AuthOperator struct {
+	strategy AuthStrategy
+}
+
+func (ao *AuthOperator) SetStrategy(s AuthStrategy) {
+	ao.strategy = s
+}
+
+// AuthFunc 返回一个 gin.HandlerFunc 中间件接口函数
+func (ao *AuthOperator) AuthFunc() gin.HandlerFunc {
+	return ao.strategy.AuthFunc()
+}