SpringBoot——定制错误页面及原理

优质博文：IT-BLOG-CN

一、SpringBoot 默认的错误处理机制

【1】浏览器返回的默认错误页面如下：

☞ 浏览器发送请求的请求头信息如下： text/html会在后面的源码分析中说到。

【2】如果是其他客户端，默认则响应错误的 JSON字符串，如下所示：

☞ 其他客户端发送请求的请求头信息如下： */* 源码中解释。

二、原理分析

参照ErrorMvcAutoConfiguration类： 错误处理的自动配置类，以下4项为此类的重要信息。

【1】ErrorMvcAutoConfiguration.ErrorPageCustomizer： 当系统出现 4xx或者 5xx之类的错误时，ErrorPageCustomizer就会生效（定制错误的响应规则），根据如下源码可知，将会来到/error请求。

@Bean
public ErrorMvcAutoConfiguration.ErrorPageCustomizer errorPageCustomizer() {return new ErrorMvcAutoConfiguration.ErrorPageCustomizer(this.serverProperties);
}//进入ErrorPageCustomizer方法，发现registerErrorPages方法：注册一个错误也
private static class ErrorPageCustomizer implements ErrorPageRegistrar, Ordered {private final ServerProperties properties;protected ErrorPageCustomizer(ServerProperties properties) {this.properties = properties;}public void registerErrorPages(ErrorPageRegistry errorPageRegistry) {ErrorPage errorPage = new ErrorPage(this.properties.getServletPrefix() + this.properties.getError().getPath());errorPageRegistry.addErrorPages(new ErrorPage[]{errorPage});}
}//进入this.properties.getError().getPath()方法，获取如下信息，得到/error请求。
@Value("${error.path:/error}")
private String path = "/error";//系统出现错误以后来到error请求进行处理；（web.xml注册的错误页面规则）

【2】BasicErrorController 处理 /error错误请求： 注意：text/html和*/*就是在此处生效。

@Bean
@ConditionalOnMissingBean(value = {ErrorController.class},search = SearchStrategy.CURRENT
)
public BasicErrorController basicErrorController(ErrorAttributes errorAttributes) {return new BasicErrorController(errorAttributes, this.serverProperties.getError(), this.errorViewResolvers);
}//进入BasicErrorController对象，获取如下信息
@Controller
@RequestMapping({"${server.error.path:${error.path:/error}}"})
public class BasicErrorController extends AbstractErrorController {private final ErrorProperties errorProperties;public BasicErrorController(ErrorAttributes errorAttributes, ErrorProperties errorProperties) {this(errorAttributes, errorProperties, Collections.emptyList());}@RequestMapping(produces = {"text/html"}//产生html类型的数据；浏览器发送的请求来到这个方法处理)public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {HttpStatus status = this.getStatus(request);Map<String, Object> model = Collections.unmodifiableMap(this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.TEXT_HTML)));response.setStatus(status.value());//去哪个页面作为错误页面；包含页面地址和页面内容ModelAndView modelAndView = this.resolveErrorView(request, response, status, model);return modelAndView != null?modelAndView:new ModelAndView("error", model);}@RequestMapping@ResponseBody//产生json数据，其他客户端来到这个方法处理；public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {Map<String, Object> body = this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.ALL));HttpStatus status = this.getStatus(request);return new ResponseEntity(body, status);}
}

☞ 如上代码中提到的错误页面解析代码，进入此方法： this.resolveErrorView(request, response, status, model);

protected ModelAndView resolveErrorView(HttpServletRequest request, HttpServletResponse response, HttpStatus status, Map<String, Object> model) {Iterator var5 = this.errorViewResolvers.iterator();ModelAndView modelAndView;do {//从所有的ErrorViewResolver得到ModelAndViewif(!var5.hasNext()) {return null;}ErrorViewResolver resolver = (ErrorViewResolver)var5.next();modelAndView = resolver.resolveErrorView(request, status, model);} while(modelAndView == null);return modelAndView;
}

【3】最终的响应页面是由DefaultErrorViewResolver解析得到的： 最重要的信息是，SpringBoot默认模板引擎的/error目录下获取 ‘status’.xml 错误页面，也可以通过4xx.xml来统配 404.xml和 400.xml等等，但是优先获取精准的页面。如果模板引擎中不存在，则会从静态页面中获取错误页面。否则返回系统默认错误页面。

 @Bean@ConditionalOnBean({DispatcherServlet.class})@ConditionalOnMissingBeanpublic DefaultErrorViewResolver conventionErrorViewResolver() {return new DefaultErrorViewResolver(this.applicationContext, this.resourceProperties);}//进入DefaultErrorViewResolver类中
public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) {ModelAndView modelAndView = this.resolve(String.valueOf(status), model);if(modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {//调用时viewname = status ***重要modelAndView = this.resolve((String)SERIES_VIEWS.get(status.series()), model);}return modelAndView;
}private ModelAndView resolve(String viewName, Map<String, Object> model) {//默认SpringBoot可以去找到一个页面？ error/404String errorViewName = "error/" + viewName;//模板引擎可以解析这个页面地址就用模板引擎解析TemplateAvailabilityProvider provider = this.templateAvailabilityProviders.getProvider(errorViewName, this.applicationContext);//模板引擎可用的情况下返回到errorViewName指定的视图地址,//当模板引擎不可用，就在静态资源文件夹下找errorViewName对应的页面 error/404.htmlreturn provider != null?new ModelAndView(errorViewName, model):this.resolveResource(errorViewName, model);
}

【4】DefaultErrorAttributes： 在页面添加错误信息，供我们使用。

@Bean
@ConditionalOnMissingBean(value = {ErrorAttributes.class},search = SearchStrategy.CURRENT
)
public DefaultErrorAttributes errorAttributes() {return new DefaultErrorAttributes();
}//进入DefaultErrorAttributes类中，发现此方法给视图中添加了status状态等信息，供我们使用。
public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {Map<String, Object> errorAttributes = new LinkedHashMap();errorAttributes.put("timestamp", new Date());this.addStatus(errorAttributes, requestAttributes);this.addErrorDetails(errorAttributes, requestAttributes, includeStackTrace);this.addPath(errorAttributes, requestAttributes);return errorAttributes;
}

三、定制错误 JSON数据

【1】自定义异常处理类，返回定制的 JSON数据。通过上述的分析，我们得知：
 ①、可以完全编写一个ErrorController的实现类，或者继承AbstractErrorController的子类，放入容器中。
 ②、也可以自定义异常处理类，返回 JSON数据。
 ③、页面上的数据或 JSON返回的数据都是可以通过errorAttributes.getErrorAttributes得到的。我们可以自定义属于自己的ErrorAttributes。

//首先我们可以通过自定义异常处理，来确定返回的数据，但这个不够灵活，我们可以与③结合使用
/*** @RequestMapping启动应用后，被 @ExceptionHandler、@InitBinder、@ModelAttribute 注解的方法，都会作用在 被 @RequestMapping* 注解的方法上。*/
@ControllerAdvice
public class MyExceptionHandler {@ResponseBody@ExceptionHandler(UserNotExistException.class)public Map<String,Object> handlerException(Exception e, HttpServletRequest request){Map<String,Object> map = new HashMap<String,Object>();request.setAttribute("javax.servlet.error.status_code","500");map.put("code","user.notexist");map.put("message",e.getMessage());return map;}
}//③自定义ErrorAttributes,一定要加入容器
@Component
public class MyErrorAttributes extends DefaultErrorAttributes{@Overridepublic Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {//获取默认的配置，在此基础上添加自己的需求Map<String, Object> map = super.getErrorAttributes(requestAttributes, includeStackTrace);//自定义自己需要的属性map.put("company","yintong");//获取我们在异常处理类中添加的信息，/*注意：当我们需要结合使用的时候异常处理必须return "forward:/error";将请求转发出去，不能直接返回map对象，同时要去掉@responseBody注解，否则ErrorAttributes不生效*/map.put("ext",requestAttributes.getAttribute("ext",requestAttributes.SCOPE_REQUEST));return map;}
}

【2】效果展示：

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/168605.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

git提交报错error: failed to push some refs to ‘git url‘

git提交报错error: failed to push some refs to ‘git url‘

1.产生错误原因 想把本地仓库提交到远程仓库&#xff0c;报错信息如下 git提交报错信息 error: src refspec master does not match any error: failed to push some refs to git url 错误原因&#xff1a; 我们在创建仓库的时候&#xff0c;都会勾选“使用Reamdme文件初始化…
阅读更多...
Android相机性能提高50%

Android相机性能提高50%

文章目录 应用举例&#xff08;可以不看这一part&#xff0c;直接跳过看具体怎么做&#xff09;&#xff1a;Snapchat 通过 Camera2 Extensions API 将新相机功能的集成速度提高了 50%**Camera2 扩展 API 可以访问高级功能更多设备上的更多机会 正文&#xff1a;开始使用扩展架…
阅读更多...
hdlbits系列verilog解答（Exams/m2014 q4h）-44

hdlbits系列verilog解答（Exams/m2014 q4h）-44

文章目录 一、问题描述二、verilog源码三、仿真结果 一、问题描述 实现以下电路&#xff1a; 二、verilog源码 module top_module (input in,output out);assign out in;endmodule三、仿真结果 转载请注明出处&#xff01;
阅读更多...
达不到的视野

达不到的视野

生而有涯&#xff0c;而知无涯。短短几十年&#xff0c;除去识文断字的积累和老眼昏聩的暮年&#xff0c;我们能拿来思考学习的攀登岁月&#xff0c;其实不多。 岁月又不饶人&#xff0c;一定年纪之后熬不了夜&#xff0c;喝不多酒&#xff0c;抽烟都咳嗽&#xff0c;咖啡又怕…
阅读更多...
Vatee万腾科技新高峰：Vatee前瞻性创新的数字化之力

Vatee万腾科技新高峰：Vatee前瞻性创新的数字化之力

Vatee万腾科技&#xff0c;一家以前瞻性创新为核心驱动力的数字化引领者&#xff0c;正迈向新的高峰。其在科技领域的卓越表现不仅体现在技术实力上&#xff0c;更展现在对未来的深刻洞察和独到思考上。 在Vatee的科技舞台上&#xff0c;前瞻性创新如一道独特的光芒&#xff0c…
阅读更多...
【Linux】yum -- 软件包管理器

【Linux】yum -- 软件包管理器

目录 一、Linux中是如何安装软件的 1.1 安装的方法 1.2 安装的本质(基本理解) 二、软件包 2.1 软件包的概念 2.2 为什么要有软件包 三、yum--软件包管理器 3.1 yum的概念 3.2 yum的使用 3.2.1 搜索一个软件 3.2.2 安装一个软件 3.2.3 卸载一个软件 3.3 yum源更新 …
阅读更多...
PYTHON从文本中查找并同时删除相邻二行的特定文字

PYTHON从文本中查找并同时删除相邻二行的特定文字

PYTHON从文本中查找并同时删除相邻二行的特定文字 例如同时删除上下行文字&#xff1a; python Copy code def remove__code(input_file, output_file):with open(input_file, r, encodingutf-8) as file:lines file.readlines()with open(output_file, w, encodingutf-8) as…
阅读更多...
Node.js入门指南（三）

Node.js入门指南（三）

目录 Node.js 模块化 介绍 模块暴露数据 导入模块 导入模块的基本流程 CommonJS 规范 包管理工具 介绍 npm cnpm yarn nvm的使用 我们上一篇文章介绍了Node.js中的http模块&#xff0c;这篇文章主要介绍Node.js的模块化&#xff0c;包管理工具以及nvm的使用。 Node…
阅读更多...
108. 将有序数组转换为二叉搜索树 --力扣 --JAVA

108. 将有序数组转换为二叉搜索树 --力扣 --JAVA

题目 给你一个整数数组 nums &#xff0c;其中元素已经按 升序 排列&#xff0c;请你将其转换为一棵 高度平衡 二叉搜索树。 高度平衡 二叉树是一棵满足「每个节点的左右两个子树的高度差的绝对值不超过 1 」的二叉树。 解题思路 可以采用二分法&#xff0c;每次选数组中间值为…
阅读更多...
Joint Cross-Modal and Unimodal Features for RGB-D Salient Object Detection

Joint Cross-Modal and Unimodal Features for RGB-D Salient Object Detection

提出的模型 the outputs H i m _i^m im​ from the unimodal RGB or depth branch in MFFM FFM means ‘Feature Fusion Module’ 作者未提供代码
阅读更多...
优秀软件设计特征与原则

优秀软件设计特征与原则

1.摘要 一款软件产品好不好用, 除了拥有丰富的功能和人性化的界面设计之外, 还有其深厚的底层基础, 而设计模式和算法是构建这个底层基础的基石。好的设计模式能够让产品开发快速迭代且稳定可靠, 迅速抢占市场先机&#xff1b;而好的算法能够让产品具有核心价值, 例如字节跳动…
阅读更多...
开源WIFI继电器之功能介绍

开源WIFI继电器之功能介绍

一、指示灯 有三颗led指示灯&#xff0c;红、绿、蓝。指示灯的状态对应的设备状态如下&#xff1a; 红灯常亮&#xff1a;设备已连接到MQTT服务器&#xff1b; 红灯慢闪&#xff1a; 二、连接wifi路由器 长按按键(GPIO0)超过5s后松开&#xff0c;按足时间会有蓝灯闪烁一下…
阅读更多...
ESP32网络开发实例-Web服务器3D动画方式显示MPU6050传感器数据

ESP32网络开发实例-Web服务器3D动画方式显示MPU6050传感器数据

Web服务器3D动画方式显示MPU6050传感器数据 文章目录 Web服务器3D动画方式显示MPU6050传感器数据1、应用介绍2、MPU6050介绍2、软件准备3、硬件准备4、代码实现4.1 Web页面创建4.2 Web服务器实现在本文中，我们将创建一个 ESP32 MPU6050 传感器读数仪表板。 读数将包括当前摄氏…
阅读更多...
GPS 定位信息获取（北斗星通 GPS）

GPS 定位信息获取（北斗星通 GPS）

GPS 定位信息获取&#xff08;1&#xff09; 首先回顾北斗星通 GPS 数据获取&#xff08;1&#xff09;~&#xff08;5&#xff09; gps_pub.cpp 将接收到的串口数据转化为GPS的经纬度信息gps_path.cpp 将经纬度信息转化为全局坐标系下的XY值&#xff0c;以第一个GPS经纬度为…
阅读更多...
【海德教育】二级建造师的主要报考条件：

【海德教育】二级建造师的主要报考条件：

工程类或工程经济类中专及以上毕业&#xff0c;从事建设工程施工管理工作满2年即可报考。1&#xff0c;报考主要审核材料&#xff1a;报名表&#xff0c;个人身份证、毕业证原件及复印件&#xff0c;加盖公章的单位资质或营业执照复印件一份&#xff0c;个人相片等。并不需要社…
阅读更多...
第三方应用调用前摄失败，导致原生相机的后摄挂掉

第三方应用调用前摄失败，导致原生相机的后摄挂掉

第一次分析出现问题&#xff1a;以为是调用前摄&#xff0c;检测不到后摄所致&#xff0c;导致误导了许久 仔细查找才发现&#xff1a;相机前摄的参数错误&#xff0c;当前app获取不到这么大的参数 Camera2-Parameters: set: Requested preview size 1080 x 1440 is not suppor…
阅读更多...
Android 13.0 app进程保活白名单功能实现

Android 13.0 app进程保活白名单功能实现

1.前言 在13.0的系统rom产品开发中，在某些重要的app即使进入后台，产品需求要求也不想被系统杀掉进程，需要app长时间保活，就是app进程保活白名单功能的实现， 所以需要在系统杀进程的时候不杀掉白名单的进程，接下来就看怎么样来实现这些功能 2.app进程保活白名单功能实…
阅读更多...
2023亚太杯B题玻璃温室的微气候调控完整论文分享

2023亚太杯B题玻璃温室的微气候调控完整论文分享

大家好&#xff0c;终于完成了2023亚太杯数学建模竞赛B题Microclimate Regulation in Glass Greenhouses&#xff08;玻璃温室的微气候调控&#xff09;的完整论文啦。 实在精力有限&#xff0c;具体的讲解以及完整成品的查看大家可以移步&#xff1a; 【亚太杯完整论文】2023…
阅读更多...
【初始前后端交互+原生Ajax+Fetch+axios+同源策略+解决跨域】

【初始前后端交互+原生Ajax+Fetch+axios+同源策略+解决跨域】

初始前后端交互原生AjaxFetchaxios同源策略解决跨域 1 初识前后端交互2 原生Ajax2.1 Ajax基础2.2 Ajax案例2.3 ajax请求方式 3 Fetch3.1 fetch基础3.2 fetch案例 4 axios4.1 axios基础4.2 axios使用4.2.1 axios拦截器4.2.2 axios中断器 5 同源策略6 解决跨域6.1 jsonp6.2 其他技…
阅读更多...
搭配：基于OpenCV的边缘检测实战

搭配：基于OpenCV的边缘检测实战

引言 计算机中的目标检测与人类识别物体的方式相似。作为人类&#xff0c;我们可以分辨出狗的形象&#xff0c;因为狗的特征是独特的。尾巴、形状、鼻子、舌头等特征综合在一起&#xff0c;帮助我们把狗和牛区分开来。 同样&#xff0c;计算机能够通过检测与估计物体的结构和性…
阅读更多...
最新文章

Copyright @ 2022~2023