refactor(http): 统一错误和成功消息的元数据字段命名

将 showErrorMessage 和 showSuccessMessage 重命名为 errorMessageMode 和 successMessageMode
This commit is contained in:
dap
2026-01-19 19:07:55 +08:00
parent 8b0cf671b5
commit 736fa21410
4 changed files with 21 additions and 21 deletions

View File

@@ -40,7 +40,7 @@ export function checkStatus(
if ( if (
errorMessage && errorMessage &&
meta && meta &&
!['none', undefined].includes(meta.showErrorMessage) !['none', undefined].includes(meta.errorMessageMode)
) { ) {
showAntdMessage({ showAntdMessage({
meta, meta,

View File

@@ -59,8 +59,8 @@ const asymmetricEncryption: BaseAsymmetricEncryption = new RsaEncryption({
const symmetricEncryption: BaseSymmetricEncryption = new AesEncryption(); const symmetricEncryption: BaseSymmetricEncryption = new AesEncryption();
const defaultMeta: AlovaMeta = { const defaultMeta: AlovaMeta = {
showSuccessMessage: 'none', successMessageMode: 'none',
showErrorMessage: 'message', errorMessageMode: 'message',
withToken: true, withToken: true,
isReturnNativeResponse: false, isReturnNativeResponse: false,
isTransformResponse: true, isTransformResponse: true,
@@ -243,7 +243,7 @@ const alovaInstance = createAlova({
successMsg = $t(`http.operationSuccess`); successMsg = $t(`http.operationSuccess`);
} }
if (!['none', undefined].includes(instance.meta?.showSuccessMessage)) { if (!['none', undefined].includes(instance.meta?.successMessageMode)) {
showAntdMessage({ showAntdMessage({
meta: instance.meta, meta: instance.meta,
message: successMsg, message: successMsg,
@@ -277,7 +277,7 @@ const alovaInstance = createAlova({
// errorMessageMode='modal'的时候会显示modal错误弹窗而不是消息提示用于一些比较重要的错误 // errorMessageMode='modal'的时候会显示modal错误弹窗而不是消息提示用于一些比较重要的错误
// errorMessageMode='none' 一般是调用时明确表示不希望自动弹出错误提示 // errorMessageMode='none' 一般是调用时明确表示不希望自动弹出错误提示
if (!['none', undefined].includes(instance.meta?.showErrorMessage)) { if (!['none', undefined].includes(instance.meta?.errorMessageMode)) {
showAntdMessage({ showAntdMessage({
meta: instance.meta, meta: instance.meta,
message: timeoutMsg, message: timeoutMsg,
@@ -304,7 +304,7 @@ const alovaInstance = createAlova({
} }
if (errMessage) { if (errMessage) {
if (!['none', undefined].includes(method.meta?.showErrorMessage)) { if (!['none', undefined].includes(method.meta?.errorMessageMode)) {
showAntdMessage({ showAntdMessage({
meta: method.meta, meta: method.meta,
message: errMessage, message: errMessage,
@@ -335,7 +335,7 @@ alovaInstance.GetWithMessage = function (url, options) {
...options, ...options,
meta: { meta: {
...options?.meta, ...options?.meta,
showSuccessMessage: 'message', successMessageMode: 'message',
}, },
}); });
}; };
@@ -345,7 +345,7 @@ alovaInstance.PostWithMessage = function (url, data, config) {
...config, ...config,
meta: { meta: {
...config?.meta, ...config?.meta,
showSuccessMessage: 'message', successMessageMode: 'message',
}, },
}); });
}; };
@@ -355,7 +355,7 @@ alovaInstance.PutWithMessage = function (url, data, config) {
...config, ...config,
meta: { meta: {
...config?.meta, ...config?.meta,
showSuccessMessage: 'message', successMessageMode: 'message',
}, },
}); });
}; };
@@ -365,7 +365,7 @@ alovaInstance.DeleteWithMessage = function (url, data, config) {
...config, ...config,
meta: { meta: {
...config?.meta, ...config?.meta,
showSuccessMessage: 'message', successMessageMode: 'message',
}, },
}); });
}; };

View File

@@ -11,14 +11,14 @@ interface ShowMessageOptions {
export function showAntdMessage(options: ShowMessageOptions) { export function showAntdMessage(options: ShowMessageOptions) {
const { meta = {}, message, type } = options; const { meta = {}, message, type } = options;
if (meta.showErrorMessage === 'message' && type === 'error') { if (meta.errorMessageMode === 'message' && type === 'error') {
window.message[type](message); window.message[type](message);
} }
if (meta.showSuccessMessage === 'message' && type === 'success') { if (meta.successMessageMode === 'message' && type === 'success') {
window.message[type](message); window.message[type](message);
} }
if (meta.showErrorMessage === 'modal' && type === 'error') { if (meta.errorMessageMode === 'modal' && type === 'error') {
window.modal.error({ window.modal.error({
content: message, content: message,
title: $t('http.errorTip'), title: $t('http.errorTip'),
@@ -26,7 +26,7 @@ export function showAntdMessage(options: ShowMessageOptions) {
okButtonProps: { danger: true }, okButtonProps: { danger: true },
}); });
} }
if (meta.showSuccessMessage === 'modal' && type === 'success') { if (meta.successMessageMode === 'modal' && type === 'success') {
window.modal.success({ window.modal.success({
content: message, content: message,
title: $t('http.successTip'), title: $t('http.successTip'),
@@ -34,13 +34,13 @@ export function showAntdMessage(options: ShowMessageOptions) {
}); });
} }
if (meta.showErrorMessage === 'notification' && type === 'error') { if (meta.errorMessageMode === 'notification' && type === 'error') {
window.notification.error({ window.notification.error({
description: message, description: message,
title: $t('http.errorTip'), title: $t('http.errorTip'),
}); });
} }
if (meta.showSuccessMessage === 'notification' && type === 'success') { if (meta.successMessageMode === 'notification' && type === 'success') {
window.notification.success({ window.notification.success({
description: message, description: message,
title: $t('http.successTip'), title: $t('http.successTip'),

View File

@@ -18,6 +18,10 @@ export type AlovaMeta = {
* 是否需要对请求体进行加密 * 是否需要对请求体进行加密
*/ */
encrypt?: boolean; encrypt?: boolean;
/**
* 错误弹窗类型
*/
errorMessageMode?: MessageType;
/** /**
* 是否返回原生axios响应 * 是否返回原生axios响应
*/ */
@@ -26,14 +30,10 @@ export type AlovaMeta = {
* 是否需要转换响应 即只获取{code, msg, data}中的data * 是否需要转换响应 即只获取{code, msg, data}中的data
*/ */
isTransformResponse?: boolean; isTransformResponse?: boolean;
/**
* 接口请求失败时的提示方式
*/
showErrorMessage?: MessageType;
/** /**
* 接口请求成功时的提示方式 * 接口请求成功时的提示方式
*/ */
showSuccessMessage?: MessageType; successMessageMode?: MessageType;
/** /**
* 是否需要在请求头中添加 token * 是否需要在请求头中添加 token
*/ */