使用@ControllerAdvice统一处理自定义异常

最新推荐文章于 2025-06-13 15:39:13 发布

罗汉爷

最新推荐文章于 2025-06-13 15:39:13 发布

阅读量1.1k

点赞数

CC 4.0 BY-SA版权

分类专栏： Java-Web # 玩转Spring Boot 文章标签： ControllerAdvice

本文链接：https://blog.youkuaiyun.com/IndexMan/article/details/94591500

玩转Spring Boot 同时被 2 个专栏收录

106 篇文章

订阅专栏

Java-Web

21 篇文章

订阅专栏

本文介绍了一种在AOP中实现统一异常处理的方法，通过自定义异常类、异常处理器和结果封装，实现了异常信息的JSON格式化返回，便于前端展示。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

最近工作中涉及到捕捉AOP方法中抛出的异常。

想针对某一种异常做一个统一的处理器并封装好异常信息以JSON格式交给前端进行提示。

主要实现的话有以下几步：

1.编写自定义异常类

package com.laoxu.easyblog.exception;

/**
 * @Description: 未授权异常
 * @Author laoxu
 * @Date 2019/7/3 21:51
 **/
public class UnAuthorizedException extends RuntimeException{
    private static final long serialVersionUID = 1L;

    private String errorCode;
    private String errorMessage;

    public UnAuthorizedException(String errorCode, String errorMessage) {
        this.errorCode = errorCode;
        this.errorMessage = errorMessage;
    }

    public String getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(String errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMessage() {
        return errorMessage;
    }

    public void setErrorMessage(String errorMessage) {
        this.errorMessage = errorMessage;
    }
}

2.编写异常处理器

package com.laoxu.easyblog.framework;

import com.laoxu.easyblog.exception.UnAuthorizedException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @Description: 异常处理器
 * @Author laoxu
 * @Date 2019/7/3 22:14
 **/
@ControllerAdvice
public class ExceptionsHandler {
    @ResponseBody
    @ExceptionHandler(UnAuthorizedException.class)//可以直接写@ExceptionHandler,不指明异常类，会自动映射
    public Result<String> customGenericExceptionHnadler(UnAuthorizedException exception){ //还可以声明接收其他任意参数
        return ResultUtil.fail(Integer.valueOf(exception.getErrorCode()),exception.getErrorMessage());
    }
}

3.包装返回信息

package com.laoxu.easyblog.framework;

/**
 * 返回结果工具类
 *
 * @author xusucheng
 * @create 2018-10-23
 **/
public class ResultUtil {
    public static boolean isOk(Result<?> result){
        return null != result && result.getCode() == ErrorStatus.OK.getCode();
    }

    public static <T> Result<T> ok(){
        return new Result<T>(ErrorStatus.OK);
    }

    public static <T> Result<T> ok(T data){
        return new Result<T>(ErrorStatus.OK.getCode(), ErrorStatus.OK.getMessage(), data);
    }

    public static <T> Result<T> fail(){
        return new Result<T>(ErrorStatus.BAD_REQUEST).fail();
    }

    public static <T> Result<T> status(ErrorStatus status){
        return new Result<T>(status.getCode(), status.getMessage()).fail();
    }

    public static <T> Result<T> fail(ErrorStatus status){
        return new Result<T>(status.getCode(), status.getMessage()).fail();
    }

    public static <T> Result<T> fail(String message){
        return fail(ErrorStatus.BAD_REQUEST.getCode(), message, (T)null).fail();
    }

    public static <T> Result<T> fail(int code, String message){
        return new Result<T>(code, message).fail();
    }

    public static <T> Result<T> fail(int code ,String message, T data){
        return new Result<T>(code, message, data).fail();
    }

    public static <T> Result<T> notfound(){
        return new Result<T>(ErrorStatus.NOT_FOUND).fail();
    }

}

4.编写测试controller

package com.laoxu.easyblog.controller;

import com.laoxu.easyblog.exception.UnAuthorizedException;
import com.laoxu.easyblog.framework.Result;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @Description:
 * @Author laoxu
 * @Date 2019/7/3 22:09
 **/
@Controller
@RequestMapping("/auth")
public class ExceptionController {

    @RequestMapping("/getLoginUser")
    public Result<String> getLoginUser(){
        throw new UnAuthorizedException("403","用户未授权！");
    }
}

5.编写测试页面

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org"
      xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity4">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>测试页</title>
    <script src="../js/jquery.min.js" th:src="@{/assets/js/jquery.min.js}"></script>


</head>
<body>

<button onclick="getLoginUser();">获取用户信息</button>
<script>
    function getLoginUser(){
        $.ajax({
            url: "/blog/auth/getLoginUser",
            type: "GET",
            success: function (result) {
                if (result.success) {
                    alert("获取成功！");
                } else {
                    alert(result.code+":"+result.message);
                }

            }
        });
    }

</script>
</body>
</html>