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

类 DictCategoryController

java.lang.Object

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

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

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

字典分类管理控制器，提供对字典分类的增删改查及数据获取功能。

从以下版本开始:

2022/7/15

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
DictCategoryController()

方法概要

限定符和类型	方法和说明
ApiResult<String>	add(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>>>	getDataList(String dictName) 根据完整的字典路径名称获取对应的数据项列表。
ApiResult<List<Map<String,Object>>>	list() 获取所有字典分类列表，并按排序字段升序排列。
ApiResult<Pager<Map<String,Object>>>	page(Map<String,Object> paramMap) 分页查询字典分类信息。
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, success, success, success, success, validateToken

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

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

构造器详细资料

DictCategoryController

public DictCategoryController()

方法详细资料

page

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

分页查询字典分类信息。

参数:

paramMap - 查询参数集合，可包含过滤条件等

返回:

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

抛出:

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")
public ApiResult<String> add(@RequestBody
                                                                                                                                                                                                        Map<String,Object> paramMap)
                                                                                                                                                                                                 throws Exception

添加一个新的字典分类记录。 在插入前会校验名称是否重复（在同一租户、父级下），并设置相关默认值如创建时间、租户ID等。

参数:

paramMap - 包含新增字典分类所需的信息，例如：dict_name、parent_id 等

返回:

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

抛出:

Exception - 插入过程中的潜在异常

delete

@PostMapping(value="/delete")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @Permission(value="sys:dict:remove")
 @OperationLog(value="\u5220\u9664\u5b57\u5178")
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的字典分类信息映射表

抛出:

Exception - 数据库访问异常或其他运行期问题

update

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

更新已有字典分类的信息。 若修改后的名称与原不同且非空，则进行重名校验；同时更新最后修改时间戳。

参数:

paramMap - 包含待更新字段的新值，必须含有有效ID

返回:

修改操作的状态反馈消息

抛出:

Exception - 数据库交互错误或其他系统级别异常

getDataList

@GetMapping(value="/getDataList")
 @Permission(value="")
public ApiResult<List<Map<String,Object>>> getDataList(@RequestParam
                                                                                                                  String dictName)
                                                                                                           throws Exception

根据完整的字典路径名称获取对应的数据项列表。 支持多层级结构解析，最终返回叶子节点下的具体选项值。

参数:

dictName - 完整的点号分割格式的字典路径名，如 "system.user.status"

返回:

符合路径定义的一组键值对数据列表

抛出:

Exception - 查询链路或转换类型时发生的问题