Merge pull request glennliao#16 from glennliao/dev

v0.2.0 alpha

Author: glennliao

.github/workflows/test.yml

@@ -0,0 +1,10 @@
+name: tests
+on:
+  push:
+    branches: [ "main" ,"dev"]
+  pull_request:
+    branches: [ "main", "dev" ]
+
+jobs:
+  simple-test:
+    run: cd test && go test -short

.github/workflows/todo.yml

@@ -1,45 +1,45 @@
-name: Todo tests
-
-on:
-  push:
-    branches: [ "main" ,"dev"]
-  pull_request:
-    branches: [ "main", "dev" ]
-
-jobs:
-
-  build:
-    runs-on: ubuntu-latest
-    services:
-      mysql:
-        image: mysql:5.7.37
-        env:
-          MYSQL_ROOT_PASSWORD: 'yourpassword'
-          MYSQL_DATABASE: 'my_apijson'
-        ports:
-          - 3306:3306
-        options: >-
-          --health-cmd="mysqladmin ping"
-          --health-interval=10s
-          --health-timeout=5s
-          --health-retries=3
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up Go
-        uses: actions/setup-go@v3
-        with:
-          go-version: 1.18
-
-
-
-      - name: Test
-        run: |
-          
-          mysql -uroot -h 127.0.0.1 --port 3306 -pyourpassword my_apijson < @demo/todo/doc/todo.sql
-          
-          cd ./@demo/todo
-          mv config.yaml.example config.yaml
-          
-          cd tests
-          go test -v
+#name: Todo tests
+#
+#on:
+#  push:
+#    branches: [ "main" ,"dev"]
+#  pull_request:
+#    branches: [ "main", "dev" ]
+#
+#jobs:
+#
+#  build:
+#    runs-on: ubuntu-latest
+#    services:
+#      mysql:
+#        image: mysql:5.7.37
+#        env:
+#          MYSQL_ROOT_PASSWORD: 'yourpassword'
+#          MYSQL_DATABASE: 'my_apijson'
+#        ports:
+#          - 3306:3306
+#        options: >-
+#          --health-cmd="mysqladmin ping"
+#          --health-interval=10s
+#          --health-timeout=5s
+#          --health-retries=3
+#    steps:
+#      - uses: actions/checkout@v3
+#
+#      - name: Set up Go
+#        uses: actions/setup-go@v3
+#        with:
+#          go-version: 1.18
+#
+#
+#
+#      - name: Test
+#        run: |
+#
+#          mysql -uroot -h 127.0.0.1 --port 3306 -pyourpassword my_apijson < @demo/todo/doc/todo.sql
+#
+#          cd ./@demo/todo
+#          mv config.yaml.example config.yaml
+#
+#          cd tests
+#          go test -v

.gitignore

@@ -1,4 +1,3 @@
 .idea
 *.exe
-config.yaml
-test
+*.sqlite3

@doc/faq.md

@@ -2,6 +2,6 @@
 
 1. 这东西有什么用?
 2. 我的接口业务流程很复杂怎么处理?
-3. 你知道graphql吗?
+3. 知道graphql吗?
 4. 如何完成文件上传下载、微信支付等操作?
 5. 我项目中没有使用goframe, 会有gin、beego等框架的版本吗?

@doc/roadmap.md

@@ -7,24 +7,26 @@
 - [x] 简易单表的post,put,delete操作 (可一次传递多个表, 单表指表表之间无关联)
 - [x] 查询权限控制(表、行、字段)
 
-## [ ] 下水 阶段
+## [x] 下水 阶段
 - [x] 增加 hook (钩子函数), 用于对接口的的前置、后置处理 (例如修改数据、清理缓存等操作)
 - [x] 增加 设置 rowKey 生成 (id生成)
 - [x] 新增多个表时, structures 中 update可引用其他边的字段 (例如新建角色,并使用新增的id 设置给权限列表中)
 - [x] 批量修改(统一设置模式+单个设置模式)、批量删除
 - [x] request的version设置
 - [x] 增加 functions , 用于对数据的处理 (字典转换、id转name等操作)
-
-
-## [ ] 摸石头 阶段
-- [ ] 开发、测试环境下记录get请求记录
 - [x] 可自定义get中查询节点的实现 (即从缓存或者其他数据源查询数据)
 - [x] 可自定义非开放请求的具体实现
 - [x] 提供 web UI 用于 _access 和 _request 的管理
 
+## [ ] 摸石头 阶段
+- [ ] 开发、测试环境下记录get请求记录
+- [ ] 多实例
+- [ ] 错误提示
+
 ## [ ] xxx 阶段
 - [ ] get请求的复杂度计算, 超过复杂度则拒绝执行(树节点计算)
 - [ ] 完善 apijson 规范的兼容实现
+- [ ] 提供一份较好的文档
 
 
 
@@ -41,7 +43,6 @@
     - [x] MUST
     - [x] REFUSE
 - [x] 分页返回total@
-
 - [x] 可用的权限方案
     - [x] get只有access中定义的才能访问
     - [x] 非get操作则必须与request指定一致才可请求

@doc/v0.2.md

@@ -0,0 +1,7 @@
+# v0.2 
+
+> 框架使用上会与apijson(java)不完全一致, 但是与前端的json请求响应规则 (即apijson的语法规则)会尽可能兼容
+
+1. 由全局配置改成apijson实例,可创建不同实例对应不同的内容
+2. 代码内部 传递的accessName 都为 _access 配置中的alias
+3. access/request配置可从配置文件中获取

README.md

@@ -1,9 +1,9 @@
-# apijson-go [下水阶段]
+# apijson-go [摸石头阶段]
 基于 go + goframe 实现的 apijson
 
 > ~~暂仍处于前期开发探索中, 请仅使用在 个人探索项目~~
-
-> 目前处于 【下水阶段】, 欢迎测试、issue、建议、pr
+> ~~目前处于 【下水阶段】, 欢迎测试、issue、建议、pr~~
+> 目前处于 【摸石头阶段】, 欢迎测试、issue、建议、pr, 请勿使用在非个人的线上项目
 
 [RoadMap 阶段规划](./@doc/roadmap.md)
 

action/action.go

@@ -2,8 +2,9 @@ package action
 
 import (
 	"context"
-	"github.com/glennliao/apijson-go/config/db"
+	"github.com/glennliao/apijson-go/config"
 	"github.com/glennliao/apijson-go/consts"
+	"github.com/glennliao/apijson-go/model"
 	"github.com/gogf/gf/v2/database/gdb"
 	"github.com/gogf/gf/v2/errors/gerror"
 	"github.com/gogf/gf/v2/frame/g"
@@ -14,20 +15,36 @@ import (
 // Action 非get查询的request表中的请求
 type Action struct {
 	ctx        context.Context
-	tagRequest *db.Request
+	tagRequest *config.Request
 	method     string
 
-	req g.Map
+	req model.Map
 
 	err error
 
 	children map[string]*Node
 	keyNode  map[string]*Node
+
+	// 关闭 access 权限验证, 默认否
+	NoAccessVerify bool
+	// 关闭 request 验证开关, 默认否
+	NoRequestVerify bool
+
+	//Access *config.Access
+
+	// dbFieldStyle 数据库字段命名风格 请求传递到数据库中
+	DbFieldStyle config.FieldStyle
+
+	// jsonFieldStyle 数据库返回的字段
+	JsonFieldStyle config.FieldStyle
+
+	Functions    *config.Functions
+	actionConfig *config.ActionConfig
 }
 
-func New(ctx context.Context, method string, req g.Map) *Action {
+func New(ctx context.Context, actionConfig *config.ActionConfig, method string, req model.Map) *Action {
 
-	request, err := checkTag(req, method)
+	request, err := checkTag(req, method, actionConfig)
 	if err != nil {
 		panic(err)
 	}
@@ -36,12 +53,13 @@ func New(ctx context.Context, method string, req g.Map) *Action {
 	delete(req, "version")
 
 	a := &Action{
-		ctx:        ctx,
-		tagRequest: request,
-		method:     method,
-		req:        req,
-		children:   map[string]*Node{},
-		keyNode:    map[string]*Node{},
+		ctx:          ctx,
+		tagRequest:   request,
+		method:       method,
+		req:          req,
+		children:     map[string]*Node{},
+		keyNode:      map[string]*Node{},
+		actionConfig: actionConfig,
 	}
 	return a
 }
@@ -63,16 +81,19 @@ func (a *Action) parse() error {
 			}
 		}
 
-		var list []g.Map
-		_v, ok := v.(g.Map)
+		var list []model.Map
+		_v, ok := v.(model.Map)
 		if ok { // 将所有node都假设成列表, 如果单个则看成一个元素的批量
-			list = []g.Map{_v}
+			list = []model.Map{_v}
 		} else {
-			list = gconv.SliceMap(v)
+			for _, m := range gconv.Maps(v) {
+				list = append(list, m)
+			}
 		}
 
 		node := newNode(key, list, structure, a.tagRequest.Executor[key])
 		node.ctx = a.ctx
+		node.action = a
 		a.keyNode[key] = &node
 		node.keyNode = a.keyNode
 		err := node.parse(a.ctx, a.method)
@@ -86,18 +107,18 @@ func (a *Action) parse() error {
 	return nil
 }
 
-func (a *Action) Result() (g.Map, error) {
+func (a *Action) Result() (model.Map, error) {
 
 	err := a.parse()
 	if err != nil {
 		return nil, err
 	}
 
-	ret := g.Map{}
+	ret := model.Map{}
 
 	for _, k := range a.tagRequest.ExecQueue {
 		node := a.children[k]
-		err = EmitHook(a.ctx, BeforeExec, node, a.method)
+		err = EmitHook(a.ctx, BeforeNodeExec, node, a.method)
 		if err != nil {
 			return nil, err
 		}
@@ -112,9 +133,8 @@ func (a *Action) Result() (g.Map, error) {
 		}
 	}
 
-	err = g.DB().Transaction(a.ctx, func(ctx context.Context, tx *gdb.TX) error {
+	err = g.DB().Transaction(a.ctx, func(ctx context.Context, tx gdb.TX) error {
 		for _, k := range a.tagRequest.ExecQueue {
-
 			node := a.children[k]
 			ret[k], err = node.execute(ctx, a.method)
 			if err != nil {
@@ -130,7 +150,7 @@ func (a *Action) Result() (g.Map, error) {
 
 	for _, k := range a.tagRequest.ExecQueue {
 		node := a.children[k]
-		err = EmitHook(a.ctx, AfterExec, node, a.method)
+		err = EmitHook(a.ctx, AfterNodeExec, node, a.method)
 		if err != nil {
 			return nil, err
 		}
@@ -139,7 +159,7 @@ func (a *Action) Result() (g.Map, error) {
 	return ret, err
 }
 
-func checkTag(req g.Map, method string) (*db.Request, error) {
+func checkTag(req model.Map, method string, requestCfg *config.ActionConfig) (*config.Request, error) {
 	_tag, ok := req["tag"]
 	if !ok {
 		return nil, gerror.New("tag 缺失")
@@ -148,7 +168,7 @@ func checkTag(req g.Map, method string) (*db.Request, error) {
 	tag := gconv.String(_tag)
 	version := req["version"]
 
-	request, err := db.GetRequest(tag, method, gconv.String(version))
+	request, err := requestCfg.GetRequest(tag, method, gconv.String(version))
 	if err != nil {
 		return nil, err
 	}

action/hook.go

@@ -3,21 +3,21 @@ package action
 import "context"
 
 const (
-	BeforeExec = iota
-	AfterExec
-	BeforeDo
-	AfterDo
+	BeforeNodeExec = iota
+	AfterNodeExec
+	BeforeExecutorDo
+	AfterExecutorDo
 )
 
 type Hook struct {
 	For string //
 	// Exec 事务外
-	BeforeExec func(ctx context.Context, n *Node, method string) error
-	AfterExec  func(ctx context.Context, n *Node, method string) error
+	BeforeNodeExec func(ctx context.Context, n *Node, method string) error
+	AfterNodeExec  func(ctx context.Context, n *Node, method string) error
 
 	// Do 事务内
-	BeforeDo func(ctx context.Context, n *Node, method string) error
-	AfterDo  func(ctx context.Context, n *Node, method string) error
+	BeforeExecutorDo func(ctx context.Context, n *Node, method string) error
+	AfterExecutorDo  func(ctx context.Context, n *Node, method string) error
 }
 
 var hooksMap = map[string][]Hook{}
@@ -33,14 +33,14 @@ func EmitHook(ctx context.Context, hookAt int, node *Node, method string) error
 
 		var handler func(ctx context.Context, n *Node, method string) error
 		switch hookAt {
-		case BeforeExec:
-			handler = hook.BeforeExec
-		case AfterExec:
-			handler = hook.AfterExec
-		case BeforeDo:
-			handler = hook.BeforeDo
-		case AfterDo:
-			handler = hook.AfterDo
+		case BeforeNodeExec:
+			handler = hook.BeforeNodeExec
+		case AfterNodeExec:
+			handler = hook.AfterNodeExec
+		case BeforeExecutorDo:
+			handler = hook.BeforeExecutorDo
+		case AfterExecutorDo:
+			handler = hook.AfterExecutorDo
 		}
 
 		if handler != nil {