spring 统一异常处理

最新推荐文章于 2025-04-02 00:25:42 发布
最新推荐文章于 2025-04-02 00:25:42 发布
阅读量265 收藏
点赞数
分类专栏： spring 文章标签： spring异常 异常统一处理
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/godson_2003/article/details/100262697
版权

异常处理的方法有很多，比如自定义一个ServiceException,在service层或者是controller层调用，本文主要是将通过spring统一处理所有接收到的异常，生成前台能够处理（比如json格式的异常），或者是用户能够看懂（比如nullexception,普通用户很难看懂什么意思）。

下面请看代码，代码只是举几个常见的异常，大家生产情况下会有很多异常出现，需要大家不断扩充这个统一异常处理类。

 

import java.util.Iterator;
import java.util.Set;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.ValidationException;

import org.apache.commons.lang3.StringUtils;
import org.apache.dubbo.remoting.RemotingException;
import org.apache.dubbo.rpc.RpcException;
import org.apache.shiro.authz.AuthorizationException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;


import cn.he.tips.ErrorTip;

/**
 * 异常处理器
 *
 */
@RestControllerAdvice
public class ServiceExceptionHandler {
    private Logger logger = LoggerFactory.getLogger(getClass());

    /**
     * 处理自定义异常
     */
    @ExceptionHandler(ServiceException.class)
    public ErrorTip handleException(ServiceException e){
        ErrorTip tip = new ErrorTip(0,e.getMessage());
        
        return tip;
    }

    
    @ExceptionHandler(AuthorizationException.class)
    public ErrorTip handleException(AuthorizationException e){
        if(logger.isDebugEnabled())
            logger.error(e.getMessage(), e);
        ErrorTip tip = new ErrorTip(0,"没有权限，请联系管理员授权");
        
        return tip;
    }

    
    @ExceptionHandler(java.lang.NumberFormatException.class)
    public ErrorTip handleException(NumberFormatException e){
        if(logger.isDebugEnabled())
            logger.error(e.getMessage(), e);
        ErrorTip tip = new ErrorTip(0,"数字类型转换错误");
        return tip;
    }
    
    
    
    
    @ExceptionHandler(org.springframework.http.converter.HttpMessageNotReadableException.class)
    public ErrorTip handleException(org.springframework.http.converter.HttpMessageNotReadableException e){
        if(logger.isDebugEnabled())
            logger.error(e.getMessage(), e);
        ErrorTip tip = new ErrorTip(0,"Bad Request！");
        return tip;
    }
    
    
    
    @ExceptionHandler(RemotingException.class)
    public ErrorTip handleException(RemotingException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"Dubbo远程服务停止");
        }else {
            tip = new ErrorTip(0,"微服务停止服务");
        }
            
        return tip;
    }
    
    
    
    
    @ExceptionHandler(java.io.NotSerializableException.class)
    public ErrorTip handleException(java.io.NotSerializableException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"类未序列化:"+e.getCause().getMessage());
        }else {
            tip = new ErrorTip(0,"实体类未序列化");
        }
        
        return tip;
    }
    
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ErrorTip handleException(MethodArgumentNotValidException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"方法参数验证错误:"+e.getCause().getMessage());
        }else {
            tip = new ErrorTip(0,"方法参数验证错误");
        }
        
        return tip;
    }
    
    @ExceptionHandler(java.lang.NullPointerException.class)
    public ErrorTip handleException(NullPointerException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"空指针错误:"+e.getCause().getMessage());
        }else {
            tip = new ErrorTip(0,"空指针错误");
        }
        
        return tip;
    }
   

    //==============
    //----验证异常
    //==============
    
    @ExceptionHandler(RpcException.class)
    public ErrorTip handleException(RpcException e){
        if(logger.isDebugEnabled())
            logger.error(e.getMessage(), e);
        String error = "";
        if(e.getCause() instanceof ConstraintViolationException){
            ConstraintViolationException ve = (ConstraintViolationException)e.getCause();
            if(ve != null){
                Set<ConstraintViolation<?>> violations = ve.getConstraintViolations();
                Iterator<ConstraintViolation<?>> it = violations.iterator();  
                while (it.hasNext()) {  
                    ConstraintViolation str = it.next();  
                    error += str.getMessage()+"<br>";
                }  
            }
        }else if(e.getCause() instanceof ServiceException){
            error += e.getMessage();
        }else{
            error += e.getCause().getLocalizedMessage();
        }
        
        if(StringUtils.isEmpty(error)) {
            error = "RCP远程调用失败!";
        }
        ErrorTip tip = new ErrorTip(0,error);
        return tip;
    }
    
    @ExceptionHandler(ValidationException.class)
    public ErrorTip handleException(ValidationException e){
        if(logger.isDebugEnabled())
            logger.error(e.getMessage(), e);
        ErrorTip tip = new ErrorTip(0,e.getMessage());
        return tip;
    }
    
    @ExceptionHandler(ConstraintViolationException.class)
    public ErrorTip handleException(ConstraintViolationException e){
        if(logger.isDebugEnabled())
            logger.error(e.getMessage(), e);
        ErrorTip tip = new ErrorTip(0,e.getMessage());
        return tip;
    }
    
    //==================
    //----JSON处理错误
    //==================
    
    @ExceptionHandler(ValidateException.class)
    public ErrorTip handleException(ValidateException e){
        if(logger.isDebugEnabled())
            logger.error("参数验证错误:"+e.getMessage(), e);
        ErrorTip tip = new ErrorTip(0,e.getMessage());
        return tip;
    }
    
    
    @ExceptionHandler(com.alibaba.fastjson.JSONException.class)
    public ErrorTip handleException(com.alibaba.fastjson.JSONException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"JSON数据转换类型错误:"+e.getCause().getMessage());
        }else {
            tip = new ErrorTip(0,"JSON数据转换类型错误");
        }
        
        return tip;
    }
    
    @ExceptionHandler(com.fasterxml.jackson.databind.exc.InvalidFormatException.class)
    public ErrorTip handleException(com.fasterxml.jackson.databind.exc.InvalidFormatException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"JSON数据转换类型错误:"+e.getCause().getMessage());
        }else {
            tip = new ErrorTip(0,"JSON数据转换类型错误");
        }
        return tip;
    }
    
    
    //=========================
    //---数据库操作失败
    //=========================
    @ExceptionHandler(DuplicateKeyException.class)
    public ErrorTip handleException(DuplicateKeyException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"数据库中已存在该记录:"+e.getCause().getMessage());
        }else {
            tip = new ErrorTip(0,"数据库中已存在该记录");
        }
        
        return tip;
    }


    @ExceptionHandler(DataNotExistException.class)
    public ErrorTip handleException(DataNotExistException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"要访问的数据不存在:"+e.getCause().getMessage());
        }else {
            tip = new ErrorTip(0,"要访问的数据不存在");
        }
        
        return tip;
    }
    
    
    @ExceptionHandler(org.springframework.dao.DataIntegrityViolationException.class)
    public ErrorTip handleException(org.springframework.dao.DataIntegrityViolationException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"数据库字段属性输入错误:"+e.getCause().getMessage());
        }else {
            tip = new ErrorTip(0,"数据库字段属性输入错误");
        }
        
        return tip;
    }
    
    @ExceptionHandler(org.hibernate.hql.internal.ast.QuerySyntaxException.class)
    public ErrorTip handleException(org.hibernate.hql.internal.ast.QuerySyntaxException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"Hibernate操作数据库操作错误:"+e.getMessage());
        }else {
            tip = new ErrorTip(0,"Hibernate操作数据库操作错误");
        }
        
        return tip;
    }
    
    @ExceptionHandler(org.hibernate.exception.SQLGrammarException.class)
    public ErrorTip handleException(org.hibernate.exception.SQLGrammarException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"Hibernate异常:SQL参数不一致。"+e.getMessage());
        }else {
            tip = new ErrorTip(0,"Hibernate异常:SQL参数不一致。");
        }
        
        return tip;
    }
    
    @ExceptionHandler(org.hibernate.StaleStateException.class)
    public ErrorTip handleException(org.hibernate.StaleStateException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"Hibernate操作数据库错误:"+e.getMessage());
        }else {
            tip = new ErrorTip(0,"Hibernate操作数据库错误。");
        }
        
        
        return tip;
    }
    
    @ExceptionHandler(org.springframework.orm.hibernate5.HibernateOptimisticLockingFailureException.class)
    public ErrorTip handleException(org.springframework.orm.hibernate5.HibernateOptimisticLockingFailureException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"Hibernate操作数据库错误:"+e.getMessage());
        }else {
            tip = new ErrorTip(0,"Hibernate操作数据库错误。");
        }
        
        return tip;
    }
    
    
    @ExceptionHandler(org.mybatis.spring.MyBatisSystemException.class)
    public ErrorTip handleException(org.mybatis.spring.MyBatisSystemException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"Mybatis操作数据库操作错误:"+e.getMessage());
        }else {
            tip = new ErrorTip(0,"Mybatis操作数据库操作错误。");
        }
        
        return tip;
    }
    @ExceptionHandler(org.apache.ibatis.binding.BindingException.class)
    public ErrorTip handleException(org.apache.ibatis.binding.BindingException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"Mybatis方法或参数绑定错误:"+e.getMessage());
        }else {
            tip = new ErrorTip(0,"Mybatis方法或参数绑定错误。");
        }
        return tip;
    }
    
    
    @ExceptionHandler(org.springframework.dao.InvalidDataAccessResourceUsageException.class)
    public ErrorTip handleException(org.springframework.dao.InvalidDataAccessResourceUsageException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"DAO数据库操作失败:"+e.getMessage());
        }else {
            tip = new ErrorTip(0,"DAO数据库操作失败。");
        }
        
        return tip;
    }
    
    @ExceptionHandler(org.apache.dubbo.remoting.TimeoutException.class)
    public ErrorTip handleException(org.apache.dubbo.remoting.TimeoutException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"DUBBO远程调用超时，请联系系统管理员调整超时时间。");
        }else {
            tip = new ErrorTip(0,"DUBBO远程调用超时，请联系系统管理员调整超时时间。");
        }
        
        return tip;
    }
   
    @ExceptionHandler(org.elasticsearch.action.ActionRequestValidationException.class)
    public ErrorTip handleException(org.elasticsearch.action.ActionRequestValidationException e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"ElasticSearch错误信息:"+e.getMessage());
        }else {
            tip = new ErrorTip(0,"ElasticSearch错误信息。");
        }
        
        return tip;
    }
    
    
    @ExceptionHandler(Exception.class)
    public ErrorTip handleException(Exception e){
        ErrorTip tip = null;
        if(logger.isDebugEnabled()) {
            logger.error(e.getMessage(), e);
            tip = new ErrorTip(0,"未知错误:"+e.getMessage());
        }else {
            tip = new ErrorTip(0,"未知错误:"+e.getMessage());
        }
        return tip;
    }
    
}

 

 

public class ErrorTip {

    private int code;
    private String message;

    public ErrorTip(int code, String message) {
        this.code = code;
        this.message = message;
    }
    public ErrorTip( String message) {
        this.code = 0;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

   
}

 

代码里面有些异常大家用不到的可以删掉，去建立、丰富你自己的异常处理类，希望能对大家有帮助

spring统一异常处理
m13012606980的专栏
06-28 249
Respect 巨人大哥：https://www.cnblogs.com/jurendage/p/11255197.html 源码：结构 maven pom.xml <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId>
Spring统一功能处理：拦截器、响应与异常的统一管理
web13765607643的博客
01-01 860
添加拦截器后，执Controller的法之前，请求会先被拦截器拦截住执 preHandle() 法，这个法需要返回个布尔类型的值：如果返回true，就表放本次操作并且继续访问controller中的法；在拦截器当中，开发员可以在应程序中做些通性的操作，如通过拦截器来拦截前端发来的请求，判断Session中是否有登录的信息，如果有就可以放，如果没有就进拦截。拦截器是Spring框架提供的核功能之，主要来拦截的请求，在指定法前后，根据业务需要执预先设定的代码。我们可以针对不同的异常，返回不同的结果。
Spring中的统一异常处理
weixin_42600182的博客
09-25 216
在具体的SSM项目开发中，由于Controller层为处于请求处理的最顶层，再往上就是框架代码的。因此，肯定需要在Controller捕获所有异常，并且做适当处理，返回给前端一个友好的错误码。 不过，Controller一多，我们发现每个Controller里都有大量重复的、冗余的异常处理代码，很是啰嗦。能否将这些重复的部分抽取出来，这样保证Controller层更专注于业务逻辑的处理，同时能够...
（自用）springboot统一异常处理
最新发布
weixin_55869972的博客
04-02 533
ErrorResponse error = new ErrorResponse(500, "服务器内部错误", System.currentTimeMillis());- **文件上传异常**：`MaxUploadSizeExceededException`- **数据库异常**：`DataIntegrityViolationException`// HTTP状态码（如400）- **权限异常**：`AccessDeniedException`- **集中管理异常**：避免散落在各Controller中。
Spring统一异常处理
抽象的螺旋
10-26 1934
相关注解概述 通过使用@RestControllerAdvice或@ControllerAdvice定义统一的异常处理类，而不是在每个Controller中逐个定义； @RestControllerAdvice：返回Json格式数据； @ControllerAdvice：返回视图类型数据； @ResponseBody：和Controller方法上的用法一样，会将方法中返回值转换成Json格式后返回给客户端； @ExceptionHandler：用来定义函数针对的异常类型，最后将Exception对象和请求
详解SpringCloud Finchley Gateway 统一异常处理
08-26
详解 SpringCloud Finchley Gateway 统一异常处理 SpringCloud Finchley Gateway 统一异常处理是指在使用 SpringCloud Finchley 版本的 Gateway 时，如何统一处理系统级异常的方法。默认情况下，SpringCloud ...
Spring Cloud zuul自定义统一异常处理实现方法
08-28
Spring Cloud zuul自定义统一异常处理实现方法 Spring Cloud zuul自定义统一异常处理实现方法是指在Spring Cloud微服务体系中，使用zuul提供filer和router功能时，实现自定义统一异常处理的方法。在zuul中，默认的...
Spring Boot统一异常处理最佳实践(拓展篇)
08-26
Spring Boot 统一异常处理最佳实践拓展篇 在 Spring Boot 中，统一异常处理是非常重要的，今天我们将介绍 Spring Boot 统一异常处理最佳实践的拓展篇。之前我们已经了解了基本的统一异常处理思路，现在我们将继续...
spring异常-全局异常处理
sinat_41680563的博客
03-08 944
在 Spring 开发中，常见的异常通常与框架配置、依赖注入、数据库操作、事务管理等相关。以下是常见的异常类型及其解决方法，以及如何实现全局统一异常处理。Spring 提供了多种方式实现全局统一异常处理，常用的方式包括：说明： 用于定义全局异常处理类， 用于处理特定异常。示例： 2.2 使用 说明： 是 和 的组合，适用于 RESTful API。示例： 2.3 使用 说明：实现 接口，处理未捕获的异常。示例： 2.4 使用 说明：在自定义异常类上使用 ，指定 HTTP
spring-统一异常处理
qq_44086930的博客
12-27 214
统一异常处理
spring中的统一异常处理
zhaoshuangjian
11-28 1146
spring中的统一异常处理
Spring 中的统一异常处理
嘻哈熊的专栏
07-10 881
1.1. HandlerExceptionResolver 接口1.2. 使用示例1.3. Controller 局部异常处理1.4. ControllerAdvice在具体的 SSM 项目开发中，由于 Controller 层为处于请求处理的最顶层，再往上就是框架代码的。 因此，肯定需要在 Controller 捕获所有异常，并且做适当处理，返回给前端一个友好的错误码。不过，Controller 一多，我们发现每个 Controller 里都有大量重复的、冗余的异常处理代码，很是啰嗦。 能否将这些重复的部
Spring MVC统一异常处理实战解析
"本文详细介绍了如何在Spring MVC应用中进行统一异常处理的实战，包括三种处理方式：SimpleMappingExceptionResolver、自定义HandlerExceptionResolver以及@ExceptionHandler注解。通过创建测试项目，从Dao层、...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值