异常处理是构建健壮且用户友好的应用程序的关键部分。在 spring boot 中，我们可以通过多种方式处理异常，以确保我们的应用程序保持稳定并向用户提供有意义的反馈。本指南将涵盖异常处理的不同策略，包括自定义异常、全局异常处理、验证错误和生产最佳实践。
1. 异常处理基础知识
异常是扰乱程序正常流程的事件。它们可以分为：
- checked exceptions： 在编译时检查的异常。
- unchecked exceptions（运行时异常）： 运行时发生的异常。
- 错误： 应用程序不应处理的严重问题，例如 outofmemoryerror。
2. 自定义异常类
创建自定义异常类有助于处理应用程序中的特定错误情况。
package com.example.springbootrefresher.exception;
public class departmentnotfoundexception extends runtimeexception {
public departmentnotfoundexception(string message) {
super(message);
}
}
3. 控制器中的异常处理
@exceptionhandler 注释：
您可以在控制器类中定义处理异常的方法。
package com.example.springbootrefresher.controller;
import com.example.springbootrefresher.exception.departmentnotfoundexception;
import org.springframework.http.httpstatus;
import org.springframework.http.responseentity;
import org.springframework.web.bind.annotation.exceptionhandler;
import org.springframework.web.bind.annotation.getmapping;
import org.springframework.web.bind.annotation.restcontroller;
@restcontroller
public class departmentcontroller {
@getmapping("/department")
public string getdepartment() {
// simulate an exception
throw new departmentnotfoundexception("department not found!");
}
@exceptionhandler(departmentnotfoundexception.class)
public responseentity handledepartmentnotfoundexception(departmentnotfoundexception ex) {
return new responseentity<>(ex.getmessage(), httpstatus.not_found);
}
}
4. 使用@controlleradvice进行全局异常处理
要全局处理异常，可以使用@controlleradvice和集中式异常处理程序。
package com.example.springbootrefresher.error;
import com.example.springbootrefresher.entity.errormessage;
import com.example.springbootrefresher.exception.departmentnotfoundexception;
import org.springframework.http.httpstatus;
import org.springframework.http.responseentity;
import org.springframework.web.bind.annotation.controlleradvice;
import org.springframework.web.bind.annotation.exceptionhandler;
import org.springframework.web.bind.annotation.responsestatus;
import org.springframework.web.context.request.webrequest;
import org.springframework.web.servlet.mvc.method.annotation.responseentityexceptionhandler;
@controlleradvice
@responsestatus
public class customresponseentityexceptionhandler extends responseentityexceptionhandler {
@exceptionhandler(departmentnotfoundexception.class)
public responseentity handledepartmentnotfoundexception(departmentnotfoundexception exception, webrequest request) {
errormessage message = new errormessage(
httpstatus.not_found.value(),
exception.getmessage(),
request.getdescription(false)
);
return responseentity.status(httpstatus.not_found)
.body(message);
}
@exceptionhandler(exception.class)
public responseentity handleglobalexception(exception exception, webrequest request) {
errormessage message = new errormessage(
httpstatus.internal_server_error.value(),
exception.getmessage(),
request.getdescription(false)
);
return responseentity.status(httpstatus.internal_server_error)
.body(message);
}
}
5. 创建标准错误响应
定义标准错误响应类来构建错误消息。
杰易OA办公自动化系统6.0
下载
基于Intranet/Internet 的Web下的办公自动化系统，采用了当今最先进的PHP技术，是综合大量用户的需求,经过充分的用户论证的基础上开发出来的，独特的即时信息、短信、电子邮件系统、完善的工作流、数据库安全备份等功能使得信息在企业内部传递效率极大提高，信息传递过程中耗费降到最低。办公人员得以从繁杂的日常办公事务处理中解放出来，参与更多的富于思考性和创造性的工作。系统力求突出体系结构简明
package com.example.springbootrefresher.entity;
public class errormessage {
private int statuscode;
private string message;
private string description;
public errormessage(int statuscode, string message, string description) {
this.statuscode = statuscode;
this.message = message;
this.description = description;
}
// getters and setters
public int getstatuscode() {
return statuscode;
}
public void setstatuscode(int statuscode) {
this.statuscode = statuscode;
}
public string getmessage() {
return message;
}
public void setmessage(string message) {
this.message = message;
}
public string getdescription() {
return description;
}
public void setdescription(string description) {
this.description = description;
}
}
6. 处理验证错误
spring boot 与 bean validation (jsr-380) 集成良好。要全局处理验证错误，请使用@controlleradvice。
package com.example.springbootrefresher.error;
import org.springframework.http.httpstatus;
import org.springframework.http.responseentity;
import org.springframework.validation.fielderror;
import org.springframework.web.bind.methodargumentnotvalidexception;
import org.springframework.web.bind.annotation.controlleradvice;
import org.springframework.web.bind.annotation.exceptionhandler;
import org.springframework.web.bind.annotation.responsestatus;
import org.springframework.web.context.request.webrequest;
import java.util.hashmap;
import java.util.map;
@controlleradvice
@responsestatus
public class validationexceptionhandler extends responseentityexceptionhandler {
@exceptionhandler(methodargumentnotvalidexception.class)
public responseentity> handlevalidationexceptions(methodargumentnotvalidexception ex) {
map errors = new hashmap<>();
ex.getbindingresult().getallerrors().foreach((error) -> {
string fieldname = ((fielderror) error).getfield();
string errormessage = error.getdefaultmessage();
errors.put(fieldname, errormessage);
});
return new responseentity<>(errors, httpstatus.bad_request);
}
}
7. 使用@responsestatus处理简单异常
对于简单的情况，可以用@responsestatus注解异常类来指定http状态码。
package com.example.SpringBootRefresher.exception;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;
@ResponseStatus(HttpStatus.NOT_FOUND)
public class DepartmentNotFoundException extends RuntimeException {
public DepartmentNotFoundException(String message) {
super(message);
}
}
8. 生产最佳实践
- 一致的错误响应：确保您的应用程序返回一致且结构化的错误响应。使用标准错误响应类。
- 日志记录： 记录异常以用于调试和监控目的。确保敏感信息不会在日志中暴露。
- 用户友好的消息：提供用户友好的错误消息。避免向用户暴露内部细节或堆栈跟踪。
- 安全： 请谨慎对待错误响应中包含的信息，以免暴露敏感数据。
- 文档： 为您的团队和未来的维护人员记录您的异常处理策略。
概括
spring boot 中的异常处理涉及使用 @exceptionhandler、@controlleradvice 和 @responsestatus 等注释来有效地管理错误。通过创建自定义异常、处理验证错误并遵循最佳实践，您可以构建强大的应用程序，以优雅地处理错误并向用户提供有意义的反馈。使用 java 17 功能可确保您的应用程序利用 java 生态系统中的最新改进。
