Home未分类190930-SpringBoot系列教程web篇之404、500异常页面配置

190930-SpringBoot系列教程web篇之404、500异常页面配置

2010 年 8 月 4 日
接着前面几篇web处理请求的博文，本文将说明，当出现异常的场景下，如404请求url不存在，，403无权，500服务器异常时，我们可以如何处理

I. 环境搭建

首先得搭建一个web应用才有可能继续后续的测试，借助SpringBoot搭建一个web应用属于比较简单的活;
创建一个maven项目，pom文件如下

<parent>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-parentartifactId>
    <version>2.1.7version>
    <relativePath/> 
parent>

<properties>
    <project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8project.reporting.outputEncoding>
    <spring-cloud.version>Finchley.RELEASEspring-cloud.version>
    <java.version>1.8java.version>
properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-webartifactId>
    dependency>
    <dependency>
        <groupId>com.alibabagroupId>
        <artifactId>fastjsonartifactId>
        <version>1.2.45version>
    dependency>
dependencies>

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-maven-pluginartifactId>
            plugin>
        plugins>
    pluginManagement>
build>
<repositories>
    <repository>
        <id>spring-milestonesid>
        <name>Spring Milestonesname>
        <url>https://repo.spring.io/milestoneurl>
        <snapshots>
            <enabled>falseenabled>
        snapshots>
    repository>
repositories>

依然是一般的流程，pom依赖搞定之后，写一个程序入口

/**
 * Created by @author yihui in 15:26 19/9/13.
 */
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}

II. 异常页面配置

在SpringBoot项目中，本身提供了一个默认的异常处理页面，当我们希望使用自定义的404,500等页面时，可以如何处理呢？

1. 默认异常页面配置

在默认的情况下，要配置异常页面非常简单，在资源路径下面，新建 error
目录，在下面添加 400.html
, 500html
页面即可


项目结构如上，注意这里的实例demo是没有使用模板引擎的，所以我们的异常页面放在static目录下；如果使用了如FreeMaker模板引擎时，可以将错误模板页面放在template目录下
接下来实际测试下是否生效, 我们先定义一个可能出现服务器500的服务

@Controller
@RequestMapping(path = "page")
public class ErrorPageRest {

    @ResponseBody
    @GetMapping(path = "divide")
    public int divide(int sub) {
        System.out.println("divide1");
        return 1000 / sub;
    }
}

请求一个不存在的url，返回我们定义的 400.html
页面 

<html>
<head>
    <title>404页面title>
head>
<body>
<h3>页面不存在h3>
body>
html>

请求一个服务器500异常，返回我们定义的 500.html
页面 

<html>
<head>
    <title>500页面title>
head>
<body>
<h2 style="color: red;">服务器出现异常!!!h2>
body>
html>

2. BasicErrorController

看上面的使用比较简单，自然会有个疑问，这个异常页面是怎么返回的呢？

从项目启动的日志中，注意一下 RequestMappingHandlerMapping

可以发现里面有个 /error
的路径不是我们自己定义的，从命名上来看，这个多半就是专门用来处理异常的Controller -> BasicErrorController
， 部分代码如下 

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {

  @Override
 public String getErrorPath() {
     return this.errorProperties.getPath();
   }

 @RequestMapping(produces = "text/html")
  public ModelAndView errorHtml(HttpServletRequest request,
          HttpServletResponse response) {
      HttpStatus status = getStatus(request);
        Map model = Collections.unmodifiableMap(getErrorAttributes(
                request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
      response.setStatus(status.value());
        ModelAndView modelAndView = resolveErrorView(request, response, status, model);
        return (modelAndView != null) ? modelAndView : new ModelAndView("error", model);
   }

 @RequestMapping
   @ResponseBody
 public ResponseEntity> error(HttpServletRequest request) {
        Map body = getErrorAttributes(request,
             isIncludeStackTrace(request, MediaType.ALL));
      HttpStatus status = getStatus(request);
        return new ResponseEntity<>(body, status);
   }
}

这个Controller中，一个返回网页的接口，一个返回Json串的接口；我们前面使用的应该是第一个，那我们什么场景下会使用到第二个呢？

  • 通过制定请求头的 Accept
    ，来限定我们只希望获取json的返回即可

3. 小结

本篇内容比较简单，归纳为两句话如下

/error

II. 其他

0. 项目

a. 系列博文

b. 项目源码

1. 一灰灰Blog

尽信书则不如，以上内容，纯属一家之言，因个人能力有限，难免有疏漏和错误之处，如发现bug或者有更好的建议，欢迎批评指正，不吝感激
下面一灰灰的个人博客，记录所有学习和工作中的博文，欢迎大家前去逛逛

打赏
如果觉得我的文章对您有帮助，请随意打赏。

Related Posts

About The Author

bjmayor

程序员，码农，php,python,ios,android,go，产品经理，创业。