12.SpringBoot统一异常处理 - 技术博客
程序智享家
精彩内容加载中

12.SpringBoot统一异常处理

在 Spring Boot 应用中,统一异常处理是一种非常实用的技术,它可以帮助我们集中管理和处理应用程序中抛出的异常,避免在每个控制器方法中重复编写异常处理代码,提高代码的可维护性和可读性。

admin 2025-02-10 831 阅读 0 评论 java框架

实现思路:

1.使用@ControllerAdvice和@ExceptionHandler注解 注解@ControllerAdvice表示这是一个控制器增强类,当控制器发生异常且符合类中定义的拦截异常类,将会被拦截。 注解ExceptionHandler定义拦截的异常类 2.使用ErrorController类来实现。 系统默认的错误处理类为BasicErrorController,将会显示如上的错误页面。

一.SpringBoot异常处理配置

1.创建统一返回结果实体

package com.tms.tblog.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.util.List;

@Data
/***
 * 统一返回结果
 */
@ApiModel(value = "ResultDto对象", description = "统一返回结果实体")
public class ResultDto<T> {
    @ApiModelProperty("消息编码")
    public String code;
    @ApiModelProperty("消息信息")
    public String message;
    @ApiModelProperty("返回对象")
    private T data;
    @ApiModelProperty("返回集合")
    private List<T> List;
    @ApiModelProperty("返回分页总页数")
    private Long total;

    public ResultDto() {
    }

    public ResultDto(String code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }
}

2.异常处理共通的配置类

package com.tms.tblog.infrastructure.exception;

import com.tms.tblog.dto.ResultDto;
import lombok.extern.log4j.Log4j2;
import org.springframework.dao.DataAccessException;
import org.springframework.validation.ObjectError;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
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.NoHandlerFoundException;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import java.sql.SQLException;
import java.util.stream.Collectors;

/**
 * 异常处理类
 *
 * @author lcj
 */
@ControllerAdvice
@Log4j2
public class ExceptionHandlerEx {

    /**
     * 处理空指针的异常
     *
     * @param req
     * @param ex
     * @return
     */
    @ExceptionHandler(value = NullPointerException.class)
    @ResponseBody
    public ResultDto nullExceptionHandler(HttpServletRequest req, NullPointerException ex) {
        log.error("发生空指针异常!原因是:", ex);
        ResultDto result = new ResultDto("1", ex.getMessage(), null);
        return result;
    }

    /**
     * 处理RuntimeException的异常
     *
     * @param req
     * @param ex
     * @return
     */
    @ExceptionHandler(value = RuntimeException.class)
    @ResponseBody
    public ResultDto runtimeExceptionHandler(HttpServletRequest req, RuntimeException ex) {
        log.error("发生RuntimeException异常:", ex);
        ResultDto result = new ResultDto("1", ex.getMessage(), null);
        return result;
    }

    /**
     * 框架参数校验错误
     *
     * @param ex
     * @return
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResultDto methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException ex) {
        String message = ex.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(", "));
        log.error("框架参数校验错误异常:", ex);
        ResultDto result = new ResultDto("1", message, null);
        return result;
    }

    /**
     * 服务器异常
     *
     * @param ex
     * @return
     */
    @ExceptionHandler({ServletException.class})
    public ResultDto servletExceptionHandler(ServletException ex) {
        log.error("服务器异常:", ex);
        ResultDto result = new ResultDto("1", ex.getMessage(), null);
        return result;
    }

    /**
     * 数据库异常
     *
     * @param ex
     * @return
     */
    @ExceptionHandler({SQLException.class, DataAccessException.class})
    public ResultDto SQLExceptionHandler(SQLException ex) {
        log.error("数据库异常:", ex);
        ResultDto result = new ResultDto("1", ex.getMessage(), null);
        return result;
    }


    /**
     * 接口不存在异常
     *
     * @param ex
     * @param request
     * @return
     */
    @ExceptionHandler(NoHandlerFoundException.class)
    public ResultDto noHandlerFoundExceptionHandler(NoHandlerFoundException ex, HttpServletRequest request) {

        log.error("接口不存在异常:", ex);
        ResultDto result = new ResultDto("1", ex.getMessage(), null);
        return result;
    }

    /**
     * 访问资源错误
     *
     * @param ex
     * @return
     */
    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    public ResultDto httpRequestMethodNotSupportedExceptionHandler(HttpRequestMethodNotSupportedException ex, HttpServletRequest request) {
        log.error("访问资源错误:", ex);
        ResultDto result = new ResultDto("1", ex.getMessage(), null);
        return result;
    }

    /**
     * 全局异常
     *
     * @param ex
     * @param request
     * @return
     */
    @ExceptionHandler(Exception.class)
    public ResultDto ExceptionHandler(HttpServletRequest request, Throwable ex) {
        log.error("异常:", ex);
        ResultDto result = new ResultDto("1", ex.getMessage(), null);
        return result;
    }

}

3.在控制器中抛出异常 在控制器的方法中抛出异常,统一异常处理类会捕获并处理这些异常。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @GetMapping("/test")
    public String test() {
        // 模拟抛出自定义异常
        throw new CustomException("This is a custom exception.");
    }
}

这只是简单的写了异常处理,后期遇到了新的异常没有处理的,陆续添加到这个配置类中,同时可以在抛出异常的时候可以添加发邮件的功能和把报错信息放到资源管理里。由于我们是演示,就不做那么麻烦了。

推荐阅读

7.SpringBoot使用Aop监控接口的执行状况 AOP(Aspect Oriented Programming),即面向切面编程,可以说是OOP(Object Oriented Programming,面向对… 5.SpringBoot配置自动生成代码 AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper… 4.SpringBoot配置MyBatis-Plus MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBa… 3.Springboot配置跨域 Springboot配置跨域有很多种方式,今天我们来看一下有哪几种方式,第一种方法还是比较常见的。… 2.SpringBoot配置lombok Lombok想要解决了的是在我们实体Bean中大量的Getter/Setter方法,以及toString, hashCode等可能不会用到,但是某些时候仍然需要… 1.SpringBoot框架搭建 Spring Boot 是 Pivotal 团队在 Spring 的基础上提供的一套全新的开源框架,其目的是为了简化 Spring 应用的搭建和开发过程。… 8.Springboot整合log4j2日志 Apache Log4j 2 是对 Log4j 的升级,它比其前身 Log4j 1.x 提供了重大改进,并提供了 Logback 中可用的许多改进,同时修复了 … 9.SpringBoot配置Redis Redis(Remote Dictionary Server ),即远程字典服务,是一个开源的使用ANSI C语言编写、支持网络、可基于内存亦可持久化的日志型、… 10.SpringBoot配置Druid连接池 连接池的作用是为了提高性能,将已经创建好的连接保存在池中,当有请求来时,直接使用已经创建好的连接对Server端进行访问。这样省略(复用)了创建连接和销毁连接的… 11.SpringBoot配置Swagger3 Swagger3(也被称为OpenAPI 3)是一个开放源代码项目,它定义了用于描述、生产、消费和可视化RESTful Web服务的规范。… 13.SpringBoot配置Thymeleaf Thymeleaf是一个java类库,他是一个优秀的、面向Java 的xml/xhtml/html5的模板引擎,可以作为mvc的web应用的view层,具有丰富… 14.SpringBoot图片文件上传 图片文件上传是经常会用到的功能,尤其是做一些大型企业网站。… 15.Springboot多模块配置 在开发大型项目时,使用 Spring Boot 多模块配置可以将项目拆分成多个独立的模块,便于团队协作开发、代码管理和维护。以下为你详细介绍 Spring Bo… 16.SpringBoot配置SSL证书 在 Spring Boot 中配置 SSL 证书可以为应用程序提供安全的 HTTPS 连接,增强数据传输的安全性。… 17.SpringBoot项目打包成jar包 打包springboot项目有两种方法,一个是直接通过mvn命令打包,另一个是使用工具打包,例如idea… 18.SpringBoot实现图片压缩 在上传图片的时候进行图片压缩,这样虽然破环了原图片的清晰度,不影响图片的美感,博客用来作为缩略图正好。… 19.Java生成sitemap网站地图 Sitemap(网站地图)在网站管理和搜索引擎优化(SEO)中扮演着重要角色。在Java中生成网站地图(sitemap)通常涉及创建一个XML文件,该文件列出了… 20.springboot使用Jsoup解析html,抓取一个网站上的全部链接 soup 是一款Java 的HTML解析器,可直接解析某个URL地址、HTML文本内容。它提供了一套非常省力的API,可通过DOM,CSS以及类似于jQuery… 21.Springboot使用Jsoup和sitemapgen4j动态生成网站地图 Sitemapgen4j是一个使用Java编写的Sitemap输出库包,通过使用SitemapGen4j你可以可以添加任意数量的URL,可以得到gzip压缩输出…

评论 (0)

暂无评论,快来抢沙发吧