从AggregateException看异常类的设计

异常是程序在有bug时最直观的表现形式,不担心有bug存在,而担心bug埋没在大堆的代码中而发现不了。

这篇随笔简单谈谈从AggregateException类源码(http://www.projky.com/dotnet/4.5.1/System/AggregateException.cs.html)中窥出的.NET
Framework类库设计的方式。

总结有以下几点:

1、特性的使用:DebuggerDisplayAttributeSerializableAttribute

2、只读属性的运用

3、简单的队列算法

AggregateException主要用在TPL库中,在等待时发生异常的Task可能不止一个,所以,设计通过InnerExceptions属性访问所有的异常。需要特别注意的是,Exception对象本身有一个InnerException属性,是单数的,少了个s,最多只能记录一个异常。先来看看它的一个典型用法:


int[] locations = GetCacheLocations();
var readCacheTasks = new Task<CacheItem>[locations.Length];
for (int i = 0; i < locations.Length; i++) {
int location = locations[i];
readCacheTasks[i] = new Task<CacheItem>(ReadDistributeCache, location);
readCacheTasks[i].Start();
}

try {
Task.WaitAll(readCacheTasks);
for(int i = 0; i < locations.Length; i++){
ProcessCacheItem(readCacheTasks[i].Result, i);
}
} catch (AggregateException ae) {
ae.Handle(e => {
return e is NotFoundException;
});
//throw ae.Flatten();
}

这段代码中,如果读取分布式缓存的多个任务发生了异常,也能及时确定是否存在一个bug。

从AggregateException的源码看,只有两个特性声明在该类上,


[Serializable]
[DebuggerDisplay("Count = {InnerExceptionCount}")]
public class AggregateException : Exception {
private int InnerExceptionCount{
get{
return InnerExceptions.Count;
}
}

......
}

DebuggerDisplayAttribute特性让我们在下断点调试时,鼠标位置在该类上出现的提示。例如,包含了3个内部异常,那么在断点提示是会是“Count
= 3”,这里访问了私有的属性,不一定要私有的,但私有的成员在写代码时不会出现在代码提示中,减少了干扰。

SerializableAttribute特性让该类支持序列化,比如序列化成xml文件、流、json等格式,再反序列化得到该类对象。仅仅声明该属性是不够的,还添加实现两个成员,一是在序列化过程中,要往结果中存什么,GetObjectData方法,二是支持反序列化的构造函数。


public override void GetObjectData(SerializationInfo info, StreamingContext context){
base.GetObjectData(info, context);
Exception[] innerExceptions = new Exception[m_innerExceptions.Count];
m_innerExceptions.CopyTo(innerExceptions, 0);
info.AddValue("InnerExceptions", innerExceptions, typeof(Exception[]));
}

protected AggregateException(SerializationInfo info, StreamingContext context) : base(info, context){
Exception[] innerExceptions = info.GetValue("InnerExceptions", typeof(Exception[])) as Exception[];
m_innerExceptions = new ReadOnlyCollection<Exception>(innerExceptions);
}

字符串“InnerExceptions”只是一个名字而已,相当于一个key,不同的属性,key必须不同,同时,还得避免继承可能导致的key重复问题。

大部分情况下,使用AggregateException都是访问它的InnerExceptions属性,


private ReadOnlyCollection<Exception> m_innerExceptions; // Complete set of exceptions.

public ReadOnlyCollection<Exception> InnerExceptions{
get { return m_innerExceptions; }
}

private AggregateException(string message, IList<Exception> innerExceptions)
: base(message, innerExceptions != null && innerExceptions.Count > 0 ? innerExceptions[0] : null)
{
Exception[] exceptionsCopy = new Exception[innerExceptions.Count];
for (int i = 0; i < exceptionsCopy.Length; i++){
exceptionsCopy[i] = innerExceptions[i];
if (exceptionsCopy[i] == null){
throw new ArgumentException(Environment.GetResourceString("AggregateException_ctor_InnerExceptionNull"));
}
}
m_innerExceptions = new ReadOnlyCollection<Exception>(exceptionsCopy);
}

它的InnerExceptions属性是只读的,避免外部访问修改,而且在构造该AggregateException对象实例时,对参数检验和直接的浅拷贝,尽量使整个过程只在返回时修改类的状态,一般情况下,可以认为该过程没有副作用。

如果你仔细想想,可能在InnerExceptions中,也存在AggregateException对象,所以,专门提供了一个Flatten方法,来提取层级中所有的非AggregateException对象到一个ReadOnlyCollection<Exception>对象中,字面意思理解就是扁平化。


public AggregateException Flatten()
{
// Initialize a collection to contain the flattened exceptions.
List<Exception> flattenedExceptions = new List<Exception>();

// Create a list to remember all aggregates to be flattened, this will be accessed like a FIFO queue
List<AggregateException> exceptionsToFlatten = new List<AggregateException>();
exceptionsToFlatten.Add(this);
int nDequeueIndex = 0;

// Continue removing and recursively flattening exceptions, until there are no more.
while (exceptionsToFlatten.Count > nDequeueIndex){
// dequeue one from exceptionsToFlatten
IList<Exception> currentInnerExceptions = exceptionsToFlatten[nDequeueIndex++].InnerExceptions;

for (int i = 0; i < currentInnerExceptions.Count; i++){
Exception currentInnerException = currentInnerExceptions[i];

if (currentInnerException == null){
continue;
}

AggregateException currentInnerAsAggregate = currentInnerException as AggregateException;

// If this exception is an aggregate, keep it around for later. Otherwise,
// simply add it to the list of flattened exceptions to be returned.
if (currentInnerAsAggregate != null){
exceptionsToFlatten.Add(currentInnerAsAggregate);
}
else{
flattenedExceptions.Add(currentInnerException);
}
}
}

return new AggregateException(Message, flattenedExceptions);
}

这段代码实现了一个FIFO队列,但并不是传统意义上的队列,没有出队列,只有入队列,通过一个递增索引记录处理到哪一个元素了。仔细琢磨,设计得还是挺不错的,简单实用。

从AggregateException看异常类的设计,布布扣,bubuko.com

时间: 2024-10-10 00:47:46

从AggregateException看异常类的设计的相关文章

通过寄生组合式继承创建js的异常类

最近项目中在做js的统一的异常处理,需要自定义异常类.理想的设计方案为:自定义一个异常错误类BaseError,继承自Error,然后再自定义若干个系统异常,例如用户取消异常.表单异常.网络异常,继承自BaseError.系统中,根据各个自定义异常做统一的异常处理,例如如果是用户发出取消操作指令,当前调用链则抛出一个用户取消异常,然后由统一异常处理捕获,先判断他是不是继承自BaseError,如果是则再根据事先定义好的处理方案处理. 为啥说这只是理想的设计方案呢?因为es5根本就没有提供js的继

类的继承与super()的意义以即如何写一个正确的异常类

这些东西都是我看了许多名师课程和自己研究的成果,严禁转载,这里指出了如何正确的自己定义一个异常类并看一看sun写的java的源代码话题一:子类的构造器执行是否一定会伴随着父类的构造执行? 1.this()与super()不能共存2.如果不显示地调用this()和super();子类对象的创建是否一定执行父类的构造3.既然super()和this()不能共存,又说子类的构造执行一定会执行父类的构造,那么我让子类的构造执行this()是不是就不能在执行父类的构造? 4.如果我非不让父类的构造执行,我

Core Java 经典笔试题总结(异常类问题)

所有代码均在本地编译运行测试,环境为 Windows7 32位机器 + eclipse Mars.2 Release (4.5.2) 2016-10-17 整理 下面的代码输出结果是多少?为什么?并由此总结几个编程规范. 1 class smallT { 2 public static void main(String args[]) { 3 smallT t = new smallT(); 4 int b = t.get(); 5 System.out.println(b); 6 } 7 8

闲话js前端框架(5)——再看自己一年前设计的微型渲染引擎

闲话js前端框架 前端人员=美工+设计+代码+测试 --题记 专题文章: 一.从avalonjs的模板说起 二.庞大的angularjs 三.再也不想碰DOM 四.组件化?有没有后端的事? 五.再看自己一年前设计的微型渲染引擎 六.在浏览器标准上做文章 七.抛开浏览器,构建应用容器 八.为何Flash.银光和Java都在网页端一蹶不振 本文属 西风逍遥游 原创, 转载请注明出处: 西风世界 http://blog.csdn.net/xfxyy_sxfancy 五.再看自己一年前设计的微型渲染引擎

java中异常类与类别

异常类的层次结构: 在 Java 中,所有的异常都有一个共同的祖先 Throwable(可抛出).Throwable 指定代码中可用异常传播机制通过 Java 应用程序传输的任何问题的共性,它们都在java.lang包下面. Error类标记了严重错误,类似内存溢出,虚拟机异常,等等,是不该出现的.这些错误表示故障发生于虚拟机自身.或者发生在虚拟机试图执行应用时,如Java虚拟机运行错误(Virtual MachineError).类定义错误(NoClassDefFoundError)等.这些错

表达式计算器类的设计5(面向对象的表达式计算器8)

计算器的github下载地址:https://github.com/ljian1992/calculator 概述 表达式计算器的类基本已经设计完成了,由于在程序运行的时候总会有这样那样的异常,例如:a +2, a没有初始化,对于异常的管理一般而言是需要自定义异常类.这个自定义异常类也是在继承了系统已经定义好的exception类,然后再重新定义内容. 异常的种类 语法异常---->SyntaxError类 赋值时左操作数不是变量:1 = 2; 缺少括号:1 + (2*2 不认识的函数: 函数缺

java中常见的异常类

1. java.lang.nullpointerexception   这个异常大家肯定都经常遇到,异常的解释是"程序遇上了空指针",简单地说就是调用了未经初始化的对象或者是不存在的对象,这个错误经常出现在创建图片,调用数组这些操作中,比如图片未经初始化,或者图片创建时的路径错误等等.对数组操作中出现空指针,很多情况下是一些刚开始学习编程的朋友常犯的错误,即把数组的初始化和数组元素的初始化混淆起来了.数组的初始化是对数组分配需要的空间,而初始化后的数组,其中的元素并没有实例化,依然是空

从MVC框架看MVC架构的设计

转自:http://blog.csdn.net/bluishglc/article/details/6690693 从MVC框架看MVC架构的设计 尽管MVC早已不是什么新鲜话题了,但是从近些年一些优秀MVC框架的设计上,我们还是会发现MVC在架构设计上的一些新亮点.本文将对传统MVC架构中的一些弊病进行解读,了解一些优秀MVC框架是如何化解这些问题的,揭示其中所折射出的设计思想与设计理念. MVC回顾   作为一种经典到不能再经典的架构模式,MVC的成功有其必然的道理,这个道理不同的人会有不同

C#高级编程八十天----异常类

异常类 在C#里,异常处理就是C#为处理错误情况提供的一种机制.它为每种错误情况提供了定制的处理方式,并且把标志错误的代码预处理错误的代码分离开来. 对.net类来说,一般的异常类System.Exception派生于System.Object.还有许多定义好的异常类(例如:System.SystemExpection,SYstem.ApplicationException等),他们又派生于System.Exception类.其中System.ApplicationException类是第三方定