SpringBoot统一异常处理

本文为joshua317原创文章,转载请注明:转载自joshua317博客 SpringBoot统一异常处理 - joshua317的博客

一、背景

在做项目时,会产生各种各样业务异常,大致可以分为下面几类

1. 参数异常:服务端接收客户端参数时,参数不符合规则而产生的问题

2. 数据库异常:服务端和数据库交互时发生的异常

3. 业务异常:系统业务产生的问题

4. 未知异常:不属于以上三种异常的情况

异常根据自己的需要,进行增加,比如服务调用异常,服务错误异常、逻辑业务异常等等

二、解决思路

对项目异常进行分类编码,服务端需要将这些异常信息返回给客户端。 建立全局异常处理类,在类中针对不同类型异常进行返回值处理,包括默认返回结果。 在业务中,不同未知抛出不同异常

三、关键代码

全局异常处理

@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
    
    /**
    *业务异常
    */
    @ExceptionHandler(BusinessException.class)
    public RetResult businessExceptionHandler(HttpServletRequest request, BusinessException e){
        if(Objects.nonNull(request)){
            StringBuffer requestUrlBuffer = request.getRequestURL();
            String method = request.getMethod();
            String requestUrl = Objects.isNull(requestUrlBuffer) ? request.getRequestURI() : requestUrlBuffer.toString();
            log.info("BusinessException:{}, \n请求URL: [{}], \n请求方式: [{}]\n", e.getMessage(), requestUrl, method, e);
        }
        return ResultUtil.error(e.getCode(), e.getMessage());
    }
    
    /**
    *参数异常
    */
    @ExceptionHandler(ParamException.class)
    public RetResult paramExceptionHandler(HttpServletRequest request, ParamException e) {
        if (Objects.nonNull(request)) {
            StringBuffer requestUrlBuffer = request.getRequestURL();
            String method = request.getMethod();
            String requestUrl = Objects.isNull(requestUrlBuffer) ? request.getRequestURI() : requestUrlBuffer.toString();
            log.info("ParamException:{}, \n请求URL: [{}], \n请求方式: [{}]\n", e.getMessage(), requestUrl, method, e);
        }
        return ResultUtil.error(e.getCode(), e.getMessage());
    }
    
    /**
    *数据库异常
    */
    @ExceptionHandler(DataBaseException.class)
    public RetResult databseExceptionHandler(HttpServletRequest request, DataBaseException e) {
        if (Objects.nonNull(request)) {
            StringBuffer requestUrlBuffer = request.getRequestURL();
            String method = request.getMethod();
            String requestUrl = Objects.isNull(requestUrlBuffer) ? request.getRequestURI() : requestUrlBuffer.toString();
            log.info("DatabseExceptionHandler{}, \n请求URL: [{}], \n请求方式: [{}]\n", e.getMessage(), requestUrl, method, e);
        }
        return ResultUtil.error(e.getCode(), e.getMessage());
    }

    @ExceptionHandler(RuntimeException.class)
    public RetResult runtimeExceptionHandler(HttpServletRequest request, RuntimeException e){
        if(Objects.nonNull(request)){
            StringBuffer requestUrlBuffer = request.getRequestURL();
            String method = request.getMethod();
            String requestUrl = Objects.isNull(requestUrlBuffer) ? request.getRequestURI() : requestUrlBuffer.toString();
            log.error("RuntimeException:{}, \n请求URL: [{}], \n请求方式: [{}]\n", e.getMessage(), requestUrl, method, e);
        }
        return ResultUtil.error(EnumResultCode.UN_KNOW_ERROR.getCode(), e.getMessage());
    }

    @ExceptionHandler(Exception.class)
    public RetResult exceptionHandler(HttpServletRequest request, Exception e){
        if(Objects.nonNull(request)){
            StringBuffer requestUrlBuffer = request.getRequestURL();
            String method = request.getMethod();
            String requestUrl = Objects.isNull(requestUrlBuffer) ? request.getRequestURI() : requestUrlBuffer.toString();
            log.error("Exception:{}, \n请求URL: [{}], \n请求方式: [{}]\n", e.getMessage(), requestUrl, method, e);
        }
        return ResultUtil.error(EnumResultCode.SYSTEM_ERROR.getCode(), e.getMessage());
    }
}

四、具体代码

一共有以下几个文件

  • ParamException.java
  • BusinessException.java
  • DataBaseException.java
  • GlobalExceptionHandler.java
  • EnumResultCode.java
  • ResultUtil.java
  • RetResult.java
  • TestDemoController.java

1.ParamException.java

package com.joshua317.share.exceptions;

import com.joshua317.share.common.enums.EnumResultCode;
import lombok.Getter;

/**
 * 业务异常专用类
 */
@Getter
public class ParamException extends RuntimeException {

    private String code;

    private String message;

    public ParamException(String message) {
        super(message);
        this.code = EnumResultCode.PARAM_ERROR.getCode();
        this.message = message;
    }
}

2.BusinessException.java

package com.joshua317.manager.exce;

import com.joshua317.share.common.enums.EnumResultCode;
import lombok.Getter;

/**
 * 业务异常专用类
 */
@Getter
public class BusinessException extends RuntimeException {

    private String code;

    private String message;

    public BusinessException(int code, String message) {
        super(message);
        this.code = code;
        this.message = message;
    }

    public BusinessException(String message) {
        super(message);
        this.code = EnumResultCode.BUSINESS_ERROR.getCode();
        this.message = message;
    }

    public BusinessException(EnumResultCode resultCode) {
        super(resultCode.getMessage());
        this.code = resultCode.getCode();
        this.message = resultCode.getMessage();
    }
}

3.DataBaseException.java

package com.joshua317.share.exceptions;

import com.joshua317.share.common.enums.EnumResultCode;
import lombok.Getter;

/**
 * 业务异常专用类
 */
@Getter
public class DataBaseException extends RuntimeException {

    private String code;

    private String message;

    public DataBaseException() {
        super(message);
        this.code = EnumResultCode.DATABASE_ERROR.getCode();
        this.message = EnumResultCode.DATABASE_ERROR.getMessage();
    }
}

4.GlobalExceptionHandler.java

package com.joshua317.manager.exce;

import com.joshua317.lib.response.exception.ApiException;
import com.joshua317.share.common.enums.EnumResultCode;
import com.joshua317.share.model.bean.RetResult;
import com.joshua317.share.utils.ResultUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.servlet.http.HttpServletRequest;
import java.util.Objects;

@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
	
	/**
	*业务异常
	*/
    @ExceptionHandler(BusinessException.class)
    public RetResult businessExceptionHandler(HttpServletRequest request, BusinessException e){
        if(Objects.nonNull(request)){
            StringBuffer requestUrlBuffer = request.getRequestURL();
            String method = request.getMethod();
            String requestUrl = Objects.isNull(requestUrlBuffer) ? request.getRequestURI() : requestUrlBuffer.toString();
            log.info("BusinessException:{}, \n请求URL: [{}], \n请求方式: [{}]\n", e.getMessage(), requestUrl, method, e);
        }
        return ResultUtil.error(e.getCode(), e.getMessage());
    }
	
	/**
	*参数异常
	*/
	@ExceptionHandler(ParamException.class)
    public RetResult paramExceptionHandler(HttpServletRequest request, ParamException e) {
        if (Objects.nonNull(request)) {
            StringBuffer requestUrlBuffer = request.getRequestURL();
            String method = request.getMethod();
            String requestUrl = Objects.isNull(requestUrlBuffer) ? request.getRequestURI() : requestUrlBuffer.toString();
            log.info("ParamException:{}, \n请求URL: [{}], \n请求方式: [{}]\n", e.getMessage(), requestUrl, method, e);
        }
        return ResultUtil.error(e.getCode(), e.getMessage());
    }
	
	/**
	*数据库异常
	*/
	@ExceptionHandler(DataBaseException.class)
    public RetResult databseExceptionHandler(HttpServletRequest request, DataBaseException e) {
        if (Objects.nonNull(request)) {
            StringBuffer requestUrlBuffer = request.getRequestURL();
            String method = request.getMethod();
            String requestUrl = Objects.isNull(requestUrlBuffer) ? request.getRequestURI() : requestUrlBuffer.toString();
            log.info("DatabseExceptionHandler{}, \n请求URL: [{}], \n请求方式: [{}]\n", e.getMessage(), requestUrl, method, e);
        }
        return ResultUtil.error(e.getCode(), e.getMessage());
    }

    @ExceptionHandler(RuntimeException.class)
    public RetResult runtimeExceptionHandler(HttpServletRequest request, RuntimeException e){
        if(Objects.nonNull(request)){
            StringBuffer requestUrlBuffer = request.getRequestURL();
            String method = request.getMethod();
            String requestUrl = Objects.isNull(requestUrlBuffer) ? request.getRequestURI() : requestUrlBuffer.toString();
            log.error("RuntimeException:{}, \n请求URL: [{}], \n请求方式: [{}]\n", e.getMessage(), requestUrl, method, e);
        }
        return ResultUtil.error(EnumResultCode.UN_KNOW_ERROR.getCode(), e.getMessage());
    }

    @ExceptionHandler(Exception.class)
    public RetResult exceptionHandler(HttpServletRequest request, Exception e){
        if(Objects.nonNull(request)){
            StringBuffer requestUrlBuffer = request.getRequestURL();
            String method = request.getMethod();
            String requestUrl = Objects.isNull(requestUrlBuffer) ? request.getRequestURI() : requestUrlBuffer.toString();
            log.error("Exception:{}, \n请求URL: [{}], \n请求方式: [{}]\n", e.getMessage(), requestUrl, method, e);
        }
        return ResultUtil.error(EnumResultCode.SYSTEM_ERROR.getCode(), e.getMessage());
    }
}

5.EnumResultCode.java

package com.joshua317.manager.exce;

import lombok.Getter;

@Getter
public enum EnumResultCode {
    //成功
    SUCCESS("0", "成功"),
    //错误
    FALSE("1", "错误"),
	PARAM_ERROR("C_1", "参数异常"),
    //内部错误
    BUSINESS_ERROR("C_2", "业务异常"),
	DATABASE_ERROR("SYS_1", "数据库异常"),
    //token超时
    TOKEN_INVALID("AUTH_0", "token无效或已超时");

    private String code;
    private String message;

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

6.ResultUtil.java

package com.joshua317.manager.exce;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import org.apache.http.HttpStatus;

import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * @author joshua317
 * @Description: 返回结果工具
 */
public class ResultUtil {

    public static RetResult success(Object obj) {
        RetResult res = new RetResult();
        res.setCode(EnumResultCode.SUCCESS.getCode());
        res.setMsg(EnumResultCode.SUCCESS.getMessage());
        res.setData(obj);
        return res;
    }

    public static RetResult success(String msg) {
        RetResult res = new RetResult();
        res.setCode(EnumResultCode.SUCCESS.getCode());
        res.setData(null);
        res.setMsg(msg);
        return res;
    }

    public static RetResult success(Object obj, String msg) {
        RetResult res = new RetResult();
        res.setCode(EnumResultCode.SUCCESS.getCode());
        res.setMsg(msg);
        res.setData(obj);
        return res;
    }

    public static RetResult success(Integer code, Object obj, String msg) {
        RetResult res = new RetResult();
        res.setCode(code);
        res.setMsg(msg);
        res.setData(obj);
        return res;
    }

    public static RetResult success(Object obj, long pageTotal) {
        RetResult res = new RetResult();
        res.setCode(EnumResultCode.SUCCESS.getCode());
        res.setMsg(EnumResultCode.SUCCESS.getMessage());
        res.setData(obj);
        res.setPageTotal(pageTotal);
        return res;
    }


    public static RetResult success(EnumResultCode exceptionCode, Object obj, long pageTotal) {
        RetResult res = new RetResult();
        res.setCode(exceptionCode.getCode());
        res.setMsg(exceptionCode.getMessage());
        res.setData(obj);
        res.setPageTotal(pageTotal);
        return res;
    }

    public static RetResult success(Integer code, Object obj, String msg, long pageTotal) {
        RetResult res = new RetResult();
        res.setCode(code);
        res.setMsg(msg);
        res.setData(obj);
        res.setPageTotal(pageTotal);
        return res;
    }

    public static RetResult success() {
        return success(EnumResultCode.SUCCESS.getMessage());
    }


    public static RetResult error(String msg) {
        RetResult res = new RetResult();
        res.setCode(EnumResultCode.SYSTEM_ERROR.getCode());
        res.setMsg(msg);
        return res;
    }

    public static RetResult error(Integer code, String msg) {
        RetResult res = new RetResult();
        res.setCode(code);
        res.setMsg(msg);
        return res;
    }
    public static RetResult error(EnumResultCode exceptionCode) {
        RetResult res = new RetResult();
        res.setCode(exceptionCode.getCode());
        res.setMsg(exceptionCode.getMessage());
        return res;
    }

    public static RetResult error(Integer code, String msg, Object obj) {
        RetResult res = new RetResult();
        res.setCode(code);
        res.setData(obj);
        res.setMsg(msg);
        return res;
    }

    public static RetResult error(Integer code, String msg, Object obj, int pageTotal) {
        RetResult res = new RetResult();
        res.setCode(code);
        res.setData(obj);
        res.setMsg(msg);
        res.setPageTotal(pageTotal);
        return res;
    }

    public static HttpServletResponse getResponse(ServletRequest request, ServletResponse response, RetResult retResult) throws IOException {
        Gson gson = new GsonBuilder().create();
        String resultString = gson.toJson(retResult);

        HttpServletRequest httpServletRequest = (HttpServletRequest) request;
        HttpServletResponse httpServletResponse = (HttpServletResponse) response;
        httpServletResponse.setHeader("Access-control-Allow-Origin", httpServletRequest.getHeader("Origin"));
        httpServletResponse.setHeader("Access-Control-Allow-Methods", "GET,POST,OPTIONS,PUT,DELETE");
        httpServletResponse.setHeader("Access-Control-Allow-Headers", httpServletRequest.getHeader("Access-Control-Request-Headers"));
        httpServletResponse.setCharacterEncoding("UTF-8");
        httpServletResponse.setContentType("application/json;charset=UTF-8");
        httpServletResponse.setStatus(HttpStatus.SC_NON_AUTHORITATIVE_INFORMATION);
        httpServletResponse.getWriter().write(resultString);

        return httpServletResponse;
    }
}

7.RetResult.java

package com.joshua317.manager.exce;

import lombok.Data;

/**
 * @author joshua317
 * @Description: 权限请求 返回结果
 */
@Data
public class RetResult {
    private String code;
    private String msg;
    private Object data;
    private long pageTotal;//分页时:查询数据数量

    public RetResult() {
        this.code = "0";
        this.msg = "";
        this.data = null;
        this.pageTotal = 0;
    }

    /**
     * 返回状态码、信息、以及数据
     */
    public RetResult(String code, String msg, Object data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
        this.pageTotal = 0;
    }

    /**
     * 返回状态码、信息、以及数据量
     */
    public RetResult(String code, String msg, Object data, int pageSize) {
        this.code = code;
        this.msg = msg;
        this.data = data;
        this.pageTotal = pageSize;
    }

    /**
     * 只返回状态码,以及信息可以用于失败时候来使用
     */
    public RetResult(String code, String msg) {
        this.code = code;
        this.msg = msg;
        this.data = null;
        this.pageTotal = 0;
    }

    /**
     * 只返回状态码和数据
     */
    public RetResult(String code, Object data) {
        this.code = code;
        this.msg = "";
        this.data = data;
        this.pageTotal = 0;
    }
}

8.TestDemoController.java

package com.joshua317.manager.exce;

import cn.hutool.core.util.StrUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

/*
 * @Description 测试接口
 * @Author joshua317
 **/
@Api(value = "测试接口")
@RequestMapping("/demo")
@RestController
public class TestDemoController {

    /**
     * 新增
     *
     * @param code 编号
     * @return
     */
    @ApiOperation(value = "新增")
    @PostMapping("/save")
    public RetResult find(@RequestParam("code") String code) {
        if (StrUtil.isEmpty(code)) {
            throw new BusinessException("code不能为空");
        }
        return ResultUtil.success("新增成功");
    }
}

本文为joshua317原创文章,转载请注明:转载自joshua317博客 SpringBoot统一异常处理 - joshua317的博客

  • 1
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
项目详细功能参考项目演示内容即可项目优势:1、项目从零开始到完结 附带视频,源码以及相关辅助资料,适合学习使用,项目也可拿来即用。2、几乎全手写代码,功能流程详细 跟着可以独立完成,附带详细代码相关常见bug 和 调试解决方案,让大家学会跟踪快速解决问题。3、系统后端使用LayUI技术,对页面不精通的小伙伴也可以快速完成精美页面的设计及应用,支持统一后台管理,也可拿来做其他项目通用后台4、针对layui 相关技术点薄弱的学员提供相关技术点学习,让快速上手完成项目研发5、选材来自生活,项目真实感强,可用学习使用和就业面试使用,适合作为面试中提高实际项目经验...6、该项目前后端分离,满足前沿技术点..项目技术栈:- 数据库:MySQL8.0- 后端技术:SpringBoot,MyBatisPlus,JWT 等- 日志技术:Log4j- 数据库连接池:druid- 前端技术:LayUI, axios,Echarts,Ztree 等- Web容器:Apache Tomcat 9- 项目管理工具:Maven3.6- 思维导图设计工具:XMIND 8- 开发工具: IDEA2020, WebStorm2020- 数据库设计软件:Power Designer16.5特别提示:1、涉及相关技术点学习,更多侧重大学生或无项目经验以及项目经验较少的学员入门到项目完结项目实战2、项目中功能处理大多提供多种解决方式,如跨域访问,更多让大家了解解决方式的同时学会技术点应用3、加入bug的调试以及代码跟踪处理,更好的让学员更多学会如何解决问题

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值