feat: axios add joinTime field

This commit is contained in:
vben
2020-12-15 21:27:45 +08:00
parent c774a6d3a0
commit f646e37754
8 changed files with 65 additions and 35 deletions

View File

@@ -1,4 +1,3 @@
import { isObject, isString } from '/@/utils/is';
import moment from 'moment';
const DATE_TIME_FORMAT = 'YYYY-MM-DD HH:mm';
@@ -34,28 +33,5 @@ export const formatAgo = (str: string | number) => {
return parseInt(String(time / 31536000000)) + '年前';
}
};
/**
* @description: 格式化请求参数时间
*/
export function formatRequestDate(params: any) {
for (const key in params) {
if (params[key] && params[key]._isAMomentObject) {
params[key] = params[key].format(DATE_TIME_FORMAT);
}
if (isString(key)) {
const value = params[key];
if (value) {
try {
params[key] = isString(value) ? value.trim() : value;
} catch (error) {
throw new Error(error);
}
}
}
if (isObject(params[key])) {
formatRequestDate(params[key]);
}
}
}
export const dateUtil = moment;

View File

@@ -0,0 +1,45 @@
import { isObject, isString } from '/@/utils/is';
export function createNow<T extends boolean>(
join: boolean,
restful: T
): T extends true ? string : object;
export function createNow(join: boolean, restful = false): string | object {
if (!join) {
return restful ? '' : {};
}
const now = new Date().getTime();
if (restful) {
return `?_t=${now}`;
}
return {
_t: now,
};
}
const DATE_TIME_FORMAT = 'YYYY-MM-DD HH:mm';
/**
* @description: 格式化请求参数时间
*/
export function formatRequestDate(params: any) {
for (const key in params) {
if (params[key] && params[key]._isAMomentObject) {
params[key] = params[key].format(DATE_TIME_FORMAT);
}
if (isString(key)) {
const value = params[key];
if (value) {
try {
params[key] = isString(value) ? value.trim() : value;
} catch (error) {
throw new Error(error);
}
}
}
if (isObject(params[key])) {
formatRequestDate(params[key]);
}
}
}

View File

@@ -3,7 +3,6 @@
import type { AxiosResponse } from 'axios';
import type { CreateAxiosOptions, RequestOptions, Result } from './types';
import { VAxios } from './Axios';
import { getToken } from '/@/utils/auth';
import { AxiosTransform } from './axiosTransform';
@@ -16,11 +15,11 @@ import { useMessage } from '/@/hooks/web/useMessage';
import { RequestEnum, ResultEnum, ContentTypeEnum } from '/@/enums/httpEnum';
import { isString } from '/@/utils/is';
import { formatRequestDate } from '/@/utils/dateUtil';
import { setObjToUrlParams, deepMerge } from '/@/utils';
import { errorStore } from '/@/store/modules/error';
import { errorResult } from './const';
import { useI18n } from '/@/hooks/web/useI18n';
import { createNow, formatRequestDate } from './helper';
const globSetting = useGlobSetting();
const prefix = globSetting.urlPrefix;
@@ -97,7 +96,7 @@ const transform: AxiosTransform = {
// 请求之前处理config
beforeRequestHook: (config, options) => {
const { apiUrl, joinPrefix, joinParamsToUrl, formatDate } = options;
const { apiUrl, joinPrefix, joinParamsToUrl, formatDate, joinTime = true } = options;
if (joinPrefix) {
config.url = `${prefix}${config.url}`;
@@ -107,17 +106,14 @@ const transform: AxiosTransform = {
config.url = `${apiUrl}${config.url}`;
}
if (config.method?.toUpperCase() === RequestEnum.GET) {
const now = new Date().getTime();
if (!isString(config.params)) {
config.data = {
// 给 get 请求加上时间戳参数,避免从缓存中拿数据。
params: Object.assign(config.params || {}, {
_t: now,
}),
params: Object.assign(config.params || {}, createNow(joinTime, false)),
};
} else {
// 兼容restful风格
config.url = config.url + config.params + `?_t=${now}`;
config.url = config.url + config.params + `${createNow(joinTime, true)}`;
config.params = undefined;
}
} else {
@@ -187,6 +183,8 @@ function createAxios(opt?: Partial<CreateAxiosOptions>) {
// 接口可能会有通用的地址部分,可以统一抽取出来
prefixUrl: prefix,
headers: { 'Content-Type': ContentTypeEnum.JSON },
// 如果是form-data格式
// headers: { 'Content-Type': ContentTypeEnum.FORM_URLENCODED },
// 数据处理方式
transform,
// 配置项,下面的选项都可以在独立的接口请求中覆盖
@@ -203,6 +201,8 @@ function createAxios(opt?: Partial<CreateAxiosOptions>) {
errorMessageMode: 'message',
// 接口地址
apiUrl: globSetting.apiUrl,
// 是否加入时间戳
joinTime: true,
},
},
opt || {}

View File

@@ -16,6 +16,8 @@ export interface RequestOptions {
apiUrl?: string;
// 错误消息提示类型
errorMessageMode?: ErrorMessageMode;
// 是否加入时间戳
joinTime?: boolean;
}
export interface CreateAxiosOptions extends AxiosRequestConfig {