使用扩展方法对调用进行验证

作者 张逸 发布于 2009年3月27日 下午9时49分

社区

.NET

主题

.NET框架,

语法,

重用

标签

C#,

语言特性,

.NET Framework Programming

利用C# 3.0提供的扩展方法技术，可以为已经编译好的程序集类型增加新的方法，从而应对新的扩展。除了在可扩展性方面所具有的优势之外，如果能够合理地结合泛型与类型推断，扩展方法还可以有效降低代码的重复，提高程序的可重用性。例如，这样的方法实现：
public class CustomerDAL
{
    public IEnumerable FindCustomers(string roleName)
    {
        return from customer
             in context.Customer
             where customer.RoleName.Equals(roleName)
             select customer;
    }
}

调用如下方法，可能抛出NullReferenceException异常：
Customer customer = new CustomerDAL().FindCustomers(Role.Admin).First();

我们需要对返回结果进行验证，如果返回为null，则可以抛出自定义异常，或者创建一个空对象，例如：
public IEnumerable FindCustomers(string roleName)
{
    IEnumerable customers = from customer
             in context.Customer
             where customer.RoleName.Equals(roleName)
             select customer;
    if (customers == null)
    {
        throw new MyException("Cann't find the customers.");
    }
    return customers;
}

如果系统有许多方法都需要对返回结果进行验证，则这样的验证逻辑就会充斥在各个方法体中，既不利于重用，也会对未来的修改造成极大的阻碍。当然，我们可以引入Null Object模式来替代对null值的判断逻辑，但这种方式仍然需要为多种类型定义不同的Null Object类型。

Craig Andera在其博客文章中提出使用扩展方法对调用进行验证。他写道：

NullReferenceException异常会抛出，但是我们希望有更具体的异常信息。因此，我们编写了如下的扩展方法：

public static T OrThrow(this T obj, Exception e) {
    if (obj == null) {
        throw e; 
    } 
    return obj;
}

利用OrThrow扩展方法，则之前的调用方式可以修改为：

Customer customer = new CustomerDAL().FindCustomers(Role.Admin).OrThrow(new MyException("Can't find Customer")).First();

Craig Andera提出： 

OrThrow扩展方法对于你所要调用的类型而言是通用的，并且它返回了该类型，所以你可以将其插入到表达式链中，而不会丢失智能感应功能。并且因为类型推断功能，实际上并不需要指定具体的类型。

也就是说，OrThrow扩展方法可以应用到任何类型上，因此它可以在各种类型上重用非空验证甚至是调用验证。借鉴这一思想，我们还可以利用此方法默认实现对象实例的创建，以避免抛出NullReferenceException异常，例如：
public static T Instance(this T obj) where T:new()
{
    if (obj == null)
    {
        obj = new T();
    }

    return obj;
}

由于Instance扩展方法中的类型参数T需要创建实例，因此必须添加new()约束。所以该扩展方法存在一定的局限，例如无法应用在之前的IEnumerable类型上。但对于如下的方法却非常有效：
public class ListObject
{
    public List Foo()
    {
        return null;
    }
}

通过Instance扩展方法，可以安全地调用List的相关属性和方法，例如Count属性：
Console.WriteLine(new ListObject().Foo().Instance().Count);

控制台打印出来的结果为0。如果没有Instance扩展方法，则会抛出NullReferenceException异常。

作为C# 3.0增加的新特性，扩展方法在大量项目中得到了广泛地应用，但绝不仅仅是提高可扩展性这么简单。在进行项目开发时，若能适当地考虑使用扩展方法，说不定会带来出奇制胜的效果。

1. 返回顶部

   关于文章代码的几个问题

   2009年4月1日 上午2时58分 发表人 李 白

   第一 我在我的公共函数里面写了
   public static T Instance(this T obj) where T:new()
   {
   if (obj == null)
   {
   obj = new T();
   }
   
   return obj;
   }
   
   但是报错
   Constraints are not allowed on non-generic declarations

   回复

2. 返回顶部

   Instance函数

   2009年4月3日 上午3时0分 发表人 li qb

   public static T Instance<T>(this T obj) where T:new()
   {
   if (obj == null)
   {
   obj = new T();
   }
   
   return obj;
   }
   
   我的必须这样才通得过，大家有按文章上的那种通过的吗？该怎么写？</t>

   回复

3. 返回顶部

   Re: 关于文章代码的几个问题

   2009年4月3日 上午3时4分 发表人 li qb

   博客原文：
   public static T OrThrow<T>(this T obj, Exception e) {
   if (obj == null) {
   throw e;
   }
   return obj;
   }
   下面回复
   That should be
   
   public static T Instance<T>(this T obj) where T: new()
   
   The <T> indicates that the method is generic on
   
   InfoQ的编辑啊</t></t></t>

   回复

4. 返回顶部

   Re: 关于文章代码的几个问题

   2009年4月3日 上午4时1分 发表人 李 白

   thank you
   搞定！谢谢了 ！。。。估计编辑是忘记了:)

   回复

5. 返回顶部

   不是忘记，而是后台发布时，这些泛型参数被过滤了

   2009年5月3日 上午8时21分 发表人 逸 张

   文中的代码段依次为：
   1.
   public class CustomerDAL
   {
   public IEnumerable<Customer> FindCustomers(string roleName)
   {
   return from customer
   in context.Customer
   where customer.RoleName.Equals(roleName)
   select customer;
   }
   }
   2.
   public IEnumerable<Customer> FindCustomers(string roleName)
   {
   IEnumerable<Customer> customers = from customer
   in context.Customer
   where customer.RoleName.Equals(roleName)
   select customer;
   if (customers == null)
   {
   throw new MyException("Cann't find the customers.");
   }
   return customers;
   }
   3.
   public static T OrThrow<T>(this T obj, Exception e) {
   if (obj == null) {
   throw e;
   }
   return obj;
   }
   4.
   public static T NullObject<T>(this T obj) where T:new()
   {
   if (obj == null)
   {
   obj = new T();
   }
   return obj;
   }
   5.
   public class ListObject
   {
   public List<string> Foo()
   {
   return null;
   }
   }</string></t></t></customer></customer></customer>

   回复

6. 返回顶部

   Re: 关于文章代码的几个问题

   2009年5月3日 上午8时49分 发表人 逸 张

   在我的博客中，代码是正确的。
   
   www.agiledon.com/post/2009/03/Use-Extension-Met...

   回复

• 更早的 >