登录功能

## 前端代码
### 登录接口

> `rc/api/sys/user.ts`

作用是与后端控制器交互

```
export function loginApi(params: LoginParams): Promise<LoginResultModel> {
    return defHttp.post<LoginResultModel>(
        {
            url: Api.Login,
            params,
        },
        {
            contentType: ContentTypeEnum.FORM_URLENCODED,
            region,
        },
    );
}
```

### 登录方法

> `rc/store/modules/user.ts`

作用是登录并将返回的 Token 值保存到内存当中，并返回 userInfo 信息

```
        async login(params: LoginParams): Promise<GetUserInfoModel | null> {
            try {
                const data = await loginApi(params);
                const { token } = data;

// save token
                this.setToken(token);
                const userInfo = {
                    roles: data.roles.map((role) => {
                        return {
                            roleName: role,
                            value: role,
                        } as RoleInfo;
                    }),
                    name: data.user.name,
                };

await this.afterLoginAction(userInfo);

return userInfo;
            } catch (error) {
                return Promise.reject(error);
            }
        },
```

### 登录后置方法

> `src/store/modules/user.ts`

作用是检测是否登录成功，并将用户信息保存到内存中

```
        async afterLoginAction(userInfo): Promise<void> {
            if (!this.getToken) return;

const userStore = useUserStore();
            userStore.setUserInfo(userInfo);

// 登录成功后跳转到ERP首页
            await router.replace(PageEnum.BASE_HOME);

return userInfo;
        },
```

## 后端代码
### 控制器层

> `liyade-template/src/main/java/tech/liyade/erp/template/inner/controller/AuthController.java`

```
    @ApiOperation("登录")
    @OpenApi
    @PostMapping("/auth/login")
    public InvokeResult<LoginBo> login(@Valid LoginVo vo) {

// 账号
        String username = vo.getUsername();
        // 密码
        String password = vo.getPassword();
        // 租户ID
        String tenantId = null;

// 判断：是否启用多租户，开启返回 true , 未开启返回 false
        if (TenantUtil.enableTenant()) {

// 多用户账号是 tenantId + @ + username
            // 根据 @ 分开 tenantId 和 username
            String[] tmpArr = username.split("@");

// 如果分开后的字符串数组小于等于 1 ，就抛出错误提示
            if (tmpArr.length <= 1) {
                throw new DefaultClientException("用户名或密码错误！");
            }

// 将字符串数组中的 tenantId 和 username 赋值
            tenantId = tmpArr[0];
            username = tmpArr[1];

// 检查租户是否存在，如果不存在就抛出错误提示
            Tenant tenant = tenantService.getById(tenantId);
            if (tenant == null) {
                throw new DefaultClientException("用户名或密码错误！");
            }

// 判断当前租户是否停用，停用就抛出错误提示
            if (!tenant.getAvailable()) {
                throw new DefaultClientException("用户已停用，无法登录！");
            }

// 向当前线程中设置登录者的租户ID
            TenantContextHolder.setTenantId(tenant.getId());
        }

// 输出登录日志
        log.info("用户 {} {} 开始登录", tenantId, username);

// 获取登录时是否需要验证码，true：需要；false：不需要。
        String loginCaptchaEnabled = sysParameterService.findByKey("login-captcha.enabled", "true");
        
        // 输出日志
        log.info("当前用户登录需要验证码 = {}", loginCaptchaEnabled);
        
        // 判断是否需要验证码，如果需要就判断验证码
        if (Boolean.valueOf(loginCaptchaEnabled)) {
            String sn = vo.getSn();
            String captcha = vo.getCaptcha();
            captchaValidator.validate(sn, captcha);
        }

// 验证租户、账号、密码是否正确
        this.checkUserLogin(tenantId == null ? null : Integer.valueOf(tenantId), username, password);

// 根据用户名称获取用户详细信息
        AbstractUserDetails user = userDetailsService.loadUserByUsername(username);

// 检测当前用户是否可以正常登录
        LoginDto dto = this.doLogin(user);

// 向 seesion 中设置用户等信息
        this.addAttributesToSession(user);

// 返回用户信息
        return InvokeResultBuilder.success(new LoginBo(dto));
    }
```

### 服务层

接口类

> `liyade-dependencies/liyade-dependencies-web-starter/src/main/java/tech/liyade/starter/web/components/security/UserDetailsService.java`

```
public interface UserDetailsService {

/**
     * 根据用户名查询 用于登录认证
     */
    AbstractUserDetails loadUserByUsername(String username) throws UserLoginException;

}
```

实现类

> `liyade-template/src/main/java/tech/liyade/erp/template/inner/impl/AbstractUserDetailsService.java`

```
    @Override
    public AbstractUserDetails loadUserByUsername(String username) throws UserLoginException {

// 根据登录名查询用户信息
        AbstractUserDetails userDetails = this.findByUsername(username);

// 判断是否有该用户
        if (ObjectUtil.isEmpty(userDetails)) {
            log.debug("用户名 {} 不存在", username);
            throw new UserLoginException("用户名或密码错误！");
        }

// 将租户ID赋值到用户信息里
        userDetails.setTenantId(TenantContextHolder.getTenantId());

// 获取登录IP，并赋值到用户信息里
        userDetails.setIp(RequestUtil.getRequestIp());

// 定义租户模块列表容器
        List<Integer> moduleIds = null;

// 如果开启多租户功能
        if (TenantUtil.enableTenant()) {
            // 获取当前租户可以使用的模块
            moduleIds = sysModuleTenantService.getAvailableModuleIdsByTenantId(
                    TenantContextHolder.getTenantId());
        }

// 先取角色的权限
        userDetails.setPermissions(sysMenuService.getRolePermissionByUserId(userDetails.getId()));

// 判断当前用户是否是管理员
        userDetails.setIsAdmin(
                userDetails.getPermissions().contains(SecurityConstants.PERMISSION_ADMIN_NAME));

// 再取菜单的权限
        Set<String> permissions = sysMenuService.getPermissionsByUserId(userDetails.getId(),
                userDetails.isAdmin(), moduleIds);

// 合并权限：将菜单权限和角色权限合并
        permissions.addAll(userDetails.getPermissions());

// 是否移除内置权限，针对admin等内置权限，因为内置权限等同于通配符权限，设置为true时会用具体的权限将内置权限替换掉，生产环境建议设置为true
        if (this.removeFixedPermission) {
            permissions.remove(SecurityConstants.PERMISSION_ADMIN_NAME);
        }

// 将权限信息设置到用户详细信息中
        userDetails.setPermissions(permissions);

// 返回用户详细信息
        return userDetails;
    }
```

### 数据访问层

> `liyade-template/src/main/java/tech/liyade/erp/template/inner/mappers/UserDetailsMapper.java`

```
public interface UserDetailsMapper extends BaseMapper {

/**
     * 根据登录名查询
     */
    DefaultUserDetails findByUsername(String username);

}
```

> `liyade-template/src/main/resources/mappers/UserDetailsMapper.xml`

```
    <select id="findByUsername" resultType="tech.liyade.starter.web.common.security.DefaultUserDetails">
        SELECT id, username, password, name, email, telephone, available, lock_status FROM sys_user
        WHERE username = #{username}
    </select>
```

### 数据表

```
CREATE TABLE `sys_user` (
  `id` varchar(32) NOT NULL COMMENT 'ID',
  `code` varchar(20) NOT NULL COMMENT '编号',
  `name` varchar(20) NOT NULL COMMENT '姓名',
  `username` varchar(30) NOT NULL COMMENT '用户名',
  `password` varchar(100) NOT NULL COMMENT '密码',
  `email` varchar(100) DEFAULT NULL COMMENT '邮箱',
  `telephone` varchar(11) DEFAULT NULL COMMENT '联系电话',
  `gender` tinyint(3) NOT NULL DEFAULT '0' COMMENT '性别 0-未知 1-男 2-女',
  `available` tinyint(1) NOT NULL DEFAULT '1' COMMENT '状态 1-在用 0停用',
  `lock_status` tinyint(1) NOT NULL DEFAULT '0' COMMENT '锁定状态',
  `description` varchar(200) NOT NULL DEFAULT '' COMMENT '备注',
  `create_by` varchar(32) NOT NULL COMMENT '创建人',
  `create_by_id` varchar(32) NOT NULL COMMENT '创建人ID',
  `create_time` datetime NOT NULL COMMENT '创建时间',
  `update_by` varchar(32) NOT NULL COMMENT '修改人',
  `update_by_id` varchar(32) NOT NULL COMMENT '修改人ID',
  `update_time` datetime NOT NULL COMMENT '修改时间',
  PRIMARY KEY (`id`) USING BTREE,
  UNIQUE KEY `code` (`code`) USING BTREE,
  UNIQUE KEY `username` (`username`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci ROW_FORMAT=DYNAMIC COMMENT='用户';
```