SpringBoot处理异常的几种常见姿势

一、使用 @ControllerAdvice 和 @ExceptionHandler 处理全局异常

公司主营业务：成都做网站、网站建设、移动网站开发等业务。帮助企业客户真正实现互联网宣传，提高企业的竞争能力。创新互联是一支青春激扬、勤奋敬业、活力青春激扬、勤奋敬业、活力澎湃、和谐高效的团队。公司秉承以“开放、自由、严谨、自律”为核心的企业文化，感谢他们对我们的高要求，感谢他们从不同领域给我们带来的挑战，让我们激情的团队有机会用头脑与智慧不断的给客户带来惊喜。创新互联推出洋县免费做网站回馈大家。

这是目前很常用的一种方式，非常推荐。测试代码中用到了 Junit 5，如果你新建项目验证下面的代码的话，记得添加上相关依赖。

1. 新建异常信息实体类

非必要的类，主要用于包装异常信息。

src/main/java/com/twuc/webApp/exception/ErrorResponse.java

 
 
 
 
    
  
  
  
  
  1. /** 
    2.   
  
  
  
  2.  * @author shuang.kou 
    3.   
  
  
  
  3.  */ 
    4.   
  
  
  
  4. public class ErrorResponse { 
    5.   
  
  
  
  5.  private String message; 
    6.   
  
  
  
  6.  private String errorTypeName; 
    7.   
  
  
  
  7.  public ErrorResponse(Exception e) { 
    8.   
  
  
  
  8.  this(e.getClass().getName(), e.getMessage()); 
    9.   
  
  
  
  9.  } 
    10.   
  
  
  
  10.  public ErrorResponse(String errorTypeName, String message) { 
    11.   
  
  
  
  11.  this.errorTypeName = errorTypeName; 
    12.   
  
  
  
  12.  this.message = message; 
    13.   
  
  
  
  13.  } 
    14.   
  
  
  
  14.  ......省略getter/setter方法 
    15.   
  
  
  
  15. } 
    16.

2. 自定义异常类型

src/main/java/com/twuc/webApp/exception/ResourceNotFoundException.java

一般我们处理的都是 RuntimeException ，所以如果你需要自定义异常类型的话直接集成这个类就可以了。

 
 
 
 
    
  
  
  
  
  1. /** 
    2.   
  
  
  
  2.  * @author shuang.kou 
    3.   
  
  
  
  3.  * 自定义异常类型 
    4.   
  
  
  
  4.  */ 
    5.   
  
  
  
  5. public class ResourceNotFoundException extends RuntimeException { 
    6.   
  
  
  
  6.  private String message; 
    7.   
  
  
  
  7.  public ResourceNotFoundException() { 
    8.   
  
  
  
  8.  super(); 
    9.   
  
  
  
  9.  } 
    10.   
  
  
  
  10.  public ResourceNotFoundException(String message) { 
    11.   
  
  
  
  11.  super(message); 
    12.   
  
  
  
  12.  this.message = message; 
    13.   
  
  
  
  13.  } 
    14.   
  
  
  
  14.  @Override 
    15.   
  
  
  
  15.  public String getMessage() { 
    16.   
  
  
  
  16.  return message; 
    17.   
  
  
  
  17.  } 
    18.   
  
  
  
  18.  public void setMessage(String message) { 
    19.   
  
  
  
  19.  this.message = message; 
    20.   
  
  
  
  20.  } 
    21.   
  
  
  
  21. } 
    22.

3. 新建异常处理类

我们只需要在类上加上@ControllerAdvice注解这个类就成为了全局异常处理类，当然你也可以通过 assignableTypes指定特定的 Controller 类，让异常处理类只处理特定类抛出的异常。

src/main/java/com/twuc/webApp/exception/GlobalExceptionHandler.java

 
 
 
 
    
  
  
  
  
  1. /** 
    2.   
  
  
  
  2.  * @author shuang.kou 
    3.   
  
  
  
  3.  */ 
    4.   
  
  
  
  4. @ControllerAdvice(assignableTypes = {ExceptionController.class}) 
    5.   
  
  
  
  5. @ResponseBody 
    6.   
  
  
  
  6. public class GlobalExceptionHandler { 
    7.   
  
  
  
  7.  ErrorResponse illegalArgumentResponse = new ErrorResponse(new IllegalArgumentException("参数错误!")); 
    8.   
  
  
  
  8.  ErrorResponse resourseNotFoundResponse = new ErrorResponse(new ResourceNotFoundException("Sorry, the resourse not found!")); 
    9.   
  
  
  
  9.  @ExceptionHandler(value = Exception.class)// 拦截所有异常, 这里只是为了演示，一般情况下一个方法特定处理一种异常 
    10.   
  
  
  
  10.  public ResponseEntity exceptionHandler(Exception e) { 
    11.   
  
  
  
  11.  if (e instanceof IllegalArgumentException) { 
    12.   
  
  
  
  12.  return ResponseEntity.status(400).body(illegalArgumentResponse); 
    13.   
  
  
  
  13.  } else if (e instanceof ResourceNotFoundException) { 
    14.   
  
  
  
  14.  return ResponseEntity.status(404).body(resourseNotFoundResponse); 
    15.   
  
  
  
  15.  } 
    16.   
  
  
  
  16.  return null; 
    17.   
  
  
  
  17.  } 
    18.   
  
  
  
  18. } 
    19.

4. controller模拟抛出异常

src/main/java/com/twuc/webApp/web/ExceptionController.java

 
 
 
 
    
  
  
  
  
  1. /** 
    2.   
  
  
  
  2.  * @author shuang.kou 
    3.   
  
  
  
  3.  */ 
    4.   
  
  
  
  4. @RestController 
    5.   
  
  
  
  5. @RequestMapping("/api") 
    6.   
  
  
  
  6. public class ExceptionController { 
    7.   
  
  
  
  7.  @GetMapping("/illegalArgumentException") 
    8.   
  
  
  
  8.  public void throwException() { 
    9.   
  
  
  
  9.  throw new IllegalArgumentException(); 
    10.   
  
  
  
  10.  } 
    11.   
  
  
  
  11.  @GetMapping("/resourceNotFoundException") 
    12.   
  
  
  
  12.  public void throwException2() { 
    13.   
  
  
  
  13.  throw new ResourceNotFoundException(); 
    14.   
  
  
  
  14.  } 
    15.   
  
  
  
  15. } 
    16.

使用 Get 请求 localhost:8080/api/resourceNotFoundException[1] （curl -i -s -X GET url），服务端返回的 JSON 数据如下：

 
 
 
 
    
  
  
  
  
  1. { 
    2.   
  
  
  
  2.  "message": "Sorry, the resourse not found!", 
    3.   
  
  
  
  3.  "errorTypeName": "com.twuc.webApp.exception.ResourceNotFoundException" 
    4.   
  
  
  
  4. } 
    5.

5. 编写测试类

MockMvc 由org.springframework.boot.test包提供，实现了对Http请求的模拟，一般用于我们测试 controller 层。

 
 
 
 
    
  
  
  
  
  1. /** 
    2.   
  
  
  
  2.  * @author shuang.kou 
    3.   
  
  
  
  3.  */ 
    4.   
  
  
  
  4. @AutoConfigureMockMvc 
    5.   
  
  
  
  5. @SpringBootTest 
    6.   
  
  
  
  6. public class ExceptionTest { 
    7.   
  
  
  
  7.  @Autowired 
    8.   
  
  
  
  8.  MockMvc mockMvc; 
    9.   
  
  
  
  9.  @Test 
    10.   
  
  
  
  10.  void should_return_400_if_param_not_valid() throws Exception { 
    11.   
  
  
  
  11.  mockMvc.perform(get("/api/illegalArgumentException")) 
    12.   
  
  
  
  12.  .andExpect(status().is(400)) 
    13.   
  
  
  
  13.  .andExpect(jsonPath("$.message").value("参数错误!")); 
    14.   
  
  
  
  14.  } 
    15.   
  
  
  
  15.  @Test 
    16.   
  
  
  
  16.  void should_return_404_if_resourse_not_found() throws Exception { 
    17.   
  
  
  
  17.  mockMvc.perform(get("/api/resourceNotFoundException")) 
    18.   
  
  
  
  18.  .andExpect(status().is(404)) 
    19.   
  
  
  
  19.  .andExpect(jsonPath("$.message").value("Sorry, the resourse not found!")); 
    20.   
  
  
  
  20.  } 
    21.   
  
  
  
  21. } 
    22.

二、 @ExceptionHandler 处理 Controller 级别的异常

我们刚刚也说了使用@ControllerAdvice注解 可以通过 assignableTypes指定特定的类，让异常处理类只处理特定类抛出的异常。所以这种处理异常的方式，实际上现在使用的比较少了。

我们把下面这段代码移到 src/main/java/com/twuc/webApp/exception/GlobalExceptionHandler.java 中就可以了。

 
 
 
 
    
  
  
  
  
  1. @ExceptionHandler(value = Exception.class)// 拦截所有异常 
    2.   
  
  
  
  2. public ResponseEntity exceptionHandler(Exception e) { 
    3.   
  
  
  
  3. if (e instanceof IllegalArgumentException) { 
    4.   
  
  
  
  4. return ResponseEntity.status(400).body(illegalArgumentResponse); 
    5.   
  
  
  
  5. } else if (e instanceof ResourceNotFoundException) { 
    6.   
  
  
  
  6. return ResponseEntity.status(404).body(resourseNotFoundResponse); 
    7.   
  
  
  
  7. } 
    8.   
  
  
  
  8. return null; 
    9.   
  
  
  
  9. } 
    10.

三、 ResponseStatusException

研究 ResponseStatusException 我们先来看看，通过 ResponseStatus注解简单处理异常的方法（将异常映射为状态码）。

src/main/java/com/twuc/webApp/exception/ResourceNotFoundException.java

 
 
 
 
    
  
  
  
  
  1. @ResponseStatus(code = HttpStatus.NOT_FOUND) 
    2.   
  
  
  
  2. public class ResourseNotFoundException2 extends RuntimeException { 
    3.   
  
  
  
  3.  public ResourseNotFoundException2() { 
    4.   
  
  
  
  4.  } 
    5.   
  
  
  
  5.  public ResourseNotFoundException2(String message) { 
    6.   
  
  
  
  6.  super(message); 
    7.   
  
  
  
  7.  } 
    8.   
  
  
  
  8. } 
    9.

src/main/java/com/twuc/webApp/web/ResponseStatusExceptionController.java

 
 
 
 
    
  
  
  
  
  1. @RestController 
    2.   
  
  
  
  2. @RequestMapping("/api") 
    3.   
  
  
  
  3. public class ResponseStatusExceptionController { 
    4.   
  
  
  
  4.  @GetMapping("/resourceNotFoundException2") 
    5.   
  
  
  
  5.  public void throwException3() { 
    6.   
  
  
  
  6.  throw new ResourseNotFoundException2("Sorry, the resourse not found!"); 
    7.   
  
  
  
  7.  } 
    8.   
  
  
  
  8. } 
    9.

使用 Get 请求 localhost:8080/api/resourceNotFoundException2[2] ，服务端返回的 JSON 数据如下：

 
 
 
 
    
  
  
  
  
  1. { 
    2.   
  
  
  
  2.  "timestamp": "2019-08-21T07:11:43.744+0000", 
    3.   
  
  
  
  3.  "status": 404, 
    4.   
  
  
  
  4.  "error": "Not Found", 
    5.   
  
  
  
  5.  "message": "Sorry, the resourse not found!", 
    6.   
  
  
  
  6.  "path": "/api/resourceNotFoundException2" 
    7.   
  
  
  
  7. } 
    8.

这种通过 ResponseStatus注解简单处理异常的方法是的好处是比较简单，但是一般我们不会这样做，通过ResponseStatusException会更加方便,可以避免我们额外的异常类。

 
 
 
 
    
  
  
  
  
  1. @GetMapping("/resourceNotFoundException2") 
    2.   
  
  
  
  2. public void throwException3() { 
    3.   
  
  
  
  3. throw new ResponseStatusException(HttpStatus.NOT_FOUND, "Sorry, the resourse not found!", new ResourceNotFoundException()); 
    4.   
  
  
  
  4. } 
    5.

使用 Get 请求 localhost:8080/api/resourceNotFoundException2[3] ，服务端返回的 JSON 数据如下,和使用 ResponseStatus 实现的效果一样：

 
 
 
 
    
  
  
  
  
  1. { 
    2.   
  
  
  
  2.  "timestamp": "2019-08-21T07:28:12.017+0000", 
    3.   
  
  
  
  3.  "status": 404, 
    4.   
  
  
  
  4.  "error": "Not Found", 
    5.   
  
  
  
  5.  "message": "Sorry, the resourse not found!", 
    6.   
  
  
  
  6.  "path": "/api/resourceNotFoundException3" 
    7.   
  
  
  
  7. } 
    8.

ResponseStatusException 提供了三个构造方法：

 
 
 
 
    
  
  
  
  
  1. public ResponseStatusException(HttpStatus status) { 
    2.   
  
  
  
  2.  this(status, null, null); 
    3.   
  
  
  
  3.  } 
    4.   
  
  
  
  4.  public ResponseStatusException(HttpStatus status, @Nullable String reason) { 
    5.   
  
  
  
  5.  this(status, reason, null); 
    6.   
  
  
  
  6.  } 
    7.   
  
  
  
  7.  public ResponseStatusException(HttpStatus status, @Nullable String reason, @Nullable Throwable cause) { 
    8.   
  
  
  
  8.  super(null, cause); 
    9.   
  
  
  
  9.  Assert.notNull(status, "HttpStatus is required"); 
    10.   
  
  
  
  10.  this.status = status; 
    11.   
  
  
  
  11.  this.reason = reason; 
    12.   
  
  
  
  12.  } 
    13.

构造函数中的参数解释如下：

•status ：http status

•reason ：response 的消息内容

•cause ：抛出的异常

分享标题：SpringBoot处理异常的几种常见姿势
当前路径：http://www.gawzjz.com/qtweb/news11/174611.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

用户体验知识

各行业网站

大足网站建设　　 　鸿艺文化　　 　网站建设　　 　梦港之夜　　 　黔盛装饰　　 　巴中倍辉科技　　 　西部信息机房　　 　腾讯云免备案主机　　 　高县网站建设　　 　成都封阳台　　 　网站优化公司　　 　微信小程序开发　　 　成都圣月窗帘　　 　网站免费收录　　 　网络推广外包　　 　清舞人间　　 　响应式网站　　 　四川晃众门窗　　 　网站推广公司　　 　成都商城网站制作