Spring Boot错误处理的艺术

在Spring Boot应用开发中，错误处理是一个不可忽视的部分。本文将深入探讨如何通过自定义ErrorController来优雅地处理和展示错误信息。

1. 错误处理基础

Spring Boot提供了ErrorAttributes接口，它帮助我们提取底层Servlet的错误属性。我们可以在自定义的ErrorController中注入ErrorAttributes Bean，来获取错误信息。

2. 自定义`ErrorController`

下面是一个自定义ErrorController的示例，它通过ErrorAttributes获取错误信息，并以表格形式展示：

public class MyCustomErrorController implements ErrorController {
    private ErrorAttributes errorAttributes;

    @RequestMapping("/error")
    public String handleError(HttpServletRequest request) {
        ServletWebRequest servletWebRequest = new ServletWebRequest(request);
        Map<String, Object> errorAttributes = this.errorAttributes.getErrorAttributes(servletWebRequest, true);
        final StringBuilder errorDetails = new StringBuilder();
        errorAttributes.forEach((attribute, value) -> {
            errorDetails.append("<tr><td>")
                        .append(attribute)
                        .append("</td><td><pre>")
                        .append(value)
                        .append("</pre></td></tr>");
        });
        return String.format("<html><head><style>td{vertical-align:top;border:solid 1px #666;}</style>"
                + "</head><body><h2>Error Page</h2><table>%s</table></body></html>", errorDetails.toString());
    }

    public String getErrorPath() {
        return "/error";
    }
}

3. 触发异常的控制器

为了测试我们的自定义错误处理，我们创建一个简单的控制器，它在处理请求时抛出异常：

public class MyAppController {
    @RequestMapping("/")
    public void handleRequest() {
        throw new RuntimeException("test exception");
    }
}

4. Spring Boot启动类

启动Spring Boot应用的入口类如下：

public class SpringBootMain {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootMain.class);
    }
}

5. 输出示例

自定义错误页面的输出示例（由于格式限制，这里不展示实际的图片）：

Error Page
+------------+--------------------------------------------------+
| Attribute  | Value                                          |
+------------+--------------------------------------------------+
| timestamp  | 2024-08-25T12:00:00.000+00:00                 |
| status     | 500                                             |
| error      | Internal Server Error                           |
| message    | test exception                                 |
| path       | /                                                |
+------------+--------------------------------------------------+

6. 示例项目技术栈

Spring Boot 2.0.0.RELEASE
Spring Framework 5.0.4.RELEASE
spring-boot-starter-web：构建Web应用程序的启动器，包括RESTful应用
JDK 1.8
Maven 3.3.9

通过上述步骤，我们不仅能够捕获和处理异常，还能以一种更友好的方式向用户展示错误信息，提高应用的用户体验和可维护性。