文档章节

优雅的处理你的Java异常

叶知泉
 叶知泉
发布于 06/11 09:26
字数 3564
阅读 4152
收藏 123

本文介绍

本文仅按照业务系统开发角度描述异常的一些处理看法.不涉及java的异常基础知识,可以自行查阅 《Java核心技术 卷I》《java编程思想》 可以得到更多的基础信息.

写在前面的话

笔者文笔功力尚浅,言语多有不妥,请慷慨指正,必定感激不尽. 本文提出了几个概念: 处理反馈 业务异常 代码错误 ,请认真思考一下各中区别.

在开发业务系统中,我们目前绝大多数采用MVC模式,但是往往有人把service跟controller紧紧的耦合在一起,甚至直接使用Threadlocal来隐式传值,并且复杂的逻辑几乎只能使用service中存储的全局对象来传递处理结果,包括异常.

这样一来首先有违MVC模式,二来逻辑十分不清晰,难以维护.本文结合工作经验,给出一些异常使用建议,使用spring来实战异常为我们带来的好处.

常常,我们读罢了各种java的书,异常的各种机制,特性都很清楚,但是始终还是不知道如何使用,甚至背下了概念,却不知道如何致用.

我们开发的业务系统,或者是产品,常常面临着这样的问题:

  • 系统运行出错,但是完全不知道错误发生的位置.
  • 我们找到了错误的位置,但是完全不知道是因为什么.
  • 系统明明出了错误,但是就是看不到错误堆栈信息.

什么情况需要自定义异常

经常看到一些项目,在全局定义一个 AppException,然后所有地方都只抛出这个异常,并且把捕获的异常case到这个AppException中.会有如下问题:

  • 浪费log日志存储空间,并且栈顶并不是最接近发生异常的代码位置.
  • 只有一种异常类,无法精准区分开异常类型
  • 异常类后期难以修改以增加其携带的信息.

什么情况需要手动处理异常

我不会把书上的东西直接复制下来,这里说一下容易记住的,并且适合业务开发的.

  • 你有能力处理异常,并且你知道如何处理
  • 你有责任处理异常

自定义业务异常

考虑如下场景: 系统提供一个API,用于修改用户信息,服务器端采用json数据交互.首先我们定义ServiceException,用来表示业务逻辑受理失败,它仅表示我们处理业务的时候发现无法继续执行下去.

/**
 * 业务受理失败异常
 */
public class ServiceException extends RuntimeException {
    //接收reason参数用来描述业务失败原因.
  public ServiceException(String reason) {  super(reason); }
}

接下来看下Controller层.

// UserController.java 
 /**
   * 修改用户信息
   * @param userID 用户ID
   * @param user 修改用户信息表单数据
   */
  @PutMapping("{userID}")
  public JSONResult updateUser(@PathVariable("userID") Integer userID, @RequestBody UpdateUserForm userForm) {
    User user = new User(); //准备业务逻辑层使用的领域模型
    BeanUtils.copyProperties(userForm, user); //拷贝要修改的值
    user.setUserId(userID); //设置主键到用户数据中
    userService.updateUser(user); //调用更新业务逻辑
    JSONResult json = new JSONResult(); //准备要响应的数据
    json.put("user", user); //把修改后的用户数据还给页面
    return json; // --  
  }

关于上述Controller写法乍一看会有一些冗余,如果无法理解,请仔细研读MVC设计模式. 先不管service,我们来考虑下. 一个业务系统不可能不对用户提交的数据进行验证,验证包括两方面 : 有效性合法性,

  • 有效性: 比如用户所在岗位,是否属于数据库有记录的岗位ID,如果不存在,无效.
  • 合法性: 比如用户名只允许输入最多12个字符,用户提交了20个字符,不合法.

有效性检查,可以交给java的校验框架执行,比如JSR303. 假设用户提交的数据经过验证都合法,还是有一些情况是不能调用修改逻辑的.

  1. 要修改的用户ID不存在.
  2. 用户被锁定,不允许修改.
  3. 乐观锁机制发现用户已经被被人修改过.
  4. 由于某种原因,我们的程序无法保存到数据库.
  5. 一些程序员错误的开发了代码,导致保存过程中出现异常,比如NPE.

对于前3种,我们认为是有效性检查失败,第4种属与我们无法处理的异常,第5种就是程序员bug.

现在的问题是,前三种情况我们如何通知用户呢?

  1. 在ccontroller 调用userService的checkUserExist()方法.
  2. 在controller直接书写业务逻辑.
  3. 在service响应一个状态码机制,比如1 2 3表示错误信息,0 表示没有任何错误.

显然前2种方法都不可取 ,因为MVC不设计模式告诉我们,controller是用来接收页面参数,并且调用逻辑处理,最后组织页面响应的地方.我们不可以在controller进行逻辑处理,controller只应该负责用户API入口和响应的处理(如若不然,思考一下如果有一天service的代码打包成jar放到另一个平台,没有controller了,该怎么办?)

状态码机制是个不错的选择,可是如此一来,用户保存逻辑变了,比如增加一个情况,不允许修改已经离职的用户,那么我们还需要修改controller的代码,代码量增加,维护成本增高,并且还耦合了service,不符合MVC设计模式.

那么怎么办呢?现在我们来看下service代码如何编写


  /**
   * 修改用户信息
   * @param user 要修改的用户数据
   */
  public void updateUser(User user) {
    User userOrig = userDao.getUserById(user.getUserID());
    if (null == userOrig) {
      throw new ServiceException("用户不存在");
    }
    if (userOrig.isLocked()) {
      throw new ServiceException("用户被锁定,不允许修改");
    }
    if (!user.getVersion().equals(userOrig.getVersion())) {
      throw new ServiceException("用户已经被别人修改过,请刷新重试");
    }
    // TODO 保存用户数据  ... 
  }

这样一来只要我们检查到不允许保存的项目,我们就可以直接throw 一个新的异常,异常机制会帮助我们中断代码执行.

接下来有2种选择:

  1. 在controller 使用try-catch进行处理.
  2. 直接把异常抛给上层框架统一处理.

第1种方式是不可取的 ,注意我们抛出的ServiceException,它仅仅逻辑处理异常,并且我们的方法前面没有声明throws ServiceException,这表示他是一个非受查异常.controller也没有关心会发生什么异常.

为什么不定义成受查异常呢? 如果是一个受查异常,那么意味着controller必须要处理你的异常.并且如果有一天你的业务逻辑变了,可能多一种检查项,就需要增加一个异常,反之需要删除一个异常,那么你的方法签名也需要改变,controller也随之要改变,这又变成了紧耦合,这和用状态码123表示处理结果没有什么不同.

我们可以为每一种检查项定义一个异常吗? 可以,但是那样显得太多余了.因为业务逻辑处理失败的时候,根据我们需求,我们只需要通知用户失败的原因(通常应该是一段字符串),以及服务器受理失败的一个状态码(有时可能不需要状态码,这要看你的设计了),这样这需要一个包含原因属性的异常即可满足我们需求.

最后我们决定这个异常继承自RuntimeException.并且包含一个接受一个错误原因的构造器,这样controller层也不需要知道异常,只要全局捕获到ServiceException做统一的处理即可,这无论是在struct1,2时代,还是springMVC中,甚至servlet年代,都是极为容易的!

异常不提供无参构造器 ,因为绝对不允许你抛出一个逻辑处理异常,但是不指明原因,想想看,你是必须要告诉用户为什么受理失败的!

如此一来,我们只需要全局统一处理下 ServiceException 就可以了,很好,spring为我们提供了ControllerAdvice机制,有关ControllerAdvice,可以查阅springMVC使用文档,下面是一个简单的示例:

@ControllerAdvice(basePackages = { "com.xxx.xxx.bussiness.xxx" })
public class ModuleControllerAdvice {
  private static final Logger LOGGER = LoggerFactory.getLogger(ModuleControllerAdvice.class);
  private static final Logger SERVICE_LOGGER = LoggerFactory.getLogger(ServiceException.class);

  /**
   * 业务受理失败
   */
  @ResponseBody
  @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
  @ExceptionHandler(ServiceException.class)
  private JSONResult handleServiceException(ServiceException exception) {
    String message = "业务受理失败,原因:" + exception.getLocalizedMessage();
    SERVICE_LOGGER.info(message);
    JSONResult json = new JSONResult();
    json.serCode(500001); // 500000表示系统异常,500001表示业务逻辑异常
    json.setMessage(message); 
    return json;
  }
}

在这个时候,我们就可以很轻松的处理各种情况了.

注意一点,在这个类中,我们定义了2个log对象,分别指向 ServiceException.class 和 ModuleControllerAdvice.class . 并且处理 ServiceException的时候使用了info级别的日志输出,这是很有用的.

  • 首先,ServiceException一定要和其他的代码错误分离,不应该混为一谈.
  • 其次,ServiceException并不一定要记录日志,我们应该提供独立的log对象,方便开关.

接下来你可以在修改用户的时候想客户端响应这样的JSON

{
    code: 200001,
    message: "业务受理失败,原因:用户名称不存在!"
}

如此一来没有任何地方需要关心异常,或者业务逻辑校验失败的情况.用户也可以得到很友好的错误提示.

如何对异常进行分类

如果你只需要一句概括,那么直接定义一个简单的异常,用于中断处理,并且与用户保持友好交互即可.

如果不可能一句话描述清楚,并且包含附加信息,比如需要在日志或者数据库记录消息ID,此时可能专门针对这种重要/复杂业务创建独立异常.

上述两种情况因为web系统,是用户发起请求之后需要等待程序给予响应结果的.

如果是后台作业,或者复杂业务需要追溯性.这种通常用流程判断语句控制,要用异常处理.我们认为这些流程判断一定在一个原子性处理中.并且检查到(不是遇到)的问题(不是异常)需要记录到用户可友好查看的日志.这种情况属于处理反馈,并不叫异常.

综上,笔者通常分为如下几类:

  1. 逻辑异常,这类异常用于描述业务无法按照预期的情况处理下去,属于用户制造的意外.
  2. 代码错误,这类异常用于描述开发的代码错误,例如NPE,ILLARG,都属于程序员制造的BUG.
  3. 专有异常,多用于特定业务场景,用于描述指定作业出现意外情况无法预先处理.

各类异常必须要有单独的日志记录,或者分级,分类可管理.有的时候仅仅想给三方运维看到逻辑异常.

写在后面的注意

异常设计的初衷是解决程序运行中的各种意外情况,且异常的处理效率比条件判断方式要低很多.

上面这句话出自<java编程思想>,但是我们思考如下几点:

业务逻辑检查,也是意外情况

UnknownHostException,表示找不到这样的主机,这个异常和NoUserException有什么区别么?换言之,没有这样的主机是异常,没有这样的用户不是异常了么? 所以一定要弄明白什么是用异常来控制逻辑,什么是定义程序异常.

异常处理效率很低

书中所示的例子,是在循环中大量使用try-catch进行检查,但是业务系统,用户发起请求的次数与该场景天壤地别.淘宝的11`11是个很好的反例.但是请你的系统上到这个级别再考虑这种问题.

  1. 系统有千万并发,不可能还去考虑这些中规中矩的按部就班的方式,别忘了MVC本来就浪费很多资源,代码量增加很多.
  2. 业务系统也存在很多巨量任务处理的情况.但是那些任务都是原子性的,现在MVC中的controller和service可不是原子性的,不然为什么要区分这么多层呢.
  3. 如果那么在乎效率,考虑下重写Throwable的fillStackTrace方法.你要知道异常的开销大到底大在什么地方,fillStackTrace是一个native方法,会填充异常类内部的运行轨迹.

不要用异常进行业务逻辑处理

我们先来看一个例子:

    //这是一个非常典型的反例,也是一个误区.
  /**
   * 处理业务消息
   * @param message 要处理的消息
   */
  public void processMessage(Message<String> message) {
    try{
        // 处理消息验证
        // 处理消息解析
        // 处理消息入库
    }catch(ValidateException e ){
        // 验证失败
    }catch(ParseException e ){
        // 解析失败
    }catch(PersistException e ){
        // 入库失败
    }
  }

上述代码就是典型的使用异常来处理业务逻辑.这种方式需要严重的禁止!上述代码最大的问题在于,我们如何利用异常来自动处理事务呢?

然而这和我们的异常中断service没有什么冲突.也并不是一回事.

  • 我们提倡在 业务处理 的时候,如果发现无法处理直接抛出异常即可.
  • 而并不是在 逻辑处理 的时候,用异常来判断逻辑进行的状况.

改正后的逻辑

  /**
   * 处理业务消息
   * @param message 要处理的消息
   */
  public void processMessage(Message<String> message) {
    // 处理消息验证
    if(!message.isValud()){
        MessageLogService.log("消息校验失败"+message.errors())
        return ;
    }
    // 处理消息解析
    if(!message.parse()){
        MessageLogService.log("消息解析失败"+message.errors())
        return ;
    }
     // TODO ....
  }

最后俏皮一句:微服务横行的今天,我们在action里面直接写业务处理,也无可厚非.

© 著作权归作者所有

共有 人打赏支持
叶知泉
粉丝 15
博文 1
码字总数 3564
作品 0
大连
程序员
加载中

评论(19)

叶知泉
叶知泉

引用来自“marinesky”的评论

其实这个'优雅'是有适用的场景的,因为ServiceException是继承RuntimeException,在发生异常时或业务检查时并不支持有返回值,在某些场景未必适用

嗯,你说得对,考虑篇幅不可能一文全部点到,文中也有指出特定异常情况到实例代码。
感谢不吝赐教。
marinesky
marinesky
其实这个'优雅'是有适用的场景的,因为ServiceException是继承RuntimeException,在发生异常时或业务检查时并不支持有返回值,在某些场景未必适用
o
ooknight

引用来自“menxin”的评论

抱歉,感觉并不优雅
请说出哪里不好, 或者你优雅的方案
Lasagna
Lasagna
实打实的经验之谈,思路可以借鉴一下,具体到自己的项目再说吧,写的很棒!
小山羊
小山羊
支持一个
叶知泉
叶知泉

引用来自“11路”的评论

和我设计的异常处理是一样的,只是自定义异常分类楼主是怎么考虑的呢?目前我们就只定义了一个业务异常类

引用来自“maradona”的评论

定义一个和多个差别不大,但在分布式系统中如果没有良好的日志系统,还是每个服务一个异常类,至少一眼就能定位出现问题的服务来,但都需要有共同的基类
楼上说的很有道理,我没有讨论分布式情况.按说分布式应该对自己的系统节点,异常模块,发送的环境等做一个描述,然后抛出.这样对定位很有帮助.
maradona
maradona

引用来自“11路”的评论

和我设计的异常处理是一样的,只是自定义异常分类楼主是怎么考虑的呢?目前我们就只定义了一个业务异常类
定义一个和多个差别不大,但在分布式系统中如果没有良好的日志系统,还是每个服务一个异常类,至少一眼就能定位出现问题的服务来,但都需要有共同的基类
叶知泉
叶知泉

引用来自“11路”的评论

和我设计的异常处理是一样的,只是自定义异常分类楼主是怎么考虑的呢?目前我们就只定义了一个业务异常类
抱歉内容不全,见更新.
IOIOIOIOIOIO
IOIOIOIOIOIO
写的很好!
11路
11路
和我设计的异常处理是一样的,只是自定义异常分类楼主是怎么考虑的呢?目前我们就只定义了一个业务异常类
SpringBoot基础教程2-1-3 异常处理规范

概述 异常处理,在平时业务处理中不可避免;但是,阅读代码最头疼的就是看到一堆语句,业务逻辑参杂其中,极难维护;那要怎样优雅的处理异常呢?请耐心阅读全文。 2. 不负责任的处理异常 直接...

Mkeeper
07/09
0
0
异常的概念和Java异常体系结构

一、 异常的概念和Java异常体系结构 异常是程序运行过程中出现的错误。本文主要讲授的是Java语言的异常处理。Java语言的异常处理框架, 是Java语言健壮性的一个重要体现。 Java把异常当作对象...

杭州_周陶忠
2013/09/10
0
0
Spring boot 2.0 之优雅停机

spring boot 框架在生产环境使用的有一段时间了,它“约定大于配置”的特性,体现了优雅流畅的开发过程,它的部署启动方式()也很优雅。但是我使用的停止应用的方式是 ,即使写了脚本,还是...

rabbitGYK
05/20
0
0
使用Spring MVC 的 @RequestBody 映射json请求参数时报异常问题

使用Spring MVC 的 @RequestBody 映射json请求参数时报“The request sent by the client was syntactically incorrect.”异常解决方案 最近工作中开发RESTful接口需要处理客户端上传的json,...

Tek_Eternal
2015/03/01
0
3
Lambda 表达式有何用处?如何使用?(针对Java8)

什么是Lambda? 我们知道,对于一个Java变量,我们可以赋给其一个“值”。 如果你想把“一块代码”赋给一个Java变量,应该怎么做呢? 比如,我想把右边那块代码,赋给一个叫做aBlockOfCode的J...

亭子happy
06/06
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

windows nvm 安装 node

nvm 是 node 的版本控制管理 下面是下载 nvm 的地址,选择 nvm-setup.zip 下载 https://github.com/coreybutler/nvm-windows/releases 就是下一步下一步,一键安装 基本命令有: nvm arch [32...

U_I_A_N
4分钟前
0
0
函数式组件完整例子

之前创建的组件是比较简单,没有管理或者监听任何传递给他的状态,也没有生命周期方法。它只是一个接收参数的函数。 在下面这个例子中,我们标记组件为 functional,这意味它是无状态 (没有响...

tianyawhl
19分钟前
0
0
linux shell大文件操作

查找字符串所在行 : grep -n “待查找字符串” “文件名” 显示指定行信息:sed -n 1p “指定文件” 表示显示指定文件第一行的信息 ----------------------------------------------------...

悲催的古灵武士
19分钟前
0
0
centos7安装nexus3

centos7安装nexus3 2018年05月24日 16:20:34 阅读数:257 1、下载nexus wget https://sonatype-download.global.ssl.fastly.net/repository/repositoryManager/3/nexus-3.12.0-01-unix.tar.......

linjin200
21分钟前
1
0
springboot整合cxf发布webservice以及调用

webservice性能不高,但是现在好多公司还是在用,恰好今天在开发的时候对接项目组需要使用到webservice下面来说下简单的案例应用 首先老规矩:引入jar包 <dependency><groupId>org.apach...

落叶清风
25分钟前
5
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部