为你Springboot项目自己设置一个通用的异常(实用干货)

作者 : 开心源码 本文共3204个字,预计阅读时间需要9分钟 发布时间: 2022-05-14 共348人阅读

前言

我们的项目通常来讲都是一个比较大的项目,包含了各种各样的服务。假如每个服务都以不同的方式返回异常信息,这样排查的时候就会比较凌乱。假如我们定义一个标准的异常解决体系。并在所有的服务中使用。那样开发起来即可以快速定位。页面也会更加的简单和直观。

本文开发环境基于springboot2.4,IDE环境是IDEA。这里从一个最简单的异常案例。逐渐过渡到完全自己设置自己的异常。

案例:Springboot查询数据库数据,发现返回的是null,就抛出异常。

OK,基于这个思想,看一下实现的思路。

一、简单案例代码实现

1、新建一个Springboot应用

image.png

2、新建dao包,创立User类

这个比较简单,代码如下:

public class User {private int id;private String name;public User() {}public User(int id, String name) {this.id = id;this.name = name;}//getter和setter方法//toString方法}

3、新建service包,创立UserService

@Servicepublic class UserService {public User findOne(int id){//原本应该向数据库查询User,但是数据库没有return null;}}

因为演示的是异常的案例,因而这里没有真正实现数据库的增删改查操作。当调用findOne方法时,直接返回为null就可。

4、新建controller包,创立UserController类

@RestControllerpublic class UserController {@Autowiredprivate UserService service;@GetMapping("/users/{id}")public User retriveUser(@PathVariable int id) throws UserNotFoundException {User user= service.findOne(id);if(user==null)throw new UserNotFoundException("id: "+ id);return user;}}

这里自己设置了一个异常UserNotFoundException,当数据库查询的时候一旦发现返回值为null,就直接抛出这个异常。

5、在controller包下,创立UserNotFoundException类

public class UserNotFoundException extends RuntimeException {public UserNotFoundException(String message){super(message);System.out.println("异常信息是:"+message);}}

6、postman测试

image

这时候进行测试会发现服务器代码会报错。我们的资源没有找到总不能提醒服务器内部错误吧。现在对抛出的异常进行一个解决。

7、异常解决

@ResponseStatus(HttpStatus.NOT_FOUND)public class UserNotFoundException extends RuntimeException {public UserNotFoundException(String message){super(message);System.out.println("异常信息是:"+message);}}

我们将增加一个注释@ResponseStatus来生成状态:404 Not Found。当然还有其余的状态。这个可以根据自己的需要去返回。我们使用了HttpStatus.NOT_FOUND客户访问的时候,一旦抛出了异常就会显示404错误。这个你换成其余的状态,还会显示其余的信息。

8、重新测试

image.png

Spring Boot和Spring MVC框架的结合提供了错误解决。其内部已经自动配置少量默认异常解决。所以在开发中为所有服务配置一致的异常消息是很重要的。

二、通用的异常解决

1、增加依赖

<dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>5.3.2</version></dependency>

2、创立异常返回实体类ExceptionResponse

这个类的作用是,当有异常时,我们想要展现的信息。

public class ExceptionResponse {private Date timestamp;private String message;private String detail;public ExceptionResponse() { }public ExceptionResponse(Date timestamp, String message, String detail) {this.timestamp = timestamp;this.message = message;this.detail = detail;}public Date getTimestamp() {return timestamp;}public String getMessage() {return message;}public String getDetail() {return detail;}}

这里只要要实现getter方法,setter方法就不需要。

3、创立通用异常解决类

@ControllerAdvice@RestControllerpublic class CustomizedResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {//此方法主要解决所有的异常信息@ExceptionHandler(Exception.class)public final ResponseEntity<Object> handleAllExceptions(Exception ex, WebRequest request) {//当出现异常时,我们输出的信息,这里被封装在了ExceptionResponseExceptionResponse exceptionResponse = new ExceptionResponse(new Date(), ex.getMessage(), request.getDescription(false));return new ResponseEntity(exceptionResponse, HttpStatus.INTERNAL_SERVER_ERROR);}//当页面资源没有找到时,抛出的异常@ExceptionHandler(UserNotFoundException.class)public final ResponseEntity<Object> handleUserNotFoundExceptions(UserNotFoundException ex, WebRequest request) {ExceptionResponse exceptionResponse = new ExceptionResponse(new Date(), ex.getMessage(), request.getDescription(false));return new ResponseEntity(exceptionResponse, HttpStatus.NOT_FOUND);}}

很简单。里面有很多API,可以自己根据需要去查就可。

4、postman测试

image.png

万事大吉。赶快为你的程序自己设置一个通用的异常解决程序吧。

说明
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是摆设,本站源码仅提供给会员学习使用!
7. 如遇到加密压缩包,请使用360解压,如遇到无法解压的请联系管理员
开心源码网 » 为你Springboot项目自己设置一个通用的异常(实用干货)

发表回复