net.sohelp.boot.engine.web

类 ModuleHelper

java.lang.Object

net.sohelp.boot.engine.web.ModuleHelper

@Component
public class ModuleHelper
extends Object

模块工具

从以下版本开始:

2024/8/23 14:45

作者:

AaronFung

构造器概要

构造器

构造器和说明
ModuleHelper()

方法概要

限定符和类型	方法和说明
FormVO	getEntityForm(String refid) 根据引用ID获取实体表单信息
EntityRefVO	getEntityRef(String refid) 根据引用ID获取实体引用对象
GridVO	getGrid(String refid) 根据引用ID获取网格视图对象 该方法首先解析引用ID获取应用名、模块名和实体名，然后通过模块服务获取模块信息。
void	saveForm(String refid, FormVO formVO) 保存表单数据 根据给定的引用ID获取实体引用信息，并调用表单服务保存表单数据
void	saveGrid(String refid, GridVO gridVO) 保存网格数据
void	saveLayout(String refid, LayoutVO layoutVO) 保存布局信息 根据给定的引用ID获取引用信息，并调用布局服务保存布局数据
boolean	validate(long userId, String refid) 验证用户权限和令牌有效性
boolean	validate(long userId, String refid, String authority) 验证用户对指定模块的访问权限

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

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

构造器详细资料

ModuleHelper

public ModuleHelper()

方法详细资料

saveForm

public void saveForm(String refid,
                     FormVO formVO)
              throws BusiException,
                     SQLException

保存表单数据 根据给定的引用ID获取实体引用信息，并调用表单服务保存表单数据

参数:

refid - 实体引用ID，用于获取对应的实体引用信息

formVO - 表单数据对象，包含需要保存的表单数据

抛出:

BusiException - 业务异常，当业务处理过程中出现错误时抛出

SQLException - 数据库异常，当数据库操作过程中出现错误时抛出

getEntityRef

public EntityRefVO getEntityRef(String refid)
                         throws BusiException,
                                SQLException

根据引用ID获取实体引用对象

参数:

refid - 引用ID，格式为"appName:moduleName:entityName"

返回:

包含实体引用信息的EntityRefVO对象

抛出:

BusiException - 当业务处理出现异常时抛出

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

getEntityForm

public FormVO getEntityForm(String refid)
                     throws BusiException,
                            SQLException,
                            EntityException

根据引用ID获取实体表单信息

参数:

refid - 引用ID，用于解析应用名和模块名

返回:

包含表单信息的FormVO对象

抛出:

BusiException - 业务异常

SQLException - 数据库操作异常

EntityException

saveLayout

public void saveLayout(String refid,
                       LayoutVO layoutVO)
                throws BusiException,
                       SQLException

保存布局信息 根据给定的引用ID获取引用信息，并调用布局服务保存布局数据

参数:

refid - 引用ID，用于获取对应的引用信息

layoutVO - 布局数据对象，包含需要保存的布局信息

抛出:

BusiException - 业务异常，当业务处理过程中出现错误时抛出

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

saveGrid

public void saveGrid(String refid,
                     GridVO gridVO)
              throws BusiException,
                     SQLException

保存网格数据

参数:

refid - 引用ID，用于解析应用、模块和网格名称

gridVO - 网格数据对象，包含要保存的网格信息

抛出:

BusiException - 业务异常，当业务处理出错时抛出

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

getGrid

public GridVO getGrid(String refid)
               throws BusiException,
                      SQLException,
                      EntityException

根据引用ID获取网格视图对象 该方法首先解析引用ID获取应用名、模块名和实体名，然后通过模块服务获取模块信息。 如果模块不存在则抛出业务异常。接着根据实体引用获取网格视图，若不存在实体引用则 通过网格服务获取。最后处理扩展实体的公式信息并更新网格属性。

参数:

refid - 引用ID，格式为"应用名:模块名:实体名"

返回:

GridVO 网格视图对象，包含网格配置和公式信息

抛出:

BusiException - 当模块不存在时抛出业务异常

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

EntityException

validate

public boolean validate(long userId,
                        String refid)
                 throws TokenAuthenticationException,
                        BusiException,
                        AccessPermissionException,
                        SQLException

验证用户权限和令牌有效性

参数:

userId - 用户ID，用于标识当前操作的用户

refid - 引用ID，用于标识需要验证的资源或操作

返回:

验证结果，true表示验证通过，false表示验证失败

抛出:

TokenAuthenticationException - 令牌认证异常

BusiException - 业务异常

AccessPermissionException - 访问权限异常

SQLException - 数据库访问异常

validate

public boolean validate(long userId,
                        String refid,
                        String authority)
                 throws BusiException,
                        SQLException,
                        TokenAuthenticationException,
                        AccessPermissionException

验证用户对指定模块的访问权限

参数:

userId - 用户ID

refid - 模块引用ID，格式为"appName:moduleName"

authority - 操作权限标识（可选），格式为"/appName/moduleName:operation"

返回:

验证通过返回true，否则抛出异常

抛出:

BusiException - 当模块不存在时抛出

SQLException - 数据库操作异常

TokenAuthenticationException - 令牌认证异常（虽然代码中未实际抛出）

AccessPermissionException - 当用户没有访问或操作权限时抛出