Spring Boot自定义错误转发页面

引言

        没有完美的程序,只有不断的追求完美,我们才能进步和成长,程序的运行不可能是一帆风顺的,当出现一些错误时,比如500服务器内部错误,404用户访问错误的URL,405用户无此权限........针对这些问题Spring Boot给我们提供了一些错误的信息页面提示。

Spring Boot提供的404错误页面

        作为开发人员我们一眼就能看懂,但是如果给用户看这种页面,不知情的用户还以为我们的系统怎么了,造成用户体验度非常不好,针对这些问题我们应该给用户友好的提示,一般我们都需要定制一些错误的页面。

自定义错误页面:

1.静态资源的方式:

        1.在resources目录下创建public/error目录,编写错误页面。

创建public/error目录,编写错误页面

2.访问测试:

2.动态方式:

1.使用IDEA建立一个Spring Boot项目,在pom.xml文件中添加和配置如下内容:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
</dependency>
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>jstl</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-jasper</artifactId>
</dependency>

2.在src/main/下创建webapp/view/error/目录,并在下面定义错误页面:

创建目录并定义错误页面

3.在application.yml文件中配置Spring MVC视图解析器:

配置Spring MVC视图解析器

4.编写ErrorConfiguration配置类:

(1)编写代码之间我们先普及一下小知识:
        我们使用基于java容器配置的方式,在Spring 3.0中引入了基于java容器的配置,SpringJava容器配置支持中的中心工件是 @Configuration注解用于注释类和@Bean 用于注释方法,对于熟悉SpringXML配置中<beans/>配置的开发人员,@Bean注释与<bean/>元素的作用相同。
        EmbeddedServletContainerCustomizer接口可以自定义嵌入式servlet容器的策略界面。这种类型的bean将在容器本身启动之前与容器工厂进行回调,因此我们可以设置端口,地址,错误页面等。
        通过查看API发现此接口只有一个方法customize,此方法需要传递ConfigurableEmeddedServletContainer的实现类对象。

        ConfigurableEmeddedServletContainer是一个接口,阅读API文档得知此接口继承了ErrorPageRegistry接口。

        阅读API文档得知ErrorPageRegistry接口中只有一个addErrorPage方法,此方法需要传递ErrorPage对象。

        阅读API文档得知ErrorPage类表示简单和容器无关的servlet错误页面抽象,此类相当于web.xml中的<error-page>,ErrorPage提供了三种构造方法,我们只使用public ErrorPage(org.springframework.http.HttpStatus status,String path)构造,指出一个错误类型(org.springframework.http.HttpStatus是一个枚举类型,里面提供了http状态码
),并传递一个错误呈现的路径即可。

ErrorPage类中三个构造中其中一个也就是我们要使用的那个

(2)知识普及完了开始编写编写ErrorConfiguration配置类:

@Configuration
public class ErrorConfiguration {
    @Bean
    public EmbeddedServletContainerCustomizer containerCustomizer() {
        return new EmbeddedServletContainerCustomizer(){
            @Override
            public void customize(ConfigurableEmbeddedServletContainer container) {
                container.addErrorPages(new ErrorPage(HttpStatus.BAD_REQUEST, "/error/400.html"));
                container.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/error/404.html"));      
                container.addErrorPages(newErrorPage(HttpStatus.METHOD_NOT_ALLOWED,"/error/405.html"));
                container.addErrorPages(new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error/500.html"));  
            }
        };
    }

5.编写ErrorController前端控制器:

(1)脑补一下:
        Spring4.3中引进了@GetMapping@PostMapping@PutMapping@DeleteMapping@PatchMapping,来帮助简化常用的HTTP方法的映射,并更好地表达被注解方法的语义。
        @GetMapping是一个组合注解,是@RequestMapping(method = RequestMethod.GET)的缩写,该注解将http get请求映射到特定的处理方法上,其余的那几个大家举一反三也就明白了吧。

(2)编写代码:

@Controller
@RequestMapping(value = "error")
public class ErrorController {
/**
 * 配置400错误转发
 * @return
 */
@GetMapping(value = "400.html")
public String badequest() {
    return "error/400";
}
/**
 * 配置404错误转发
 * @return
 */
@GetMapping(value = "404.html")
public String notFound() {
    return "error/404";
}
/**
 * 配置405错误转发
 * @return
 */
@GetMapping(value = "405.html")
public String merthodNotAllowed() {
    return "error/405";
}
/**
 * 配置500错误转发
 * @return
 */
@GetMapping(value = "500.html")
public String serverError() {
    return "error/500";
 }
}

6.访问测试:

总结

        这两种方式我这里都进行了配置,我想证明一下两种方式如果同时存将会使用哪种方式呢,通过实践证明,当静态资源配置和动态配置同时存在时动态资源配置生效。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,128评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,316评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,737评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,283评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,384评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,458评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,467评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,251评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,688评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,980评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,155评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,818评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,492评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,142评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,382评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,020评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,044评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,644评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,796评论 6 342
  • 什么是Spring Spring是一个开源的Java EE开发框架。Spring框架的核心功能可以应用在任何Jav...
    jemmm阅读 16,449评论 1 133
  • 文章作者:Tyan博客:noahsnail.com 3.4 Dependencies A typical ente...
    SnailTyan阅读 4,147评论 2 7
  • 记忆中小时候的夏天并不像现在一样,动辄“高温预警”“防汛预警”“干旱预警”,小时候的夏天是最快乐的。 那时我们家还...
    哈哈哈哈哈喽啊阅读 188评论 2 0