java.lang.Object

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

net.sohelp.boot.dev.web.system.user.UserController

@RestController("dev-system-user") @RequestMapping("/dev/system/user") public class UserController extends BaseController

用户控制器，用于处理与用户相关的操作。包括用户分页查询、租户分配、用户信息维护等功能。

从以下版本开始:: 2024/08/24
作者:: AaronFung

字段概要

从类继承的字段 net.sohelp.boot.admin.core.base.BaseController
request, response
构造器概要

构造器

构造器

说明

UserController()
方法概要

修饰符和类型

方法

说明

ApiResult<String>

add(Map<String,Object> userMap)

新增用户并初始化其角色和组织关系。

ApiResult<String>

assignTenant(Map<String,Object> dataMap)

将多个租户分配给一个用户。

ApiResult<String>

delete(String[] ids)

删除指定用户及相关联的数据记录。

ApiResult<Map<String,Object>>

getById(String id)

根据用户ID获取详细信息。

ApiResult<Map<String,Object>>

getSetting(String id)

获取用户的个性化设置信息。

ApiResult<Pager<Map<String,Object>>>

getThirdpartUserPage(Map<String,Object> paramMap)

获取第三方平台绑定的用户分页数据。

ApiResult<String>

layoutByToken(Map<String,Object> dataMap)

根据Token注销特定用户的登录会话。

ApiResult<String>

layoutByUserId(Map<String,Object> dataMap)

注销指定用户的所有会话。

ApiResult<Pager<Map<String,Object>>>

page(Map<String,Object> paramMap)

获取所有用户的分页数据，并附加组织名称及在线状态等扩展字段。

ApiResult<Pager<Map<String,Object>>>

pageAssignTenant(Map<String,Object> paramMap)

根据租户ID读取已分配租户分页查询结果。

ApiResult<List<Map<String,Object>>>

pageTokenByUser(String userId)

根据用户ID获取其对应的Token列表。

ApiResult<Pager<Map<String,Object>>>

pageUnAssignTenant(Map<String,Object> paramMap)

根据租户ID获取未分配的用户分页查询结果。

ApiResult<String>

password(Map<String,Object> paramMap)

重置用户的登录密码。

ApiResult<List<Map<String,Object>>>

select(String name)

获取用户下拉选项列表。

String

treeByUser()

构建基于用户的树形结构JSON字符串。

ApiResult<String>

unAssignTenant(Map<String,Object> dataMap)

取消将某些租户分配给某个用户。

ApiResult<String>

update(Map<String,Object> userMap)

更新用户基本信息以及相关角色配置。

ApiResult<String>

updateSetting(Map<String,Object> paramMap)

更新用户的个性化设置项。

ApiResult<String>

updateStatus(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

构造器详细资料
- UserController
  
  public UserController()
方法详细资料
- pageUnAssignTenant
  
  @GetMapping("/pageUnAssignTenant") @Permission("ADMIN") public ApiResult<Pager<Map<String,Object>>> pageUnAssignTenant(@RequestParam Map<String,Object> paramMap)
  
  根据租户ID获取未分配的用户分页查询结果。
  
  参数:
  
  paramMap - 请求参数映射表，包含查询条件如用户ID等
  
  返回:
  
  返回分页数据，包含未被指定租户关联的用户列表
- pageAssignTenant
  
  @GetMapping("/pageAssignTenant") @Permission("ADMIN") public ApiResult<Pager<Map<String,Object>>> pageAssignTenant(@RequestParam Map<String,Object> paramMap)
  
  根据租户ID读取已分配租户分页查询结果。
  
  参数:
  
  paramMap - 请求参数映射表，包含查询条件如用户ID等
  
  返回:
  
  返回分页数据，包含已被指定租户关联的用户列表
- assignTenant
  
  @Transactional(rollbackFor=java.lang.Exception.class) @PostMapping("/assignTenant") public ApiResult<String> assignTenant(@RequestBody Map<String,Object> dataMap) throws SQLException
  
  将多个租户分配给一个用户。
  
  参数:
  
  dataMap - 数据映射表，包括用户ID和要分配的租户ID列表
  
  返回:
  
  操作成功提示信息
  
  抛出:
  
  SQLException - SQL执行异常时抛出
- unAssignTenant
  
  @Transactional(rollbackFor=java.lang.Exception.class) @PostMapping("/unAssignTenant") @Permission("ADMIN") public ApiResult<String> unAssignTenant(@RequestBody Map<String,Object> dataMap) throws SQLException
  
  取消将某些租户分配给某个用户。
  
  参数:
  
  dataMap - 数据映射表，包括用户ID和要取消分配的租户ID列表
  
  返回:
  
  操作成功提示信息
  
  抛出:
  
  SQLException - SQL执行异常时抛出
- page
  
  @GetMapping("/page") @Permission("ADMIN") public ApiResult<Pager<Map<String,Object>>> page(@RequestParam Map<String,Object> paramMap) throws Exception
  
  获取所有用户的分页数据，并附加组织名称及在线状态等扩展字段。
  
  参数:
  
  paramMap - 查询参数映射表
  
  返回:
  
  分页后的用户列表及其相关信息
  
  抛出:
  
  Exception - 执行过程中可能发生的异常
- pageTokenByUser
  
  @GetMapping("pageTokenByUser") @Permission("ADMIN") public ApiResult<List<Map<String,Object>>> pageTokenByUser(@RequestParam String userId)
  
  根据用户ID获取其对应的Token列表。
  
  参数:
  
  userId - 用户唯一标识符
  
  返回:
  
  Token列表集合
- layoutByUserId
  
  @PostMapping("layoutByUserId") @Permission("ADMIN") public ApiResult<String> layoutByUserId(@RequestBody Map<String,Object> dataMap)
  
  注销指定用户的所有会话。
  
  参数:
  
  dataMap - 数据映射表，包含需要注销的用户ID列表
  
  返回:
  
  操作成功提示信息
- layoutByToken
  
  @PostMapping("layoutByToken") @Permission("ADMIN") public ApiResult<String> layoutByToken(@RequestBody Map<String,Object> dataMap)
  
  根据Token注销特定用户的登录会话。
  
  参数:
  
  dataMap - 数据映射表，包含需要注销的Token值
  
  返回:
  
  操作成功提示信息
- select
  
  @GetMapping("/select") @Permission("ADMIN") public ApiResult<List<Map<String,Object>>> select(@RequestParam(required=false) String name) throws Exception
  
  获取用户下拉选项列表。
  
  参数:
  
  name - 可选筛选关键字（用户名）
  
  返回:
  
  用户简略信息列表
  
  抛出:
  
  Exception - 执行过程中的潜在异常
- getById
  
  @GetMapping("/getById") @Permission("ADMIN") public ApiResult<Map<String,Object>> getById(@RequestParam String id) throws SQLException, TokenAuthenticationException
  
  根据用户ID获取详细信息。
  
  参数:
  
  id - 用户唯一标识符
  
  返回:
  
  用户详细信息
  
  抛出:
  
  SQLException - SQL执行异常时抛出
  
  TokenAuthenticationException - 认证失败时抛出
- update
  
  @PostMapping("/update") @Transactional(rollbackFor=java.lang.Exception.class) @OperationLog(value="\u4fee\u6539\u7528\u6237", important=true) @Permission("ADMIN") public ApiResult<String> update(@RequestBody Map<String,Object> userMap) throws Exception
  
  更新用户基本信息以及相关角色配置。
  
  参数:
  
  userMap - 用户更新数据
  
  返回:
  
  成功或错误消息
  
  抛出:
  
  Exception - 执行过程中的潜在异常
- add
  
  @PostMapping("/add") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("ADMIN") @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("ADMIN") public ApiResult<String> delete(@RequestBody String[] ids) throws Exception
  
  删除指定用户及相关联的数据记录。
  
  参数:
  
  ids - 要删除的用户ID数组
  
  返回:
  
  成功或错误消息
  
  抛出:
  
  Exception - 执行过程中的潜在异常
- updateStatus
  
  @PostMapping("/updateStatus") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("ADMIN") public ApiResult<String> updateStatus(@RequestBody Map<String,Object> paramMap) throws SQLException, EntityException, EntityEventException, EntityValidateException, EntityFormulaException, DuplicateKeyException, TokenAuthenticationException
  
  修改用户的状态（启用/禁用）。
  
  参数:
  
  paramMap - 参数映射表，包含用户ID和目标状态码
  
  返回:
  
  成功或错误消息
  
  抛出:
  
  SQLException - SQL执行异常时抛出
  
  TokenAuthenticationException - 认证失败时抛出
  
  EntityException - 实体操作异常时抛出
  
  EntityEventException - 事件触发异常时抛出
  
  EntityValidateException - 验证失败时抛出
  
  EntityFormulaException - 公式计算异常时抛出
  
  DuplicateKeyException - 主键冲突时抛出
- 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 - SQL执行异常时抛出
  
  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 - SQL执行异常时抛出
  
  EntityException - 实体操作异常时抛出
  
  EntityEventException - 事件触发异常时抛出
  
  EntityValidateException - 验证失败时抛出
  
  EntityFormulaException - 公式计算异常时抛出
  
  DuplicateKeyException - 主键冲突时抛出
- password
  
  @PostMapping("/password") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("ADMIN") public ApiResult<String> password(@RequestBody Map<String,Object> paramMap) throws SQLException
  
  重置用户的登录密码。
  
  参数:
  
  paramMap - 密码重置参数映射表
  
  返回:
  
  成功或错误消息
  
  抛出:
  
  SQLException - SQL执行异常时抛出
- getThirdpartUserPage
  
  @GetMapping("/getThirdpartUserPage") @Permission("ADMIN") public ApiResult<Pager<Map<String,Object>>> getThirdpartUserPage(@RequestParam Map<String,Object> paramMap) throws SQLException
  
  获取第三方平台绑定的用户分页数据。
  
  参数:
  
  paramMap - 查询参数映射表
  
  返回:
  
  第三方用户分页数据
  
  抛出:
  
  SQLException - SQL执行异常时抛出
- treeByUser
  
  @PostMapping("/treeByUser") public String treeByUser() throws Exception
  
  构建基于用户的树形结构JSON字符串。
  
  返回:
  
  树状结构JSON字符串
  
  抛出:
  
  Exception - 执行过程中的潜在异常

类 UserController

字段概要

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

构造器概要

方法概要

从类继承的方法 net.sohelp.boot.admin.core.base.BaseController

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

构造器详细资料

UserController

方法详细资料

pageUnAssignTenant

pageAssignTenant

assignTenant

unAssignTenant

page

pageTokenByUser

layoutByUserId

layoutByToken

select

getById

update

add

delete

updateStatus

updateSetting

getSetting

password

getThirdpartUserPage

treeByUser