net.sohelp.boot.engine.web.controller

类 EngineCrudController

java.lang.Object

net.sohelp.boot.admin.core.base.BaseController

net.sohelp.boot.engine.web.controller.EngineCrudController

@RestController(value="engine-web-crud")
 @RequestMapping(value="/engine/web/crud")
 @ConditionalOnExpression(value="${sohelp-boot.engine.enabled:true} && ${sohelp-boot.engine.crud.enabled:true}")
public class EngineCrudController
extends BaseController

CRUD引擎

从以下版本开始:

2024/8/22 10:05

作者:

AaronFung

字段概要

从类继承的字段 net.sohelp.boot.admin.core.base.BaseController

request, response

构造器概要

构造器

构造器和说明
EngineCrudController()

方法概要

限定符和类型	方法和说明
ApiResult<?>	create(com.alibaba.fastjson.JSONObject jsonObject) 创建单据接口 该接口用于创建新的单据，通过传入包含单据信息的JSON对象来实现单据的创建操作。
ApiResult<String>	delete(Map<String,Object> dataMap) 指量单据删除接口 该接口用于删除指量单据，支持单个或多个ID删除，并验证用户操作权限。
ApiResult<Map<String,Object>>	detail(String refid, String id) 获取指定记录的详细信息 通过refid和id获取对应记录的详细信息，并封装成ApiResult返回
ApiResult<Map<String,Object>>	getById(String refid, String id) 根据ID获取数据 通过指定的refid和id从数据库中获取对应的数据，并封装成ApiResult返回
ApiResult<Map<String,Object>>	initial(String refid) 获取模块初始化数据 该接口用于根据模块地址获取相应的初始化数据，并进行权限验证。
ApiResult<Pager<Map<String,Object>>>	page(Map<String,Object> paramMap) 分页查询接口 该接口用于根据传入的参数进行分页查询，并返回查询结果。
ApiResult<Pager<Map<String,Object>>>	pageByFk(Map<String,Object> paramMap) 根据外键分页查询数据接口 该接口通过传入包含外键和其他查询条件的参数Map，分页查询并返回相关数据
ApiResult<?>	save(com.alibaba.fastjson.JSONObject jsonObject) 保存数据接口 该接口用于保存通过JSON对象传递的数据，并进行权限验证。
ApiResult<?>	update(com.alibaba.fastjson.JSONObject jsonObject) 单据更新接口 用于更新单据信息，并进行权限验证和保存操作。

从类继承的方法 net.sohelp.boot.admin.core.base.BaseController

error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, success, success, success, success, validateToken

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

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

构造器详细资料

EngineCrudController

public EngineCrudController()

方法详细资料

create

@PostMapping(value="/create")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<?> create(@RequestBody
                                                                                                                                          com.alibaba.fastjson.JSONObject jsonObject)
                                                                                                                                   throws BusiException,
                                                                                                                                          SQLException,
                                                                                                                                          TokenAuthenticationException,
                                                                                                                                          AccessPermissionException,
                                                                                                                                          EntityException

创建单据接口 该接口用于创建新的单据，通过传入包含单据信息的JSON对象来实现单据的创建操作。

参数:

jsonObject - 包含单据信息的JSON对象，其中必须包含"refid"字段用于权限验证

返回:

返回ApiResult对象，表示操作的结果，包含成功或失败的信息

抛出:

BusiException - 业务异常，当业务逻辑出现错误时抛出

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

TokenAuthenticationException - 令牌认证异常，当令牌验证失败时抛出

AccessPermissionException - 访问权限异常，当权限验证失败时抛出

EntityException - 实体异常，当实体操作失败时抛出

save

@PostMapping(value="/save")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<?> save(@RequestBody
                                                                                                                                      com.alibaba.fastjson.JSONObject jsonObject)
                                                                                                                               throws BusiException,
                                                                                                                                      SQLException,
                                                                                                                                      TokenAuthenticationException,
                                                                                                                                      AccessPermissionException,
                                                                                                                                      EntityException,
                                                                                                                                      ScriptException

保存数据接口 该接口用于保存通过JSON对象传递的数据，并进行权限验证。

参数:

jsonObject - 包含要保存的数据的JSON对象，其中必须包含"refid"字段用于权限验证

返回:

返回ApiResult对象，包含操作结果信息

抛出:

BusiException - 业务逻辑异常，如参数不合法或操作失败

SQLException - 数据库操作异常

TokenAuthenticationException - 令牌认证异常，如令牌无效或已过期

AccessPermissionException - 访问权限异常，如用户无权限执行该操作

EntityException - 实体相关异常，如实体不存在或操作实体时出错

ScriptException

update

@PostMapping(value="/update")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<?> update(@RequestBody
                                                                                                                                          com.alibaba.fastjson.JSONObject jsonObject)
                                                                                                                                   throws BusiException,
                                                                                                                                          SQLException,
                                                                                                                                          TokenAuthenticationException,
                                                                                                                                          AccessPermissionException,
                                                                                                                                          EntityException

单据更新接口 用于更新单据信息，并进行权限验证和保存操作。

参数:

jsonObject - 包含更新信息的JSON对象

返回:

返回操作结果的ApiResult对象

抛出:

BusiException - 业务逻辑异常

SQLException - 数据库操作异常

TokenAuthenticationException - Token认证异常

AccessPermissionException - 访问权限异常

EntityException - 实体异常

detail

@GetMapping(value="/detail")
 @Permission(value="")
public ApiResult<Map<String,Object>> detail(@RequestParam
                                                                                                  String refid,
                                                                                                  String id)
                                                                                           throws BusiException,
                                                                                                  SQLException,
                                                                                                  TokenAuthenticationException,
                                                                                                  AccessPermissionException

获取指定记录的详细信息 通过refid和id获取对应记录的详细信息，并封装成ApiResult返回

参数:

refid - 引用ID，用于验证地址和模块操作权限

id - 记录ID，用于获取详细信息的唯一标识

返回:

封装了详细信息的ApiResult对象

抛出:

BusiException - 业务异常，当业务逻辑出现错误时抛出

SQLException - 数据库访问异常，当数据库操作失败时抛出

TokenAuthenticationException - 令牌认证异常，当令牌验证失败时抛出

AccessPermissionException - 访问权限异常，当没有操作权限时抛出

getById

@GetMapping(value="/getById")
 @Permission(value="")
public ApiResult<Map<String,Object>> getById(@RequestParam
                                                                                                    String refid,
                                                                                                    String id)
                                                                                             throws BusiException,
                                                                                                    SQLException,
                                                                                                    TokenAuthenticationException,
                                                                                                    AccessPermissionException

根据ID获取数据 通过指定的refid和id从数据库中获取对应的数据，并封装成ApiResult返回

参数:

refid - 引用ID，用于验证地址和模块操作权限

id - 数据ID，用于从数据库中获取对应的数据

返回:

返回包含数据的ApiResult对象

抛出:

BusiException - 业务异常，当业务逻辑出现错误时抛出

SQLException - 数据库查询异常，当数据库操作失败时抛出

TokenAuthenticationException - 令牌认证异常，当令牌验证失败时抛出

AccessPermissionException - 访问权限异常，当没有操作权限时抛出

initial

@GetMapping(value="/initial")
 @Permission(value="")
public ApiResult<Map<String,Object>> initial(@RequestParam
                                                                                                    String refid)
                                                                                             throws BusiException,
                                                                                                    SQLException,
                                                                                                    TokenAuthenticationException,
                                                                                                    AccessPermissionException,
                                                                                                    EntityException

获取模块初始化数据 该接口用于根据模块地址获取相应的初始化数据，并进行权限验证。

参数:

refid - 模块地址，用于定位需要获取初始化数据的模块

返回:

返回包含初始化数据的ApiResult对象

抛出:

BusiException - 业务异常，当业务逻辑出现错误时抛出

SQLException - 数据库访问异常，当数据库操作失败时抛出

TokenAuthenticationException - 令牌认证异常，当令牌验证失败时抛出

AccessPermissionException - 访问权限异常，当没有访问权限时抛出

EntityException - 实体异常，当实体相关操作出错时抛出

page

@GetMapping(value="/page")
 @Permission(value="")
public ApiResult<Pager<Map<String,Object>>> page(@RequestParam
                                                                                                     Map<String,Object> paramMap)
                                                                                              throws BusiException,
                                                                                                     SQLException,
                                                                                                     TokenAuthenticationException,
                                                                                                     AccessPermissionException,
                                                                                                     EntityException

分页查询接口 该接口用于根据传入的参数进行分页查询，并返回查询结果。

参数:

paramMap - 包含查询条件的参数映射，其中可以包含分页信息以及查询条件等。 - refid: 引用ID，用于标识要查询的数据源或表。 - 其他参数: 根据具体业务需求传入的查询条件。

返回:

返回分页查询的结果，封装在ApiResult对象中的Pager>类型。

抛出:

BusiException - 当业务逻辑出现错误时抛出。

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

TokenAuthenticationException - 当令牌认证失败时抛出。

AccessPermissionException - 当访问权限验证失败时抛出。

EntityException

pageByFk

@GetMapping(value="/pageByFk")
 @Permission(value="")
public ApiResult<Pager<Map<String,Object>>> pageByFk(@RequestParam
                                                                                                             Map<String,Object> paramMap)
                                                                                                      throws BusiException,
                                                                                                             SQLException,
                                                                                                             TokenAuthenticationException,
                                                                                                             AccessPermissionException,
                                                                                                             EntityException

根据外键分页查询数据接口 该接口通过传入包含外键和其他查询条件的参数Map，分页查询并返回相关数据

参数:

paramMap - 包含查询条件的参数Map，其中必须包含"refid"和"id"两个键，"refid"用于指定关联的外键，"id"用于验证请求合法性

返回:

ApiResult>> 分页查询结果，封装在ApiResult对象中

抛出:

BusiException - 如果"id"参数为空，则抛出BusiException异常

SQLException - 数据库查询过程中发生异常

TokenAuthenticationException - 令牌认证失败异常

AccessPermissionException - 访问权限验证失败异常

EntityException

delete

@PostMapping(value="/delete")
 @Permission(value="")
public ApiResult<String> delete(@RequestBody
                                                                                       Map<String,Object> dataMap)
                                                                                throws BusiException,
                                                                                       SQLException,
                                                                                       TokenAuthenticationException,
                                                                                       AccessPermissionException

指量单据删除接口 该接口用于删除指量单据，支持单个或多个ID删除，并验证用户操作权限。

参数:

dataMap - 包含删除请求的数据，其中"id"为要删除的单据ID，可以是单个ID或ID列表，"refid"为关联的业务模块ID

返回:

返回操作结果的ApiResult对象，包含操作成功的信息

抛出:

BusiException - 业务异常，如删除操作失败时抛出

SQLException - 数据库操作异常，如数据库连接失败或SQL执行错误时抛出

TokenAuthenticationException - 令牌认证异常，如令牌无效或过期时抛出

AccessPermissionException - 访问权限异常，如用户无操作权限时抛出