SpringBoot实战项目学习（7）——进行统一的异常处理

最新推荐文章于 2022-04-21 12:31:39 发布
最新推荐文章于 2022-04-21 12:31:39 发布
阅读量349 收藏 1
点赞数
分类专栏： SpringBoot实战项目 文章标签： java spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Felix_hyfy/article/details/107799309
版权

文章目录

在Spring Boot中进行统一的异常处理，包括两种方式的处理：第一种对常见API形式的接口进行异常处理，统一封装返回格式；第二种是对模板页面请求的异常处理，统一处理错误页面

基于GitHub项目xkcoding/**spring-boot-demo**进行学习

项目地址：https://github.com/xkcoding/spring-boot-demo

项目结构

  • exception/handler包下一共有五个包：
    • constant包：保存状态码及对应信息
    • controller包：控制器
    • exception包：放置异常基类及其子类
    • handler包：放置统一异常处理（json和页面异常处理）
    • model包

在这里插入图片描述

pom.xml

  • 页面需要使用thymeleaf模板引擎渲染，所以需要导入thymeleaf依赖
<?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>

	<artifactId>spring-boot-demo-exception-handler</artifactId>
	<version>1.0.0-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>spring-boot-demo-exception-handler</name>
	<description>Demo project for Spring Boot</description>

	<parent>
		<groupId>com.xkcoding</groupId>
		<artifactId>spring-boot-demo</artifactId>
		<version>1.0.0-SNAPSHOT</version>
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
    <!--模板引擎thymeleaf依赖-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-thymeleaf</artifactId>
		</dependency>

		<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>
			<optional>true</optional>
		</dependency>
	</dependencies>

	<build>
		<finalName>spring-boot-demo-exception-handler</finalName>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

配置文件application.yml

server:
  port: 8080
  servlet:
    context-path: /demo
spring:
  thymeleaf:
    cache: false      # 禁用thymeleaf模板缓存
    mode: HTML
    encoding: UTF-8
    servlet:
      content-type: text/html

页面模板error.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head lang="en">
	<meta charset="UTF-8"/>
	<title>统一页面异常处理</title>
</head>
<body>
<h1>统一页面异常处理</h1>
<div th:text="${message}"></div>
</body>
</html>

状态码封装类Status

  • 这种通用类一般会放在common包下，在这里放在了constant包下
package com.xkcoding.exception.handler.constant;

import lombok.Getter;

/**
 * <p>
 * 状态码封装
 * </p>
 *
 * @package: com.xkcoding.exception.handler.constant
 * @description: 状态码封装
 * @author: yangkai.shen
 * @date: Created in 2018/10/2 9:02 PM
 * @copyright: Copyright (c) 2018
 * @version: V1.0
 * @modified: yangkai.shen
 */
@Getter
public enum Status {
	/**
	 * 操作成功
	 */
	OK(200, "操作成功"),
	
	/**
	 * 未知异常
	 */
	UNKNOWN_ERROR(500, "服务器出错啦");
	/**
	 * 状态码
	 */
	private Integer code;
	/**
	 * 内容
	 */
	private String message;

	Status(Integer code, String message) {
		this.code = code;
		this.message = message;
	}
}

异常类

异常基类BaseException

  • 异常基类需要继承运行时异常类RuntimeException
package com.xkcoding.exception.handler.exception;

import com.xkcoding.exception.handler.constant.Status;
import lombok.Data;
import lombok.EqualsAndHashCode;

/**
 * <p>
 * 异常基类
 * </p>
 *
 * @package: com.xkcoding.exception.handler.exception
 * @description: 异常基类
 * @author: yangkai.shen
 * @date: Created in 2018/10/2 9:31 PM
 * @copyright: Copyright (c) 2018
 * @version: V1.0
 * @modified: yangkai.shen
 */
@Data
@EqualsAndHashCode(callSuper = true)
public class BaseException extends RuntimeException {

  /**
   * 状态码和消息字段
   */
  private Integer code;
	private String message;

	public BaseException(Status status) {
	  // 输出异常信息
		super(status.getMessage());
		this.code = status.getCode();
		this.message = status.getMessage();
	}

	public BaseException(Integer code, String message) {
		super(message);
		this.code = code;
		this.message = message;
	}
}

JSON异常类JsonException

package com.xkcoding.exception.handler.exception;

import com.xkcoding.exception.handler.constant.Status;
import lombok.Getter;

/**
 * <p>
 * JSON异常
 * </p>
 *
 * @package: com.xkcoding.exception.handler.exception
 * @description: JSON异常
 * @author: yangkai.shen
 * @date: Created in 2018/10/2 9:18 PM
 * @copyright: Copyright (c) 2018
 * @version: V1.0
 * @modified: yangkai.shen
 */
@Getter
public class JsonException extends BaseException {

	public JsonException(Status status) {
		super(status);
	}

	public JsonException(Integer code, String message) {
		super(code, message);
	}
}

页面处理异常类PageException

package com.xkcoding.exception.handler.exception;

import com.xkcoding.exception.handler.constant.Status;
import lombok.Getter;

/**
 * <p>
 * 页面异常
 * </p>
 *
 * @package: com.xkcoding.exception.handler.exception
 * @description: 页面异常
 * @author: yangkai.shen
 * @date: Created in 2018/10/2 9:18 PM
 * @copyright: Copyright (c) 2018
 * @version: V1.0
 * @modified: yangkai.shen
 */
@Getter
public class PageException extends BaseException {

	public PageException(Status status) {
		super(status);
	}

	public PageException(Integer code, String message) {
		super(code, message);
	}
}

通用API接口封装类ApiResponse

  • 通过这个类可以将各种异常、有状态的API或者自定义消息的API以统一的ApiResponse类型格式返回
package com.xkcoding.exception.handler.model;

import com.xkcoding.exception.handler.constant.Status;
import com.xkcoding.exception.handler.exception.BaseException;
import lombok.Data;

/**
 * <p>
 * 通用的 API 接口封装
 * </p>
 *
 * @package: com.xkcoding.exception.handler.model
 * @description: 通用的 API 接口封装
 * @author: yangkai.shen
 * @date: Created in 2018/10/2 8:57 PM
 * @copyright: Copyright (c) 2018
 * @version: V1.0
 * @modified: yangkai.shen
 */
@Data
public class ApiResponse {
	/**
	 * 状态码
	 */
	private Integer code;

	/**
	 * 返回内容
	 */
	private String message;

	/**
	 * 返回数据
	 */
	private Object data;

	/**
	 * 无参构造函数
	 */
	private ApiResponse() {

	}

	/**
	 * 全参构造函数
	 *
	 * @param code    状态码
	 * @param message 返回内容
	 * @param data    返回数据
	 */
	private ApiResponse(Integer code, String message, Object data) {
		this.code = code;
		this.message = message;
		this.data = data;
	}

	/**
	 * 构造一个自定义的API返回
	 *
	 * @param code    状态码
	 * @param message 返回内容
	 * @param data    返回数据
	 * @return ApiResponse
	 */
	public static ApiResponse of(Integer code, String message, Object data) {
		return new ApiResponse(code, message, data);
	}

	/**
	 * 构造一个成功且带数据的API返回
	 *
	 * @param data 返回数据
	 * @return ApiResponse
	 */
	public static ApiResponse ofSuccess(Object data) {
		return ofStatus(Status.OK, data);
	}

	/**
	 * 构造一个成功且自定义消息的API返回
	 *
	 * @param message 返回内容
	 * @return ApiResponse
	 */
	public static ApiResponse ofMessage(String message) {
		return of(Status.OK.getCode(), message, null);
	}

	/**
	 * 构造一个有状态的API返回
	 *
	 * @param status 状态 {@link Status}
	 * @return ApiResponse
	 */
	public static ApiResponse ofStatus(Status status) {
		return ofStatus(status, null);
	}

	/**
	 * 构造一个有状态且带数据的API返回
	 *
	 * @param status 状态 {@link Status}
	 * @param data   返回数据
	 * @return ApiResponse
	 */
	public static ApiResponse ofStatus(Status status, Object data) {
		return of(status.getCode(), status.getMessage(), data);
	}

	/**
	 * 构造一个异常且带数据的API返回
	 *
	 * @param t    异常
	 * @param data 返回数据
	 * @param <T>  {@link BaseException} 的子类
	 * @return ApiResponse
	 */
	public static <T extends BaseException> ApiResponse ofException(T t, Object data) {
		// 输出的类型T是BaseException的继承类
    // 返回的ApiResponse类
	  return of(t.getCode(), t.getMessage(), data);
	}

	/**
	 * 构造一个异常且带数据的API返回
	 *
	 * @param t   异常
	 * @param <T> {@link BaseException} 的子类
	 * @return ApiResponse
	 */
	public static <T extends BaseException> ApiResponse ofException(T t) {
		return ofException(t, null);
	}
}

统一异常处理类DemoExceptionHandler

  • 该类将json异常返回为一个JSON字符串；
  • 将页面异常创建一个视图对象，并设置其相关属性，将视图返回到前端，由模板引擎进行解析并显示
package com.xkcoding.exception.handler.handler;

import com.xkcoding.exception.handler.exception.JsonException;
import com.xkcoding.exception.handler.exception.PageException;
import com.xkcoding.exception.handler.model.ApiResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;

/**
 * <p>
 * 统一异常处理
 * </p>
 *
 * @package: com.xkcoding.exception.handler.handler
 * @description: 统一异常处理
 * @author: yangkai.shen
 * @date: Created in 2018/10/2 9:26 PM
 * @copyright: Copyright (c) 2018
 * @version: V1.0
 * @modified: yangkai.shen
 */
@ControllerAdvice
@Slf4j
public class DemoExceptionHandler {
	private static final String DEFAULT_ERROR_VIEW = "error";

	/**
	 * 统一 json 异常处理
	 *
	 * @param exception JsonException
	 * @return 统一返回 json 格式
	 */
	@ExceptionHandler(value = JsonException.class)
	@ResponseBody
	public ApiResponse jsonErrorHandler(JsonException exception) {
	  // 使用占位符，记录日志信息
		log.error("【JsonException】:{}", exception.getMessage());
		// 返回一个ApiResponse，本质上是一个JSON字符串，只有code和message，而data为null
		return ApiResponse.ofException(exception);
	}

	/**
	 * 统一 页面 异常处理
	 *
	 * @param exception PageException
	 * @return 统一跳转到异常页面
	 */
	@ExceptionHandler(value = PageException.class)
	public ModelAndView pageErrorHandler(PageException exception) {
	  // 记录日志信息
		log.error("【DemoPageException】:{}", exception.getMessage());
		// 创建一个ModelAndView对象
		ModelAndView view = new ModelAndView();
		view.addObject("message", exception.getMessage());
		// 设置视图的名字为error
    // 视图解析器会到templates文件夹下寻找同名的模板，并进行渲染（渲染message字段，将原始数据进行替换）
		view.setViewName(DEFAULT_ERROR_VIEW);
		return view;
	}
}

测试控制器TestController

package com.xkcoding.exception.handler.controller;

import com.xkcoding.exception.handler.constant.Status;
import com.xkcoding.exception.handler.exception.JsonException;
import com.xkcoding.exception.handler.exception.PageException;
import com.xkcoding.exception.handler.model.ApiResponse;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;

/**
 * <p>
 * 测试Controller
 * </p>
 *
 * @package: com.xkcoding.exception.handler.controller
 * @description: 测试Controller
 * @author: yangkai.shen
 * @date: Created in 2018/10/2 8:49 PM
 * @copyright: Copyright (c) 2018
 * @version: V1.0
 * @modified: yangkai.shen
 */
@Controller
public class TestController {

	@GetMapping("/json")
	@ResponseBody
	public ApiResponse jsonException() {
		throw new JsonException(Status.UNKNOWN_ERROR);
	}

	@GetMapping("/page")
	public ModelAndView pageException() {
		throw new PageException(Status.UNKNOWN_ERROR);
	}
}

测试

  • 访问http://localhost:8080/demo/json，可以看到json类型的异常字符串

    在这里插入图片描述

  • 访问http://localhost:8080/demo/page，可以看到thymeleaf已经将相关字段渲染为异常信息

在这里插入图片描述

Felix_hyfy
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
springboot 常用配置，模板引擎，全局异常处理使用代码
09-27
springBoot  全局的异常处理；springboot常用的属性配置；Spring Boot 使用thymeleaf；Spring Boot 使用freemarker
SpringBoot 统一异常处理详解
08-26
SpringBoot 统一异常处理是指在 SpringBoot 应用程序中统一处理异常的机制，通过将所有异常统一处理，提高了应用程序的健壮性和可维护性。在本文中，我们将详细介绍 SpringBoot 统一异常处理的实现细节，并提供了...
​Spring Cloud：统一异常处理
程序员闪充宝
02-26 335
作者：BNDongwww.cnblogs.com/bndong/p/10135370.html在启动应用时会发现在控制台打印的日志中出现了两个路径为 {[/error]} 的访问地址，当系...
SpringBoot实战（十）:统一异常处理
通往精英的成长之路
06-21 993
强烈推荐一个大神的人工智能的教程：http://www.captainbed.net/zhanghan 【前言】 处理好异常对系统有很好的保护作用同时会大大提高用户的体验，对异常统一处理是一个非常实用的技巧，接下来介绍一下如何在系统中对异常进行统一处理； 【统一异常处理】 一、未加统一异常处理时 启动程序，并访问http://...
【翠花学习单例模式】项目框架升级之单例模式及统一异常处理
m0_57082679的博客
04-21 295
优点： 可以对资源进行重复利用，节约重复创建和销毁的成本，从而降低服务器压力，提高程序效率。 实现单例模式的三个关键点： 一个类只有一个实例。 自行创建实例对象。 对外提供实例对象。 示例一：饿汉式写法 饿汉可以理解为当前应用程序很“饥饿”， 需要立即获取到类的实例对象，即在类加载的时候就完成了实例的创建工作。因此类加载速度相对较慢，不过第一次获取实例会很快。因为饿汉模式是在类初始化时就自行实例化，所以不存在线程安全问题。 示例二：懒汉式写法一 懒汉式是懒加载的意思，即在类加载时
项目框架升级单例-统一异常
weixin_46461502的博客
07-22 103
单例模式 什么是单例，在数据连接或者说数据数据使用的时候在通过new 关键字创建的对象，都不是同一个对象，这样造成了一个对象不能多重调用 ，而单例对象是一次调用就一直保持不变，尽管有新的实例，也是原来的第一次使用的实例对象 并且是static的 单例方式 1.一个类只有一个对象 当前了中才能有对象 因为构造方法是被私有化了 2.自行创建实例对象 在使用这个对象的时候，在自己的类中实例化出自己 3.对外提供静态类对象 这个对象只会执行一次，在当前类中无论怎么创建实例，永远都是一个 每一个对象都是独
SpringBoot 2 统一异常处理过程解析
08-25
SpringBoot 2 统一异常处理过程解析 统一异常处理是 SpringBoot 2 中的一个重要机制，它可以帮助开发者更好地处理应用程序中的异常。通过本文，我们将详细介绍 SpringBoot 2 统一异常处理过程解析，来帮助读者更好...
SpringBoot逻辑异常统一处理方法
08-25
在本文中，我们将探讨 SpringBoot 逻辑异常统一处理方法，该方法主要介绍了如何在 SpringBoot 项目中实现逻辑异常的统一处理。通过示例代码，我们将展示如何创建一个异常处理核心子模块，并如何在 SpringBoot 项目中...
SpringBoot初始教程之统一异常处理详解
08-30
当页面发生异常时，SpringBoot会自动将请求转到/error路径，BasicErrorController将对异常进行统一处理。我们可以通过application.yaml文件中的error.path属性来自定义error页面的路径。 BasicErrorController提供...
springboot统一异常处理
01-24
springboot统一异常处理
详解Spring boot/Spring 统一错误处理方案的使用
08-27
主要介绍了详解Spring boot/Spring 统一错误处理方案的使用，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
66个404错误页面模板免费打包下载
09-30
怎么使用404页面？ 一、下载404页面模板。 点击下载404页面模板，然后解压，可以发现有很多404网页模板。挑选一个您最喜欢的页面代码。 二、修改404页面中的素材网址为绝对地址。 为了您的404页面素材正常显示，需要您修改一下素材中的引用网址。例如网页中一个网址为"/404/Main.jpg"那么你应该改成带有网址的“http://www.390seo.com/404/Main.jpg” 三、将修改好的代码上传到网站中 用FTP软件将网站上传到网站中，并且部署好网页和素材之间的关系。如果有死链接之类的要第一时间解决。 四、在服务器上配置自定义404的路径 这里边可能会遇到两种情况： 1、虚拟主机。一般空间商提供的面板都有自定义404的功能，根据提示设置成自定义的404页面。 2、独立服务器或VPS。这个稍微复杂一些，在网站管理里边找到网站，打开属性 > 自定义出错页面 > 404 然后填入。 五、检查404页面是否能够正常访问 找一个打不开的网址，看看是否会显示自定义的404页面。如果没有返回第四步重新设置，直到看到显示正确为止。 六、检查404页面返回码。 有时候正常使用了，返回码可不一定正常。检查返回状态码建议使用这个工具：http://tool.chinaz.com/pagestatus/。在这个工具中404页面返回码如果不正常，返回调试都不行，请看这篇文章。
简单漂亮404错误页面模板.zip
05-27
简单漂亮404错误页面模板，抱歉，找不到此页面~你请求访问的页面，暂时找不到，我们建议你返回首页官网进行浏览，谢谢！有进入官网首页按钮链接。
SpringBoot全局异常处理
qq_43610675的博客
03-09 134
自定义错误页面 覆盖错误页面方式 在/resources/templates下面创建error.html就可以覆盖默认的错误页面 代码示例 <!DOCTYPE html> <html lang="en" xmlns:th="http://www.w3.org/1999/xhtml"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <
统一返回结果和异常处理 内有模板
weixin_50224527的博客
09-14 252
统一返回结果 创建异常枚举 package com.atguigu.srb.common.result; import lombok.AllArgsConstructor; import lombok.Getter; import lombok.ToString; @Getter @ToString @AllArgsConstructor public enum ResponseEnum { SUCCESS(0, "成功"), ERROR(-1, "服务器内部错误"), //-1
Spring Boot的统一异常处理
nuist_NJUPT的博客
10-30 595
Spring Boot的统一异常处理 在Spring Boot应用开发中，不管是对底层数据库的操作，对业务层的操作，还是对控制层的操作，都会不可避免的遇到各种未知的异常需要处理，如果每个过程都单独处理异常，那么系统的代码耦合度高，工作量大且不好统一，以后维护的工作量也很大。 如果能将所有类型的异常处理从各层中解耦出来，则既保证了相关处理过程的功能单一，也实现了异常信息的统一处理和维护。幸运的是，Spring的框架支持这样的实现，本节将从自定义error页面，@ExceptionHandler注解以及@Con
Spring Boot中进行统一的异常处理
志豪的博客
12-11 122
spring-boot-demo-exception-handler 此 demo 演示了如何在Spring Boot中进行统一的异常处理，包括了两种方式的处理：第一种对常见API形式的接口进行异常处理，统一封装返回格式；第二种是对模板页面请求的异常处理，统一处理错误页面。 pom.xml <?xml version="1.0" encoding="UTF-8"?> <pro...
单例模式，异常处理
dafeng_xiaobai的博客
05-26 171
创建单例 class A(object): __instance = None def __new__(cls): if cls.__instance == None: cls.__instance = object.__new__(cls) return cls.__instance else: return cls.__instance ​ a = A() b = A() #a与...
SpringBoot统一处理异常
大老杨的博客
04-28 784
在springboot项目，报错有着默认的提示，这篇文章介绍一下如何统一处理异常。 新建项目，pom文件如下： &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSche...
[] - 2023-08-16 告别繁琐：SpringBoot 拦截器与统一功能处理.pdf
最新发布
12-11
该资源是一份关于如何在SpringBoot应用中使用拦截器实现统一功能处理的PDF教程，特别强调了简化用户登录权限验证、数据格式返回以及异常处理的方法。这份资料可能适合对SpringBoot和AOP编程感兴趣的开发者，尤其是...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值