当前位置:天才代写 > tutorial > JAVA 教程 > 一个用于J2EE应用措施的异常处理惩罚框架

一个用于J2EE应用措施的异常处理惩罚框架

2017-11-10 08:00 星期五 所属: JAVA 教程 浏览:463

副标题#e#

在大大都Java项目中,大部门代码都是样板代码。异常处理惩罚就属于此类代码。纵然业务逻辑只有3到4行代码,用于异常处理惩罚的代码也要占10到20行。本文将接头如何让异常处理惩罚保持简朴和直观,使开拓人员可以专心于开拓业务逻辑,而不是把时间挥霍在编写异常处理惩罚的样板代码上。本文还将说明用于在J2EE情况中建设和处理惩罚异常的基本常识和指导原则,并提出了一些可以利用异常办理的业务问题。本文将利用Struts框架作为暗示实现,但该要领合用于任何暗示实现。

利用checked和unchecked异常的场景

您是否曾经想过,为什么要在编写好的代码块周围安排一个try-catch块,即便明知道无法对这些异常举办什么处理惩罚,而只满意于把它们放在catch块中?您大概想知道,为什么不能把这项事情放在一个会合的处所完成?在大大都环境下,这个处所对付J2EE应用措施来说就是一个前端节制器。换句话说,开拓人员不会因为它们而受到滋扰,因为基础不必许多地干涉它们。可是,假如一个要领名称包括一个throws子句,会呈现什么环境呢?开拓人员可能必需捕获这些异常,可能把它们放在本身的要领的throws子句中。这就是疾苦的来源!幸运的是,Java API有一类叫做unchecked exception的异常,它们不必捕获。可是,仍然存在一个问题:按照什么来抉择哪些是checked异常,哪些是unchecked异常?下面给出一些指导原则:

终端用户无法采纳有效操纵的异常应该作为unchecked异常。譬喻,致命的和不行规复的异常就应该是unchecked。把XMLParseException(在理会XML文件时抛出)作为checked异常没有任何意义,因为惟一可以或许采纳的法子就是基于异常跟踪来办理基础问题。通过扩展java.lang.RuntimeException,可以建设自界说的unchecked异常。

在应用措施中,与用户操纵相关的异常应该是checked异常。checked异常要求客户端来捕获它们。您大概会问,为什么不把所有异常都看成是unchecked。这样做的问题在于,个中一些异常无法在正确的位置被捕获到。这会带来更大的问题,因为错误只有在运行时才气被识别。checked异常的例子有业务确认异常、安详性异常等等。

异常抛出计策

只捕获根基应用措施异常(假定为BaseAppException)并在throws子句中声明

在大大都J2EE应用措施中,关于针对某个异常应该在哪一界面上显示哪条错误动静的决定只能在暗示层中做出。这会带来另一个问题:为什么我们不能把这种决定放在一个民众的处所呢?在J2EE应用措施中,前端节制器就是一个举办常见处理惩罚的会合位置。

另外,必需有一种用于流传异常的通用机制。异常也需要以一种普适的方法得处处理惩罚。为此,我们始终需要在节制器端捕获根基应用措施异常BaseAppException。这意味着我们需要把BaseAppException异常(只有这个异常)放入可以抛出checked异常的每个要领的throws子句中。这里的观念是利用多态来埋没异常的实际实现。我们在节制器中捕获BaseAppException,可是所抛出的特定异常实例大概是几个派生异常类中的任意一个。借助于这种要领,可以得到很多异常处理惩罚方面的机动性:

不需要在throws子句中放入大量的checked异常。throws子句中只需要有一个异常。

不需要再对应用措施异常利用杂乱的catch块。假如需要处理惩罚它们,一个catch块(用于BaseAppException)就足够了。

开拓人员不需要亲自举办异常处理惩罚(日志记录以及获取错误代码)。这种抽象是由ExceptionHandler完成的,稍后本文会就此点举办接头。

纵然稍后把更多异常引入到要领实现中,要领名称也不会改变,因此也不需要修改客户端代码,不然就会引起连锁回响。然而,抛出的异常需要在要领的Javadoc中指定,以便让客户端可以看到要领约束。

下面给出抛出checked异常的一个例子:

public void updateUser(UserDTO userDTO)
throws BaseAppException{
  UserDAO userDAO = new UserDAO();
  UserDAO.updateUser(userDTO);
  ...
  if(...)
  throw new RegionNotActiveException("Selected region is not active");
}
Controller Method:
...
try{
  User user = new User();
  user.updateUser(userDTO);
}catch(BaseAppException ex){
  //ExceptionHandler is used to handle
  //all exceptions derived from BaseAppException
}
...


#p#副标题#e#

迄今为止,我们已经说明,对付所有大概抛出checked异常并被Controller挪用的要领,其throws子句中应该只包括checked异常。然而,这实际上体现着我们在throws子句中不能包括其他任何应用措施异常。可是,假如需要基于catch块中某种范例的异常来执行业务逻辑,那又该怎么办呢?要处理惩罚这类环境,要领还可以抛出一个特定异常。记着,这是一种特例,开拓人员绝对不能认为这是理所虽然的。同样,此处接头的应用措施异常应该扩展BaseAppException类。下面给出一个例子:

#p#分页标题#e#

CustomerDAO method:
//throws CustomerNotActiveException along with
//BaseAppException
public CustomerDTO getCustomer(InputDTO inputDTO)
throws BaseAppException,
CustomerNotActiveException {
  . . .
  //Make a DB call to fetch the customer
  //details based on inputDTO
  . . .
  // if not details found
  throw new CustomerNotActiveException("Customer is not active");
}
Client method:
//catch CustomerNotActiveException
//and continues its processing
public CustomerDTO getCustomerDetails(UserDTO userDTO)
throws BaseAppException{
  ...
  CustomerDTO custDTO = null;
  try{
   //Get customer details
   //from local database
   customerDAO.getCustomerFromLocalDB();
  }catch(CustomerNotActiveException){
   ...
   return customerDAO .activateCustomerDetails();
  }
}

在web应用措施条理上处理惩罚unchecked异常

所有unchecked异常都应该在web应用措施条理长举办处理惩罚。可以在web.xml文件中设置web页面,以便当应用措施中呈现unchecked异常时,可以把这个web页面显示给终端用户。

把第三方异常包装到特定于应用措施的异常中

当一个异常发源于另一个外部接口(组件)时,应该把它包装到一个特定于应用措施的异常中,并举办相应处理惩罚。

例子:

try {
  BeanUtils.copyProperties(areaDTO, areaForm);
} catch (Exception se) {
  throw new CopyPropertiesException("Exception occurred while using
copy properties", se);
}

这里,CopyPropertiesException扩展了java.lang.RuntimeException,我们将会记录它。我们捕获的是Exception,而不是copyProperties要领可以抛出的特定checked异常,因为对付所有这些异常来说,我们城市抛出同一个unchecked CopyPropertiesException异常。

过多异常

您大概想知道,假如我们为每条错误动静建设一个异常,异常类自身是否会溢出呢?譬喻,假如“Order not found”是OrderNotFoundException的一条错误动静,您必定不会让CustomerNotFoundException的错误动静为“Customer not found”,来由很明明:这两个异常代表同样的意义,惟一的区别在于利用它们的上下文差异。所以,假如可以在处理惩罚异常时指定上下文,我们无疑可以把这些异常归并为一个RecordNotFoundException。下面给出一个例子:

try{
  ...
}catch(BaseAppException ex){
  IExceptionHandler eh =ExceptionHandlerFactory.getInstance().create();
  ExceptionDTO exDto = eh.handleException("employee.addEmployee", userId, ex);
}

在这里,employee.addEmployee上下文将被附加给一个上下文敏感的异常的错误代码,从而发生惟一的错误代码。譬喻,假如RecordNotFoundException的错误代码是errorcode.recordnotfound,那么这个上下文的最终错误代码将变为errorcode.recordnotfound.employee.addEmployee,它对付这个上下文是惟一的错误代码。

然而,我们要给出一个告诫:假如您筹备在同一个客户端要领中利用多个接口,并且这些接口都可以抛出RecordNotFoundException异常,那么想要知道是哪个实体激发了这个异常就变得十分坚苦。假如业务接口是民众的,并且可以被各类外部客户端利用,那么发起只利用特定的异常,而不利用像RecordNotFoundException这样的一般性异常。特定于上下文的异常对付基于数据库的可规复异常来说很是有用,因为在这种环境下,异常类始终是沟通的,差异的只有它们呈现的上下文。

#p#副标题#e#

J2EE应用措施的异常条理布局

正如前面接头的那样,我们需要界说一个异常基类,叫做BaseAppException,它包括了所有应用措施异常的默认行为。我们将把这个基类放到所有大概抛出checked异常的要领的throws子句中。应用措施的所有checked异常都应该是这个基类的子类。有多种界说错误处理惩罚抽象的方法。然而,个中的区别更多地是与业务类而不是与技能有关。对错误处理惩罚的抽象可分为以下几类。所有这些异常类都是从BaseAppException派生而来。

checked异常

业务异常:执行业务逻辑时呈现的异常。BaseBusinessException是这类异常的基类。

数据库异常:与耐久化机制举办交互时抛出的异常。BaseDBException是这类异常的基类。

安详性异常:执行安详性操纵时呈现的异常。这类异常的基类是BaseSecurityException。

确认异常:在从终端用户处得到确认以执行某个特定任务时利用。这类异常的基类是BaseConfirmationException。

unchecked异常

#p#分页标题#e#

系统异常:有时候我们但愿利用unchecked异常。譬喻下面的环境:不想亲自处理惩罚来自第三方库API的异常,而是但愿把它们包装在unchecked异常中,然后抛出给节制器。有时会呈现设置问题,这些问题也不能由客户端举办处理惩罚,而应该被看成unchecked异常。所有自界说的unchecked异常都应该扩展自java.lang.RuntimeException类。

暗示层上的异常处理惩罚

暗示层独自认真抉择对一个异常采纳什么操纵。这种决定涉及到识别抛出异常的错误代码。另外,我们还需要知道在处理惩罚错误之后应该把错误动静重定向到哪一界面。

我们需要对基于异常范例得到错误代码这个进程举办抽象。须要时还应该执行日志记录。我们把这种抽象称之为ExceptionHandler。它基于“四人帮”(Gang of Four,GOF) 外观模式(《Design Patterns》一书中说,该模式是用于“为子系统中的一组接口提供一个统一接口。外观界说了一个更高级此外接口,使子系统变得越发易于利用。”),是用于处理惩罚所有派生自BaseAppException的异常的整个异常处理惩罚系统的外观。下面给出一个在Struts Action要领中举办异常处理惩罚的例子:

try{
  ...
  DivisionDTO storeDTO = divisionBusinessDelegate.getDivisionByNum(fromDivisionNum);
}catch(BaseAppException ex){
  IExceptionHandler eh = ExceptionHandlerFactory.getInstance().create();
  String expContext = "divisionAction.searchDivision";
  ExceptionDTO exDto = eh.handleException(expContext , userId, ex);
  ActionErrors errors = new ActionErrors();
  errors.add(ActionErrors.GLOBAL_ERROR,new ActionError(
exDto.getMessageCode()));
  saveErrors(request, errors);
  return actionMapping.findForward("SearchAdjustmentPage");
}

假如更仔细地调查我们方才编写的异常处理惩罚代码,您大概会心识到,为每个Struts要领编写的代码是十分相似的,这也是一个问题。我们的方针是尽大概地去掉样板代码。我们需要再次对它举办抽象。

办理方案是利用模板要领(Template Method)设计模式(引自GOF:“它用于实现一个算法的稳定部门,并把可变的算法部门留给子类来实现。”)。我们需要一个包括模板要领形式算法的基类。该算法将包括用于BaseAppException的try-catch块和对dispatchMethod要领的挪用,要领实现(委托给派生类)如下面的基于Struts的Action中所示:

public abstract class BaseAppDispatchAction
extends DispatchAction{
  ...
  protected static ThreadLocal
  expDisplayDetails = new ThreadLocal();
  public ActionForward execute(ActionMapping mapping,ActionForm form,
HttpServletRequest request,HttpServletResponse response) throws Exception{
   ...
   try{
    String actionMethod = request.getParameter(mapping.getParameter());
    finalDestination =dispatchMethod(mapping,form, request, response,actionMethod);
   }catch (BaseAppException Ex) {
    ExceptionDisplayDTO expDTO = (ExceptionDisplayDTO)expDisplayDetails
.get();
    IExceptionHandler expHandler = ExceptionHandlerFactory
.getInstance().create();
    ExceptionDTO exDto = expHandler.handleException(
expDTO.getContext(), userId, Ex);
    ActionErrors errors = new ActionErrors();
    errors.add(ActionErrors.GLOBAL_ERROR, new ActionError(exDto .getMessageCode()));
    saveErrors(request, errors);
    return mapping.findForward(expDTO.getActionForwardName());
   } catch(Throwable ex){
    //log the throwable
    //throw ex;
   } finally {
    expDisplayDetails.set(null);
   }

#p#副标题#e#

在Struts中,DispatchAction::dispatchMethod要领用于把请求转发给正确的Action要领,叫做actionMethod。

我们假定从一个HTTP请求得到searchDivision作为actionMethod:dispatchMethod将在BaseAppDispatchAction的派生Action类中把请求分配给searchDivision要领。在这里,您可以看到,异常处理惩罚仅在基类中完成,而派生类则只实现Action要领。这回收了模板要领设计模式,在该模式中,异常处理惩罚部门是保持稳定的,而dispatchMethod要领的实际实现(可变部门)则交由派生类完成。

修改后的Struts Action要领如下所示:

#p#分页标题#e#

...
String exceptionActionForward = "SearchAdjustmentPage";
String exceptionContext = "divisionAction.searchDivision";
ExceptionDisplayDTO expDTO = new ExceptionDisplayDTO(expActionForward,
exceptionContext);
expDisplayDetails.set(expDTO);
...
DivisionDTO divisionDTO =divisionBusinessDelegate.getDivisionByNum(fromDivisionNum);
...

此刻它看起来相当清晰。因为异常处理惩罚是在一个会合的位置上(BaseAppDispatchAction)完成的,手动错误大概造成的影响也降至最低。

然而,我们需要配置异常上下文和ActionForward要领的名称,假如有异常呈现,请求就会被转发到该要领。我们将在ThreadLocal变量expDisplayDetails中配置这些内容。

可是,为什么要利用java.lang.ThreadLocal变量呢?expDisplayDetails是BaseAppDispatchActiion类中的一个受掩护数据成员,这也是它需要是线程安详的原因。java.lang.ThreadLocal工具在这里便可派上用场。

异常处理惩罚措施

在上一部门中,我们接头了如何对异常处理惩罚举办抽象。下面给出一些应该满意的约束:

识别异常范例并得到相应的错误代码,该错误代码可用于显示一条动静给终端用户。

记录异常。底层的日志记录机制被埋没,可以基于一些情况属性对其举办设置。

您大概已经留意到了,我们在暗示层中捕获的惟一异常就是BaseAppException。由于所有checked异常都是BaseAppException的子类,这意味着我们要捕获BaseAppException的所有派生类。基于类名称来识别错误代码再容易不外了。

//exp is an object of BaseAppException
String className = exp.getClass().getName();

可以基于异常类的名称在一个XML文件(exceptioninfo.xml)中对错误代码举办设置。下面给出异常设置的一个例子:

<exception name="EmployeeConfirmationException">
  <messagecode>messagecode.laborconfirmation</messagecode>
  <confirmationind>true</confirmationind>
  <loggingtype>nologging</loggingtype>
</exception>

正如您看到的那样,我们把这个异常变为显式,要利用的动静代码是messagecode.employeeconfirmation。然后,为了实现国际化的目标,可以从ResourceBundle提取实际的动静。我们很清楚,不需要对这类异常执行日志记录,因为它只是一条确认动静,而不是一个应用措施错误。

让我们看一看上下文敏感异常的一个例子:

<exception name="RecordNotFoundException">
  <messagecode>messagecode.recordnotfound</messagecode>
  <confirmationind>false</confirmationind>
  <contextind>true</contextind>
  <loggingtype>error</loggingtype>
</exception>

#p#副标题#e#

在这里,这个表达式的contextind为true。在handleException要领中通报的上下文可用于建设惟一的错误代码。譬喻,假如我们把order.getOrder看成一个上下文举办通报,功效获得的动静代码就是异常的动静代码和所通报的上下文的串联。因此,我们得到了一个像messagecode.recordnotfound.order.getOrder这样的惟一动静代码。

对付每个异常来说,可以把exceptioninfo.xml 中的数据封装到一个叫做ExceptionInfoDTO的数据传输工具(data transfer object,DTO)。此刻,我们还需要一个占位符,用于缓存这些工具,因为我们不想在异常呈现时重复理会XML文件和建设工具。这项事情可以委托给一个叫做ExceptionInfoCache的类来完成,这个类将会在从exceptioninfo.xml文件读取ExceptionInfoDTO工具信息之后缓存所有这些工具。

此刻您是否弄清楚了这整个进程?这种要领的焦点部门是ExceptionHandler实现,该实现将利用封装在ExceptionInfoDTO中的数据来获打动静代码,建设ExceptionDTO工具,然后基于在给定异常的ExceptionInfoDTO中指定的日志记录范例来记录它。

下面是ExceptionHandler实现的handleException要领:

public ExceptionDTO handleException(String userId,BaseAppException exp) {
  ExceptionDTO exDTO = new ExceptionDTO();
  ExceptionInfoCache ecache = ExceptionInfoCache.getInstance();
  ExceptionInfo exInfo = ecache.getExceptionInfo( ExceptionHelper.getClassName(exp));
  String loggingType = null;
  if (exInfo != null) {
   loggingType = exInfo.getLoggingType();
   exDTO.setConfirmation(exInfo.isConfirmation());
   exDTO.setMessageCode(exInfo.getMessageCode());
  }
  FileLogger logger = new FileLoggerFactory().create();
  logger.logException(exp, loggingType);

按照差异的业务需求,ExceptionHandler接口可以有多种实现。抉择利用何种实现的任务可交由Factory来完成,出格是ExceptionHandlerFactory类。

竣事语

#p#分页标题#e#

假如缺乏全面的异常处理惩罚计策,一些非凡的异常处理惩罚块便大概导致呈现非尺度的错误处理惩罚和不行维护的代码。通过利用上面的要领,便可简化J2EE应用措施中的异常处理惩罚进程。

 

    关键字:

[contact-form-7 id="17097" title="form2"]天才代写-代写联系方式