save for 调整

Author: glennliao

@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,6 +2,7 @@ package action
 
 import (
 	"context"
+	"github.com/glennliao/apijson-go/config"
 	"github.com/glennliao/apijson-go/config/db"
 	"github.com/glennliao/apijson-go/consts"
 	"github.com/glennliao/apijson-go/model"
@@ -29,6 +30,8 @@ type Action struct {
 	NoAccessVerify bool
 	// 关闭 request 验证开关, 默认否
 	NoRequestVerify bool
+
+	Access *config.Access
 }
 
 func New(ctx context.Context, method string, req model.Map) *Action {

action/node.go

@@ -31,6 +31,8 @@ type Node struct {
 	executor  string
 
 	keyNode map[string]*Node
+
+	access *config.Access
 }
 
 func newNode(key string, req []model.Map, structure *db.Structure, executor string) Node {
@@ -143,10 +145,12 @@ func (n *Node) roleUpdate() error {
 
 func (n *Node) checkAccess(ctx context.Context, method string, accessRoles []string) error {
 
-	role, err := config.DefaultRoleFunc(ctx, config.RoleReq{
-		Table:    n.TableName,
-		Method:   method,
-		NodeRole: n.Role,
+	// todo 可配置单次的内容, 而非直接使用整个的
+
+	role, err := n.action.Access.DefaultRoleFunc(ctx, config.RoleReq{
+		AccessName: n.TableName,
+		Method:     method,
+		NodeRole:   n.Role,
 	})
 
 	if err != nil {
@@ -164,8 +168,8 @@ func (n *Node) checkAccess(ctx context.Context, method string, accessRoles []str
 	}
 
 	for i, item := range n.req {
-		where, err := config.AccessConditionFunc(ctx, config.AccessConditionReq{
-			Table:               n.TableName,
+		where, err := n.action.Access.ConditionFunc(ctx, config.ConditionReq{
+			AccessName:          n.TableName,
 			TableAccessRoleList: accessRoles,
 			Method:              method,
 			NodeRole:            n.Role,
@@ -177,11 +181,11 @@ func (n *Node) checkAccess(ctx context.Context, method string, accessRoles []str
 		}
 
 		if method == http.MethodPost {
-			for k, v := range where {
+			for k, v := range where.Where() {
 				n.Data[i][k] = v
 			}
 		} else {
-			for k, v := range where {
+			for k, v := range where.Where() {
 				n.Where[i][k] = v
 			}
 		}
@@ -304,24 +308,24 @@ func (n *Node) do(ctx context.Context, method string, dataIndex int) (ret model.
 			return nil, err
 		}
 
-		if access.RowKeyGen != "" {
-			for i, _ := range n.Data {
-
-				rowKeyVal, err = config.RowKeyGen(ctx, access.RowKeyGen, n.TableName, n.Data[i])
-				if err != nil {
-					return nil, err
-				}
-
-				for k, v := range rowKeyVal {
-					if k == consts.RowKey {
-						n.Data[i][access.RowKey] = v
-					} else {
-						n.Data[i][k] = v
-					}
-				}
-
-			}
-		}
+		//if access.RowKeyGen != "" {
+		//	for i, _ := range n.Data {
+		//
+		//		rowKeyVal, err = config.RowKeyGen(ctx, access.RowKeyGen, n.TableName, n.Data[i])
+		//		if err != nil {
+		//			return nil, err
+		//		}
+		//
+		//		for k, v := range rowKeyVal {
+		//			if k == consts.RowKey {
+		//				n.Data[i][access.RowKey] = v
+		//			} else {
+		//				n.Data[i][k] = v
+		//			}
+		//		}
+		//
+		//	}
+		//}
 
 		var id int64
 

apijson.go

@@ -0,0 +1,50 @@
+package apijson
+
+import (
+	"context"
+	"github.com/glennliao/apijson-go/config"
+)
+
+type Plugin interface {
+	Install(ctx context.Context, a *ApiJson)
+}
+
+type ApiJson struct {
+	config *config.Config
+	Debug  bool // 是否开启debug模式, 显示每步骤
+	ctx    context.Context
+}
+
+var DefaultApiJson = New()
+
+type App struct {
+}
+
+func New() *ApiJson {
+	a := &ApiJson{}
+	a.config = config.New()
+	a.ctx = context.Background()
+	return a
+}
+
+// Load load for defaultApiJson, 简化使用
+func Load(app func(ctx context.Context, a *ApiJson)) *ApiJson {
+	DefaultApiJson.Use(app)
+	DefaultApiJson.Load()
+	return DefaultApiJson
+}
+
+func (a *ApiJson) Use(p ...func(ctx context.Context, a *ApiJson)) *ApiJson {
+	for _, plugin := range p {
+		plugin(a.ctx, a)
+	}
+	return a
+}
+
+func (a *ApiJson) Load() {
+
+}
+
+func (a *ApiJson) Config() *config.Config {
+	return a.config
+}

config/access.go

@@ -7,55 +7,82 @@ import (
 	"github.com/samber/lo"
 )
 
-type AccessConditionReq struct {
-	Table               string
+// 设置 _access/_request 自定义表名
+// todo
+var (
+	TableAccess  = "_access"
+	TableRequest = "_request"
+)
+
+type ConditionReq struct {
+	AccessName          string // _access 中的alias
 	TableAccessRoleList []string
 	Method              string
 	NodeReq             g.Map  //节点的请求数据
 	NodeRole            string // 节点的角色
 }
 
-type RoleReq struct {
-	Table    string
-	Method   string
-	NodeRole string // 前端传入的节点的角色, 目前未传入则为空
+type ConditionRet struct {
+	condition map[string]any
 }
 
-// AccessCondition 根据传入的ctx获取用户信息, 结合req 中的信息 返回需要添加到sql的where条件
-type AccessCondition func(ctx context.Context, req AccessConditionReq) (g.Map, error)
+func (c *ConditionRet) Add(k string, v any) { // todo any?
+	c.condition[k] = v
+}
+
+func (c *ConditionRet) Where() map[string]any {
+	return c.condition
+}
+
+type AccessCondition func(ctx context.Context, req ConditionReq) (*ConditionRet, error)
+
+type RoleReq struct {
+	AccessName string
+	Method     string
+	NodeRole   string // 前端传入的节点的角色, 目前未传入则为空
+}
 
-// DefaultRole nodeRole 为前端显式指定的role, 需要此函数中判断该role是不是用户角色之一, 返回最终该节点的角色
 type DefaultRole func(ctx context.Context, req RoleReq) (string, error)
 
-var (
-	// AccessVerify 是否禁用权限验证
-	NoAccessVerify = true
-	// AccessConditionFunc 自定义权限限制条件
-	AccessConditionFunc AccessCondition
-	// DefaultRoleFunc 自定义获取节点的默认角色
-	DefaultRoleFunc DefaultRole = func(ctx context.Context, req RoleReq) (string, error) {
-		return consts.UNKNOWN, nil
-	}
-)
+func defaultRole(ctx context.Context, req RoleReq) (string, error) {
+	return consts.UNKNOWN, nil
+}
 
-// 设置 _access/_request 自定义表名
-var (
-	TableAccess  = "_access"
-	TableRequest = "_request"
-)
+func defaultCondition(ctx context.Context, req ConditionReq) (*ConditionRet, error) {
+	return &ConditionRet{}, nil
+}
 
-// =========================  角色 =======================
-// 角色列表
-// access 中填写的角色应在角色列表中
+type Access struct {
+	// 禁用_access权限校验, 默认为false, 需手动开启
+	NoVerify bool
 
-var (
-	roleList = []string{consts.UNKNOWN, consts.LOGIN, consts.OWNER, consts.ADMIN}
-)
+	// 用于 根据accessName+user来自定义添加sql条件, 完成数据的权限限制
+	ConditionFunc AccessCondition
+
+	// nodeRole 为前端显式指定的role, 需要此函数中判断该role是不是用户角色之一, 返回最终该节点的角色
+	DefaultRoleFunc DefaultRole
+
+	roleList []string
+}
+
+func NewAccess() *Access {
+
+	a := &Access{}
+	a.ConditionFunc = defaultCondition
+	a.DefaultRoleFunc = defaultRole
+	a.roleList = []string{consts.UNKNOWN, consts.LOGIN, consts.OWNER, consts.ADMIN}
+
+	return a
+}
 
-func AddRole(name string) {
-	if !lo.Contains(roleList, name) {
-		roleList = append(roleList, name)
+// AddRole 添加应用中额外的角色
+func (a *Access) AddRole(roles []string) *Access {
+	for _, role := range roles {
+		if !lo.Contains(a.roleList, role) {
+			a.roleList = append(a.roleList, role)
+		}
 	}
+	return a
 }
 
-func RoleList() []string { return roleList }
+func (a *Access) RoleList() []string { return a.roleList }

config/config.go

@@ -1,5 +1,20 @@
 package config
 
-var (
-	Debug = false
-)
+type Config struct {
+	Access           *Access
+	MaxTreeWidth     int
+	MaxTreeDeep      int
+	rowKeyGenFuncMap map[string]RowKeyGenFuncHandler
+}
+
+func New() *Config {
+	a := &Config{}
+	a.Access = NewAccess()
+
+	a.MaxTreeWidth = 5
+	a.MaxTreeDeep = 5
+
+	a.rowKeyGenFuncMap = make(map[string]RowKeyGenFuncHandler)
+
+	return a
+}

config/node.go

@@ -8,20 +8,18 @@ import (
 
 type RowKeyGenFuncHandler func(ctx context.Context, genParam g.Map, table string, data g.Map) (g.Map, error)
 
-var rowKeyGenFuncMap = map[string]RowKeyGenFuncHandler{}
-
-func RowKeyGen(ctx context.Context, genFuncName string, table string, data g.Map) (g.Map, error) {
-	if f, exists := rowKeyGenFuncMap[genFuncName]; exists {
+func (a *Config) RowKeyGen(ctx context.Context, genFuncName string, table string, data g.Map) (g.Map, error) {
+	if f, exists := a.rowKeyGenFuncMap[genFuncName]; exists {
 		return f(ctx, g.Map{}, table, data)
 	}
 
 	return nil, nil
 }
 
-func RowKeyGenFunc(name string, f RowKeyGenFuncHandler) {
-	rowKeyGenFuncMap[name] = f
+func (a *Config) RowKeyGenFunc(name string, f RowKeyGenFuncHandler) {
+	a.rowKeyGenFuncMap[name] = f
 }
 
-func RowKeyGenList() []string {
-	return lo.Keys(rowKeyGenFuncMap)
+func (a *Config) RowKeyGenList() []string {
+	return lo.Keys(a.rowKeyGenFuncMap)
 }