refactor: 代码重构优化(VueUse使用)

Former-commit-id: f33b8d352dd9e9b2a706c94cdd7afa150ac12931

src/api/auth/index.ts

@@ -1,13 +1,13 @@
 import request from '@/utils/request';
 import { AxiosPromise } from 'axios';
-import { ILoginData, TokenResult, VerifyCode } from './types';
+import { LoginData, LoginResult } from './types';
 
 /**
  *
- * @param data {LoginForm}
+ * @param data {LoginData}
  * @returns
  */
-export function loginApi(data: ILoginData): AxiosPromise<TokenResult> {
+export function loginApi(data: LoginData): AxiosPromise<LoginResult> {
   return request({
     url: '/api/v1/auth/login',
     method: 'post',
@@ -24,13 +24,3 @@ export function logoutApi() {
     method: 'delete'
   });
 }
-
-/**
- * 获取图片验证码
- */
-export function getCaptcha(): AxiosPromise<VerifyCode> {
-  return request({
-    url: '/captcha?t=' + new Date().getTime().toString(),
-    method: 'get'
-  });
-}

src/api/auth/types.ts

@@ -1,23 +1,15 @@
 /**
- * 登录数据类型
+ * 登录请求
  */
-export interface ILoginData  {
+export interface LoginData {
   username: string;
   password: string;
-  /**
-   * 验证码Code
-   */
-  //verifyCode: string;
-  /**
-   * 验证码Code服务端缓存key(UUID)
-   */
-  // verifyCodeKey: string;
 }
 
 /**
- * Token响应类型
+ * 登录详情
  */
-export interface TokenResult {
+export interface LoginResult {
   accessToken: string;
   refreshToken: string;
   expires: number;

src/api/user/index.ts

@@ -1,6 +1,6 @@
 import request from '@/utils/request';
 import { AxiosPromise } from 'axios';
-import { UserForm, UserInfo, UserPageResult, UserQuery } from './types';
+import { UserForm, UserInfo, UserPageVO, UserQuery } from './types';
 
 /**
  * 登录成功后获取用户信息（昵称、头像、权限集合和角色集合）
@@ -19,7 +19,7 @@ export function getUserInfo(): AxiosPromise<UserInfo> {
  */
 export function listUserPages(
   queryParams: UserQuery
-): AxiosPromise<UserPageResult> {
+): AxiosPromise<PageResult<UserPageVO[]>> {
   return request({
     url: '/api/v1/users/pages',
     method: 'get',

src/api/user/types.ts

@@ -9,7 +9,7 @@ export interface UserInfo {
 }
 
 /**
- * 用户查询参数
+ * 用户查询对象类型
  */
 export interface UserQuery extends PageQuery {
   keywords: string;
@@ -18,48 +18,102 @@ export interface UserQuery extends PageQuery {
 }
 
 /**
- * 用户分页列表项声明
+ * 用户分页对象
  */
-export interface UserType {
-  id: string;
-  username: string;
-  nickname: string;
-  mobile: string;
-  gender: number;
-  avatar: string;
-  email: string;
-  status: number;
-  deptName: string;
-  roleNames: string;
-  createTime: string;
+export interface UserPageVO {
+  /**
+   * 用户头像地址
+   */
+  avatar?: string;
+  /**
+   * 创建时间
+   */
+  createTime?: Date;
+  /**
+   * 部门名称
+   */
+  deptName?: string;
+  /**
+   * 用户邮箱
+   */
+  email?: string;
+  /**
+   * 性别
+   */
+  genderLabel?: string;
+  /**
+   * 用户ID
+   */
+  id?: number;
+  /**
+   * 手机号
+   */
+  mobile?: string;
+  /**
+   * 用户昵称
+   */
+  nickname?: string;
+  /**
+   * 角色名称，多个使用英文逗号(,)分割
+   */
+  roleNames?: string;
+  /**
+   * 用户状态(1:启用;0:禁用)
+   */
+  status?: number;
+  /**
+   * 用户名
+   */
+  username?: string;
 }
 
 /**
- * 用户分页项类型声明
- */
-export type UserPageResult = PageResult<UserType[]>;
-
-/**
- * 用户表单类型声明
+ * 用户表单类型
  */
 export interface UserForm {
-  id: number | undefined;
-  deptId: number;
-  username: string;
-  nickname: string;
-  password: string;
-  mobile: string;
-  email: string;
-  gender: number;
-  status: number;
-  remark: string;
-  roleIds: number[];
+  /**
+   * 用户头像
+   */
+  avatar?: string;
+  /**
+   * 部门ID
+   */
+  deptId?: number;
+  /**
+   * 邮箱
+   */
+  email?: string;
+  /**
+   * 性别
+   */
+  gender?: number;
+  /**
+   * 用户ID
+   */
+  id?: number;
+  mobile?: string;
+  /**
+   * 昵称
+   */
+  nickname?: string;
+  /**
+   * 角色ID集合
+   */
+  roleIds?: number[];
+  /**
+   * 用户状态(1:正常;0:禁用)
+   */
+  status?: number;
+  /**
+   * 用户名
+   */
+  username?: string;
 }
 
 /**
- * 用户导入表单类型声明
+ * 用户导入视图对象类型
  */
-export interface UserImportData {
+export interface UserImportVO {
   deptId: number;
   roleIds: number[];
 }