UserCache (SohelpBoot 1.1.15-SNAPSHOT API)

java.lang.Object
- net.sohelp.boot.admin.core.cache.UserCache

```
@Component
public class UserCache
extends Object
```
用户Cache

从以下版本开始:

2023/7/21 15:16

作者:

AaronFung

构造器概要

构造器
构造器和说明

UserCache()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`clear()` 清除全部用户缓存数据
`Map<String,Object>`	`getByLoginName(String userName)` 根据登录名获取用户信息
`Map<String,Object>`	`getByUserName(String userName)` 根据用户名从缓存中获取用户信息
`String`	`getLoginName(Long userId)` 根据用户ID获取其登录名
`String`	`getNickname(Long userId)` 根据用户ID获取其昵称
`Integer`	`getPowerType(Long userId)` 获取指定用户ID对应的权限类型
`Long`	`getTenantId(Long userId)` 获取指定用户所在的租户ID
`Map<String,Object>`	`getUser(long userId)` 获取指定用户ID的简短用户信息
`String`	`getUserAvatar(Long userId)` 获取指定用户ID的头像Base64编码
`Map<String,Object>`	`getUserMap(Long userId)` 根据用户ID获取完整用户信息
`String`	`getUserName(Long userId)` 根据用户ID获取其用户名
`String`	`getUserNo(Long userId)` 根据用户ID获取其用户编号
`List<Map<String,Object>>`	`getUsers(List<Long> users)` 根据多个用户ID批量获取用户基础信息
`boolean`	`isAdministrator(Long userId)` 判断给定用户是否是管理员角色
`boolean`	`isDeveloper(Long userId)` 判断给定用户是否是开发者角色
`boolean`	`isLoginEnabled(Long userId)` 判断账户是否处于启用状态
`List<Map<String,Object>>`	`list()` 获取所有用户列表
`void`	`reload()` 刷新整个用户缓存数据（清空后重新加载）
`void`	`reload(Object userId)` 根据特定用户ID刷新该用户的缓存数据
`void`	`remove(Object userId)` 删除指定用户ID在缓存中的条目

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

方法详细资料

list

@Comment(value="\u83b7\u53d6\u6240\u6709\u7528\u6237\u5217\u8868")
public List<Map<String,Object>> list()
                                                                                                  throws SQLException

获取所有用户列表

返回:: 所有用户的列表
抛出:: SQLException - 数据库查询异常时抛出

getByUserName
```
public Map<String,Object> getByUserName(String userName)
                                 throws SQLException
```
根据用户名从缓存中获取用户信息

参数:

userName - 用户名，用于匹配缓存中的用户记录

返回:

包含用户信息的Map对象，如果未找到则返回null

抛出:

SQLException - 如果数据库访问出现异常（虽然当前实现未直接使用数据库，但保留异常声明）

getByLoginName
```
public Map<String,Object> getByLoginName(String userName)
                                  throws SQLException
```
根据登录名获取用户信息

参数:

userName - 用户登录名

返回:

包含用户信息的Map对象，如果未找到则返回null

抛出:

SQLException - 如果数据库操作发生异常

getUser
```
@Comment(value="\u83b7\u53d6\u7528\u6237\u4fe1\u606f")
public Map<String,Object> getUser(long userId)
                                                                                   throws SQLException
```
获取指定用户ID的简短用户信息

参数:

userId - 用户ID

返回:

包含用户id、用户名和头像的基础信息映射表；若未找到则返回空HashMap

抛出:

SQLException - 数据库查询异常时抛出

getUsers
```
public List<Map<String,Object>> getUsers(List<Long> users)
                                  throws SQLException
```
根据多个用户ID批量获取用户基础信息

参数:

users - 用户ID列表

返回:

符合条件的所有用户基础信息列表

抛出:

SQLException - 数据库查询异常时抛出

reload

@Comment(value="\u542f\u52a8\uff0c\u521d\u59cb\u5316\u5230\u7f13\u5b58")
public void reload()
                                                                                      throws SQLException

刷新整个用户缓存数据（清空后重新加载）

抛出:: SQLException - 数据库查询异常时抛出

reload

@Comment(value="\u6839\u636e\u7528\u6237id\u521d\u59cb\u5316\u5230\u7f13\u5b58\u4e2d")
public void reload(Object userId)
                                                                                                    throws SQLException

根据特定用户ID刷新该用户的缓存数据

参数:: userId - 需要更新的用户ID
抛出:: SQLException - 数据库查询异常时抛出

getNickname

@Comment(value="\u83b7\u53d6\u7528\u6237\u59d3\u540d")
public String getNickname(Long userId)
                                                                           throws SQLException

根据用户ID获取其昵称

参数:: userId - 用户ID
返回:: 对应的昵称，如无对应记录则返回空字符串
抛出:: SQLException - 数据库查询异常时抛出

getPowerType

@Comment(value="\u83b7\u53d6\u7528\u6237\u6743\u9650\u7c7b\u578b")
public Integer getPowerType(Long userId)
                                                                                         throws SQLException

获取指定用户ID对应的权限类型

参数:: userId - 用户ID
返回:: 权限类型的整数值，如无对应记录则返回-1
抛出:: SQLException - 数据库查询异常时抛出

getUserName

@Comment(value="\u83b7\u53d6\u7528\u6237\u59d3\u540d")
public String getUserName(Long userId)
                                                                           throws SQLException

根据用户ID获取其用户名

参数:: userId - 用户ID
返回:: 对应的用户名，如无对应记录则返回空字符串
抛出:: SQLException - 数据库查询异常时抛出

getUserAvatar
```
@Comment(value="\u83b7\u53d6\u7528\u6237\u5934\u50cf")
public String getUserAvatar(Long userId)
                                                                             throws SQLException
```
获取指定用户ID的头像Base64编码

参数:

userId - 用户ID

返回:

头像的Base64编码字符串，如无对应记录则返回空字符串

抛出:

SQLException - 数据库查询异常时抛出

getUserNo

@Comment(value="\u83b7\u53d6\u7528\u6237\u7f16\u53f7")
public String getUserNo(Long userId)
                                                                         throws SQLException

根据用户ID获取其用户编号

参数:: userId - 用户ID
返回:: 对应的用户编号，如无对应记录则返回空字符串
抛出:: SQLException - 数据库查询异常时抛出

getLoginName

@Comment(value="\u6839\u636e\u7528\u6237ID\u83b7\u53d6\u767b\u5f55\u540d\u79f0")
public String getLoginName(Long userId)
                                                                                                      throws SQLException

根据用户ID获取其登录名

参数:: userId - 用户ID
返回:: 登录名，如无对应记录则返回空字符串
抛出:: SQLException - 数据库查询异常时抛出

getUserMap

@Comment(value="\u6839\u636e\u7528\u6237ID\u83b7\u53d6\u7528\u6237\u8be6\u60c5")
public Map<String,Object> getUserMap(Long userId)
                                                                                                                throws SQLException

根据用户ID获取完整用户信息

参数:: userId - 用户ID
返回:: 完整用户信息Map对象，如无对应记录则返回空HashMap
抛出:: SQLException - 数据库查询异常时抛出

isDeveloper

@Comment(value="\u662f\u5426\u4e3a\u5f00\u53d1\u4eba\u5458")
public boolean isDeveloper(Long userId)
                                                                                  throws SQLException

判断给定用户是否是开发者角色

参数:: userId - 用户ID
返回:: true表示是开发者，false表示不是
抛出:: SQLException - 数据库查询异常时抛出

isAdministrator

@Comment(value="\u662f\u5426\u4e3a\u7ba1\u7406\u5458")
public boolean isAdministrator(Long userId)
                                                                                throws SQLException

判断给定用户是否是管理员角色

参数:: userId - 用户ID
返回:: true表示是管理员，false表示不是
抛出:: SQLException - 数据库查询异常时抛出

isLoginEnabled

@Comment(value="\u662f\u5426\u542f\u7528\u5e10\u6237")
public boolean isLoginEnabled(Long userId)
                                                                               throws SQLException

判断账户是否处于启用状态

参数:: userId - 用户ID
返回:: true表示已启用，false表示被禁用
抛出:: SQLException - 数据库查询异常时抛出

getTenantId

@Comment(value="\u6839\u636e\u7528\u6237ID\u83b7\u53d6\u7528\u6237\u5f53\u524d\u6240\u5728\u79df\u6237ID")
public Long getTenantId(Long userId)
                                                                                                                             throws SQLException

获取指定用户所在的租户ID

参数:: userId - 用户ID
返回:: 租户ID，如无对应记录则返回null
抛出:: SQLException - 数据库查询异常时抛出

clear

@Comment(value="\u6e05\u7a7a\u7528\u6237\u7f13\u5b58")
public void clear()

清除全部用户缓存数据

remove

@Comment(value="\u6839\u636e\u7528\u6237ID\u6e05\u7a7a\u7528\u6237\u7f13\u5b58")
public void remove(Object userId)

删除指定用户ID在缓存中的条目

参数:: userId - 用户ID

类 UserCache

构造器概要

方法概要

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

构造器详细资料

UserCache

方法详细资料

list

getByUserName

getByLoginName

getUser

getUsers

reload

reload

getNickname

getPowerType

getUserName

getUserAvatar

getUserNo

getLoginName

getUserMap

isDeveloper

isAdministrator

isLoginEnabled

getTenantId

clear

remove