程序包 net.sohelp.boot.dev.web.system.dict

类 DictionaryDataController

java.lang.Object

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

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

@RestController("dev-system-dict-data")
@RequestMapping("/dev/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(String[] ids)	删除指定ID集合中的多个字典项。
ApiResult<Map<String,Object>>	getById(String id)	根据ID获取单个字典项详细信息。
ApiResult<List<Map<String,Object>>>	list(Map<String,Object> paramMap)	获取所有符合条件的字典项列表（不分页）。
ApiResult<Pager<Map<String,Object>>>	page(Map<String,Object> paramMap)	分页查询字典项信息。
ApiResult<String>	refreshDictCache()	刷新系统中使用的字典缓存。
ApiResult<String>	update(Map<String,Object> paramMap)	更新已有字典项的信息。

从类继承的方法 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, response, responseStream, success, success, success, success, validateToken

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

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

构造器详细资料

DictionaryDataController

public DictionaryDataController()

方法详细资料

page

@GetMapping("/page")
@Permission("ADMIN")
public ApiResult<Pager<Map<String,Object>>> page(@RequestParam
 Map<String,Object> paramMap)
                                          throws Exception

分页查询字典项信息。

参数:

paramMap - 请求参数映射，包含查询条件等

返回:

返回分页结果对象，包含当前页的数据列表及相关分页信息

抛出:

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

list

@GetMapping("/list")
@Permission("ADMIN")
public ApiResult<List<Map<String,Object>>> list(@RequestParam
 Map<String,Object> paramMap)
                                         throws Exception

获取所有符合条件的字典项列表（不分页）。

参数:

paramMap - 请求参数映射，用于构建查询条件

返回:

返回字典项列表

抛出:

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

add

@PostMapping("/add")
@Permission("ADMIN")
@OperationLog("\u6dfb\u52a0\u5b57\u5178\u9879")
public ApiResult<String> add(@RequestBody
 Map<String,Object> paramMap)
                      throws Exception

添加新的字典项记录。

参数:

paramMap - 包含待插入字段值的请求体参数

返回:

操作结果提示信息

抛出:

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

delete

@PostMapping("/delete")
@Permission("ADMIN")
@OperationLog("\u5220\u9664\u5b57\u5178\u9879")
public ApiResult<String> delete(@RequestBody
 String[] ids)
                         throws Exception

删除指定ID集合中的多个字典项。

参数:

ids - 待删除的字典项主键数组

返回:

删除操作的结果提示信息

抛出:

Exception - 执行SQL删除语句时可能发生的异常

getById

@GetMapping("/getById")
@Permission("ADMIN")
public ApiResult<Map<String,Object>> getById(@RequestParam
 String id)
                                      throws Exception

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

参数:

id - 要查询的字典项唯一标识符

返回:

对应字典项的信息Map结构

抛出:

Exception - 查询数据库失败时抛出异常

update

@PostMapping("/update")
@Permission("ADMIN")
public ApiResult<String> update(@RequestBody
 Map<String,Object> paramMap)
                         throws Exception

更新已有字典项的信息。

参数:

paramMap - 包含更新字段与新值的请求体参数

返回:

修改操作的结果提示信息

抛出:

Exception - 在执行更新或校验过程中的潜在异常

batchDelete

@PostMapping("/batchDelete")
@Permission("ADMIN")
@OperationLog("\u5220\u9664\u5b57\u5178\u9879")
public ApiResult<String> batchDelete(@RequestBody
 Map<String,Object> paramMap)
                              throws Exception

批量删除一组字典项。

参数:

paramMap - 请求体参数，其中应包含要删除的ID列表

返回:

删除操作的结果提示信息

抛出:

Exception - 构造SQL或执行删除时可能引发的异常

refreshDictCache

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

刷新系统中使用的字典缓存。

返回:

缓存刷新状态提示信息

抛出:

Exception - 刷新缓存过程中可能遇到的问题