Aurora???????????

当框架抛出异常时，为便于应用开发人员判断错误的原因，异常信息应尽可能多地自我解释，让开发人员能明白这个异常是怎么回事，为什么会发生，应该怎样处理。为此，Aurora框架内的异常应该做到：

以下逐条说明，框架开发者应如何设计异常。

原则上，任何异常信息都应支持多语言，在使用时通过代码来获取当前语言环境下的异常信息。 异常多语言的实现采用JDK的标准多语言机制，将异常信息保存在property文件中，按JDK标准命名规范添加各种语言的Locale后缀。为便于维护、使用大量的异常信息，Aurora框架做以下约定：

例如，Aurora展示层的异常信息文件名为：

resources/aurora_presentation_exceptions.properties

属于同一个模块的package，可以共用一个exception property文件。

aurora.presentation.component.screen_include_invoke_error=Error when invoking included screen: {0}

   static {
       MessageFactory.loadResource("resources.aurora_presentation_exceptions");
   }

  String msg = MessageFactory.getMessage(
    "aurora.presentation.component.screen_include_invoke_error", 
    new Object[]{ "a.screen" } );

Error when invoking included screen: a.screen

如前所述，实现多语言时，已经需要为每个异常信息定义一个代码。在Aurora框架中，异常自己的代码就与异常信息代码一致。在前面的例子中，aurora.presentation.component.screen_include_invoke_error这个代码就代表在页面中包含另一个screen文件时出错，可以此代码在相应的文档中检索异常的详细信息。

异常代码的设计应遵循以下约定：

在Aurora框架中，定义了一个接口，来抽象一切可以提供源文件来源信息的对象：

package uncertain.util.resource;

public interface ILocatable {
    
    public Location getOriginLocation();
    
    public String   getOriginSource();

}

其中，getOriginSource()返回源文件资源名；getOriginLocation()返回一个uncertain.util.resource.Location对象，能标识在源文件中的位置。如果错误能追溯来来源文件，那么应抛出实现此接口的异常。

特别的，当通过O/C Mapping机制，通过CompositeMap映射到Java对象时，CompositeMap本身已经包含了来源文件及位置信息，Java对象可实现uncertain.ocm.IConfigurable接口，在beginConfigure()方法中接收CompositeMap，读取其中的位置信息，保存在自己的field中，并实现ILocatable接口，以便今后提供位置信息。例如，uncertain.proc.AbstractEntry类是大多数工作流中的entry类的基类，其中：

public abstract class AbstractEntry implements IEntry, IConfigurable, ILocatable {
    ...
    protected String    source;
    protected Location  location;

    public void beginConfigure(CompositeMap config){
        source = config.getSourceFile()==null?null:config.getSourceFile().getAbsolutePath();
        location = config.getLocation();
    }
    public void endConfigure(){
        
    }
    
    public Location getOriginLocation(){
        return location;
    }
    
    public String getOriginSource(){
        return source;
    }
   
   ...

这样，当它的子类需要抛出异常时，就可将自己作为ILocatable实例传递给异常类的构造函数，以传递位置信息。

通过uncertain.exception.MessageFactory.getExceptionMessage() 静态方法，可以为exception信息添加标准的前缀，如异常代码，异常产生的源文件位置等。通常，在自定义的exception中，可以重载getMessage()方法，调用MessageFactory.getExceptionMessage()，来创建标准格式的异常信息。例如：

public String getMessage() {
        String msg = super.getMessage();
        return MessageFactory.getExceptionMessage(this, msg);
}

调用此方法时，需要将原始exception message作为参数传递。为避免死循环，MessageFactory不会直接调用exception的getMessage()。

uncertain.exception包中定义了以下标准异常：

java.lang.Exception
   +--uncertain.exception.BaseException

java.lang.RuntimeException
   +--uncertain.exception.BaseRuntimeException
         +--GeneralException
         +--ConfigurationFileException

对于经常使用的异常代码，uncertain.exception.BuiltinExceptionFactory提供了一些静态方法用于更加方便地构造。例如，createAttributeMissing()方法返回必填属性没有填写的异常：

public static ConfigurationFileException createAttributeMissing( ILocatable locatable, String attrib_name ){
        return new ConfigurationFileException(
   "uncertain.exception.validation.attribute_missing", 
   new Object[]{attrib_name}, 
   null, 
   locatable);
    }

在Aurora框架中，异常的定义及使用的基本步骤：

uncertain.proc.Set对象实现<set>标记。在run()方法中，执行实际功能之前，先检查必要的属性是否设置。如果没有，就抛出异常：

 public void run(ProcedureRunner runner) {
        // 检查field属性是否设置
        if(field==null)
            throw BuiltinExceptionFactory.createAttributeMissing(this, "field");
        // 检查sourceField或value属性之一是否设置
        if(sourceField==null && value==null)
            throw BuiltinExceptionFactory.createOneAttributeMissing(this, "sourceField,value");
         ...
}

BuiltinExceptionFactory.createAttributeMissing()会获取预定义在Uncertain项目>/resources/UncertainBuiltinExceptions.properties中定义的，代码为uncertain.exception.validation.attribute_missing的异常信息。在中文环境下，会产生这样的异常：

HTTP Status 500 -

type Exception report

message

description The server encountered an internal error () that prevented it from fulfilling this request.

exception

javax.servlet.ServletException: uncertain.exception.ConfigurationFileException: 异常代码：
		uncertain.exception.validation.attribute_missing 源文件:
		/Users/zhoufan/Work/workspace/HAP2010/HAP2010/web/footer.screen, 
		第12行, 第17列 Attribute 属性"field"不能为空。请检查源文件，设置这个属性。
        aurora.service.http.FacadeServlet.handleException(FacadeServlet.java:70)
        aurora.service.http.AbstractFacadeServlet.service(AbstractFacadeServlet.java:131)
        javax.servlet.http.HttpServlet.service(HttpServlet.java:722)
root cause

uncertain.exception.ConfigurationFileException: 异常代码：uncertain.exception.validation.attribute_missing 
		源文件:/Users/zhoufan/Work/workspace/HAP2010/HAP2010/web/footer.screen, 第12行, 
		第17列 Attribute 属性"field"不能为空。请检查源文件，设置这个属性。
        uncertain.exception.BuiltinExceptionFactory.createAttributeMissing(BuiltinExceptionFactory.java:13)
        uncertain.proc.Set.run(Set.java:65)
...