top.dcenter.ums.security.core.api.service

接口 UmsUserDetailsService

所有超级接口:

UserDetailsRegisterService, org.springframework.security.core.userdetails.UserDetailsService

public interface UmsUserDetailsService
extends org.springframework.security.core.userdetails.UserDetailsService, UserDetailsRegisterService

用户名密码、手机短信登录、第三方授权登录及自动注册、用户注册服务：

1. 用于用户名密码登录与手机短信登录逻辑。

2. 用于用户名密码注册与手机短信注册逻辑。

3. 用于第三方登录注册逻辑。

注意: 如果是多租户系统, 注册或查询时通过 TenantContextHolder.getTenantId() 来获取租户 id, TenantContextHolder 需自己实现. 因为多租户授权逻辑必须要有 TENANT_tenantId Authority, 所以多租户注册时新用户时必须要添加 TENANT_tenantId Authority.

版本:

V1.0 Created by 2020/5/16 11:48

作者:

YongWu zheng

方法概要

限定符和类型	方法和说明
List<Boolean>	existedByUsernames(String... usernames) 在本地账户中检查是否存在 usernames, usernames 为本地账户的 usernames.
default String[]	generateUsernames(me.zhyd.oauth.model.AuthUser authUser) existedByUsernames(String...) usernames 生成规则.
org.springframework.security.core.userdetails.UserDetails	loadUserByUserId(String userId) 用于第三方登录时查询服务, userId 为本地账户的 userId, 如果是多租户系统, 查询时通过 TenantContextHolder.getTenantId() 来获取租户 id.

从接口继承的方法 org.springframework.security.core.userdetails.UserDetailsService

loadUserByUsername

从接口继承的方法 top.dcenter.ums.security.core.api.service.UserDetailsRegisterService

registerUser, registerUser, registerUser, registerUser

方法详细资料

loadUserByUserId

@NonNull
org.springframework.security.core.userdetails.UserDetails loadUserByUserId(@NonNull
                                                                                     String userId)
                                                                              throws org.springframework.security.core.userdetails.UsernameNotFoundException

用于第三方登录时查询服务, userId 为本地账户的 userId, 如果是多租户系统, 查询时通过 TenantContextHolder.getTenantId() 来获取租户 id.

参数:

userId - userId 为本地账户的 userId (必须具有唯一性, username 支持唯一索引, 也可以是 username)

返回:

the UserDetails requested, 注意 UserDetails.getUsername() 中的 username 即视为 userId

抛出:

org.springframework.security.core.userdetails.UsernameNotFoundException - 没有此 userId 的用户

另请参阅:

UserDetailsService.loadUserByUsername(String)

existedByUsernames

@NonNull
List<Boolean> existedByUsernames(@NonNull
                                           String... usernames)
                                    throws IOException

在本地账户中检查是否存在 usernames, usernames 为本地账户的 usernames. 如果是多租户系统, 查询时通过 TenantContextHolder.getTenantId() 来获取租户 id.
注意: 如果在你本地账户用户名允许重名, 直接都返回 true(List = [true, true, true])

参数:

usernames - usernames 为本地账户的 username, 一般通过调用 generateUsernames(AuthUser) 获取

返回:

usernames 是否存在的列表(true 表示存在), 与传入的 usernames 顺序一一对应

抛出:

IOException - 数据库查询异常

generateUsernames

@NonNull
default String[] generateUsernames(@NonNull
                                             me.zhyd.oauth.model.AuthUser authUser)

existedByUsernames(String...) usernames 生成规则. 如需自定义重新实现此逻辑

参数:

authUser - 第三方用户信息

返回:

返回一个 username 数组