top.dcenter.ums.security.core.api.tenant.handler

接口 TenantContextHolder

public interface TenantContextHolder

多租户上下文存储器. 实现此接口并注入 IOC 容器后, 会自动注入 UMS 默认实现的注册/登录/授权组件, 要实现 ums 框架具有多租户功能, 必须实现此接口并注入 IOC 容器.
功能:
1. tenantIdHandle(HttpServletRequest, String)从注册用户入口或登录用户入口提取 tenantId 及进行必要的逻辑处理(如: tenantId 存入 ThreadLocal, 或存入 session, 或存入 redis 缓存等).
2. getTenantId(),方便后续用户注册、登录、授权的数据处理(如：sql 添加 tenantId 的条件，注册用户添加 TENANT_tenantId 权限，根据 tenantId 获取角色的权限数据).
3. getTenantId(Authentication) 默认实现方法, 用户已登录的情况下, 获取租户 ID, 直接从 authority 中解析获取.
注意:
1. 多租户系统中, 在未登录时需要用到 tenantId 的接口, 如: UserCache.getUserFromCache(String)/UmsUserDetailsService 等接口, 可通过 getTenantId() 来获取 tenantId. 登录用户可以通过 Authentication 来获取 tenantId.
2. UMS 默认的登录与注册逻辑中, 都内置了 tenantIdHandle(HttpServletRequest, String) 逻辑, 用户在实现 UserCache/UmsUserDetailsService 等接口中需要 tenantId 时, 调用 getTenantId() 方法即可.
3. 如果自定义的注册或登录逻辑, 需要自己先调用 tenantIdHandle(HttpServletRequest, String) 逻辑, 再在 实现 UserCache/UmsUserDetailsService 等接口中需要 tenantId 时, 调用 getTenantId() 方法即可.

版本:

V2.0 Created by 2020.11.30 14:05

作者:

YongWu zheng

方法概要

限定符和类型	方法和说明
String	getTenantId() 获取租户 ID: 1.
default String	getTenantId(org.springframework.security.core.Authentication authentication) 用户已登录的情况下, 获取租户 ID, 直接从 authority 中解析获取.
default String	getTenantId(Collection<? extends org.springframework.security.core.GrantedAuthority> authorities) 通过 authorities 获取租户 ID, 直接从 authority 中解析获取.
default String	getTenantId(org.springframework.security.core.userdetails.UserDetails userDetails) 通过 UserDetails 获取租户 ID, 直接从 authority 中解析获取.
String	tenantIdHandle(javax.servlet.http.HttpServletRequest request, String tenantId) 提取 tenantId 及进行必要的逻辑处理(如: tenantId 存入 ThreadLocal, 或存入 session, 或存入 redis 缓存等), 方便后续调用.

方法详细资料

tenantIdHandle

@NonNull
String tenantIdHandle(@NonNull
                                javax.servlet.http.HttpServletRequest request,
                                @Nullable
                                String tenantId)
                         throws TenantIdNotFoundException

提取 tenantId 及进行必要的逻辑处理(如: tenantId 存入 ThreadLocal, 或存入 session, 或存入 redis 缓存等), 方便后续调用.

参数:

request - HttpServletRequest

tenantId - 租户 id, 有时候用户自定义登录/注册等接口时, 可能 tenantId 通过 uri 模板变量传递, 此时通过此参数传递, 省的对 HttpServletRequest 进行解析, 如果需要对 HttpServletRequest 进行解析时, 此参数为 null.

返回:

返回 tenantId

抛出:

TenantIdNotFoundException - 获取不到租户 ID 异常

getTenantId

@NonNull
String getTenantId()
                      throws TenantIdNotFoundException

获取租户 ID: 1. 未登录情况从缓存获取租户 ID(如: 从 ThreadLocal 中获取 tenantId, 或从 session 中获取 tenantId, 或从 redis 缓存中获取 tenantId等).
2. 已登录情况可以调用默认方法 getTenantId(Authentication)

 Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
 if (authentication != null && !(authentication instanceof AnonymousAuthenticationToken) && authentication.isAuthenticated()) {
     // 已登录用户获取租户 id
     return getTenantId(authentication);
 }
 

返回:

返回 tenantId

抛出:

TenantIdNotFoundException - 获取不到租户 ID 异常

getTenantId

@NonNull
default String getTenantId(@NonNull
                                     org.springframework.security.core.Authentication authentication)
                              throws TenantIdNotFoundException

用户已登录的情况下, 获取租户 ID, 直接从 authority 中解析获取.

参数:

authentication - Authentication 必须是登录成功的用户, 未登录用户直接抛 TenantIdNotFoundException 异常.

返回:

返回租户 id

抛出:

TenantIdNotFoundException - 获取不到租户 ID 异常

getTenantId

@NonNull
default String getTenantId(@NonNull
                                     org.springframework.security.core.userdetails.UserDetails userDetails)
                              throws TenantIdNotFoundException

通过 UserDetails 获取租户 ID, 直接从 authority 中解析获取.

参数:

userDetails - UserDetails

返回:

返回租户 id

抛出:

TenantIdNotFoundException - 获取不到租户 ID 异常

getTenantId

@Nullable
default String getTenantId(@NonNull
                                      Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

通过 authorities 获取租户 ID, 直接从 authority 中解析获取.

参数:

authorities - 用户权限列表

返回:

返回 tenantId 或 null.