UserController (SohelpBoot 1.1.15-SNAPSHOT API)

java.lang.Object
- net.sohelp.boot.admin.core.base.BaseController
- - net.sohelp.boot.demo.web.system.user.UserController

@RestController(value="admin-system-user")
 @RequestMapping(value="/admin/system/user")
public class UserController
extends BaseController

用户控制器类，用于处理与用户相关的操作。

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

构造器概要

构造器
构造器和说明

UserController()

构造器
构造器和说明
`UserController()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ApiResult<String>`	`add(Map<String,Object> userMap)` 添加新用户。
`ApiResult<String>`	`delete(List<String> ids)` 删除指定ID的用户及其相关联的数据。
`ApiResult<Map<String,Object>>`	`getById(String id)` 根据ID获取单个用户详细信息。
`ApiResult<Map<String,Object>>`	`getSetting(String id)` 获取特定用户的配置信息。
`ApiResult`	`getThirdpartUserPage(Map<String,Object> paramMap)` 获取第三方平台绑定的用户信息分页数据。
`ApiResult<String>`	`offline(Map<String,Object> paramMap)` 强制某位在线用户退出系统。
`ApiResult<Pager<Map<String,Object>>>`	`page(Map<String,Object> paramMap)` 分页查询用户信息。
`ApiResult<String>`	`password(Map<String,Object> paramMap)` 重置用户密码。
`ApiResult<List<Map<String,Object>>>`	`select(String name)` 获取用户下拉列表。
`String`	`treeByUser()` 构建基于组织结构的用户树形结构JSON字符串。
`ApiResult<String>`	`update(Map<String,Object> userMap)` 更新用户信息。
`ApiResult<String>`	`updateSetting(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

构造器详细资料
- UserController
```
public UserController()
```

方法详细资料

page

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

分页查询用户信息。

参数:: paramMap - 请求参数映射表
返回:: 包含分页数据的结果对象
抛出:: Exception - 查询过程中可能抛出的异常

select

@GetMapping(value="/select")
public ApiResult<List<Map<String,Object>>> select(String name)
                                                                         throws Exception

获取用户下拉列表。

参数:: name - 模糊匹配用户名的关键字（可选）
返回:: 用户列表结果对象
抛出:: Exception - 查询过程中的异常

getById

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

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

参数:: id - 用户唯一标识符
返回:: 用户详情结果对象
抛出:: SQLException - 数据库访问错误时抛出

update

@PostMapping(value="/update")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @OperationLog(value="\u4fee\u6539\u7528\u6237")
 @Permission(value="user:ad2d")
public ApiResult<String> update(@RequestBody
                                                                                                                                                                                                          Map<String,Object> userMap)
                                                                                                                                                                                                   throws Exception

更新用户信息。

参数:: userMap - 用户信息映射表
返回:: 成功或失败提示信息
抛出:: Exception - 处理过程中可能出现的异常

add

@PostMapping(value="/add")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @Permission(value="sys:user:save")
 @OperationLog(value="\u6dfb\u52a0\u7528\u6237")
public ApiResult<String> add(@RequestBody
                                                                                                                                                                                                        Map<String,Object> userMap)
                                                                                                                                                                                                 throws Exception

添加新用户。

参数:: userMap - 新增用户的信息映射表
返回:: 添加成功的提示信息
抛出:: Exception - 插入数据库或其他业务逻辑中出现的问题

delete

@PostMapping(value="/delete")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @OperationLog(value="\u5220\u9664\u7528\u6237")
 @Permission(value="sys:user:remove")
public ApiResult<String> delete(@RequestBody
                                                                                                                                                                                                                List<String> ids)
                                                                                                                                                                                                         throws Exception

删除指定ID的用户及其相关联的数据。

参数:: ids - 要删除的用户ID集合
返回:: 删除操作的结果消息
抛出:: Exception - 执行删除操作时发生的异常

updateSetting

@PostMapping(value="/updateSetting")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @Permission(value="ADMIN")
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(value="/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(value="/password")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @Permission(value="sys:user:change_pwd")
public ApiResult<String> password(@RequestBody
                                                                                                                                                                      Map<String,Object> paramMap)
                                                                                                                                                               throws SQLException

重置用户密码。

参数:: paramMap - 密码参数映射表
返回:: 密码重置成功的信息
抛出:: SQLException - 数据库操作异常

offline

@PostMapping(value="/offline")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @Permission(value="ADMIN")
public ApiResult<String> offline(@RequestBody
                                                                                                                                                      Map<String,Object> paramMap)
                                                                                                                                               throws SQLException

强制某位在线用户退出系统。

参数:: paramMap - 请求参数映射表
返回:: 下线成功的提示信息
抛出:: SQLException - 数据库操作异常

getThirdpartUserPage

@GetMapping(value="/getThirdpartUserPage")
 @Permission(value="")
public ApiResult getThirdpartUserPage(@RequestParam
                                                                                                          Map<String,Object> paramMap)
                                                                                                   throws SQLException

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

参数:: paramMap - 查询条件参数映射表
返回:: 第三方用户分页结果对象
抛出:: SQLException - 数据库访问异常

treeByUser
```
@PostMapping(value="/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

方法详细资料

page

select

getById

update

add

delete

updateSetting

getSetting

password

offline

getThirdpartUserPage

treeByUser