cn.bootx.platform.starter.auth.util.SecurityUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-starter-auth Show documentation
There is a newer version: 1.3.6.2
package cn.bootx.platform.starter.auth.util;

import cn.bootx.platform.common.core.code.CommonCode;
import cn.bootx.platform.common.core.entity.UserDetail;
import cn.bootx.platform.starter.auth.cache.SessionCacheLocal;
import cn.bootx.platform.starter.auth.exception.NotLoginException;
import cn.dev33.satoken.exception.SaTokenException;
import cn.dev33.satoken.stp.StpUtil;
import cn.hutool.core.util.DesensitizedUtil;
import lombok.experimental.UtilityClass;
import org.springframework.lang.Nullable;

import javax.servlet.http.HttpServletRequest;
import java.util.Optional;

/**
 * 安全工具类
 *
 * @author xxm
 * @since 2021/8/2
 */
@UtilityClass
public class SecurityUtil {

    private final String LOGIN_TYPE_PARAMETER = "loginType";

    private final String CLIENT_PARAMETER = "client";

    /**
     * 获取当前用户,无异常
     * @return 当前登录用户
     */
    public Optional getCurrentUser() {
        return getCurrentUser0();
    }

    /**
     * 获取当前用户,无异常
     * @return 当前登录用户的id,如未登录
     */
    public Long getUserIdOrDefaultId() {
        return getCurrentUser().map(UserDetail::getId).orElse(DesensitizedUtil.userId());
    }

    /**
     * 获取用户id
     * @throws NotLoginException 未登录异常
     */
    public Long getUserId() {
        return getCurrentUser().map(UserDetail::getId).orElseThrow(NotLoginException::new);
    }

    /**
     * 获取用户
     * @throws NotLoginException 未登录异常
     */
    public UserDetail getUser() {
        return getCurrentUser().orElseThrow(NotLoginException::new);
    }

    /**
     * 获取登录方式 异步环境中获取会有问题
     */
    @Nullable
    public String getLoginType(HttpServletRequest request) {
        return request.getParameter(LOGIN_TYPE_PARAMETER);
    }

    /**
     * 获取终端Code 异步环境中获取会有问题
     */
    @Nullable
    public String getClient(HttpServletRequest request) {
        return request.getParameter(CLIENT_PARAMETER);
    }

    /**
     * 获取当前用户,无异常, 使用线程缓存来减少redis的访问频率
     */
    private Optional getCurrentUser0() {
        Optional userDetail = Optional.ofNullable(SessionCacheLocal.getUserInfo());
        if (!userDetail.isPresent()) {
            try {
                userDetail = Optional.ofNullable(StpUtil.getSession())
                    .map(saSession -> saSession.getModel(CommonCode.USER, UserDetail.class));
                SessionCacheLocal.putUserInfo(userDetail.orElse(null));
            }
            catch (SaTokenException e) {
                userDetail = Optional.empty();
            }
        }
        return userDetail;
    }

}