package org.dromara.web.service;
|
|
import cn.dev33.satoken.exception.NotLoginException;
|
import cn.dev33.satoken.secure.BCrypt;
|
import cn.dev33.satoken.stp.StpUtil;
|
import cn.hutool.core.bean.BeanUtil;
|
import cn.hutool.core.util.ObjectUtil;
|
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
|
import jakarta.servlet.http.HttpServletRequest;
|
import lombok.RequiredArgsConstructor;
|
import lombok.extern.slf4j.Slf4j;
|
import me.zhyd.oauth.model.AuthResponse;
|
import me.zhyd.oauth.model.AuthUser;
|
import org.dromara.common.core.constant.Constants;
|
import org.dromara.common.core.constant.GlobalConstants;
|
import org.dromara.common.core.constant.TenantConstants;
|
import org.dromara.common.core.domain.R;
|
import org.dromara.common.core.domain.dto.RoleDTO;
|
import org.dromara.common.core.domain.model.LoginUser;
|
import org.dromara.common.core.domain.model.XcxLoginUser;
|
import org.dromara.common.core.enums.DeviceType;
|
import org.dromara.common.core.enums.LoginType;
|
import org.dromara.common.core.enums.TenantStatus;
|
import org.dromara.common.core.enums.UserStatus;
|
import org.dromara.common.core.exception.user.CaptchaException;
|
import org.dromara.common.core.exception.user.CaptchaExpireException;
|
import org.dromara.common.core.exception.user.UserException;
|
import org.dromara.common.core.utils.*;
|
import org.dromara.common.log.event.LogininforEvent;
|
import org.dromara.common.redis.utils.RedisUtils;
|
import org.dromara.common.satoken.utils.LoginHelper;
|
import org.dromara.common.tenant.exception.TenantException;
|
import org.dromara.common.tenant.helper.TenantHelper;
|
import org.dromara.common.web.config.properties.CaptchaProperties;
|
import org.dromara.system.domain.SysUser;
|
import org.dromara.system.domain.bo.SocialUserBo;
|
import org.dromara.system.domain.vo.SocialUserVo;
|
import org.dromara.system.domain.vo.SysTenantVo;
|
import org.dromara.system.domain.vo.SysUserVo;
|
import org.dromara.system.mapper.SysUserMapper;
|
import org.dromara.system.service.ISocialUserService;
|
import org.dromara.system.service.ISysPermissionService;
|
import org.dromara.system.service.ISysTenantService;
|
import org.dromara.system.service.ISysUserService;
|
import org.springframework.beans.BeanUtils;
|
import org.springframework.beans.factory.annotation.Value;
|
import org.springframework.stereotype.Service;
|
|
import java.io.IOException;
|
import java.time.Duration;
|
import java.util.Date;
|
import java.util.List;
|
import java.util.function.Supplier;
|
|
/**
|
* 登录校验方法
|
*
|
* @author Lion Li
|
*/
|
@RequiredArgsConstructor
|
@Slf4j
|
@Service
|
public class SysLoginService {
|
|
private final SysUserMapper userMapper;
|
private final ISocialUserService socialUserService;
|
private final CaptchaProperties captchaProperties;
|
private final ISysPermissionService permissionService;
|
private final ISysTenantService tenantService;
|
|
@Value("${user.password.maxRetryCount}")
|
private Integer maxRetryCount;
|
|
@Value("${user.password.lockTime}")
|
private Integer lockTime;
|
|
/**
|
* 登录验证
|
*
|
* @param username 用户名
|
* @param password 密码
|
* @param code 验证码
|
* @param uuid 唯一标识
|
* @return 结果
|
*/
|
public String login(String tenantId, String username, String password, String code, String uuid) {
|
boolean captchaEnabled = captchaProperties.getEnable();
|
// 验证码开关
|
if (captchaEnabled) {
|
validateCaptcha(tenantId, username, code, uuid);
|
}
|
// 校验租户
|
checkTenant(tenantId);
|
|
// 框架登录不限制从什么表查询 只要最终构建出 LoginUser 即可
|
SysUserVo user = loadUserByUsername(tenantId, username);
|
checkLogin(LoginType.PASSWORD, tenantId, username, () -> !BCrypt.checkpw(password, user.getPassword()));
|
// 此处可根据登录用户的数据不同 自行创建 loginUser 属性不够用继承扩展就行了
|
LoginUser loginUser = buildLoginUser(user);
|
// 生成token
|
LoginHelper.loginByDevice(loginUser, DeviceType.PC);
|
|
recordLogininfor(loginUser.getTenantId(), username, Constants.LOGIN_SUCCESS, MessageUtils.message("user.login.success"));
|
recordLoginInfo(user.getUserId());
|
return StpUtil.getTokenValue();
|
}
|
|
public String smsLogin(String tenantId, String phonenumber, String smsCode) {
|
// 校验租户
|
checkTenant(tenantId);
|
// 通过手机号查找用户
|
SysUserVo user = loadUserByPhonenumber(tenantId, phonenumber);
|
|
checkLogin(LoginType.SMS, tenantId, user.getUserName(), () -> !validateSmsCode(tenantId, phonenumber, smsCode));
|
// 此处可根据登录用户的数据不同 自行创建 loginUser 属性不够用继承扩展就行了
|
LoginUser loginUser = buildLoginUser(user);
|
// 生成token
|
LoginHelper.loginByDevice(loginUser, DeviceType.APP);
|
|
recordLogininfor(loginUser.getTenantId(), user.getUserName(), Constants.LOGIN_SUCCESS, MessageUtils.message("user.login.success"));
|
recordLoginInfo(user.getUserId());
|
return StpUtil.getTokenValue();
|
}
|
|
public String emailLogin(String tenantId, String email, String emailCode) {
|
// 校验租户
|
checkTenant(tenantId);
|
// 通过邮箱查找用户
|
SysUserVo user = loadUserByEmail(tenantId, email);
|
|
checkLogin(LoginType.EMAIL, tenantId, user.getUserName(), () -> !validateEmailCode(tenantId, email, emailCode));
|
// 此处可根据登录用户的数据不同 自行创建 loginUser 属性不够用继承扩展就行了
|
LoginUser loginUser = buildLoginUser(user);
|
// 生成token
|
LoginHelper.loginByDevice(loginUser, DeviceType.APP);
|
|
recordLogininfor(loginUser.getTenantId(), user.getUserName(), Constants.LOGIN_SUCCESS, MessageUtils.message("user.login.success"));
|
recordLoginInfo(user.getUserId());
|
return StpUtil.getTokenValue();
|
}
|
|
|
public String xcxLogin(String xcxCode) {
|
// xcxCode 为 小程序调用 wx.login 授权后获取
|
// todo 以下自行实现
|
// 校验 appid + appsrcret + xcxCode 调用登录凭证校验接口 获取 session_key 与 openid
|
String openid = "";
|
// 框架登录不限制从什么表查询 只要最终构建出 LoginUser 即可
|
SysUserVo user = loadUserByOpenid(openid);
|
// 校验租户
|
checkTenant(user.getTenantId());
|
|
// 此处可根据登录用户的数据不同 自行创建 loginUser 属性不够用继承扩展就行了
|
XcxLoginUser loginUser = new XcxLoginUser();
|
loginUser.setTenantId(user.getTenantId());
|
loginUser.setUserId(user.getUserId());
|
loginUser.setUsername(user.getUserName());
|
loginUser.setUserType(user.getUserType());
|
loginUser.setOpenid(openid);
|
// 生成token
|
LoginHelper.loginByDevice(loginUser, DeviceType.XCX);
|
|
recordLogininfor(loginUser.getTenantId(), user.getUserName(), Constants.LOGIN_SUCCESS, MessageUtils.message("user.login.success"));
|
recordLoginInfo(user.getUserId());
|
return StpUtil.getTokenValue();
|
}
|
|
/**
|
* 社交登录
|
*
|
* @param source 登录来源
|
* @param authUser 授权响应实体
|
* @param request Http请求对象
|
* @return 统一响应实体
|
*/
|
public R<String> socialLogin(String source, AuthResponse<AuthUser> authUser, HttpServletRequest request) {
|
// 判断授权响应是否成功
|
if (!authUser.ok()) {
|
return R.fail("对不起，授权信息验证不通过，请退出重试！");
|
}
|
AuthUser authUserData = authUser.getData();
|
SocialUserVo user = socialUserService.selectSocialUserByAuthId(authUserData.getSource() + authUserData.getUuid());
|
if (ObjectUtil.isNotNull(user)) {
|
//执行登录和记录登录信息操作
|
return loginAndRecord(user.getTenantId(), user.getUserName(), authUserData);
|
} else {
|
// 判断是否已登录
|
if (LoginHelper.getUserId() == null) {
|
return R.fail("授权失败，请先登录才能绑定");
|
}
|
SocialUserBo socialUserBo = new SocialUserBo();
|
socialUserBo.setUserId(LoginHelper.getUserId());
|
socialUserBo.setAuthId(authUserData.getSource() + authUserData.getUuid());
|
socialUserBo.setSource(authUserData.getSource());
|
socialUserBo.setUserName(authUserData.getUsername());
|
socialUserBo.setNickName(authUserData.getNickname());
|
socialUserBo.setAvatar(authUserData.getAvatar());
|
socialUserBo.setOpenId(authUserData.getUuid());
|
BeanUtils.copyProperties(authUserData.getToken(), socialUserBo);
|
|
socialUserService.insertByBo(socialUserBo);
|
SysUserVo lodingData = loadUserByUsername(LoginHelper.getTenantId(), LoginHelper.getUsername());
|
//执行登录和记录登录信息操作
|
return loginAndRecord(lodingData.getTenantId(), socialUserBo.getUserName(), authUserData);
|
}
|
}
|
|
/**
|
* 执行登录和记录登录信息操作
|
*
|
* @param tenantId 租户ID
|
* @param userName 用户名
|
* @param authUser 授权用户信息
|
* @return 统一响应实体
|
*/
|
private R<String> loginAndRecord(String tenantId, String userName, AuthUser authUser) {
|
checkTenant(tenantId);
|
SysUserVo dbUser = loadUserByUsername(tenantId, userName);
|
LoginHelper.loginByDevice(buildLoginUser(dbUser), DeviceType.SOCIAL);
|
recordLogininfor(dbUser.getTenantId(), userName, Constants.LOGIN_SUCCESS, MessageUtils.message("user.login.success"));
|
recordLoginInfo(dbUser.getUserId());
|
return R.ok(StpUtil.getTokenValue());
|
}
|
|
/**
|
* 退出登录
|
*/
|
public void logout() {
|
try {
|
LoginUser loginUser = LoginHelper.getLoginUser();
|
if (TenantHelper.isEnable() && LoginHelper.isSuperAdmin()) {
|
// 超级管理员 登出清除动态租户
|
TenantHelper.clearDynamic();
|
}
|
StpUtil.logout();
|
recordLogininfor(loginUser.getTenantId(), loginUser.getUsername(), Constants.LOGOUT, MessageUtils.message("user.logout.success"));
|
} catch (NotLoginException ignored) {
|
}
|
}
|
|
/**
|
* 记录登录信息
|
*
|
* @param tenantId 租户ID
|
* @param username 用户名
|
* @param status 状态
|
* @param message 消息内容
|
*/
|
private void recordLogininfor(String tenantId, String username, String status, String message) {
|
LogininforEvent logininforEvent = new LogininforEvent();
|
logininforEvent.setTenantId(tenantId);
|
logininforEvent.setUsername(username);
|
logininforEvent.setStatus(status);
|
logininforEvent.setMessage(message);
|
logininforEvent.setRequest(ServletUtils.getRequest());
|
SpringUtils.context().publishEvent(logininforEvent);
|
}
|
|
/**
|
* 校验短信验证码
|
*/
|
private boolean validateSmsCode(String tenantId, String phonenumber, String smsCode) {
|
String code = RedisUtils.getCacheObject(GlobalConstants.CAPTCHA_CODE_KEY + phonenumber);
|
if (StringUtils.isBlank(code)) {
|
recordLogininfor(tenantId, phonenumber, Constants.LOGIN_FAIL, MessageUtils.message("user.jcaptcha.expire"));
|
throw new CaptchaExpireException();
|
}
|
return code.equals(smsCode);
|
}
|
|
/**
|
* 校验邮箱验证码
|
*/
|
private boolean validateEmailCode(String tenantId, String email, String emailCode) {
|
String code = RedisUtils.getCacheObject(GlobalConstants.CAPTCHA_CODE_KEY + email);
|
if (StringUtils.isBlank(code)) {
|
recordLogininfor(tenantId, email, Constants.LOGIN_FAIL, MessageUtils.message("user.jcaptcha.expire"));
|
throw new CaptchaExpireException();
|
}
|
return code.equals(emailCode);
|
}
|
|
/**
|
* 校验验证码
|
*
|
* @param username 用户名
|
* @param code 验证码
|
* @param uuid 唯一标识
|
*/
|
public void validateCaptcha(String tenantId, String username, String code, String uuid) {
|
String verifyKey = GlobalConstants.CAPTCHA_CODE_KEY + StringUtils.defaultString(uuid, "");
|
String captcha = RedisUtils.getCacheObject(verifyKey);
|
RedisUtils.deleteObject(verifyKey);
|
if (captcha == null) {
|
recordLogininfor(tenantId, username, Constants.LOGIN_FAIL, MessageUtils.message("user.jcaptcha.expire"));
|
throw new CaptchaExpireException();
|
}
|
if (!code.equalsIgnoreCase(captcha)) {
|
recordLogininfor(tenantId, username, Constants.LOGIN_FAIL, MessageUtils.message("user.jcaptcha.error"));
|
throw new CaptchaException();
|
}
|
}
|
|
private SysUserVo loadUserByUsername(String tenantId, String username) {
|
SysUser user = userMapper.selectOne(new LambdaQueryWrapper<SysUser>()
|
.select(SysUser::getUserName, SysUser::getStatus)
|
.eq(TenantHelper.isEnable(), SysUser::getTenantId, tenantId)
|
.eq(SysUser::getUserName, username));
|
if (ObjectUtil.isNull(user)) {
|
log.info("登录用户：{} 不存在.", username);
|
throw new UserException("user.not.exists", username);
|
} else if (UserStatus.DISABLE.getCode().equals(user.getStatus())) {
|
log.info("登录用户：{} 已被停用.", username);
|
throw new UserException("user.blocked", username);
|
}
|
if (TenantHelper.isEnable()) {
|
return userMapper.selectTenantUserByUserName(username, tenantId);
|
}
|
return userMapper.selectUserByUserName(username);
|
}
|
|
private SysUserVo loadUserByPhonenumber(String tenantId, String phonenumber) {
|
SysUser user = userMapper.selectOne(new LambdaQueryWrapper<SysUser>()
|
.select(SysUser::getPhonenumber, SysUser::getStatus)
|
.eq(TenantHelper.isEnable(), SysUser::getTenantId, tenantId)
|
.eq(SysUser::getPhonenumber, phonenumber));
|
if (ObjectUtil.isNull(user)) {
|
log.info("登录用户：{} 不存在.", phonenumber);
|
throw new UserException("user.not.exists", phonenumber);
|
} else if (UserStatus.DISABLE.getCode().equals(user.getStatus())) {
|
log.info("登录用户：{} 已被停用.", phonenumber);
|
throw new UserException("user.blocked", phonenumber);
|
}
|
if (TenantHelper.isEnable()) {
|
return userMapper.selectTenantUserByPhonenumber(phonenumber, tenantId);
|
}
|
return userMapper.selectUserByPhonenumber(phonenumber);
|
}
|
|
private SysUserVo loadUserByEmail(String tenantId, String email) {
|
SysUser user = userMapper.selectOne(new LambdaQueryWrapper<SysUser>()
|
.select(SysUser::getEmail, SysUser::getStatus)
|
.eq(TenantHelper.isEnable(), SysUser::getTenantId, tenantId)
|
.eq(SysUser::getEmail, email));
|
if (ObjectUtil.isNull(user)) {
|
log.info("登录用户：{} 不存在.", email);
|
throw new UserException("user.not.exists", email);
|
} else if (UserStatus.DISABLE.getCode().equals(user.getStatus())) {
|
log.info("登录用户：{} 已被停用.", email);
|
throw new UserException("user.blocked", email);
|
}
|
if (TenantHelper.isEnable()) {
|
return userMapper.selectTenantUserByEmail(email, tenantId);
|
}
|
return userMapper.selectUserByEmail(email);
|
}
|
|
private SysUserVo loadUserByOpenid(String openid) {
|
// 使用 openid 查询绑定用户 如未绑定用户 则根据业务自行处理 例如 创建默认用户
|
// todo 自行实现 userService.selectUserByOpenid(openid);
|
SysUserVo user = new SysUserVo();
|
if (ObjectUtil.isNull(user)) {
|
log.info("登录用户：{} 不存在.", openid);
|
// todo 用户不存在 业务逻辑自行实现
|
} else if (UserStatus.DISABLE.getCode().equals(user.getStatus())) {
|
log.info("登录用户：{} 已被停用.", openid);
|
// todo 用户已被停用 业务逻辑自行实现
|
}
|
return user;
|
}
|
|
/**
|
* 构建登录用户
|
*/
|
private LoginUser buildLoginUser(SysUserVo user) {
|
LoginUser loginUser = new LoginUser();
|
loginUser.setTenantId(user.getTenantId());
|
loginUser.setUserId(user.getUserId());
|
loginUser.setDeptId(user.getDeptId());
|
loginUser.setUsername(user.getUserName());
|
loginUser.setUserType(user.getUserType());
|
loginUser.setMenuPermission(permissionService.getMenuPermission(user.getUserId()));
|
loginUser.setRolePermission(permissionService.getRolePermission(user.getUserId()));
|
loginUser.setDeptName(ObjectUtil.isNull(user.getDept()) ? "" : user.getDept().getDeptName());
|
List<RoleDTO> roles = BeanUtil.copyToList(user.getRoles(), RoleDTO.class);
|
loginUser.setRoles(roles);
|
return loginUser;
|
}
|
|
/**
|
* 记录登录信息
|
*
|
* @param userId 用户ID
|
*/
|
public void recordLoginInfo(Long userId) {
|
SysUser sysUser = new SysUser();
|
sysUser.setUserId(userId);
|
sysUser.setLoginIp(ServletUtils.getClientIP());
|
sysUser.setLoginDate(DateUtils.getNowDate());
|
sysUser.setUpdateBy(userId);
|
userMapper.updateById(sysUser);
|
}
|
|
/**
|
* 登录校验
|
*/
|
private void checkLogin(LoginType loginType, String tenantId, String username, Supplier<Boolean> supplier) {
|
String errorKey = GlobalConstants.PWD_ERR_CNT_KEY + username;
|
String loginFail = Constants.LOGIN_FAIL;
|
|
// 获取用户登录错误次数，默认为0 (可自定义限制策略 例如: key + username + ip)
|
int errorNumber = ObjectUtil.defaultIfNull(RedisUtils.getCacheObject(errorKey), 0);
|
// 锁定时间内登录 则踢出
|
if (errorNumber >= maxRetryCount) {
|
recordLogininfor(tenantId, username, loginFail, MessageUtils.message(loginType.getRetryLimitExceed(), maxRetryCount, lockTime));
|
throw new UserException(loginType.getRetryLimitExceed(), maxRetryCount, lockTime);
|
}
|
|
if (supplier.get()) {
|
// 错误次数递增
|
errorNumber++;
|
RedisUtils.setCacheObject(errorKey, errorNumber, Duration.ofMinutes(lockTime));
|
// 达到规定错误次数 则锁定登录
|
if (errorNumber >= maxRetryCount) {
|
recordLogininfor(tenantId, username, loginFail, MessageUtils.message(loginType.getRetryLimitExceed(), maxRetryCount, lockTime));
|
throw new UserException(loginType.getRetryLimitExceed(), maxRetryCount, lockTime);
|
} else {
|
// 未达到规定错误次数
|
recordLogininfor(tenantId, username, loginFail, MessageUtils.message(loginType.getRetryLimitCount(), errorNumber));
|
throw new UserException(loginType.getRetryLimitCount(), errorNumber);
|
}
|
}
|
|
// 登录成功 清空错误次数
|
RedisUtils.deleteObject(errorKey);
|
}
|
|
private void checkTenant(String tenantId) {
|
if (!TenantHelper.isEnable()) {
|
return;
|
}
|
if (TenantConstants.DEFAULT_TENANT_ID.equals(tenantId)) {
|
return;
|
}
|
SysTenantVo tenant = tenantService.queryByTenantId(tenantId);
|
if (ObjectUtil.isNull(tenant)) {
|
log.info("登录租户：{} 不存在.", tenantId);
|
throw new TenantException("tenant.not.exists");
|
} else if (TenantStatus.DISABLE.getCode().equals(tenant.getStatus())) {
|
log.info("登录租户：{} 已被停用.", tenantId);
|
throw new TenantException("tenant.blocked");
|
} else if (ObjectUtil.isNotNull(tenant.getExpireTime())
|
&& new Date().after(tenant.getExpireTime())) {
|
log.info("登录租户：{} 已超过有效期.", tenantId);
|
throw new TenantException("tenant.expired");
|
}
|
}
|
|
}
|
