Spring Boot教程(10) – 错误处理

如果你使用Spring Initializr新建一个web项目,运行并访问他的话,因为没有写控制器,你会得到一个错误页面,告诉你请求路径没找到(404错误):

页面标题为“Whitelabel Error Page”,直译为“白标错误页”,啥是白标,知乎上我搜到了这个答案:

White Label 意思是你开发了一个产品,而这个产品可以根据其他不同公司的品牌形象(品牌logo,品牌颜色,图片等等)包装成该公司自身的产品。

Gary Ma

我觉着吧,“白标错误页”的意思就是这个错误页面是个样板,你可以根据自己的需求自定义错误页面样式。

错误页面,可以是静态HTML文件,也可以用模板引擎生成。

Spring Boot的静态内容,可以放在类路径下的static或者public或者resources或者 META-INF/resources目录下。我通常选择static目录,这时候错误页面需要放在static/error目录下,文件后缀为html,文件名为它所代表的HTTP状态码,比如处理404错误的文件路径为static/error/404.html。如果你想让错误页面接受更多的状态码,可以写成4xx.html或者5xx.html

如果你使用模板引擎生成错误页面,文件需要放在类路径下templates/error目录,文件后缀根据不同的模板引擎而定,文件名依然是HTTP状态码。

如果你对以上两种自定义错误页面的方式不太满意,你可以自己实现一个ErrorViewResolver类型的Bean,这个Bean用来处理如何将HTTP状态码和视图对应:

Spring Boot的错误处理机制不仅仅可以展示网页,也可以返回JSON。你尝试在命令行输入命令curl localhost:8080可以得到类似下图的错误信息。

同样的错误,在浏览器和在终端(或者其他非浏览器方式)的输出是不一样的。但是他们所包含的信息是一样的。这些信息是由ErrorAttributes对象提供的,ErrorAttributes会根据网络请求的信息,生成一个Map<String, Object>对象,上图的JSON就是根据它生成的,“白标错误页”也是根据它生成的。你要是想自定义Map里的东西,那就自己实现ErrorAttributes,作为Bean放到容器里。它的默认实现是DefaultErrorAttributes,你可以参考参考。

自定义ErrorAttributes

还没完,咱们继续深入。

如果你的控制器方法在处理请求的时候异常了,那么框架会将你的请求转发(forward,不是redirect)到/error路径。有个控制器是专门处理/error路径请求的,叫做BasicErrorController,本文到从开头到现在提到的所有东西的逻辑都在它的代码里,建议你读一读。这个/error路径其实也是可以改的,修改server.error.path属性就行。错误处理机制其实是由一个自动配置类ErrorMvcAutoConfiguration触发生效的,BasicErrorControllerDefaultErrorAttributes都是在这个配置类里创建的,在这里,你还能找到“白标错误页”的生成代码。

如果Spring Boot默认的错误处理机制(即BasicErrorController)还不够你用的,那就只能自己写个控制器了。自己写控制器,你返回给客户端什么东西都中。注意你的控制器还得实现ErrorController接口,这样才能把BasicErrorController给替换掉,如下图。

上面的代码复用了server.error.path属性。你通过handleError方法就可以定制响应请求了,不管是返回页面还是JSON还是其他的,都可以搞。

到这里还不能满足你对错误处理的需要?

上面说的都是Spring Boot的错误处理机制,其实Spring MVC还自带了一些。在控制器里,可以添加一个方法并加上@ExceptionHandler注解,这样不管控制器的哪个请求处理方法出现了异常,都会到这个方法里处理。

图中的参数类型是Exception,可以从它那里获取异常信息。不过它范围有点大,你可以在注解里加个参数,让errorHandler方法接受的异常更具体一点。

你还可以写多个错误处理方法,每个处理不同类型或者场景下的异常。错误处理方法的参数除了上面提到的Exception,还有很多可以用,比如HttpMethodWebRequestModel等等,具体列表可以查看官方文档。错误处理方法的返回值跟请求处理方法(handler methods)的返回值也都差不多,比如ModelAndView、模板文件名字、ResponseEntity<>等等。

@ExceptionHandler结合@ControllerAdvice注解可以处理所有控制器的异常。不过我们先到这里,稍后的文章再谈他。

关于 “Spring Boot教程(10) – 错误处理” 的 2 个意见

发表评论

电子邮件地址不会被公开。