AbstractErrorController简介-笔记

1. AbstractErrorController简介

org.springframework.boot.autoconfigure.web.servlet.error.AbstractErrorController 是 Spring Boot 提供的一个用于处理 HTTP 错误（如 404、500 等）的抽象类，用于自定义错误响应的逻辑。它是 Spring Boot 自动配置中默认错误处理机制的一部分，允许开发者扩展或覆盖默认的错误处理行为。

主要功能

1. 集中处理错误：统一处理全局异常（如 404、500）或自定义异常。
2. 自定义错误响应：可以返回特定格式的 JSON 响应、HTML 页面或重定向到指定页面。
3. 与 Spring MVC 集成：支持通过 @RequestMapping 或 @GetMapping 定义错误处理逻辑。
4. 扩展性：通过继承 AbstractErrorController 可以灵活地覆盖默认行为。

2. 使用示例

2.1 代码演示

以下是一个自定义错误处理的示例，继承 AbstractErrorController 并返回 JSON 格式的错误信息。

step1. 准备工作

定义统一输出UnifiedResult：

import java.util.Map;
import lombok.Data;

@Data
public class UnifiedResult<T> {
    private int code;
    private String message;
    private T data;
    private Map<String, Object> errorAttributes;
}

step2. 自定义错误控制器

import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.lang3.StringUtils;
import org.springframework.boot.autoconfigure.web.servlet.error.AbstractErrorController;
import org.springframework.boot.web.servlet.error.ErrorAttributes;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping
public class CustomErrorController extends AbstractErrorController {

    // 构造函数注入 ErrorAttributes
    public CustomErrorController(ErrorAttributes errorAttributes) {
        super(errorAttributes);
    }

    //【核心逻辑】
    //处理所有错误请求
    @RequestMapping("/error")
    public UnifiedResult handleError(HttpServletRequest request) {
        //按照统一格式输出异常信息
        UnifiedResult unifiedResult = new UnifiedResult();

        //获取错误信息
        Map<String, Object> errorAttributes = getErrorAttributes(request, true);
        unifiedResult.setErrorAttributes(errorAttributes);
        String message = String.valueOf(errorAttributes.get("message"));
        if(StringUtils.isBlank(message)) {
            message = "custom-未知错误";
        }
        unifiedResult.setMessage(message);

        //获取 HTTP 状态码
        HttpStatus status = getStatus(request).value() == 404 ? HttpStatus.NOT_FOUND : HttpStatus.INTERNAL_SERVER_ERROR;
        unifiedResult.setCode(status.value());

        return unifiedResult;
    }

    
    @Override
    public String getErrorPath() {
        return "";
    }
}

关键方法说明

• getErrorAttributes(HttpServletRequest, boolean)：获取错误详情（如异常信息、时间戳等）。
• getStatus(HttpServletRequest)：获取错误对应的 HTTP 状态码。
• /error 映射：Spring Boot 默认将 /error 映射到错误控制器，无需额外配置。

step3.创建个测试Controller

@RestController
public class TestHelloController {
    @GetMapping(value = "/TestHelloController/hello")
    public String valueHello() {
        return "HelloController  say hello";
    }
}

step4. 测试

case1.正常访问：

浏览器访问：http://127.0.0.1:8080/TestHelloController/hello ，输出结果如下：

 case2. 没有CustomErrorController时，访问不存在的path

浏览器访问：http://127.0.0.1:8080/TestHelloController/hello123 ，输出结果如下，是Spring默认的报错页面：

 case2. 有CustomErrorController时，访问不存在的path

浏览器访问：http://127.0.0.1:8080/TestHelloController/hello123 ，输出结果为我们自定义的json格式：

2.2 注意事项

1. 优先级问题：自定义错误控制器会覆盖 Spring Boot 默认的 BasicErrorController。
2. 模板支持：如果需要返回 HTML 页面，可在 src/main/resources/templates/error/ 目录下添加对应状态码的模板（如 404.html）。
3. 异常处理：对于业务异常，建议结合 @ControllerAdvice 和 @ExceptionHandler 进行更细粒度的控制。可参考：统一异常处理@ExceptionHandler-笔记-优快云博客

通过继承 AbstractErrorController，你可以灵活定制 Spring Boot 应用的错误响应逻辑，满足 API 或 Web 应用的特定需求。