ControllerAdvice和ErrorController的用法

最新推荐文章于 2023-12-23 19:14:44 发布
原创 最新推荐文章于 2023-12-23 19:14:44 发布 · 2.1k 阅读 · 3 ·
本内容遵循CC 4.0 BY-SA版权协议
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
收录于
Spring

当前文章被收录于：

Spring
2 篇文章 2 人学习
订阅专栏 查看详情
本文介绍了在Java中，@ControllerAdvice用于处理Exception，而ErrorController则处理Error。详细讲解了ErrorController的源码和重写样例，以及@ControllerAdvice的使用示例，帮助理解Spring Boot中如何优雅地处理错误信息。

介绍

在Java中异常可以分为Error和Exception，@ControllerAdvice用来处理系统中的Exception，ErrorController处理系统中的Error。

ErrorController

在项目中我们遇到404找不到的错误、或者500服务器错误都需要配置相应的页面给用户一个友好的提示，而在Spring Boot中我们需要如何设置。

当系统出现404或者405等错误信息时，springboot默认的访问路径为/error，所以实现ErrorController并重写。

ErrorController源码

package org.springframework.boot.web.servlet.error;

import org.springframework.stereotype.Controller;

/**
 * Marker interface used to indicate that a {@link Controller @Controller} is used to
 * render errors. Primarily used to know the error paths that will not need to be secured.
 *
 * @author Phillip Webb
 * @since 2.0.0
 */
@FunctionalInterface
public interface ErrorController {

	/**
	 * Returns the path of the error page.
	 * @return the error path
	 */
	String getErrorPath();

}

重写ErrorController样例

/**
 * 全局Error/404处理
 * @author geekidea
 * @date 2018-11-08
 */
@ApiIgnore
@RestController
@Slf4j
public class GlobalErrorController implements ErrorController {

    private static final String ERROR_PATH = "/error";

    @RequestMapping(ERROR_PATH)
    public ApiResult<?> handleError(HttpServletRequest request,HttpServletResponse response){
        int status = response.getStatus();
        switch (status){
            case HttpServletResponse.SC_UNAUTHORIZED:
                return ApiResult.fail(ApiCode.UNAUTHORIZED);
            case HttpServletResponse.SC_FORBIDDEN:
                return ApiResult.fail(ApiCode.NOT_PERMISSION);
            case HttpServletResponse.SC_NOT_FOUND:
                return ApiResult.fail(ApiCode.NOT_FOUND);
            default:
                break;
        }
        return ApiResult.fail(ApiCode.FAIL);
    }

    @Override
    public String getErrorPath() {
        log.error("errorPath....");
        return ERROR_PATH;
    }
}

@ControllerAdvice

ControllerAdvice用来处理发生Exception错误的注解。需要注意的是不能使用try catch 捕获

@ControllerAdvice样例

/**
 * @author geekidea
 * @date 2018-11-08
 */
@ControllerAdvice
@RestController
@Slf4j
public class GlobalExceptionHandler {

    /**
     * 非法参数验证异常
     *
     * @param ex
     * @return
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(value = HttpStatus.OK)
    public ApiResult<List<String>> handleMethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException ex) {
        printRequestDetail();
        BindingResult bindingResult = ex.getBindingResult();
        List<String> list = new ArrayList<>();
        List<FieldError> fieldErrors = bindingResult.getFieldErrors();
        for (FieldError fieldError : fieldErrors) {
            list.add(fieldError.getDefaultMessage());
        }
        Collections.sort(list);
        log.error(getApiCodeString(ApiCode.PARAMETER_EXCEPTION) + ":" + JSON.toJSONString(list));
        return ApiResult.fail(ApiCode.PARAMETER_EXCEPTION, list);
    }

    /**
     * 系统登录异常处理
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = SysLoginException.class)
    @ResponseStatus(HttpStatus.OK)
    public ApiResult<Boolean> sysLoginExceptionHandler(SysLoginException exception) {
        printRequestDetail();
        printApiCodeException(ApiCode.LOGIN_EXCEPTION, exception);
        return ApiResult.fail(ApiCode.LOGIN_EXCEPTION);
    }


    /**
     * HTTP解析请求参数异常
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = HttpMessageNotReadableException.class)
    @ResponseStatus(HttpStatus.OK)
    public ApiResult<Boolean> httpMessageNotReadableException(HttpMessageNotReadableException exception) {
        printRequestDetail();
        printApiCodeException(ApiCode.PARAMETER_EXCEPTION, exception);
        return ApiResult.fail(ApiCode.PARAMETER_EXCEPTION);
    }

    /**
     * HTTP
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = HttpMediaTypeException.class)
    @ResponseStatus(HttpStatus.OK)
    public ApiResult<Boolean> httpMediaTypeException(HttpMediaTypeException exception) {
        printRequestDetail();
        printApiCodeException(ApiCode.HTTP_MEDIA_TYPE_EXCEPTION, exception);
        return ApiResult.fail(ApiCode.HTTP_MEDIA_TYPE_EXCEPTION);
    }

    /**
     * 自定义业务/数据异常处理
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = {SpringBootPlusException.class})
    @ResponseStatus(HttpStatus.OK)
    public ApiResult<Boolean> springBootPlusExceptionHandler(SpringBootPlusException exception) {
        printRequestDetail();
        log.error("springBootPlusException:", exception);
        int errorCode;
        if (exception instanceof BusinessException) {
            errorCode = ApiCode.BUSINESS_EXCEPTION.getCode();
        } else if (exception instanceof DaoException) {
            errorCode = ApiCode.DAO_EXCEPTION.getCode();
        } else if (exception instanceof VerificationCodeException) {
            errorCode = ApiCode.VERIFICATION_CODE_EXCEPTION.getCode();
        } else {
            errorCode = ApiCode.SPRING_BOOT_PLUS_EXCEPTION.getCode();
        }
        return new ApiResult<Boolean>()
                .setCode(errorCode)
                .setMessage(exception.getMessage());
    }


    /**
     * 登录授权异常处理
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = AuthenticationException.class)
    @ResponseStatus(HttpStatus.OK)
    public ApiResult<Boolean> authenticationExceptionHandler(AuthenticationException exception) {
        printRequestDetail();
        printApiCodeException(ApiCode.AUTHENTICATION_EXCEPTION, exception);
        return ApiResult.fail(ApiCode.AUTHENTICATION_EXCEPTION);
    }


    /**
     * 未认证异常处理
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = UnauthenticatedException.class)
    @ResponseStatus(HttpStatus.OK)
    public ApiResult<Boolean> unauthenticatedExceptionHandler(UnauthenticatedException exception) {
        printRequestDetail();
        printApiCodeException(ApiCode.UNAUTHENTICATED_EXCEPTION, exception);
        return ApiResult.fail(ApiCode.UNAUTHENTICATED_EXCEPTION);
    }


    /**
     * 未授权异常处理
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = UnauthorizedException.class)
    @ResponseStatus(HttpStatus.OK)
    public ApiResult<Boolean> unauthorizedExceptionHandler(UnauthorizedException exception) {
        printRequestDetail();
        printApiCodeException(ApiCode.UNAUTHORIZED_EXCEPTION, exception);
        return ApiResult.fail(ApiCode.UNAUTHORIZED_EXCEPTION);
    }


    /**
     * JWT Token解析异常
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = JWTDecodeException.class)
    @ResponseStatus(HttpStatus.OK)
    public ApiResult<Boolean> jWTDecodeExceptionHandler(JWTDecodeException exception) {
        printRequestDetail();
        printApiCodeException(ApiCode.JWTDECODE_EXCEPTION, exception);
        return ApiResult.fail(ApiCode.JWTDECODE_EXCEPTION);
    }

    /**
     * 默认的异常处理
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = HttpRequestMethodNotSupportedException.class)
    @ResponseStatus(HttpStatus.OK)
    public ApiResult<String> httpRequestMethodNotSupportedExceptionHandler(Exception exception) {
        printRequestDetail();
        printApiCodeException(ApiCode.HTTP_REQUEST_METHOD_NOT_SUPPORTED_EXCEPTION, exception);
        return ApiResult.fail(ApiCode.HTTP_REQUEST_METHOD_NOT_SUPPORTED_EXCEPTION.getCode(), exception.getMessage());
    }

    /**
     * 默认的异常处理
     *
     * @param exception
     * @return
     */
    @ExceptionHandler(value = Exception.class)
    @ResponseStatus(HttpStatus.OK)
    public ApiResult<Boolean> exceptionHandler(Exception exception) {
        printRequestDetail();
        printApiCodeException(ApiCode.SYSTEM_EXCEPTION, exception);
        return ApiResult.fail(ApiCode.SYSTEM_EXCEPTION);
    }


    /**
     * 打印请求详情
     */
    private void printRequestDetail() {
        RequestDetail requestDetail = RequestDetailThreadLocal.getRequestDetail();
        if (requestDetail != null) {
            log.error("异常来源：ip: {}, path: {}", requestDetail.getIp(), requestDetail.getPath());
        }
    }

    /**
     * 获取ApiCode格式化字符串
     *
     * @param apiCode
     * @return
     */
    private String getApiCodeString(ApiCode apiCode) {
        if (apiCode != null) {
            return String.format("errorCode: %s, errorMessage: %s", apiCode.getCode(), apiCode.getMessage());
        }
        return null;
    }

    /**
     * 打印错误码及异常
     *
     * @param apiCode
     * @param exception
     */
    private void printApiCodeException(ApiCode apiCode, Exception exception) {
        log.error(getApiCodeString(apiCode), exception);
    }

}
标签
#spring #java
SpringBoot异常统一处理方法——ErrorController
TechSavant的博客
08-14 472
在handleException方法中，我们通过HttpServletRequest对象获取了异常相关的信息，如状态码、具体的异常对象和消息等。同时，我们可以自定义异常类，并在应用程序中抛出这些异常，以触发全局异常处理逻辑。接下来，我们需要创建一个全局异常处理类，用于捕获和处理所有的异常。这时，全局异常处理类GlobalExceptionHandler就会捕获到该异常，并返回一个包含异常信息的错误响应给前端。首先，我们需要创建一个自定义的异常类，用于表示我们希望捕获和处理的特定异常。
Spring Boot错误处理的艺术
最新发布
m0_62153576的博客
08-25 484
下面是一个自定义的示例，它通过});}"
SpringBoot - 自定义404异常 - 【ErrorController 、ControllerAdvice、BasicErrorController】
LawssssCat的博客
03-31 2100
复制、改改、即可 package cn.vshop.security.web.controller; import cn.vshop.security.exception.ServiceException; import org.springframework.boot.autoconfigure.web.ErrorController; import org.springframework.h...
SpringBoot异常处理ErrorController详解
境里婆娑
05-29 1万+
文章目录一、背景二、SpringBoot的默认异常处理BasicErrorController三、自定义错误异常 写在前面： 我是「境里婆娑」。我还是从前那个少年，没有一丝丝改变，时间只不过是考验，种在心中信念丝毫未减，眼前这个少年，还是最初那张脸，面前再多艰险不退却。 写博客的目的就是分享给大家一起学习交流，如果您对 Java感兴趣，可以关注我，我们一起学习。 前言：ErrorController是SpringBoot调用Controller出错时的一个统一处理接口，它的实现为BasicErrorCo
全局异常处理及自定义异常：ErrorController与@ControllerAdvice区别和用法
jwf111的博客
03-15 1万+
参考资料 springboot继承AbstractErrorController实现全局的异常处理 https://blog.csdn.net/qq_29684305/article/details/82286469 spring boot 原生错误处理ErrorController https://blog.csdn.net/shenyunsese/article/details...
@ControllerAdvice和ErrorController的用法
java_chegnxuyuan的博客
09-17 3465
在Java中异常可以分为Error和Exception，@ControllerAdvice用来处理系统中的Exception，ErrorController处理系统中的Error。 1.ErrorController 当系统出现404或者405等错误信息时，springboot默认的访问路径为/error，所以实现ErrorController并重写 getErrorPath方法 @...
springMvc中@ControllerAdvice和ErrorController接口使用
panda-star的博客
06-29 819
springMvc中@ControllerAdvice和ErrorController接口使用 一、简介 springMvc中对全局的处理，可以使用aop。这里介绍另外一种方式，借助springMvc的ControllerAdvice注解和ErrorController接口。 二、ControllerAdvice注解 @ControllerAdvice(直接返回请求体，可以使用@RestControllerAdvice)可以对控制器进行全局处理，通常借助＠ExceptionHandler、@InitBind
基于ControllerAdvice+ErrorController+Filter，Springboot全局化处理异常信息（自定义error页面或json返回）
热门推荐
東₂₀₂₃²⁰²³
02-21 1万+
适用要求： 1. 自定义error页面，并能对error信息进行封装 2.根据不同的异常返回不同的信息 3. 能根据请求地址（或其他信息）决策返回页面还是json 解决思路： 1. 自定义error页面 这个比较简单，继承ErrorController接口实现自己的Controller即可。 可参见:org.springframework....
springboot使用@ControllerAdvice和ErrorController实现全局异常控制。
yuru974882032的博客
06-19 1274
注：该方法无法处理未进入Controller的异常，比如404和Filter中的异常 下面放一个简单的实现 @ControllerAdvice @Slf4j //lombok中的日志注解 public class GlobalExceptionHandler { @ExceptionHandler(Exception.class) //不可预知的异常可以直接用Exception捕获 public String exceptionHandler(HttpServletResponse res
Springboot全局异常处理：@ControllerAdvice和ErrorController
Razera的博客
03-15 964
Springboot全局异常处理：@ControllerAdvice和ErrorController 目前有两种方式可以实现全局异常处理 @ControllerAdvice ErrorController 两种处理方式可以同时使用，个人理解同时使用时 @ControllerAdvice是用来捕获Controller中抛出的异常; ErrorController则是捕获未被@ControllerAdvice捕获的异常，用来做兜底异常处理; 一. @ControllerAdvice 实现 @Cont
全局异常处理之@RestControllerAdvice和ErrorController详解
青青子衿，悠悠我心
12-13 2018
在我们平时做项目时全局异常处理一般有两种实现方式。 1.写一个类，添加上@RestControllerAdvice注解，在写处理方法，加上@ExceptionHandler注解 2.写一个controller，实现ErrorController接口，写一个error接口，实现异常处理的逻辑。 那么，这两种方式有什么区别呢？他们能不能同时存在呢？同时存在的话又会是怎么处理的呢？下面说一说...
SpringBoot实践之---处理全局统一异常的两种方法与区别（@ControllerAdvice、@ExceptionHandler 与 ErrorController类）
luckykapok918的专栏
11-06 2986
前言 在后端发生异常或者是请求出错时，前端通常显示如下 Whitelabel Error Page This application has no explicit mapping for /error, so you are seeing this as a fallback. Fri Jun 07 15:38:07 CST 2019 There was an unexpected er...
SpringBoot学习－（二十一）SpringBoot异常统一处理
大白能的博客
01-31 2652
SpringBoot自带的异常处理 SpringBoot默认返回的异常信息 { "timestamp": 1517369509468, "status": 500, "error": "Internal Server Error", "exception": "java.lang.IndexOutOfBoundsException", "messag
springboot使用AdviceController和ErrorController处理异常和错误
qq_44574863的博客
05-09 1740
目录结构： 1,定义一个处理异常和错误的界面 <!DOCTYPE HTML> <html xmlns:th="http://www.thymeleaf.org"> <head> <title>问答社区</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <link rel="stylesheet" hr
Spring Boot & Spring MVC 异常处理的 N 种方法
程序员高级码农的博客
12-23 942
curl http://localhost:8080/return-text-plain，会隐含一个请求头Accept: */*，会匹配到FooController.returnTextPlain(produces=text/plain)方法，注意：如果请求头不是Accept: */*或Accept: text/plain，那么是匹配不到FooController.returnTextPlain的。请求的时候指定Accept头，避免匹配到BasicErrorController.error方法。
spring boot 404 500-》自定义异常 、error页面白板页面：ControllerAdvice、ExceptionHandler；
n20164206199的博客
02-09 873
本章讲解：spring boot ：error返回的页面 对于输错的网址：或者是不存在的自己设计错误页面： 例如url=localhost:8222/123(错误网址） 原本写的只是Whitelabel Error Page（白板错误页面） 修改后：当然可以根据4xxx，5xx来设置不同的message 1.定义白页 (whilelabel） 在template下写一个error.html ...
关于SpringBoot，我有话要讲（Filter和Controller中的异常处理）
m0_64363449的博客
08-19 784
这里定义一个 TokenErrorController ，继承自 SpringBoot 提供的 BasicErrorController 这个类，然后重写 error 这个方法（如果是页面的话，重写 errorHtml 这个方法），用于返回自定义的 Response 数据。
Springboot全局异常处理
程序员一博
11-26 3923
springboot默认发生4xx错误时候，pc端响应的页面如下如果是移动端（手机端）将会响应json格式的数据，如下。
SpringBoot全局统一异常处理(包含404错误处理)
MUTONG的博客
06-17 1295
SpringBoot全局统一异常处理(包含404错误处理) 1.ControllerAdvice&&ExceptionHandler处理异常 package com.lius.controllers; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController.
SpringBoot 异常处理的主要组件有哪些
it_xushixiong的博客
06-22 990
自定义异常类用于处理应用程序中的特定异常。当应用程序中出现指定类型的异常时，自定义异常类会自动捕获并进行处理。} }在上面的代码中，类继承了类，并定义了一个错误代码属性errorCode。当应用程序中抛出类型的异常时，异常处理器会自动捕获并进行处理。本文介绍了 SpringBoot 异常处理的主要组件，包括注解、注解、接口、自定义异常类和异常处理器。这些组件可以让我们方便地处理应用程序中出现的各种异常，提高应用程序的稳定性和可靠性。
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

mangoBUPT

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值