如何优雅的处理Spring Boot异常信息详解

更新时间：2019年04月13日 07:14:27 作者：罗摩尔

这篇文章主要给大家介绍了关于如何优雅的处理Spring Boot异常信息的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Spring Boot具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧

Spring Boot 异常处理

异常处理是一种识别并响应错误的一致性机制，异常机制可以把程序中的异常处理代码和正常的业务逻辑代码分离，包装程序的可读性和健壮性。在Spring Boot应用程序中，能够捕获并及时的响应客户端的错误操作是一件非常重要的事情。在本章节中,我将展示如何处理Spring Boot中的异常。

1. 相关注解说明

在进行演示之前，我们先了解一下在Spring Boot应用程序中与异常处理相关的几个注解

注解名称	说明
@ControllerAdvice	该标签用于处理全局的异常信息
@ExceptionHadler	用于处理特定异常信息，并返回相关的响应到客户端

首先，我们需要使用**@ControllerAdvice**注解来定义一个全局的异常信息处理类，其语法如下：

package com.ramostear.exception.handler;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:33
 */
@ControllerAdvice
public class UserExceptionHandler {
	//TODO ...
}

接下来，我们需要定义一个扩展了RuntimeException类的自定义异常处理类：

package com.ramostear.exception.handler;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:31
 */
public class UserNotFoundException extends RuntimeException{
 private static final long serialVersionUID = 5534028121297403043L;
}

最后，我们使用**@ExceptionHandler**注解来定义一个处理具体异常信息的方法，其语法如下：

@ExceptionHandler(value = UserNotFoundException.class)
 public ResponseEntity<Object> exception(UserNotFoundException ex){
  return new ResponseEntity<>("user not found.", HttpStatus.NOT_FOUND);
 }

以上工作准备完成之后，我们可以使用如下的方式来处理API中的异常信息：

@GetMapping("/users/{id}")
 public ResponseEntity<Object> getUser(@PathVariable(name = "id") long id){
  if(!userRepo.containsKey ( id )){
   throw new UserNotFoundException ();
  }
  return new ResponseEntity<> (userRepo.get (id), HttpStatus.OK);
 }

接下来的内容当中，我将给出完整的示例代码，使用HTTP GET方法请求一个用户信息，当用户存储库中没有相应的用户信息时，返回“user not found”提示信息。

2. 自定义异常信息类 — UserNotFoundException.java

package com.ramostear.exception.handler;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:31
 */
public class UserNotFoundException extends RuntimeException{
 private static final long serialVersionUID = 5534028121297403043L;
}

说明：这里只是做了一个简单的扩展

2. 全局异常处理类 —UserExceptionHandler.java

package com.ramostear.exception.handler;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:33
 */
@ControllerAdvice
public class UserExceptionHandler {


 @ExceptionHandler(value = UserNotFoundException.class)
 public ResponseEntity<Object> exception(UserNotFoundException ex){
  return new ResponseEntity<>("user not found.", HttpStatus.NOT_FOUND);
 }
}

在UserExceptionHandler.java文件中，我们定义了一个处理用户不存在异常的方法，

3. API类 — UserServiceController.java

package com.ramostear.exception.handler.controller;

import com.ramostear.exception.handler.UserNotFoundException;
import com.ramostear.exception.handler.model.User;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.PostConstruct;
import java.util.HashMap;
import java.util.Map;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:26
 */
@RestController
public class UserServiceController {

 private static Map<Long,User> userRepo = new HashMap<>();

 @PostConstruct
 public void initUserRepo(){
  User admin = new User ().setId ( 1 ).setName ( "admin" );
  userRepo.put ( admin.getId (),admin );

  User editor = new User ().setId ( 2 ).setName ( "editor" );
  userRepo.put ( editor.getId (),editor );
 }


 @GetMapping("/users/{id}")
 public ResponseEntity<Object> getUser(@PathVariable(name = "id") long id){
  if(!userRepo.containsKey ( id )){
   throw new UserNotFoundException ();
  }
  return new ResponseEntity<> (userRepo.get (id), HttpStatus.OK);
 }
}

在getUser()方法中，如果用户没有找到，则抛出UserNotFoundException异常。

4. 应用主类 —ExceptionHandlerApplication.java

package com.ramostear.exception.handler;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ExceptionHandlerApplication {

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

5. 用户POJO类 — User.java

package com.ramostear.exception.handler.model;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:23
 */
@Getter
@Setter
@NoArgsConstructor
public class User {

 private long id;

 private String name;

 public User setId(long id){
  this.id = id;
  return this;
 }

 public User setName(String name){
  this.name = name;
  return this;
 }
}

6. Maven构建文件 — pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.3.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.ramostear</groupId>
	<artifactId>exception-handler</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>exception-handler</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

8. 运行测试

接下来，我们将打包运行我们的程序，本次教程演示将使用IDEA来运行程序，运行结果如下图所示：

然后，启动Postman应用程序，我们先在地址栏输入：http://localhost:8080/users/1 ，观察正常情况下的测试信息：

Postman的测试结果显示，请求状态为200，且返回了用户的详细信息。现在，我们更新URL为：http://localhost:8080/users/3 ,再次观察测试结果：

此时的HTTP Status为404，且返回了“user not found.”的提示信息。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对脚本之家的支持。

您可能感兴趣的文章:

Spring下token过期时间分平台(web和app)设置方法
本文详细介绍了在Spring环境下,针对web端和APP端实现不同token过期时间的方法,通过整合SpringBoot、springSecurity和JWT框架,文章讲解了登录流程、JWT的基本组成以及token鉴权的核心步骤,需要的朋友可以参考下
2024-10-10
Java实战之在线租房系统的实现
这篇文章主要介绍了利用Java实现的在线租房系统，文中用到了SpringBoot、Redis、MySQL、Vue等技术，文中示例代码讲解详细，需要的可以参考一下
2022-02-02
Java方法重写_动力节点Java学院整理
在Java和其他一些高级面向对象的编程语言中，子类可继承父类中的方法，而不需要重新编写相同的方法。但有时子类并不想原封不动地继承父类的方法，而是想作一定的修改，这就需要采用方法的重写。方法重写又称方法覆盖，下文给大家介绍java方法重写及重写规则，一起学习吧
2017-04-04
idea创建包含多个springboot module的maven project的方法
这篇文章主要介绍了idea创建包含多个springboot module的maven project的方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-09-09
Java 跳出递归循环问题解决办法
这篇文章主要介绍了 Java 跳出递归循环问题解决办法的相关资料,需要的朋友可以参考下
2017-07-07
【MyBatis源码全面解析】MyBatis一二级缓存介绍
下面小编就为大家带来一篇【MyBatis源码全面解析】MyBatis一二级缓存介绍。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-06-06
mybatis通过TypeHandler list转换string类型转换方式
这篇文章主要介绍了mybatis通过TypeHandler list转换string类型转换方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-07-07
Java使用Queryable-pageable实现分页效果
这篇文章主要为大家介绍了Java如何使用Queryable-pageable从而实现分页效果，文中的示例代码简洁易懂，感兴趣的小伙伴可以动手尝试一下
2022-06-06
Java设计模式之建造者模式（Builder模式）介绍
这篇文章主要介绍了Java设计模式之建造者模式（Builder模式）介绍,本文讲解了为何使用建造者模式、如何使用建造者模式、Builder模式的应用等内容,需要的朋友可以参考下
2015-03-03
解决偶现的MissingServletRequestParameterException异常问题
这篇文章主要介绍了解决偶现的MissingServletRequestParameterException问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-10-10

如何优雅的处理Spring Boot异常信息详解

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具