net.sohelp.boot.demo.web.system.dict

类 DictionaryDataController

java.lang.Object

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

net.sohelp.boot.demo.web.system.dict.DictionaryDataController

@RestController(value="admin-system-dict-data")
 @RequestMapping(value="/admin/system/dict/data")
public class DictionaryDataController
extends BaseController

字典数据项管理控制器，提供对字典数据的增删改查及缓存刷新功能。

从以下版本开始:

2022/7/15

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
DictionaryDataController()

方法概要

限定符和类型	方法和说明
ApiResult<String>	add(Map<String,Object> paramMap) 添加一个新的字典项。
ApiResult<String>	batchDelete(Map<String,Object> paramMap) 批量删除多个字典项。
ApiResult<String>	delete(Map<String,Object> paramMap) 删除指定ID的字典项。
ApiResult<Map<String,Object>>	getById(String id) 根据ID获取单个字典项详细信息。
ApiResult<List<Map<String,Object>>>	list() 获取所有字典项列表。
ApiResult<Pager<Map<String,Object>>>	page(Map<String,Object> paramMap) 分页查询字典项列表。
ApiResult<String>	refreshDictCache() 强制刷新系统中的字典缓存。
ApiResult<String>	update(Map<String,Object> paramMap) 更新指定ID的字典项信息。

从类继承的方法 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

构造器详细资料

DictionaryDataController

public DictionaryDataController()

方法详细资料

page

@GetMapping(value="/page")
 @Permission(value="sys:dict:list")
public ApiResult<Pager<Map<String,Object>>> page(@RequestParam
                                                                                                                  Map<String,Object> paramMap)
                                                                                                           throws Exception

分页查询字典项列表。

参数:

paramMap - 请求参数，包含分页信息和主键ID（main_id）

返回:

返回分页结果，包含当前页的数据列表和总记录数

抛出:

Exception - 查询过程中可能抛出异常

list

@GetMapping(value="/list")
 @Permission(value="sys:dict:list")
public ApiResult<List<Map<String,Object>>> list()
                                                                                                          throws Exception

获取所有字典项列表。

返回:

返回完整的字典项列表，按排序字段升序排列

抛出:

Exception - 查询数据库时可能出现异常

add

@PostMapping(value="/add")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @Permission(value="sys:dict:save")
 @OperationLog(value="\u6dfb\u52a0\u5b57\u5178\u9879")
public ApiResult<String> add(@RequestBody
                                                                                                                                                                                                              Map<String,Object> paramMap)
                                                                                                                                                                                                       throws Exception

添加一个新的字典项。

参数:

paramMap - 包含新增字典项的信息，如名称、所属字典ID等

返回:

操作结果，成功或失败提示信息

抛出:

Exception - 数据库操作或其他业务逻辑中可能发生的异常

delete

@PostMapping(value="/delete")
 @Permission(value="sys:dict:remove")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @OperationLog(value="\u5220\u9664\u5b57\u5178\u9879")
public ApiResult<String> delete(@RequestBody
                                                                                                                                                                                                                      Map<String,Object> paramMap)
                                                                                                                                                                                                               throws Exception

删除指定ID的字典项。

参数:

paramMap - 包含要删除的字典项ID

返回:

操作结果，成功或失败提示信息

抛出:

Exception - 数据库操作或其他业务逻辑中可能发生的异常

getById

@GetMapping(value="/getById")
 @Permission(value="sys:dict:list")
public ApiResult<Map<String,Object>> getById(@RequestParam
                                                                                                                 String id)
                                                                                                          throws Exception

根据ID获取单个字典项详细信息。

参数:

id - 要查询的字典项ID

返回:

返回对应ID的字典项信息

抛出:

Exception - 查询数据库时可能出现异常

update

@PostMapping(value="/update")
 @Permission(value="sys:dict:update")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> update(@RequestBody
                                                                                                                                                              Map<String,Object> paramMap)
                                                                                                                                                       throws Exception

更新指定ID的字典项信息。

参数:

paramMap - 包含更新后的字典项信息

返回:

操作结果，成功或失败提示信息

抛出:

Exception - 数据库操作或其他业务逻辑中可能发生的异常

batchDelete

@PostMapping(value="/batchDelete")
 @Permission(value="sys:dict:remove")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @OperationLog(value="\u5220\u9664\u5b57\u5178\u9879")
public ApiResult<String> batchDelete(@RequestBody
                                                                                                                                                                                                                                Map<String,Object> paramMap)
                                                                                                                                                                                                                         throws Exception

批量删除多个字典项。

参数:

paramMap - 包含待删除的字典项ID集合

返回:

操作结果，成功或失败提示信息

抛出:

Exception - 数据库操作或其他业务逻辑中可能发生的异常

refreshDictCache

@PostMapping(value="/refreshDictCache")
 @OperationLog(value="\u5237\u65b0\u7f13\u5b58")
public ApiResult<String> refreshDictCache()
                                                                                                                              throws Exception

强制刷新系统中的字典缓存。

返回:

操作结果，表示缓存刷新成功

抛出:

Exception - 缓存加载过程中的潜在异常