net.sohelp.boot.dev.web.user

类 UserController

java.lang.Object

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

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

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

用户详情控制器，提供用户相关的操作接口。

从以下版本开始:

2022/5/13

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
UserController()

方法概要

限定符和类型	方法和说明
ApiResult<String>	changePassword(Map<String,Object> paramMap) 修改当前用户的登录密码。
ApiResult<Map<String,Object>>	detail() 获取当前用户的详细信息。
ApiResult<List<Map<String,Object>>>	getThirdpartConfig() 获取当前用户绑定的第三方平台配置列表。
ApiResult<String>	offline(Map<String,Object> paramMap) 强制指定用户下线。
ApiResult<String>	saveLang(Map<String,Object> paramMap) 保存用户的语言设置。
ApiResult<String>	saveSize(Map<String,Object> paramMap) 保存用户的界面尺寸设置。
ApiResult<String>	saveTheme(Map<String,Object> paramMap) 保存用户的界面主题设置。
ApiResult<String>	saveThirdpartConfig(Map<String,Object> paramMap) 保存或更新用户绑定的第三方平台配置。
ApiResult<String>	update(Map<String,Object> paramMap) 更新用户的基本信息。
ApiResult	updateLogo(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, success, success, success, success, validateToken

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

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

构造器详细资料

UserController

public UserController()

方法详细资料

updateLogo

@PostMapping(value="/updateLogo")
 @Permission(value="ADMIN")
public ApiResult updateLogo(@RequestBody
                                                                                            Map<String,Object> dataMap)
                                                                                     throws TokenAuthenticationException

更新用户的头像信息。 接收一个包含头像数据的Base64字符串，并将其保存为文件， 同时更新数据库中的用户头像字段。

参数:

dataMap - 包含头像数据的Map对象，其中"avatar"键对应Base64格式的图像数据

返回:

返回操作结果，成功则返回提示信息，失败则返回错误原因

抛出:

TokenAuthenticationException - 当认证失败时抛出异常

update

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

更新用户的基本信息。 根据传入的数据更新当前登录用户的地址、编号、姓名等基本信息。

参数:

paramMap - 包含要更新的用户信息的Map对象

返回:

返回操作结果，成功则返回提示信息

抛出:

Exception - 操作过程中可能发生的异常

getThirdpartConfig

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

获取当前用户绑定的第三方平台配置列表。

返回:

返回当前用户绑定的所有可用第三方平台的信息列表

抛出:

Exception - 操作过程中可能发生的异常

saveThirdpartConfig

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

保存或更新用户绑定的第三方平台配置。 支持手机号和邮箱两种类型的验证方式，在保存前会校验验证码的有效性。

参数:

paramMap - 包含第三方平台配置信息的Map对象

返回:

返回操作结果，成功则返回提示信息

抛出:

Exception - 操作过程中可能发生的异常

changePassword

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

修改当前用户的登录密码。 在修改之前会对原密码进行校验，并确保新密码与确认密码一致。

参数:

paramMap - 包含旧密码、新密码及确认密码的Map对象

返回:

返回操作结果，成功则返回提示信息

抛出:

SQLException - 数据库访问异常

TokenAuthenticationException - 认证失败时抛出异常

detail

@GetMapping(value="/detail")
 @Permission(value="ADMIN")
 @CrossOrigin(origins="*",
             maxAge=3600L)
public ApiResult<Map<String,Object>> detail()
                                                                                                                                                        throws Exception

获取当前用户的详细信息。 包括用户基础信息、组织机构信息、角色权限以及绑定的第三方平台等综合信息。

返回:

返回包含用户详细信息的结果对象

抛出:

Exception - 操作过程中可能发生的异常

offline

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

强制指定用户下线。 通过Sa-Token框架注销该用户的登录状态。

参数:

paramMap - 包含需要强制下线的用户ID的Map对象

返回:

返回操作结果，成功则返回提示信息

抛出:

SQLException - 数据库访问异常

saveTheme

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

保存用户的界面主题设置。

参数:

paramMap - 包含主题配置信息的Map对象

返回:

返回操作结果，成功则返回提示信息

抛出:

Exception - 操作过程中可能发生的异常

saveSize

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

保存用户的界面尺寸设置。

参数:

paramMap - 包含尺寸配置信息的Map对象

返回:

返回操作结果，成功则返回提示信息

抛出:

Exception - 操作过程中可能发生的异常

saveLang

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

保存用户的语言设置。

参数:

paramMap - 包含语言配置信息的Map对象

返回:

返回操作结果，成功则返回提示信息

抛出:

Exception - 操作过程中可能发生的异常