springboot异常处理

 

前言

在springboot项目中,一般我们访问不存在的资源或内部服务报错,会报下面的异常页面,这是springboot为我们定制的异常页面,

404

定义一个项目,加入依赖:

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
</dependencies>

定义一个Controller类,

package com.zhihao.miao.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @GetMapping("/user/home")
    public String index(){
        logger.info("user home");
        return "user home";
    }

    @GetMapping("/user/help")
    public String help(){
        logger.info("user help");
        throw new IllegalArgumentException("args is empty");
    }
}

启动类启动:

package com.zhihao.miao;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}

访问不存在的资源

 

404

访问内部资源报错的资源

 

500

如何去掉springboot默认的异常处理逻辑
查看org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration类,

 

发现org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration类就是springboot默认的异常处理逻辑,我们在springboot应用容器中去除这个类即可去掉springboot默认的异常处理逻辑。

修改启动类,排除ErrorMvcAutoConfiguration类

package com.zhihao.miao;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration;

@SpringBootApplication(exclude =ErrorMvcAutoConfiguration.class)
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}

再次访问上面的资源就出现经典的tomcat异常

 

404

500

如何定制自己的异常页面

使用ErrorPageRegistrar方法
写一个类,实现ErrorPageRegistrar接口,然后实现registerErrorPages方法,在该方法里面,添加具体的错误处理逻辑(类似web.xml里面配置错误处理方式),这一种也是全局的异常处理。

定义一个MyErrorPageRegistrar实现ErrorPageRegistrar接口

package com.zhihao.miao.bean;

import org.springframework.boot.web.servlet.ErrorPage;
import org.springframework.boot.web.servlet.ErrorPageRegistrar;
import org.springframework.boot.web.servlet.ErrorPageRegistry;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

@Component
public class MyErrorPageRegistrar implements ErrorPageRegistrar {

    @Override
    public void registerErrorPages(ErrorPageRegistry registry) {
        //具体的错误码错误异常页面
        ErrorPage e404 = new ErrorPage(HttpStatus.NOT_FOUND,"/404.html");
        ErrorPage e500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR,"/500.html");
        //指定具体异常的错误定制页面
        ErrorPage argspage = new ErrorPage(IllegalArgumentException.class,"/argsException.html");
        registry.addErrorPages(e404,e500,argspage);
    }
}

定义的3个错误页面,
404.html:

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Insert title here</title>
</head>
<body>
<h1>404 not found</h1>
</body>
</html>

500.html:

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Insert title here</title>
</head>
<body>
<h1>500 server error</h1>
</body>
</html>

argsException.html:

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Insert title here</title>
</head>
<body>
<h1>args is empty</h1>
</body>
</html>

启动类,可以不指定排除默认的springboot异常处理,因为新定义的全局异常处理springboot的就不执行了

package com.zhihao.miao;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration;

//@SpringBootApplication(exclude =ErrorMvcAutoConfiguration.class)
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}

再去访问之前的资源

资源不存在

 

404

IllegalArgumentException

发现具体异常定义的异常处理优于状态码异常处理。

使用@ExceptionHandler注解
新建一个项目,定义一个Controller进行测试,

package com.zhihao.miao.controller;

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

import java.io.FileNotFoundException;

@RestController
public class BookController {

    //对异常进行处理,这种方式只能处理当前类中的异常,也就是局部异常处理
    @ExceptionHandler(value=FileNotFoundException.class)
    public String error(){
        return "file is not found exception";
    }

    @ExceptionHandler(value=Exception.class)
    public String excep(Exception e){
        return "not found exception: "+e.getMessage();
    }

    @GetMapping("/book/error1")
    public String error1() throws FileNotFoundException {
        throw new FileNotFoundException("book.txt not found");
    }

    @GetMapping("/book/error2")
    public String error2() throws ClassNotFoundException {
        throw new ClassNotFoundException("Book class not found");
    }

}

启动类启动:

package com.zhihao.miao;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration;

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}

访问http://localhost:8080/book/error1,抛出FileNotFoundException异常,被当前类的@ExceptionHandler注解给捕获到进行异常逻辑处理。定义在其他Controller类中的此种异常不会被其捕获,所以此种异常处理也是局部异常处理。

 

使用@ControllerAdvice注解定义全局异常

定义GlobalExceptionHandler标记注解@ControllerAdvice

package com.zhihao.miao.bean;

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * 可以在全局异常处理的类中进行具体的异常处理,也可以在全局异常类中进行所有异常的处理,
 * @ExceptionHandler的value值不同。
 */
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ArithmeticException.class)
    @ResponseBody
    public String ArithmeticHandler(Exception e){
        return "global error " + e.getClass().getName();
    }

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public String error(Exception e){
        return "global error" + e.getMessage();
    }
}

定义Controller

@RestController
public class UserController {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @GetMapping("/user/home")
    public String index(){
        logger.info("user home");
        return "user home";
    }

    @GetMapping("/user/help")
    public String help(){
        logger.info("user help");
        throw new IllegalArgumentException("args is empty");
    }
}

访问http://localhost:8080/user/help

这个处理异常的方法必须要求本身的方法返回参数和@ExceptionHandler(***Exception.class)异常修饰的方法必须要一样的。

总结这种异常处理的步骤:
写一个类,需要加上@ControllerAdvice注解,然后使用@ExceptionHandler异常进行异常定位。
如果一个Controller类中定义了@ExceptionHandler注解修饰的方法,那么当前类中异常捕获优先于全局定义的异常。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
SpringBoot提供了一套默认的异常处理机制。一旦程序出现异常,SpringBoot会向/error的URL发送请求,并通过BasicErrorController来处理该请求。默认情况下,SpringBoot会跳转到默认显示异常信息的页面来展示异常信息。如果我们希望将所有的异常统一跳转到自定义的错误页面,可以在src/main/resources/templates目录下创建一个名为error.html的页面。通过覆盖默认的错误页面,我们可以实现自定义的异常处理。 除了使用SpringBoot的默认配置外,还可以通过自定义错误页面来处理异常。我们可以在src/main/resources/templates目录下创建error.html页面,并将其命名为error。通过这种方式,我们可以自定义错误页面的内容和样式来展示异常信息。 在处理异常的过程中,可以关注ErrorMvcAutoConfiguration中的三个关键点。通过对SpringBoot错误处理机制源码的跟踪,我们可以更深入地了解异常处理的实现细节。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [SpringBoot异常处理](https://blog.csdn.net/Linging_24/article/details/126077782)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* *3* [SpringBoot 异常处理详解](https://blog.csdn.net/qq_42402854/article/details/91415966)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值