Spring Cloud zuul自定义统一异常处理实现方法

来详细讲解一下“Spring Cloud zuul自定义统一异常处理实现方法”的完整攻略。

1. 背景介绍

Zuul 是 Netflix 出品的一个基于 JVM 用于构建可伸缩的微服务架构的 API 网关服务器。Zuul 的主要功能是路由转发和过滤器。路由功能是微服务的一部分，它将请求路由到相应的服务。Zuul 还能够对请求进行过滤，其中最常用的是安全过滤器。

在 Zuul 网关中，我们可以通过实现自己的 Zuul 过滤器来完成自定义需求，其中也包括了对于异常的处理。

2. 自定义统一异常处理实现流程

2.1 编写自定义异常类

在实现自定义统一异常处理之前，首先需要定义自己的异常，这里我们以一个简单的示例为例。在 com.example.demo.exception 包中新建一个 MyException 类，继承自 RuntimeException：

package com.example.demo.exception;

public class MyException extends RuntimeException {

    private static final long serialVersionUID = 1L;

    public MyException(String message) {
        super(message);
    }
}

2.2 编写自定义异常处理器

处理 Zuul 抛出的异常和正常请求一样，需要利用 Zuul 过滤器来实现，在 com.example.demo.filter 包中编写一个名为 ErrorFilter 的自定义过滤器：

/**
 * Zuul自定义异常处理器
 */
@Component
public class ErrorFilter extends ZuulFilter {

    /**
     * 过滤器类型，有pre、route、post、error四种类型
     * pre：在请求被路由之前执行，比如身份验证、日志记录等
     * route：在路由请求时执行
     * post：在路由之后执行，比如添加响应头、解析响应、日志记录等
     * error：处理请求时发生错误时执行，比如断路器、缓存异常等
     */
    @Override
    public String filterType() {
        return "error";
    }

    /**
     * 过滤器的执行顺序，数字越大表示执行优先级越低
     */
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     * 是否启用当前过滤器
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * 过滤器的具体逻辑
     */
    @Override
    public Object run() throws ZuulException {
        RequestContext requestContext = RequestContext.getCurrentContext();
        HttpServletResponse response = requestContext.getResponse();
        Exception exception = (Exception) requestContext.get("throwable");
        String message = exception.getMessage();
        response.setContentType("application/json;charset=utf-8");
        try {
            response.getWriter().write(JsonUtil.toJson(Result.error(message)));
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

2.3 测试自定义异常处理器

通过以上的方式，我们已经成功实现了 Zuul 的自定义统一异常处理器，现在来测试一下。首先在 controller 中抛出一个自定义异常：

/**
 * 测试Controller
 */
@RestController
@RequestMapping("/test")
public class TestController {

    @GetMapping("/ex")
    public void ex() {
        throw new MyException("自定义异常");
    }
}

启动应用并访问 localhost:8080/test/ex，就会看到自定义异常的信息被正确返回了。

3. 例子说明

3.1 例子一：返回带有自定义状态码的错误信息

除了返回异常信息，有时候还需要返回自定义的状态码以方便前端进行处理。在自定义异常类中添加一个状态码：

public class MyException extends RuntimeException {

    private static final long serialVersionUID = 1L;

    private Integer code;

    public MyException(Integer code, String message) {
        super(message);
        this.code = code;
    }
}

然后在 ErrorFilter 中的具体逻辑中设置状态码并以 JSON 形式返回：

response.setContentType("application/json;charset=utf-8");
try {
    Integer statusCode = (exception instanceof MyException) ? ((MyException) exception).getCode() : HttpStatus.INTERNAL_SERVER_ERROR.value();
    response.setStatus(statusCode);// 设置状态码
    response.getWriter().write(JsonUtil.toJson(Result.error(statusCode, message)));// 返回错误信息
} catch (Exception e) {
    e.printStackTrace();
}

3.2 例子二：记录异常日志

在 ErrorFilter 中添加记录错误日志的功能：

@Override
public Object run() throws ZuulException {
    RequestContext requestContext = RequestContext.getCurrentContext();
    HttpServletResponse response = requestContext.getResponse();
    Exception exception = (Exception) requestContext.get("throwable");
    String message = exception.getMessage();
    // 1.记录日志
    log.error(message, exception);
    // 2.返回错误信息
    response.setContentType("application/json;charset=utf-8");
    try {
        Integer statusCode = (exception instanceof MyException) ? ((MyException) exception).getCode() : HttpStatus.INTERNAL_SERVER_ERROR.value();
        response.setStatus(statusCode);
        response.getWriter().write(JsonUtil.toJson(Result.error(statusCode, message)));
    } catch (Exception e) {
        e.printStackTrace();
    }
    return null;
}

这样，在应用运行时，当出现异常时就会自动记录日志到指定的文件中。注意，要先在 Filter 的类中引入 Log 对象：

/**
 * Zuul自定义异常处理器
 */
@Component
@Slf4j
public class ErrorFilter extends ZuulFilter {

    // ...
}

4. 总结

以上就是实现 Zuul 自定义统一异常处理的方法了，总的来说，需要通过自定义异常类和错误过滤器来实现。同时，可以根据实际需求设置不同的状态码，记录日志等。