程序包 net.sohelp.boot.engine.web

类 CrudHelper

java.lang.Object

net.sohelp.boot.engine.web.CrudHelper

@Component
public class CrudHelper
extends Object

引擎数据执行CRUD操作

从以下版本开始:

2024/8/23 14:42

作者:

AaronFung

构造器概要

构造器

构造器	说明
CrudHelper()

方法概要

修饰符和类型	方法	说明
void	create(String refid, com.alibaba.fastjson.JSONObject jsonObject)	根据给定的引用ID和业务对象，创建或更新业务实体。
void	delete(String refid, List<Object> ids)	删除指定引用ID对应的数据记录
Map<String,Object>	detail(String refid, String id)	获取指定模块下的业务实体详情
Map<String,Object>	getById(String refid, Object id)	根据给定的引用ID和ID获取对应的对象数据
Map<String,Object>	initial(String refid)	初始化方法，用于初始化并返回一个包含业务实体数据的Map
Pager<Map<String,Object>>	page(String refid, Map<String,Object> paramMap)	根据模块ID和参数分页查询数据
Pager<Map<String,Object>>	pageByFk(String refid, Object fkId)	根据外键分页查询数据
void	save(String refid, com.alibaba.fastjson.JSONObject jsonObject)	保存数据到数据库
Map<String,Object>	saveFormByCrudUpdater(String entityName, Map<String,Object> recordMap)	通过CRUD更新器保存表单数据
CrudUpdaterVO	saveGrid(String entityName, String fkName, Object fkValue, CrudUpdaterVO crudUpdaterVO)	通过CRUD更新器批量保存网格数据（支持增删改操作）
CrudUpdaterVO	saveGrid(String entityName, CrudUpdaterVO crudUpdaterVO)	通过CRUD更新器保存网格数据
List<Map<String,Object>>	toList(String refid, Map<String,Object> paramMap)	根据引用ID和参数映射查询实体数据列表
void	update(String refid, com.alibaba.fastjson.JSONObject jsonObject)	更新模块数据

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CrudHelper

public CrudHelper()

方法详细资料

saveGrid

public CrudUpdaterVO saveGrid(String entityName,
 CrudUpdaterVO crudUpdaterVO)
                       throws TokenAuthenticationException,
ScriptException,
BusiException,
SQLException,
EntityException

通过CRUD更新器保存网格数据

参数:

entityName - 实体名称

crudUpdaterVO - CRUD更新器值对象，包含需要更新的数据

返回:

更新后的CRUD更新器值对象

抛出:

TokenAuthenticationException - 令牌认证异常

ScriptException - 脚本执行异常

BusiException - 业务异常

SQLException - 数据库SQL异常

EntityException - 实体异常

saveGrid

public CrudUpdaterVO saveGrid(String entityName,
 String fkName,
 Object fkValue,
 CrudUpdaterVO crudUpdaterVO)
                       throws BusiException,
SQLException,
TokenAuthenticationException,
ScriptException,
EntityException

通过CRUD更新器批量保存网格数据（支持增删改操作）

参数:

entityName - 实体名称，用于确定操作的数据表

fkName - 外键字段名称，用于关联插入数据

fkValue - 外键字段值，用于设置关联字段值

crudUpdaterVO - 包含增删改操作的CRUD更新器对象

抛出:

BusiException - 业务异常

SQLException - 数据库操作异常

TokenAuthenticationException - 令牌认证异常

ScriptException - 脚本执行异常

EntityException - 实体处理异常

功能说明： 1. 批量删除操作：根据crudUpdaterVO中的deleted数组执行删除 2. 批量更新操作：处理更新数据并执行公式计算 3. 批量插入操作：处理插入数据（包含ID生成、外键设置、自动编号等）

saveFormByCrudUpdater

public Map<String,Object> saveFormByCrudUpdater(String entityName,
 Map<String,Object> recordMap)
                                         throws BusiException,
SQLException,
TokenAuthenticationException,
EntityException

通过CRUD更新器保存表单数据

根据记录Map中的主键ID判断是新增还是更新操作： - 当ID为空或为"0"时，执行新增操作：生成新ID、格式化插入数据、自动编号处理、插入记录 - 当ID存在时，执行更新操作：格式化更新数据、更新记录

参数:

entityName - 实体名称，对应数据库表名

recordMap - 记录数据Map，包含要保存的字段值，其中"id"字段表示主键ID

抛出:

BusiException - 业务异常

SQLException - 数据库操作异常

TokenAuthenticationException - 令牌认证异常

EntityException - 实体处理异常

save

public void save(String refid,
 com.alibaba.fastjson.JSONObject jsonObject)
          throws BusiException,
SQLException,
EntityException,
TokenAuthenticationException,
ScriptException

保存数据到数据库

参数:

refid - 模块标识

jsonObject - 要保存的数据

抛出:

BusiException - 业务异常

SQLException - SQL异常

EntityException - 实体异常

TokenAuthenticationException - 令牌认证异常

ScriptException - 脚本异常

update

public void update(String refid,
 com.alibaba.fastjson.JSONObject jsonObject)
            throws BusiException,
SQLException,
EntityException,
TokenAuthenticationException

更新模块数据

参数:

refid - 模块ID

jsonObject - 需要更新的数据对象

抛出:

BusiException - 业务异常

SQLException - SQL异常

EntityException - 实体异常

TokenAuthenticationException - 令牌认证异常

create

public void create(String refid,
 com.alibaba.fastjson.JSONObject jsonObject)
            throws BusiException,
SQLException,
EntityException,
TokenAuthenticationException

根据给定的引用ID和业务对象，创建或更新业务实体。

参数:

refid - 业务模块的引用ID

jsonObject - 包含业务对象信息的JSON对象

抛出:

BusiException - 业务异常

SQLException - SQL异常

EntityException - 实体异常

TokenAuthenticationException - 令牌认证异常

pageByFk

public Pager<Map<String,Object>> pageByFk(String refid,
 Object fkId)
                                   throws BusiException,
SQLException,
TokenAuthenticationException,
EntityException

根据外键分页查询数据

参数:

refid - 引用ID，用于标识需要查询的模块

fkId - 外键ID，用于分页查询的数据

返回:

分页查询结果

抛出:

BusiException - 当参数不符合要求时抛出

SQLException - 当数据库操作出现异常时抛出

TokenAuthenticationException

EntityException

page

public Pager<Map<String,Object>> page(String refid,
 Map<String,Object> paramMap)
                               throws BusiException,
SQLException,
TokenAuthenticationException,
EntityException

根据模块ID和参数分页查询数据

参数:

refid - 模块ID

paramMap - 查询参数

返回:

分页查询结果

抛出:

BusiException - 业务异常

SQLException - SQL异常

TokenAuthenticationException - 认证异常

EntityException

toList

public List<Map<String,Object>> toList(String refid,
 Map<String,Object> paramMap)
                                throws BusiException,
SQLException,
TokenAuthenticationException,
EntityException

根据引用ID和参数映射查询实体数据列表

功能流程： 1. 验证模块操作权限并获取模块信息 2. 根据引用类型获取对应的网格配置 3. 检查实体是否存在并支持逻辑删除条件 4. 构建查询条件并执行SQL查询 5. 格式化查询结果后返回

参数:

refid - 引用ID，用于定位实体和网格配置

paramMap - 查询参数映射，用于动态条件替换

返回:

包含实体数据的列表，每个元素为Map结构

抛出:

BusiException - 当模块/网格/实体不存在时抛出

SQLException - 当数据库操作异常时抛出

TokenAuthenticationException - 当认证失败时抛出

EntityException - 当实体处理异常时抛出

initial

public Map<String,Object> initial(String refid)
                           throws BusiException,
SQLException,
EntityException,
TokenAuthenticationException

初始化方法，用于初始化并返回一个包含业务实体数据的Map

参数:

refid - 模块标识

返回:

包含业务实体数据的Map

抛出:

BusiException - 业务异常

SQLException - SQL异常

EntityException - 实体异常

TokenAuthenticationException - 令牌认证异常

getById

public Map<String,Object> getById(String refid,
 Object id)
                           throws BusiException,
SQLException

根据给定的引用ID和ID获取对应的对象数据

参数:

refid - 模块引用ID

id - 对象ID

返回:

包含对象数据的Map

抛出:

BusiException - 业务异常

SQLException - SQL异常

detail

public Map<String,Object> detail(String refid,
 String id)
                          throws BusiException,
SQLException

获取指定模块下的业务实体详情

参数:

refid - 模块标识

id - 业务实体ID

返回:

包含业务实体详情信息的Map对象

抛出:

BusiException - 业务异常

SQLException - SQL异常

delete

public void delete(String refid,
 List<Object> ids)
            throws BusiException,
SQLException

删除指定引用ID对应的数据记录

参数:

refid - 引用ID

ids - 待删除的数据ID列表

抛出:

BusiException - 业务异常

SQLException - 数据库异常