Vendure电商平台中的错误处理机制深度解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00916/article/details/148487629

Vendure电商平台中的错误处理机制深度解析

vendure A headless GraphQL commerce platform for the modern web 项目地址: https://gitcode.com/gh_mirrors/ve/vendure

前言

在构建电商平台时，完善的错误处理机制对于保障系统稳定性和提升用户体验至关重要。Vendure作为现代化的电商框架，提供了一套清晰且强大的错误处理体系。本文将深入解析Vendure中的错误处理机制，帮助开发者更好地理解和应用。

错误分类

Vendure将错误分为两大类，每类都有其独特的处理方式：

1. 意外错误(Unexpected Errors)

这类错误指不应该发生但确实发生的系统异常情况，如：

服务器内部错误(500)
数据库连接问题
资源权限不足
其他未预料到的运行时错误

特点：

通常通过抛出Error对象来处理
在GraphQL响应中以errors数组形式返回
需要全局错误处理机制

示例代码：

const customer = await this.findOneByUserId(ctx, user.id);
if (!customer) {
    throw new InternalServerError('error.cannot-locate-customer-for-user');
}

客户端处理建议：

// 使用拦截器处理GraphQL错误
if (Array.isArray(result.errors)) {
    const errorMessage = result.errors.map(e => e.message).join('\n');
    // 根据错误类型采取不同措施
    if (result.errors.some(e => e.extensions?.code === 'FORBIDDEN')) {
        // 处理权限不足情况
        redirectToLogin();
    } else {
        // 其他错误处理
        showErrorToast(errorMessage);
    }
}

2. 预期错误(Expected Errors/ErrorResults)

这类错误是业务逻辑中可预见的失败情况，如：

优惠券码无效
库存不足
订单状态转换失败

特点：

实现ErrorResult接口
通过GraphQL联合类型(union)定义
包含明确的错误代码和描述信息
需要针对每种错误类型进行特定处理

核心接口：

interface ErrorResult {
  errorCode: ErrorCode!
  message: String!
}

预期错误的深入解析

1. 类型定义

Vendure使用GraphQL联合类型定义可能返回的错误结果：

union ApplyCouponCodeResult = Order
  | CouponCodeExpiredError
  | CouponCodeInvalidError
  | CouponCodeLimitError

2. 客户端查询方式

查询预期错误时需要使用条件片段：

mutation ApplyCoupon($code: String!) {
  applyCouponCode(couponCode: $code) {
    __typename
    ...on Order {
      id
      couponCodes
    }
    ...on ErrorResult {
      errorCode
      message
    }
    ...on CouponCodeLimitError {
      limit
    }
  }
}

3. 服务端处理

在插件开发中，可以使用isGraphQlErrorResult辅助函数：

const result = await orderService.transitionToState(ctx, orderId, newState);
if (isGraphQlErrorResult(result)) {
    // 处理错误结果
    logger.error(`Transition failed: ${result.message}`);
    throw result;
} else {
    // 处理成功情况
    return result;
}

4. 客户端处理最佳实践

完整类型安全处理示例：

const result = await applyCouponCodeMutation({ variables: { code } });

switch (result.data?.applyCouponCode.__typename) {
    case 'Order':
        // 处理成功应用优惠券
        updateCart(result.data.applyCouponCode);
        break;
    case 'CouponCodeExpiredError':
        showToast('该优惠券已过期');
        break;
    case 'CouponCodeInvalidError':
        showToast('优惠券无效');
        break;
    case 'CouponCodeLimitError':
        showToast(`每个用户限用${result.data.applyCouponCode.limit}次`);
        break;
    default:
        // 类型安全保护
        const _exhaustiveCheck: never = result.data?.applyCouponCode;
        showToast('未知错误');
}

错误处理的高级技巧

1. 错误本地化

Vendure的错误消息支持国际化，可以通过错误代码实现多语言错误提示：

// 服务端
throw new UserInputError('error.coupon-code-expired');

// 客户端
const errorMessages = {
    'error.coupon-code-expired': {
        en: 'Coupon code has expired',
        zh: '优惠券已过期'
    }
};

function getLocalizedMessage(error) {
    return errorMessages[error.message]?.[currentLanguage] || error.message;
}

2. 自定义错误类型

开发者可以扩展Vendure的错误系统：

// 定义自定义错误类
export class CustomBusinessError extends ErrorResult {
    readonly __typename = 'CustomBusinessError';
    readonly errorCode = ErrorCode.CUSTOM_BUSINESS_ERROR;
    readonly message = 'Custom business error occurred';
    
    constructor(public readonly customField: string) {
        super();
    }
}

// 注册到GraphQL schema
extend type Mutation {
    customOperation: CustomOperationResult!
}

union CustomOperationResult = SuccessType | CustomBusinessError

3. 错误监控集成

可以将Vendure错误集成到监控系统：

// 全局错误拦截器
@Injectable()
export class ErrorMonitorInterceptor implements NestInterceptor {
    intercept(context: ExecutionContext, next: CallHandler) {
        return next.handle().pipe(
            catchError(err => {
                if (err instanceof InternalServerError) {
                    monitoringService.trackError(err);
                }
                return throwError(err);
            })
        );
    }
}