类 UserController
java.lang.Object
net.sohelp.boot.admin.core.base.BaseController
net.sohelp.boot.demo.web.system.user.UserController
@RestController("admin-system-user")
@RequestMapping("/admin/system/user")
public class UserController
extends BaseController
用户控制器类,用于处理与用户相关的操作。
-
字段概要
从类继承的字段 net.sohelp.boot.admin.core.base.BaseController
request, response -
构造器概要
构造器 -
方法概要
修饰符和类型方法说明添加新用户。删除指定ID的用户及其相关联的数据。根据ID获取单个用户详细信息。getSetting(String id) 获取特定用户的配置信息。getThirdpartUserPage(Map<String, Object> paramMap) 获取第三方平台绑定的用户信息分页数据。强制某位在线用户退出系统。分页查询用户信息。重置用户密码。获取用户下拉列表。构建基于组织结构的用户树形结构JSON字符串。更新用户信息。updateSetting(Map<String, Object> paramMap) 更新特定用户的配置项。updateStatus(Map<String, Object> dataMap) 更新用户状态。从类继承的方法 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
-
构造器详细资料
-
UserController
public UserController()
-
-
方法详细资料
-
page
@GetMapping("/page") @Permission("sys:user:list") public ApiResult<Pager<Map<String,Object>>> page(@RequestParam Map<String, Object> paramMap) throws Exception分页查询用户信息。- 参数:
paramMap- 请求参数映射表- 返回:
- 包含分页数据的结果对象
- 抛出:
Exception- 查询过程中可能抛出的异常
-
select
@GetMapping("/select") public ApiResult<List<Map<String,Object>>> select(String name) throws Exception 获取用户下拉列表。- 参数:
name- 模糊匹配用户名的关键字(可选)- 返回:
- 用户列表结果对象
- 抛出:
Exception- 查询过程中的异常
-
getById
@GetMapping("/getById") @Permission("sys:user:list") public ApiResult<Map<String,Object>> getById(@RequestParam String id) throws SQLException 根据ID获取单个用户详细信息。- 参数:
id- 用户唯一标识符- 返回:
- 用户详情结果对象
- 抛出:
SQLException- 数据库访问错误时抛出
-
updateStatus
@PostMapping("/updateStatus") @Permission("sys:user:start") public ApiResult<String> updateStatus(@RequestBody Map<String, Object> dataMap) 更新用户状态。- 返回:
-
update
@PostMapping("/update") @Transactional(rollbackFor=java.lang.Exception.class) @OperationLog(value="\u4fee\u6539\u7528\u6237", important=true) @Permission("user:ad2d") public ApiResult<String> update(@RequestBody Map<String, Object> userMap) throws Exception更新用户信息。- 参数:
userMap- 用户信息映射表- 返回:
- 成功或失败提示信息
- 抛出:
Exception- 处理过程中可能出现的异常
-
add
@PostMapping("/add") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("sys:user:save") @OperationLog(value="\u6dfb\u52a0\u7528\u6237", important=true) public ApiResult<String> add(@RequestBody Map<String, Object> userMap) throws Exception添加新用户。- 参数:
userMap- 新增用户的信息映射表- 返回:
- 添加成功的提示信息
- 抛出:
Exception- 插入数据库或其他业务逻辑中出现的问题
-
delete
@PostMapping("/delete") @Transactional(rollbackFor=java.lang.Exception.class) @OperationLog(value="\u5220\u9664\u7528\u6237", important=true) @Permission("sys:user:remove") public ApiResult<String> delete(@RequestBody List<String> ids) throws Exception 删除指定ID的用户及其相关联的数据。- 参数:
ids- 要删除的用户ID集合- 返回:
- 删除操作的结果消息
- 抛出:
Exception- 执行删除操作时发生的异常
-
updateSetting
@PostMapping("/updateSetting") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("ADMIN") @OperationLog(value="\u4fee\u6539\u7528\u6237\u6743\u9650\u8bbe\u7f6e", important=true) public ApiResult<String> updateSetting(@RequestBody Map<String, Object> paramMap) throws SQLException, EntityException, EntityEventException, EntityValidateException, EntityFormulaException, DuplicateKeyException更新特定用户的配置项。- 参数:
paramMap- 配置参数映射表- 返回:
- 设置成功的响应信息
- 抛出:
SQLException- 数据库操作异常EntityException- 实体处理异常EntityEventException- 实体事件异常EntityValidateException- 实体验证异常EntityFormulaException- 公式计算异常DuplicateKeyException- 主键冲突异常
-
getSetting
@GetMapping("/getSetting") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<Map<String,Object>> getSetting(@RequestParam String id) throws SQLException, EntityException, EntityEventException, EntityValidateException, EntityFormulaException, DuplicateKeyException 获取特定用户的配置信息。- 参数:
id- 用户唯一标识符- 返回:
- 包含用户配置信息的结果对象
- 抛出:
SQLException- 数据库访问异常EntityException- 实体处理异常EntityEventException- 实体事件异常EntityValidateException- 实体验证异常EntityFormulaException- 公式计算异常DuplicateKeyException- 主键冲突异常
-
password
@PostMapping("/password") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("sys:user:resetpassword") public ApiResult<String> password(@RequestBody Map<String, Object> paramMap) throws SQLException重置用户密码。支持两种密码加密格式:
- SHA-256 加盐格式(96 位):使用 PasswordUtil 进行加密
- MD5 格式(32 位):向后兼容旧版密码
- 参数:
paramMap- 密码参数映射表,包含 id(用户 ID)和 password(新密码)- 返回:
- 密码重置成功的信息
- 抛出:
SQLException- 数据库操作异常
-
offline
@PostMapping("/offline") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("sys:user:offline") public ApiResult<String> offline(@RequestBody Map<String, Object> paramMap) throws SQLException强制某位在线用户退出系统。- 参数:
paramMap- 请求参数映射表- 返回:
- 下线成功的提示信息
- 抛出:
SQLException- 数据库操作异常
-
getThirdpartUserPage
@GetMapping("/getThirdpartUserPage") @Permission("") public ApiResult getThirdpartUserPage(@RequestParam Map<String, Object> paramMap) throws SQLException获取第三方平台绑定的用户信息分页数据。- 参数:
paramMap- 查询条件参数映射表- 返回:
- 第三方用户分页结果对象
- 抛出:
SQLException- 数据库访问异常
-
treeByUser
构建基于组织结构的用户树形结构JSON字符串。- 返回:
- 树状结构的JSON字符串表示
- 抛出:
Exception- 构造树的过程中可能遇到的异常
-