SpringBoot项目自定义异常，配置全局异常统一处理，避免出现大量try/catch的问题

于 2023-12-21 10:21:44 发布
阅读量437 收藏 8
点赞数 10
分类专栏： Java 文章标签： spring boot java 全局异常处理
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43659871/article/details/135124597
版权

完整代码地址在结尾！！

第一步，创建一个SpringBoot项目，此处不赘述

第二步，编写application.yml配置文件，如下

server:
  port: 8085

spring:
  application:
    name: exception-demo-server

第三步，创建响应码枚举ResponseEnums，统一响应类Response，如下

ResponseEnums

import lombok.AllArgsConstructor;
import lombok.Getter;

/**
 * @version 1.0
 * @author jinhaoxun
 * @date 2018-05-09
 * @description 响应码枚举
 */
@Getter
@AllArgsConstructor
public enum ResponseEnums {

    /**
     * 请求成功
     */
    SUCCESS(200,"请求成功"),
    /**
     * 系统异常，请稍后重试
     */
    EXCEPTION(10000,"系统异常，请稍后重试"),
    /**
     * 请求的资源(网页等)不存在
     */
    NOT_FOUND(404,"请求的资源(网页等)不存在"),

    /**
     * 共6位,1：系统异常码和值定义在该类中，大家公用
     * 前2位表示大板块（10：系统，11：管理后台模块，12：文章模块，13：公共模块，14：上传下载文件模块）
     * 第3,4位表示项目的小模块，5，6位代表具体错误
     */
    /**************************           系统模块             *******************************/
    /**
     * 登陆超时
     */
    LOGIN_TIMEOUT(100001  ,"登陆超时"),
    /**
     * 参数有误
     */
    WRONG_PARAM(100002  ,"参数有误"),
    /**
     * 缺少必要的参数
     */
    MISS_PARAM(100003  ,"缺少必要的参数"),
    /**
     * Hystrix 降级开启抛出异常
     */
    HYSTRIX_THROW_EXCEPTION(100004  ,"请求超时，请稍后重试"),

    /**************************           账号模块             *******************************/
    /**
     * 您没有该权限
     */
    MNG_PERMISSION_DENY(110101,"您没有该权限"),
    /**
     * 密码错误
     */
    PASSWORD_WRONG(110102,"密码错误"),
    /**
     * 用户不存在
     */
    USER_NOT_EXIST(110103,"用户不存在"),
    /**
     * 账号被封禁
     */
    ACCOUNT_IS_BLOCKED(110104,"账号被封禁"),
    /**
     * 账号已注销
     */
    ACCOUNT_IS_CANCELLED(110105,"账号已注销"),
    /**
     * 验证码已过期
     */
    VERIFICATION_CODE_EXPIRED(110106,"验证码已过期"),
    /**
     * 从Redis中获取验证码错误
     */
    GET_CODE_WRONG_FROM_REDIS(110107,"从Redis中获取验证码错误"),
    /**
     * 身份信息已过期
     */
    IDENTITY_INFORMATION_IS_EXPIRED(110108,"身份信息已过期"),
    /**
     * 用户未登录
     */
    USER_NOT_LOG_IN(110109,"用户未登录"),
    /**
     * 用户退出登录失败
     */
    USER_LOG_OUT_FAIL(110110,"用户退出登录失败"),

    /**
     * 密码修改失败
     */
    PASSWORD_CHANGE_FAIL(110112,"密码修改失败"),
    /**
     * 账号封禁失败
     */
    ACCOUNT_BLOCK_FAIL(110113,"账号封禁失败"),
    /**
     * 账号解封失败
     */
    ACCOUNT_UNSEALING_FAIL(110114,"账号解封失败"),
    /**
     * 账号注册失败
     */
    ACCOUNT_REGISTRATION_FAIL(110115,"账号注册失败"),
    /**
     * 获取手机验证码失败
     */
    GET_PHONE_CODE_FAIL(110116,"获取手机验证码失败"),
    /**
     * 获取邮箱验证码失败
     */
    GET_EMAIL_CODE_FAIL(110117,"获取邮箱验证码失败"),
    /**
     * 获取用户信息失败
     */
    GET_USERINFO_FAIL(110118,"获取用户信息失败"),
    /**
     * 更新用户信息失败
     */
    UPDATE_USERINFO_FAIL(110119,"更新用户信息失败"),
    /**
     * 账号注销失败
     */
    ACCOUNT_CANAEL_FAIL(110120,"账号注销失败"),
    /**
     * 重复获取验证码
     */
    REPEAT_GET_USER_LOG_IN_CODE(110121,"重复获取验证码"),
    /**
     * 验证码已过期
     */
    USER_LOG_IN_CODE_EXPIRATIONED(110122,"验证码已过期"),
    /**
     * 验证码错误
     */
    USER_LOG_IN_CODE_WRONG(110123,"验证码错误"),
    ;

    public Integer code;
    public String msg;

}

Response

import com.luoyu.exception.constant.ResponseEnums;
import lombok.Data;

import java.io.Serializable;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

/**
 * Response
 *
 * @author luoyu
 * @date 2018/10/07 13:28
 * @description 通用返回类
 */
@Data
public class Response implements Serializable {

    private String msg;
    private int code;
    private Object data;
    private String time;

    private Response() {
    }

    private Response(int code, String msg) {
        this.code = code;
        this.msg = msg;
        this.time = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss").format(LocalDateTime.now());
    }

    private Response(int code, String msg, Object data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
        this.time = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss").format(LocalDateTime.now());
    }

    public static Response success() {
        return new Response(ResponseEnums.SUCCESS.getCode(), ResponseEnums.SUCCESS.getMsg());
    }

    public static Response success(Object data) {
        return new Response(ResponseEnums.SUCCESS.getCode(), ResponseEnums.SUCCESS.getMsg(), data);
    }

    public static Response success(Object data, String msg) {
        return new Response(ResponseEnums.SUCCESS.getCode(), msg, data);
    }

    public static Response fail() {
        return new Response(ResponseEnums.EXCEPTION.getCode(), ResponseEnums.EXCEPTION.getMsg());
    }

    public static Response fail(ResponseEnums responseEnums) {
        return new Response(responseEnums.getCode(), responseEnums.getMsg());
    }

    public static Response fail(ResponseEnums responseEnums, Object data) {
        return new Response(responseEnums.getCode(), responseEnums.getMsg(), data);
    }

    public static Response fail(int code, String msg) {
        return new Response(code, msg);
    }

    public static Response fail(int code, String msg, Object data) {
        return new Response(code, msg, data);
    }

}

第四步，创建自定义异常类CustomException，如下

import lombok.Data;

import java.io.Serializable;

/**
 * @version 1.0
 * @author jinhaoxun
 * @date 2018-05-09
 * @description 自定义统一异常（相当于业务异常）
 */
@Data
public class CustomException extends Exception implements Serializable {

	private static final long serialVersionUID = 1L;

	private Integer code;

	private String log;

	/**
	 * @author jinhaoxun
	 * @description 构造器
	 * @param code 异常状态码
	 * @param log 异常打印日志
	 * @param msg 异常返回信息
	 */
	public CustomException(Integer code, String log, String msg) {
		super(msg);
		this.code = code;
		this.log = log;
	}

}

第五步，创建全局异常统一处理类ExceptionHandle，如下

import com.luoyu.exception.constant.ResponseEnums;
import com.luoyu.exception.entity.vo.Response;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

/**
 * @version 1.0
 * @author jinhaoxun
 * @date 2018-05-09
 * @description 统一的异常处理
 */
@Slf4j
@RestControllerAdvice
public class ExceptionHandle {

	/**
	 * @author jinhaoxun
	 * @description 统一的异常处理方法
	 * @param e 抛出的异常
	 * @return 返回给前端的错误信息提示
	 */
	@ExceptionHandler(value = Exception.class)
	public Response handleException(Exception e){
		if(e instanceof CustomException) {
			CustomException ex = (CustomException)e;
			log.info("自定义业务异常：msg：" + ex.getMessage() + "，log：" + ex.getLog(), e);
			return Response.fail(ex.getCode(), ex.getMessage(),null);
		}else if(e instanceof MethodArgumentNotValidException) {
			MethodArgumentNotValidException ex = (MethodArgumentNotValidException)e;
			log.error("参数校验异常：msg：" + ex.getBindingResult().getFieldError().getDefaultMessage());
			return Response.fail(ResponseEnums.WRONG_PARAM.getCode(),
					ResponseEnums.WRONG_PARAM.getMsg() + "："
							+ ex.getBindingResult().getFieldError().getDefaultMessage(), null);
		}else{
			log.error("统一系统异常：msg：" + e.getMessage(), e);
			return Response.fail(ResponseEnums.EXCEPTION.getCode(), ResponseEnums.EXCEPTION.getMsg(), null);
		}
	}

}

说明

  1. @ExceptionHandler用于统一处理某一类异常，从而能够减少代码重复率和复杂度，所有抛出来的异常都会在这里被捕获

第六步，创建TestService，TestServiceImpl，TestController，如下

TestService

/**
 * @Description:
 * @Author: jinhaoxun
 * @Date: 2020/7/10 10:31 上午
 * @Version: 1.0.0
 */
public interface TestService {

    void get1() throws Exception;

    void get2() throws Exception;

}

TestServiceImpl

import com.luoyu.exception.exception.CustomException;
import com.luoyu.exception.service.TestService;
import org.springframework.stereotype.Service;

/**
 * @Description:
 * @Author: jinhaoxun
 * @Date: 2020/7/10 10:32 上午
 * @Version: 1.0.0
 */
@Service
public class TestServiceImpl implements TestService {

    @Override
    public void get1() throws Exception {
        int i = 1/0;
    }

    @Override
    public void get2() throws Exception {
        try {
            int i = 1/0;
        }catch (Exception e){
            throw new CustomException(10086, "自定义打印异常", "自定义返回异常");
        }
    }
    
}

TestController

import com.luoyu.exception.entity.vo.Response;
import com.luoyu.exception.service.TestService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * @Description:
 * @Author: jinhaoxun
 * @Date: 2020/7/10 10:31 上午
 * @Version: 1.0.0
 */
@RestController
@RequestMapping("/test")
public class TestController {

    @Resource
    private TestService testService;

    /**
     * @author jinhaoxun
     * @description 测试接口1
     */
    @GetMapping("/get1")
    public Response get1() throws Exception {
        testService.get1();
        return Response.success();
    }

    /**
     * @author jinhaoxun
     * @description 测试接口2
     */
    @GetMapping("/get2")
    public Response get2() throws Exception {
        testService.get2();
        return Response.success();
    }

}

解释

  1. 从可能出现异常的地方往外面抛异常，本文是从service开始，直到controller往外面抛出异常后，会被ExceptionHandle捕获，然后自行进行处理，打印日志，统一状态码，错误信息返回给前端。

第七步，启动项目，使用postman调接口，如下图

测试1，使用GET请求http://localhost:8085/test/get1

image.png

image.png

测试2，使用GET请求http://localhost:8085/test/get2

image.png

image.png

完整代码地址：https://github.com/Jinhx128/springboot-demo

注：此工程包含多个module，本文所用代码均在exception-demo模块下

天不生我小金
关注
  • 10
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
和 try catch 说再见，SpringBoot 统一异常处理就该这么搞！
m0_71777195的博客
04-27 226
Spring在3.2版本增加了一个注解，可以与等注解注解配套使用。不过跟异常处理相关的只有注解，从字面上看，就是 异常处理器 的意思Assert(断言)是Spring 家族的，在我们写测试用例的时候经常会用到，使用断言能让我们编码的时候有一种非一般丝滑的感觉Assert 的部分源码，可以看到，Assert 其实就是帮我们把if {…}封装了一下，抛出的异常是2.1 自定义接口Assert。
springboot优雅处理异常
winne的博客
07-06 812
优雅解决springboot项目中写满的通篇异常，清楚大部分冗余代码
springboot实现事务以及与trycatch的完美搭配
清秋愁上愁的博客
06-04 2706
sprinboot实现事务很easy，两个注解，@EnableTransactionManagement 以及@Transactional。如果只添加了@Transactional的话，可能事务不会被启用。 事务就是从方法开始到结束过程中，只要出现异常，为了不影响数据被污染，会将出现异常之前做的数据处理回滚，即恢复数据到方法开始的时候。 方法体中难免会添加try catch去处理异常，既然catch到了异常的话，事务很难触发回滚，因为事务只能在runtimeException的时候才会触发回滚。 我的两个解
在Spring Boot项目中使用全局异常处理
pikcacho_pkq的博客
10-17 1597
接着上一篇在Spring Boot项目中使用统一返回结果一文中，继续添加全局异常处理部分。
Sping boot try catch语句后 @Transactional事务不回滚（已解决）
weixin_54586234的博客
11-12 1916
原因：try catch语句会捕获你发出的异常 @Transactional感知不到抛出的异常 自然也就不会进行事物回滚。1.使用以下配置（基础的 Transactional配置只能拦截RuntimeException和Error异常）2.catch中添加（手动进行回滚）
Springboot之自定义全局异常处理的实现
08-25
Springboot之自定义全局异常处理的实现是指在Springboot框架中，通过自定义异常处理器来捕获和处理全局异常的方法。这种方法可以帮助开发者更好地处理程序中的异常，提高程序的稳定性和可靠性。 为什么需要自定义...
Springboot全局异常捕获及try catch区别解析
08-19
try catch语句通常用于捕获和处理特定的业务逻辑异常，而Springboot全局异常捕获机制则用于捕获和处理应用程序中的所有未捕获的异常，以便提供统一的错误处理机制。 此外，还需要注意的是，try catch语句和...
SpringBoot如何优雅地处理全局异常详解
08-25
在SpringBoot项目中，每个Controller方法中都需要try-catch来捕获异常，这样会导致代码重复和难以维护。更重要的是，这种方式对代码的可读性和美观性产生了负面影响。因此，我们需要一种更加优雅的方式来处理全局...
Java异常处理机制try catch流程详解
08-19
Java异常处理机制try catch流程详解 Java 异常处理机制是 Java 语言中一个非常重要的机制，它允许开发者捕获和处理运行时的异常，从而提高程序的鲁棒性和可靠性。下面是 Java 异常处理机制的详细介绍。 一、异常...
C++之try catch 异常处理入门实例
08-28
抛出异常后需要捕获异常以及异常处理程序，其基本语法如下：try{//可能抛出异常的语句}catch (异常类型1){//异常类型1的处理程序}catch (异常类型2){//异常类型2的处理程序}// ……catch (异常类型n){//异常类型n的...
spring boot 全局异常统一拦截处理
AlbenXie的博客
08-26 1457
经常开发接口的同学肯定知道，接口返回的数据格式必须有固定的格式，方便调用者 对于不同的异常我们在实际开发中最好也有统一的处理 在spring boot中与默认的异常页面，如果我们要开发rest风格的api,返回的json数据 那么异常提示也要是json格式的，返回一个页面的错误异常就不友好了 接下来我看怎么统一处理这些异常信息以及自己定义一些常用的异常 先定义一个全局的异常类,继承Exception ，里面有code属性，表示请求的响应状态码 public class GlobalExcept
spring Boot手把手教学(7): 抛弃try-catch, 如何优雅统一处理异常（包含404处理）
非著名程序猿
12-09 908
1、前言2、自定义异常处理3、完整代码 1、前言 我们在项目开发中，难免碰到业务代码异常，无论是server 500, 还是其他异常。 我们这里简单说一下，如何抛弃try-catch，统一进行异常响应处理； ❝ 错误类型： 1、自定义业务服务代码异常（根据各自项目需求） 2、ServletException HTTP请求异常 3、内部代码异常：比如 mysql 查询表名错误 4、请求接口404：这个在统一异常中无法获取，需要额外处理 ❞ 正常情况下，我们需要这么写： ❝ JobController ❞ /
看完这篇，SpringBoot再也不用写try/catch了
最新发布
AmazDreamer的博客
07-28 270
本文介绍了使用 SpringBoot 时，如何通过配置全局异常处理器统一处理项目中的一些通用的异常，避免程序员不断的写try/catch导致的代码冗余，有利于代码的维护。如果我们不统一的处理异常，开发人员经常会在代码中东一块的西一块的写上 try catch代码块，长久以往容易堆积成屎山。value 的值为需要处理的异常类的 class 文件。在业务中，遇到业务异常的地方，我们直接 throw 抛出对应的业务异常即可。本篇主要讲述在SpringBoot 中，如何用全局异常处理优雅的处理异常。
自定义异常
weixin_43821010的博客
11-06 906
java自定义异常
如何自定义异常Java
weixin_74077856的博客
06-29 3279
情况确实如此，无论是在Java自带异常还是，用户自定义异常，他们都是去掉用父类有参或者无参构造方法，异常这种一层一层的去调用父类构造方法，是异常发生的基本流程，最终干实事的是最终类Throwable，所以上述的我的自定义的异常是符合异常的基本规范的，最后的是如何去使用自定义的编译时异常去规范我们的程序呢，下面是我对异常的使用，如图。这样看是不是舒服多了，自定义编译时异常的功能用处广泛，应用的方向广泛，也体现Java高度面向对象的包容性。下面是他的具体用法，如图。下面是控制台输出，如图。
自定义异常（源码）
zzvar的博客
07-04 1074
自定义异常内容1. LogicException（自定义异常类）2. CommonExceptionHandler（全局异常处理）总结 内容 1. LogicException（自定义异常类） 写一个自定义异常类 package com.yy.springboot.exception; /** * 自定义异常类 */ public class LogicException extends RuntimeException { public LogicException(String mess
springboot(九)--统一异常处理(500)、错误页处理(404)
热门推荐
jasnet_u的博客
08-11 2万+
如题，本篇我们介绍下springboot中统一异常500处理，以及错误页404处理。 一、统一异常处理(500) 主要针对于服务器出现500异常的情况，返回自定义的500页面到用户浏览器，或者输出错误json数据到用户浏览器。 如果ex是业务层抛出的自定义异常则或取自定义异常的自定义状态码和自定义消息+错误堆栈信息；如果ex不是自定义异常，则获取ex的错误堆栈信息。 MvcExceptio...
异常集中处理是不是必须要try/catch
03-26
异常集中处理不一定必须要使用try/catch语句，但是try/catch是一种常见的实现方式。其他实现方式包括使用异常过滤器、使用异常处理函数或者使用框架提供的异常处理机制等。选择哪种实现方式取决于具体的应用场景和...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值