springboot转发http请求_网易后端实习生分享:Springboot异常和错误处理规范

由于错误在所难免,异常处理已经成为开发工作中不可或缺的部分。

在web开发中,我们通常不希望用户看到一个写满StackTrace的错误页面;同时,我们希望出现错误或发生异常时,开发运维人员可以看到详细的错误信息,以便进行查错和DEBUG。

所以,在开发过程中,应重视异常处理。在进行业务逻辑开发之前,就应该定义好自己的异常处理流程。

1. 异常处理流程概述

b2bb6712a641a793a86237f881785749.png

异常处理的对象分为两类:

  1. 错误的请求:程序处理前就已经发生,如RequestMapping中不存在该请求的URL以及其他的一些HTTP错误。
  2. 程序中的错误:各种异常,包括Runtime异常。

Springboot会统一处理第1种错误,由ErrorController捕获并进行处理,根据请求的Accpet字段返回错误页面或json数据。这里贴出Springboot自己的BasicErrorController实现:

@Controllerpublic class BasicErrorController implements ErrorController {    @Value("${error.path:/error}")    private String errorPath;    private final ErrorAttributes errorAttributes;    public BasicErrorController(ErrorAttributes errorAttributes) {        Assert.notNull(errorAttributes, "ErrorAttributes must not be null");        this.errorAttributes = errorAttributes;    }    public String getErrorPath() {        return this.errorPath;    }    @RequestMapping(        value = {"${error.path:/error}"},        produces = {"text/html"}    )    public ModelAndView errorHtml(HttpServletRequest request) {        return new ModelAndView("error", this.getErrorAttributes(request, false));    }    @RequestMapping({"${error.path:/error}"})    @ResponseBody    public ResponseEntity> error(HttpServletRequest request) {        Map body = this.getErrorAttributes(request, this.getTraceParameter(request));        HttpStatus status = this.getStatus(request);        return new ResponseEntity(body, status);    }    //……}

也可以自己写一个ErrorController返回自定义页面。

对于程序中发送的异常,可以手动进行捕获。如果没有手动捕获或有所遗漏,Springboot提供了@ExceptionHandler(value={})对某种类型的异常统一进行处理。通常,可以通过转发(forward)或重定向(redirect)方式将该异常转给自己定制的ExceptionController进行处理。ExceptionController可以根据请求类型返回错误页面或json数据。

2. 自定义RuntimeException

可以定制自己的Exception进行异常信息记录:

public abstract class BaseRuntimeException extends RuntimeException {    private static final long serialVersionUID = -1842796916322056555L;    public BaseRuntimeException() {        super();    }    public BaseRuntimeException(String message) {        super(message);    }    public BaseRuntimeException(String message, Throwable cause) {        super(message, cause);    }    /**     * 返回异常的错误码     */    public abstract Integer getErrorCode();    /**     * 返回异常的描述(不带应用前缀)     */    public abstract String getErrorMessage();    /**     * 返回异常的日志(带应用前缀)     */    public abstract String getErrorLog();}

然后再Service层定义该服务模块异常信息。

public class MiscServiceException extends BaseRuntimeException implements IReThrowException {    private static final long serialVersionUID = -1844670008823631700L;    private MiscErrorCode miscErrorCode = MiscErrorCode.SUCCESS;    private String errorLog = MiscErrorCode.SUCCESS.getDesc();    public MiscServiceException() {        super();    }    public MiscServiceException(String message, Throwable cause) {        super(message, cause);        this.errorLog = message;    }    public MiscServiceException(String message) {        super(message);        this.errorLog = message;    }    public MiscServiceException(String message, MiscErrorCode miscErrorCode) {        super(message);        this.miscErrorCode = miscErrorCode;        this.errorLog = message;    }    /**     * 返回异常的错误码.
* 方便日志查看追踪. * * @see BaseRuntimeException#getErrorCode() */ @Override public Integer getErrorCode() { return miscErrorCode.getValue(); } /** * 返回异常的描述.
* 可直接用于前端错误提示. * * @see BaseRuntimeException#getErrorMessage() */ @Override public String getErrorMessage() { return miscErrorCode.getDesc(); } /** * 返回异常的日志.
* 用于服务器日志打印. * * @see BaseRuntimeException#getErrorLog() */ @Override public String getErrorLog() { return errorLog; }}

在Service层生成异常对象并抛出。

if (…)    throw new MiscServiceException(“log message…”, MiscErrorCode.XXXERRIR);

在Manager层继续向上抛出。

public interface SomeService {    DTO someFunc() throws MiscServiceException {    //…}

在Controller层捕获异常,进行处理——返回相关页面。

try {//…} catch (MiscServiceException e) {log.error(e.getErrorLog());return ResponseView.fail(e.getErrorCode(), e.getErrorMessage());}

如此以来,代码中定义的异常和错误均可以捕捉。

由于BaseRuntimeException是一种RuntimeException,Mananger层声明方法是不加throws Exception也可以通过编译。小猿建议每一个Manager的方法都加上throws Exception声明。另外,BaseRuntimeException实际上也可以直接继承Exception,这样编译器会强制要求对其进行异常进行处理。

3. @ExceptionHandler

上述方案解决了一部分自定义异常。对于其他的自己未定义的Runtime Exception,例如Null Pointer Exception,Springboot提供了ExceptionHandler,用于捕获所有代码中没有主动catch的异常。通常,我们该异常转发(forward)或重定向(redirect)至某个自定义的Controller进行处理。

转发和重定向的效果不同:在浏览器端,转发的请求,页面不会跳转,URL不会改变;重定向的请求,URL会改变。重定向实际上是浏览器进行了两次请求。对于参数传递,两种方式采取的方法也不同。重定向方式可以使用RedirectAttributes传递参数,转发方式则将参数放置在Request的Attributes中。

转发:

@ControllerAdvicepublic class CustomExceptionHandler {    /**     * 将异常页转发到错误页     */    @ExceptionHandler(Exception.class)    public ModelAndView handleError(HttpServletRequest req, Exception ex) {        log.info("Exception e : " + ex, ex);        if (BaseRuntimeException.class.isAssignableFrom(ex.getClass())) {            BaseRuntimeException e = (BaseRuntimeException) ex;            req.setAttribute("code", e.getErrorCode());            req.setAttribute("message", e.getErrorMessage());        } else {            req.setAttribute("code", FrontCode.OTHER_ERROR.getCode());            req.setAttribute("message", FrontCode.OTHER_ERROR.getDesc());        }        return new ModelAndView("forward:/exception");    }}

重定向:

/** * 将异常页使用重定向方式到错误页 * * @param req * @param ex * @param mode * @return */@ExceptionHandler(Exception.class) public ModelAndView handleError(HttpServletRequest req, Exception ex ,RedirectAttributes mode) {     log.info("Exception e : " + ex,ex);     ModelAndView mav = new ModelAndView();     if (BaseRuntimeException.class.isAssignableFrom(ex.getClass())) {     BaseRuntimeException e = (BaseRuntimeException) ex;     mode.addAttribute("code",e.getErrorCode());     mode.addAttribute("message",e.getErrorMessage());     }     else {     mode.addAttribute("code", FrontCode.OTHER_ERROR.getCode());     mode.addAttribute("message", FrontCode.OTHER_ERROR.getDesc());     }     return new ModelAndView("redirect:/exception");}

4. ErrorController

在下文贴出的示例中,我们将异常处理的Controller也放在ErrorController中。其中,errorHtml方法同于对没有经过Controller层的错误进行处理,返回自定义错误页;exception和exceptionHtml方法负责接收ExceptionHandler转发或重定向的异常处理流,根据produces的类型是”json/application”还是“text/html”,分别返回json和错误页面。

@Controllerpublic class CommonErrorController implements ErrorController {    @Autowired    private UserSecurityHelper userSecurityHelper;    private static final String ERROR_PATH = "error";    private static final String EXCEPTION_PATH = "exception";    @RequestMapping(value = ERROR_PATH)    public ModelAndView errorHtml(HttpServletRequest request) {        ModelAndView modelAndView = new ModelAndView("/error/error");        Object statusCode = request.getAttribute("javax.servlet.error.status_code");        //当请求的错误类型非404、403、402、401时,返回500的错误页面        if (statusCode == null                || (!statusCode.equals(HttpStatus.NOT_FOUND.value())                && !statusCode.equals(HttpStatus.UNAUTHORIZED.value())                && !statusCode.equals(HttpStatus.PAYMENT_REQUIRED.value()) && !statusCode                .equals(HttpStatus.FORBIDDEN.value()))) {            statusCode = HttpStatus.INTERNAL_SERVER_ERROR.value();        }        modelAndView.addObject("code", statusCode);        modelAndView.addObject("message", "你很神,找到了不存在的页面。");        return modelAndView;    }    /*    * 使用forward转发.    */    @RequestMapping(value = EXCEPTION_PATH, produces = "application/json")    @ResponseBody    public ResponseEntity exception(HttpServletRequest request) {        Integer code = (Integer) request.getAttribute("code");        String message = (String) request.getAttribute("message");        return ResponseView.fail(code, message);    }    @RequestMapping(value = EXCEPTION_PATH, produces = {"text/html"})    public ModelAndView exceptionHtml(HttpServletRequest request) {        EduWebUser eduWebUser = userSecurityHelper.getEduWebUser();        ModelAndView mav = new ModelAndView("/error/error");        mav.addObject("code", (Integer) request.getAttribute("code"));        mav.addObject("message", (String) request.getAttribute("message"));        mav.addObject("webUser", eduWebUser);        return mav;    }    @Override    public String getErrorPath() {        return ERROR_PATH;    }}

如果使用Redirect跳转,ErrorController中接收参数的相应代码要随之改变。

/*使用Redirect跳转*/@RequestMapping(value = EXCEPTION_PATH, produces = "application/json")@ResponseBodypublic ResponseEntity exception(HttpServletRequest request , @RequestParam(required = false) String message,                                @RequestParam(required = false) Integer code) {    Map body = new HashMap<>(4);    body.put("code", code);    body.put("message", message);    return new ResponseEntity(body, HttpStatus.OK);}@RequestMapping(value = EXCEPTION_PATH, produces = { "text/html"})public ModelAndView exceptionHtml(HttpServletRequest request , @RequestParam(required = false) String message,                                  @RequestParam(required = false) Integer code) {    ModelAndView mav = new ModelAndView("/error/error");    EduWebUser eduWebUser = userSecurityHelper.getEduWebUser();    mav.addObject("code", code);    mav.addObject("message", message);    mav.addObject("webUser", eduWebUser);    return mav;}

5. 测试

我们定义了专门用于测试的Service和Controller。其中,throw测试程序中代码捕获异常,silent测试由ExceptionHandler捕获的异常。

public interface ExceptionService {    public void testThrowException() throws MiscServiceException;    public void testSilentException();}@Service("exceptionService")public class ExceptionServiceImpl implements ExceptionService {    @Override    public void testThrowException() throws MiscServiceException {        throw new ForumException("Log Message");    }    @Override    public void testSilentException() {        throw new ForumException("Log Message");    }}@RestController@RequestMapping("/exception")public class ExceptionController {    @Resource    private ExceptionService exceptionService;    @RequestMapping("/throw")    public ResponseEntity testThrow() {        try {            exceptionService.testThrowException();            return ResponseView.success(null);        } catch (MiscServiceException e) {            e.printStackTrace();            return ResponseView.fail(e.getErrorCode(), e.getErrorMessage());        }    }    @RequestMapping("/silent")    public ResponseEntity testSilent() {        exceptionService.testSilentException();        return ResponseView.success(null);    }}

测试记录如下。

代码主动捕获异常:

9e84a425523ad0c229062d0f1293ac4a.png

Springboot通过forward方式统一捕获异常:

c5f27558632c68b0197ff38fda2edebe.png

Springboot通过redirect方式统一捕获异常:

eca52291060afb5fa27055c8061aaeb7.png

Springboot统一捕获异常,返回json:

38001ac989c8d506d843db846a9f025a.png

对于Controller之前发生的错误和异常,返回自定义页面:

b0cce0bcf4ccff08fd35f50bd680e9fe.png

如果对我的更新内容很感兴趣,希望可以得到您的一个点赞和关注,这将是对我最大的鼓励和支持,感谢~不论多与少,我都会坚持更新。另外,私聊我【Java学习资料】可以收获互联网大厂Java面经和Java最新最全资料~帮助你早日拿到互联网大厂的offer~

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

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

相关文章

java 偏向锁 怎么用_Java锁升级、偏向锁、轻量级锁

偏向锁当锁对象第一次被线程获取时&#xff0c;虚拟机会把对象头的锁状态标志设置为01(即偏向状态)&#xff0c;同时&#xff0c;使用CAS操作把获取到这个锁的线程的ID记录在对象头的mark word中。如果这个CAS操作成功&#xff0c;那么&#xff0c;以后持有这个偏向锁的线程在进…

springmvc 拦截器_Spring MVC拦截器学习

1 介绍Spring Web MVC是基于Servlet API构建的原始Web框架。2 拦截器2.1 定义springmvc框架的一种拦截机制2.2 使用2.2.1 两步走实现HandlerInterceptor接口注册&#xff08;xml或者注解 &#xff09;2.2.2 HandlerInterceptor接口实现HandlerInterceptor接口import org.spring…

python如何生成列表和元组数据_Python数据类型(列表和元组)

1.3 List(列表)列表由一系列按特定顺序排列的元素组成。在Python中&#xff0c;用方括号[ ]来表示列表&#xff0c;并用逗号来分隔其中的元素。1.3.1 访问列表元素在Python中&#xff0c;第一个列表元素的索引为0&#xff0c;而不是1。>>> bicycles [trek, cannondal…

mysql socket 与IP区别_MySQL本地用IP登陆而非socket

##想当然的指定hostname和端口。。。。失败[rootmysql01 ~]# /opt/mysql/bin/mysql -uroot -h localhost -P 3307 -pEnter password:ERROR 2002 (HY000): Cant connect to local MySQL server through socket /tmp/mysql.sock (2)##正确方法&#xff0c;指定通信协议 --protoco…

python画矩形函数drawrectangle_Python3 tkinter基础 Canvas create_rectangle 画矩形

Python : 3.7.0OS : Ubuntu 18.04.1 LTSIDE : PyCharm 2018.2.4Conda : 4.5.11typesetting : Markdowncode"""Author : 行初心Date : 18-9-30Blog : www.cnblogs.com/xingchuxinGitee : gitee.com/zhichengjiu"""from tkinter import *def main(…

java文件读入原理_描述一下JVM加载class文件的原理机制

1、JVM 简介JVM 是我们Javaer 的最基本功底了&#xff0c;刚开始学Java 的时候&#xff0c;一般都是从“Hello World ”开始的&#xff0c;然后会写个复杂点class &#xff0c;然后再找一些开源框架&#xff0c;比如Spring &#xff0c;Hibernate 等等&#xff0c;再然后就开发…

python为什么closed_为什么Python无法解析此JSON数据? [关闭] - Why can't Python parse this JSON data? [closed]...

问题&#xff1a;I have this JSON in a file: 我在文件中有此JSON&#xff1a;{"maps": [{"id": "blabla","iscategorical": "0"},{"id": "blabla","iscategorical": "0"}],"…

mysql 缓解竞争热点_MySQL优化之缓存优化

高兴的是有博友mark了我的文章。我知道mark之后&#xff0c;很少会再来继续关注的。但是从侧面说明了在博友点开博客的同时&#xff0c;他感觉这篇博客是有价值的&#xff0c;是能够弥补他的知识欠缺。一篇博客最重要的是对自己有用&#xff0c;如果再对别人有用&#xff0c;那…

python for循环1 到10_python for循环(1)

对于一个初学者来说for循环可能会击溃很多人&#xff0c;因为网上找的python的for循环没有详细的介绍for循环的条件以及for循环后面定义的东西是什么意思。首先我先举一个常用的例子。for i in range(1,10) :print i上面这两条代码是用来在屏幕上打印1到9的。这里就不对range这…

java maven junit_【JUnit】JUnit 与 maven 集成

环境JDK 11JUnit 4.13Spring Tool Suite 4.6.2Maven 3.6.3与 maven 集成因为已经是 maven 项目了&#xff0c;所以不再需要任何东西&#xff0c;默认就与 maven 集成了。不过由于 maven-surefire-plugin 自身的缺陷&#xff0c;导致测试时&#xff0c;如果有中文&#xff0c;则…

最长不重复子串python_python经典算法题:无重复字符的最长子串

题目&#xff1a;无重复字符的最长子串。给定一个字符串&#xff0c;请你找出其中不含有重复字符的 最长子串 的长度。示例 1:输入: “abcabcbb”输出: 3解释: 因为无重复字符的最长子串是 “abc”&#xff0c;所以其长度为 3。示例 2:输入: “bbbbb”输出: 1解释: 因为无重复字…

python构造referer_Python爬虫小偏方:修改referer绕开登录和访问频率限制

看官们在写爬虫程序时应该都会遇到如下问题&#xff1a;你的爬虫程序开发时能正常抓取网页&#xff0c;但是正式大量抓取时&#xff0c;抓取的网站总是返回403或者500等&#xff1b;你抓取的网站需要登录&#xff0c;要花大量时间去研究网站登录流程。遇到问题1&#xff0c;我们…

微信流媒体直播java_微信小程序直播带货教程

微信小程序直播带货教程微信小程序正式推出直播带货组件&#xff0c;很多正在使用 “api工厂” 的用户&#xff0c;这几天一直在问&#xff0c;现有小程序如何使用直播带货的功能&#xff0c;需要不需要做很复杂的改动&#xff1f;是否需要重新开发小程序&#xff1f;使用门槛高…

铺砖问题JAVA_java彩色瓷砖编程题分析

牛牛喜欢彩色的东西,尤其是彩色的瓷砖。牛牛的房间内铺有L块正方形瓷砖。每块砖的颜色有四种可能:红、绿、蓝、黄。给定一个字符串S, 如果S的第i个字符是R, ‘G, ‘B或Y,那么第i块瓷砖的颜色就分别是红、绿、蓝或者黄。牛牛决定换掉一些瓷砖的颜色,使得相邻两块瓷砖的颜色均不相…

python灰度图像为什么显示成彩色的_python opencv image 怎么变成伪彩色

匿名用户1级2017-05-16 回答OpenCV 生成 伪彩色图像opencv中没有易用的伪彩色图像生成函数&#xff0c;这里提供一个改造过的函数&#xff0c;利用自定义colorbar 将灰度图像转换成为伪彩色图像&#xff0c;优点在于提供了对于颜色的直观可操控性&#xff0c;转换方便。函数代码…

vue和java实现页面增删改_SpringBoot-Vue实现增删改查及分页小DEMO

前言主要通过后端 Spring Boot 技术和前端 Vue 技术来简单开发一个demo&#xff0c;实现增删改查、分页功能以及了解Springboot搭配vue完成前后端分离项目的开发流程。开发栈前端开发工具&#xff1a;WebStorm开发框架&#xff1a;vue axios包管理工具: npm打包工具&#xff1…

读取24位ad的值_实践案例丨利用小熊派开发板获取土壤湿度传感器的ADC值

摘要&#xff1a;一文带你用小熊派开发板动手做土壤湿度传感器。一、实验准备1.实验环境一块stm32开发板&#xff08;推荐使用小熊派&#xff09;&#xff0c;以及数据线已经安装STM32CubeMX已经安装KeilMDK,并导入stm32开发板对应的芯片包&#xff08;小熊派使用的是STM32L431…

java 计算两个时间戳_Java时间戳计算重叠持续时间与间隔

我相信下面的方法给出了你的Joda时间解的等价物。private static final LocalTime START LocalTime.of(18, 0);private static final LocalTime END LocalTime.of(8, 0);public static Duration overlap(ZonedDateTime currentStart, ZonedDateTime currentEnd) {ZonedDateTi…

python ini文件删除修改_如何在INI文件中编写时删除空格 - Python

这是RawConfigParser.write的定义&#xff1a;def write(self, fp):"""Write an .ini-format representation of the configuration state."""if self._defaults:fp.write("[%s]\n" % DEFAULTSECT)for (key, value) in self._defaults…

php 如何守护进程_PHP 如何实现守护进程

PHP 如何实现守护进程发布时间&#xff1a;2020-07-11 15:29:31来源&#xff1a;亿速云阅读&#xff1a;58作者&#xff1a;LeahPHP 如何实现守护进程&#xff1f;针对这个问题&#xff0c;这篇文章详细介绍了相对应的分析和解答&#xff0c;希望可以帮助更多想解决这个问题的小…