SpringBoot自定义异常处理机制

说明：在完整的项目结构中，我们通常会创建一套自定义的异常处理机制，在系统可能出现异常的地方手动抛出这些异常，可以快速定位到异常代码片段，提高系统的可维护性。

本文介绍在SpringBoot项目中，搭建一套自定义异常处理机制。

统一响应结果

首先，创建一个统一响应结果类，如下，用于统一后台的返回结果，请求成功返回数据，请求失败返回错误信息；

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

/**
 * 后端统一返回结果
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Result<T> implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 编码：1成功 0和其他数字为失败
     */
    private Integer code;

    /**
     * 错误信息
     */
    private String msg;

    /**
     * 数据
     */
    private T data;


    /**
     * 成功并返回
     *
     * @param <T>
     * @return
     */
    public static <T> Result<T> success() {
        Result<T> result = new Result<T>();
        result.code = 1;
        return result;
    }

    /**
     * 成功并返回数据
     *
     * @param object
     * @param <T>
     * @return
     */
    public static <T> Result<T> success(T object) {
        Result<T> result = new Result<T>();
        result.data = object;
        result.code = 1;
        return result;
    }

    /**
     * 失败，并返回信息
     *
     * @param msg
     * @param <T>
     * @return
     */
    public static <T> Result<T> error(String msg) {
        Result result = new Result();
        result.msg = msg;
        result.code = 0;
        return result;
    }
}

然后，创建两个接口，用于用户登录，根据ID查找用户，如下：

（controller层）

import com.hezy.pojo.entity.User;
import com.hezy.pojo.vo.Result;
import com.hezy.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/exception")
public class UserController {

    @Autowired
    private UserService userService;

    @PostMapping("/login")
    public Result login(@RequestBody User user){
        return userService.login(user);
    }

    @GetMapping("/get")
    public Result get(Integer id){
        return userService.getUser(id);
    }
}

（Service实现类，其中TODO表示待完成的部分）

import cn.hutool.core.util.ObjUtil;
import com.hezy.pojo.entity.User;
import com.hezy.pojo.vo.Result;
import com.hezy.service.UserService;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {

    @Override
    public Result login(User user) {
        // 对user进行校验
        if (!ObjUtil.isAllNotEmpty(user, user.getUsername(), user.getPassword())) {
            return Result.error("非法参数异常");
        }

        // TODO 根据用户名查询数据库，校验该用户是否存在
        if (true) {
            return Result.error("该用户不存在");
        }

        // TODO 保存用户信息到数据库
        
        return Result.success(user);
    }

    @Override
    public Result getUser(Integer id) {
        // 对id进行校验
        if (id == null || id < 0) {
            return Result.error("非法参数异常");
        }

        // TODO 根据用户名查询数据库, 校验用户是否存在
        if (true) {
            return Result.error("该用户不存在");
        }

        return Result.success(new User(id, "张三", "123456"));
    }
}

（用户实体类）

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * id
     */
    private Integer id;

    /**
     * 账号
     */
    private String username;

    /**
     * 密码
     */
    private String password;
}

启动项目，运行；

在这里插入图片描述

（测试登录接口，因为在if里面写死了，所以返回错误信息）

在这里插入图片描述

（测试获取用户对象接口，因为在if里面写死了，所以返回错误信息）

在这里插入图片描述

异常枚举

接下来，对上面的异常进行统一处理。

首先，创建一个异常的枚举类，里面包含了异常状态码，异常信息等，如下：

/**
 * 异常枚举类
 */
public enum ExceptionEnum {

    PARAM_EXCEPTION(10001, "非法参数异常"),

    PARAM_LACK(10002, "参数不全异常"),

    UNKNOW_EXCEPTION(99999, "未知异常");

    private int status;

    private String message;

    ExceptionEnum(int status, String message) {
        this.status = status;
        this.message = message;
    }

    public int getStatus() {
        return status;
    }

    public String getMessage() {
        return message;
    }
}

自定义异常

创建一个自定义异常类，继承RuntimeException类，如下：

import com.hezy.enums.ExceptionEnum;

/**
 * 自定义异常
 */
public class MyException extends RuntimeException{

    /**
     * 异常枚举
     */
    private ExceptionEnum exceptionEnum;

    public MyException(ExceptionEnum exceptionEnum) {
        super(exceptionEnum.getMessage());
        this.exceptionEnum = exceptionEnum;
    }

    public ExceptionEnum getExceptionEnum() {
        return exceptionEnum;
    }

    /**
     * 手动抛出异常
     * @param exceptionEnum
     * @return
     */
    public static MyException throwException(ExceptionEnum exceptionEnum){
        return new MyException(exceptionEnum);
    }
}

再创建一个异常的controller，自定义捕获对应的异常，并打印信息；

import com.hezy.enums.ExceptionEnum;
import com.hezy.pojo.vo.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

/**
 * 全局异常处理器
 */
@RestControllerAdvice
@Slf4j
public class GlobalException {

    /**
     * 自定义异常
     * @param e
     * @return
     */
    @ExceptionHandler(MyException.class)
    public Result handleException(MyException e){
        log.error(e.getMessage());
        return Result.builder()
                .code(0)
                .msg(e.getExceptionEnum().getMessage())
                .build();
    }

    /**
     * 全局异常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    public Result handleException(Exception e){
        log.error(e.getMessage());
        return Result.builder()
                .code(0)
                .msg(ExceptionEnum.UNKNOW_EXCEPTION.getMessage())
                .build();
    }
}

最后，对前面业务实现类里面的代码进行修改，当参数校验错误时，直接抛出异常，如下：

import cn.hutool.core.util.ObjUtil;
import com.hezy.enums.ExceptionEnum;
import com.hezy.exception.MyException;
import com.hezy.pojo.entity.User;
import com.hezy.pojo.vo.Result;
import com.hezy.service.UserService;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {

    @Override
    public Result login(User user) {
        // 对user进行校验，其中user、username、password，都不能为空
        if (!ObjUtil.isAllNotEmpty(user, user.getUsername(), user.getPassword())) {
            throw new MyException(ExceptionEnum.PARAM_LACK);
        }

        // TODO 根据用户名查询数据库，校验该用户是否存在
        if (true) {
            return Result.error("该用户不存在");
        }

        // TODO 保存用户信息到数据库

        return Result.success(user);
    }

    @Override
    public Result getUser(Integer id) {
        // id == null，参数不全异常
        if (id == null) {
            throw new MyException(ExceptionEnum.PARAM_LACK);
        }

        // id < 0，非法参数异常
        if (id < 0) {
            throw new MyException(ExceptionEnum.PARAM_EXCEPTION);
        }

        // TODO 根据用户名查询数据库, 校验用户是否存在
        if (true) {
            return Result.error("该用户不存在");
        }

        return Result.success(new User(id, "张三", "123456"));
    }
}

启动项目，测试；

（当user中的username为空时）

在这里插入图片描述

在这里插入图片描述

（当获取对象的id < 0时）

在这里插入图片描述

在这里插入图片描述

当发生其他未知异常时，如post请求的接口，我们使用get方式发送时；

在这里插入图片描述

就会被全局异常捕获到，并在控制台打印报错信息；

在这里插入图片描述

如果此时，需要新增一个异常，只需要在ExceptionEnum（异常枚举类）中新增一个枚举项即可，如下：

（新增一个登录异常）

/**
 * 异常枚举类
 */
public enum ExceptionEnum {

    PARAM_EXCEPTION(10001, "非法参数异常"),

    PARAM_LACK(10002, "参数不全异常"),
    
    LOGIN_EXCEPTION(10003, "登录异常"),

    UNKNOW_EXCEPTION(99999, "未知异常");

    private int status;

    private String message;

    ExceptionEnum(int status, String message) {
        this.status = status;
        this.message = message;
    }

    public int getStatus() {
        return status;
    }

    public String getMessage() {
        return message;
    }
}

总结

通过异常枚举类 + 自定义异常类 + SpringBoot的异常处理注解，可以实现对项目量身定做一套异常处理机制，根据项目中出现的异常，来返回对应的异常信息，非常方便。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/218483.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

2023.12.1 --数据仓库之 拉链表

2023.12.1 --数据仓库之 拉链表

目录 什么是拉链表 为什么要做拉链表? 没使用拉链表: 使用了拉链表: 题中订单拉链表的形成过程 实现语句 什么是拉链表 拉链表是缓慢渐变维的一种解决方案. 拉链表,记录每条信息的生命周期,一旦一条记录的生命周期结束,就重新开始一条新的记录,并把当前日期放入生效开始…
阅读更多...
EI论文复现：基于组合双向拍卖的共享储能机制研究程序代码！

EI论文复现：基于组合双向拍卖的共享储能机制研究程序代码！

本程序参考EI期刊论文《基于组合双向拍卖的共享储能机制研究》&#xff0c;文中的组合双向拍卖交易机制较为新颖&#xff0c;本质上属于博弈范畴&#xff0c;共享储能是目前的研究热点&#xff0c;牵涉到共享储能参与者的投标策略和收益函数&#xff0c;文中所提模型可为电力市…
阅读更多...
【兔子王赠书第10期】零基础入门Python，看这篇就够啦！

【兔子王赠书第10期】零基础入门Python，看这篇就够啦！

文章目录 写在前面推荐图书前言为什么要学习编程如何学习编程本书内容获得帮助 推荐理由粉丝福利写在后面 写在前面 粉丝福利第10期来啦&#xff0c;本期博主给大家推荐一本非常适合零基础入门Python的图书&#xff1a;《Python超能学习手册》&#xff0c;祝大家读完本书后都可…
阅读更多...
深入微服务架构 | 微服务与k8s架构解读

深入微服务架构 | 微服务与k8s架构解读

微服务项目架构解读 ① 什么是微服务&#xff1f; 微服务是指开发一个单个小型的但有业务功能的服务&#xff0c;每个服务都有自己的处理和轻量通讯机制&#xff0c;可以部署在单个或多个服务器上。 微服务也指一种种松耦合的、有一定的有界上下文的面向服务架构。也就是说&…
阅读更多...
＜Linux＞（极简关键、省时省力）《Linux操作系统原理分析之linux存储管理（5）》（21）

＜Linux＞（极简关键、省时省力）《Linux操作系统原理分析之linux存储管理（5）》（21）

《Linux操作系统原理分析之linux存储管理&#xff08;5&#xff09;》&#xff08;21&#xff09; 6 Linux存储管理6.6 Linux 物理空间管理6.6.1 Linux 物理内存空间6.6.2 物理页面的管理6.6.3 空闲页面管理——buddy 算法 6.7 内存的分配与释放6.7.1 物理内存分配的数据结构 6…
阅读更多...
运维工具之MobaXterm工具安装和使用

运维工具之MobaXterm工具安装和使用

一、MobaXterm工具简介 MobaXterm是远程计算的终极工具箱。在一个Windows应用程序中&#xff0c;它提供了大量的功能&#xff0c;这些功能是为程序员、网站管理员、it管理员以及几乎所有需要以更简单的方式处理远程工作的用户量身定制的。MobaXterm在一个开箱即用的可移植exe文…
阅读更多...
ros2与stm32通讯比较优秀的串口库

ros2与stm32通讯比较优秀的串口库

这个是我确定的串口库&#xff1a;serial: serial::Serial Class Reference (wjwwood.io) 我也不知道其他的串口库了&#xff0c;我就知道几个&#xff0c;然后我觉得这个是3个里面学习周期比较短&#xff0c;然后质量比较可靠的库 我隐隐觉得这个串口库就是ros1选择的串口库…
阅读更多...
如何在Linux环境搭建本地SVN服务器并结合cpolar实现公网访问

如何在Linux环境搭建本地SVN服务器并结合cpolar实现公网访问

目录 前言 1. Ubuntu安装SVN服务 2. 修改配置文件 2.1 修改svnserve.conf文件 2.2 修改passwd文件 2.3 修改authz文件 3. 启动svn服务 4. 内网穿透 4.1 安装cpolar内网穿透 4.2 创建隧道映射本地端口 5. 测试公网访问 6. 配置固定公网TCP端口地址 6.1 保留一个固定…
阅读更多...
SVN 版本管理

SVN 版本管理

SVN 文件状态 这里有一张图片可以说明&#xff1a;
阅读更多...
C#中内置的泛型委托Func与Action

C#中内置的泛型委托Func与Action

简介 从C# 3.0起很少需要自己声明委托。System.Func 是一个泛型委托&#xff0c;它可以表示带有返回值的方法。它可以接受一个到多个输入参数&#xff0c;并返回一个指定类型的结果。System.Func 委托的最后一个类型参数表示方法的返回值类型。而System.Action系列代表返回voi…
阅读更多...
文章解读与仿真程序复现思路——中国电机工程学报EI\CSCD\北大核心《考虑富氧燃烧技术的电–气–热综合能源系统低碳经济调度》

文章解读与仿真程序复现思路——中国电机工程学报EI\CSCD\北大核心《考虑富氧燃烧技术的电–气–热综合能源系统低碳经济调度》

这个标题涉及到一个关于能源系统和经济调度的复杂主题。让我们逐步解读&#xff1a; 电–气–热综合能源系统&#xff1a; 指的是一个综合的能源系统&#xff0c;包括了电力、气体&#xff08;可能是天然气等&#xff09;、热能等多个能源形式。这种系统的设计和优化旨在使不同…
阅读更多...
vue+electron问题汇总

vue+electron问题汇总

1. Vue_Bug Failed to fetch extension, trying 4 more times 描述&#xff1a;项目启动时报错 解决&#xff1a;注释图片中内容 2. Module not found: Error: Can’t resolve ‘fs’ in 描述&#xff1a;项目启动报错 解决&#xff1a;vue.config.js中添加图中数据 3.导入…
阅读更多...
8.7 矢量图层点要素点分布（Point displacement）使用

8.7 矢量图层点要素点分布（Point displacement）使用

文章目录 前言点分布&#xff08;Point displacement&#xff09;QGis代码实现 总结 前言 前面介绍了矢量-点要素-单一符号、矢量-点要素-分类符号、矢量-点要素-分级符号以及矢量-点要素-基于规则的使用本章介绍如何使用点分布&#xff08;Point displacement&#xff09;说明…
阅读更多...
Java集合常见问题

Java集合常见问题

目录 Java集合 1.前言2.集合3.Collection接口类3.1 List接口3.1.1 ArrayList&#xff08;常用&#xff09;3.1.2 LinkedList&#xff08;常用&#xff09;3.1.3 Vector&#xff08;不常用&#xff09; 3.2 Set接口3.2.1 HashSet&#xff08;常用&#xff09;3.2.2 LinkedHash…
阅读更多...
软件设计中如何画各类图之五用例图（Use Case Diagram）：系统功能需求与用户交互的图形化描述

软件设计中如何画各类图之五用例图（Use Case Diagram）：系统功能需求与用户交互的图形化描述

目录 1 前言2 用例图基本介绍3 用例图的符号及说明3.1 用例&#xff08;Use Case&#xff09;3.2 参与者&#xff08;Actor&#xff09;3.2 关系&#xff08;Relationships&#xff09; 4 画用例图的步骤4.1 确定系统边界4.2 识别参与者4.3 定义用例4.4 绘制关系4.5 完善细节 5…
阅读更多...
webpack学习-2.管理资源

webpack学习-2.管理资源

webpack学习-2.管理资源 1.这章要干嘛2.加载css注意顺序&#xff01; 3.总结 1.这章要干嘛 管理资源&#xff0c;什么意思呢&#xff1f;管理什么资源&#xff1f;项目中经常会 导入各种各样的css文件&#xff0c;图片文件&#xff0c;字体文件&#xff0c;数据文件等等&#…
阅读更多...
双目光波导AR眼镜_AR智能眼镜主板PCB定制开发

双目光波导AR眼镜_AR智能眼镜主板PCB定制开发

AR眼镜方案的未来发展潜力非常巨大。随着技术的进步&#xff0c;AR眼镜的光学模块将变得更小巧&#xff0c;像素密度也会增加&#xff0c;实现更高分辨率的画面&#xff0c;甚至能够达到1080P、2K和4K级别的清晰度&#xff0c;从而提升用户的视觉体验。 AR智能眼镜的硬件方面&a…
阅读更多...
spring cloud nacos整合gateway

spring cloud nacos整合gateway

文章目录 gateway快速入门创建gateway服务&#xff0c;引入依赖编写启动类编写基础配置和路由规则重启测试网关路由的流程图 断言工厂过滤器工厂路由过滤器的种类请求头过滤器默认过滤器总结 全局过滤器全局过滤器作用自定义全局过滤器过滤器执行顺序 跨域问题什么是跨域问题解…
阅读更多...
GitHub上1.5K标星的QA和软件测试学习路线图

GitHub上1.5K标星的QA和软件测试学习路线图

​最近在GitHub上发现一个项目&#xff0c;项目描述了作为QA工程师&#xff0c;进行软件测试技能提升时的&#xff0c;建议的软件测试学习顺序图​。 虽然2021年起就不再更新了&#xff0c;但是居然有1.5K的​星。 整个项目有两个部分​&#xff1a; ​1.QA和软件测试学习顺序…
阅读更多...
1.uniapp基础

1.uniapp基础

1.uniapp基础 官方文档&#xff1a;uni-app官网 1.1开发工具 &#xff08;1&#xff09;工具&#xff1a; HBuilderX HBuilderX-高效极客技巧 1.2 新建项目 &#xff08;1&#xff09; 文件》新建项目 ​ &#xff08;2&#xff09;选择相应的配置信息&#xff0c;填写项目根路…
阅读更多...
最新文章

Copyright @ 2022~2023