专栏首页.Net Core技术分享设计模式:规约模式(Specification-Pattern)

设计模式:规约模式(Specification-Pattern)

“其实地上本没有路,走的人多了,也便成了路”——鲁迅《故乡》

这句话很好的描述了设计模式的由来。前辈们通过实践和总结,将优秀的编程思想沉淀成设计模式,为开发者提供了解决问题的思路。除此之外,设计模式还是开发者之间沟通的桥梁,是程序员的语言,比如我说这段代码用的是单例模式,你就知道它的基本实现和用法。因此非常有必要弄清楚常用的设计模式。

前辈们有很多优秀的设计模式文章和图书,而本系列是我的学习笔记,我会尽量清晰易懂的将自己知道的分享出来,如果有不准确的地方请及时指正 ^_^

本文来讲解《规约模式(Specification-Pattern)》

什么是规约模式?

规约模式经常在DDD中使用,用来将业务规则(通常是隐式业务规则)封装成独立的逻辑单元,从而将隐式业务规则提炼为显示概念,并达到代码复用的目的。

讲理论就是很枯燥,比如上面这段定义,虽然说明白了什么是规约模式,但是又引入了两个概念:隐式业务规则和显示概念。太无趣了,我决定皮一下子……

  • 什么是隐式业务规则?假如你开发了一个网站,你的目标用户是18岁以上人群,你懂的,当地的政策不允许18岁以下浏览。那么你该如何验证注册用户是否符合要求呢?
public ActionResult Register(UserRegisterInfo user){
    if(user.Age < 18){
        throw new Exception("Too young too simple...");
    }
    
    //todo:注册逻辑
}

在Register方法中if语句就是一条隐式业务规则。

当然这样写也能满足业务规则,但是改天新来一个叫王二的程序员,没闹明白为啥要加if判断、或者没闹明白为啥是18,本万物皆可盘的态度盘了这段代码,程序仍然照常运行,王二也很开心,但是业务完整性就被破坏了。因此就需要将隐式的业务规则提炼成现实概念。

  • 什么是显示概念?显示概念跟隐式业务规则相对应,意味着我们要把上面代码中的if判断提炼出来了。
public ActionResult Register(UserRegisterInfo user){
    var specification = new UserMustBeAdultSpecification();
    if(!specification.IsSatisfiedBy(user)){
        throw new Exception("Too young too simple...");
    }
    
    //todo:注册逻辑
}

class UserMustBeAdultSpecification {
    private int adultAge;
    public UserMustBeAdultSpecification(int adultAge = 18){
        this.adultAge = adultAge;
    }
    
    public IsSatisfiedBy(UserRegisterInfo user){
        return user.Age > this.adultAge;
    }
}

我们把if判断提炼成一个显示概念,用来确认用户必须是成人。这样王二来了以后,也不至于揣着明白装糊涂。

为什么需要规约模式?

这里先说一下为什么需要把隐式业务规则转变为显示概念?通常我们的业务规则不会仅仅验证一下年龄这么简单,例如订单提交,你可能需要验证用户账号是否可用、订单商品的库存是否满足预定量、配送地址是否完整……如果仅仅是通过一连串的if判断,那就真的太不利于维护了,并且if嵌套的多了代码难于理解,不好说明白具体意图。因此需要将隐式业务规则转换成显示概念,这也是DDD的要求。

如果上面的例子还不能很好的打动你,我们再举一个栗子。

你的网站不仅仅需要注册吧,它可能还有更新用户信息的功能,更新的时候我们仍然需要确认用户必须是成人,看吧,提炼的显示概念再一次派上用场,达到了代码复用的目的,这样就满足了DRY的要求。

另外,规约模式还有一个更加常用的场景,就是进行数据查询,继续往下看……

如何实现规约模式?

规约模式要求我们每个规约都要有一个bool IsSatisfiedBy(model)方法,用来验证模型是否满足规约要求,我们上面的例子就是典型的规约类,但是没有进行任何抽象。

规约的另一个更常用的用途是进行数据筛选,而我们的筛选条件通常是复杂的,因此规约还要实现链式操作。因此需要进行抽象,到达操作一致的目的。

以下代码来自codeproject,不喜勿喷,熟悉的直接绕道最后一段。

定义接口:

public interface ISpecification<T>    {
    bool IsSatisfiedBy(T o);
    ISpecification<T> And(ISpecification<T> specification);
    ISpecification<T> Or(ISpecification<T> specification);
    ISpecification<T> Not(ISpecification<T> specification);
}

每个规约实现四个方法:IsSatisfiedBy()、And()、Or()、Not()。IsSatisfiedBy()方法主要实现业务规则,而其它三个则用来将复合业务规则连在一起。

来看它的抽象实现:

public abstract class CompositeSpecification<T> : ISpecification<T>     
{
    public abstract bool IsSatisfiedBy(T o);

    public ISpecification<T> And(ISpecification<T> specification)       
    {
        return new AndSpecification<T>(this, specification);
    }
    public ISpecification<T> Or(ISpecification<T> specification)        
    {
        return new OrSpecification<T>(this, specification);
    }
    public ISpecification<T> Not(ISpecification<T> specification)       
    {
        return new NotSpecification<T>(specification);
    }
}

对于所有复合规约来说,And()、Or()、Not()方法都是相同的,只有IsSatisfiedBy()方法会有区别。接来下看一下链式规约的实现,分别对应And()、Or()、Not()方法:

public class AndSpecification<T> : CompositeSpecification<T>    
{
    ISpecification<T> leftSpecification;
    ISpecification<T> rightSpecification;

    public AndSpecification(ISpecification<T> left, ISpecification<T> right)  {
        this.leftSpecification = left;
        this.rightSpecification = right;
    }

    public override bool IsSatisfiedBy(T o)   {
        return this.leftSpecification.IsSatisfiedBy(o) 
            && this.rightSpecification.IsSatisfiedBy(o);
    }
}

public class OrSpecification<T> : CompositeSpecification<T>    
{
    ISpecification<T> leftSpecification;
    ISpecification<T> rightSpecification;

    public AndSpecification(ISpecification<T> left, ISpecification<T> right)  {
        this.leftSpecification = left;
        this.rightSpecification = right;
    }

    public override bool IsSatisfiedBy(T o)   {
        return this.leftSpecification.IsSatisfiedBy(o) 
            || this.rightSpecification.IsSatisfiedBy(o);
    }
}

public class NotSpecification<T> : CompositeSpecification<T>    
{
    ISpecification<T> specification;

    public AndSpecification(ISpecification<T> specification)  {
        this.specification = specification;
    }

    public override bool IsSatisfiedBy(T o)   {
        return !this.specification.IsSatisfiedBy(o);
    }
}

Linq表达式规约

当规约用于数据查询时,使用Linq表达式规约将非常有用。但是,这种方式与规约模式的初衷相悖,因为我们再一次把业务规则隐藏在了Linq表达式中。

基于表达式的规约

public class ExpressionSpecification<T> : CompositeSpecification<T>   {
    private Func<T, bool> expression;
    public ExpressionSpecification(Func<T, bool> expression)    {
        if (expression == null)
            throw new ArgumentNullException();
        else
            this.expression = expression;
    }

    public override bool IsSatisfiedBy(T o)   {
        return this.expression(o);
    }
}

看完代码你会发现,只要你愿意,表达式规约能够满足你几乎所有需求。因此说它是一种反模式,是违背初衷的用法。为啥还要列出来呢?对于查询来说太强大了……此处可以写一篇《论提升规约模式十倍生产力的方法》。

代码的用法

我们依然复制codeproject上面的代码:

class Program
{
    static void Main(string[] args)
    {
        List<Mobile> mobiles = new List<Mobile> { 
            new Mobile(BrandName.Samsung, Type.Smart, 700), 
            new Mobile(BrandName.Apple, Type.Smart), 
            new Mobile(BrandName.Htc, Type.Basic), 
            new Mobile(BrandName.Samsung, Type.Basic) };

        ISpecification<Mobile> samsungExpSpec =
           new ExpressionSpecification<Mobile>(o => o.BrandName == BrandName.Samsung);
        ISpecification<Mobile> htcExpSpec =
           new ExpressionSpecification<Mobile>(o => o.BrandName == BrandName.Htc);
        ISpecification<Mobile> SamsungHtcExpSpec =  samsungExpSpec.Or(htcExpSpec);        
        ISpecification<Mobile> NoSamsungExpSpec = 
          new ExpressionSpecification<Mobile>(o => o.BrandName != BrandName.Samsung);

        var samsungMobiles = mobiles.FindAll(o => samsungExpSpec.IsStatisfiedBy(o));
        var htcMobiles = mobiles.FindAll(o => htcExpSpec.IsStatisfiedBy(o));
        var samsungHtcMobiles = mobiles.FindAll(o => SamsungHtcExpSpec.IsStatisfiedBy(o));
        var noSamsungMobiles = mobiles.FindAll(o => NoSamsungExpSpec.IsStatisfiedBy(o));
    }
}

组合查询:

ISpecification<Mobile> complexSpec = (samsungExpSpec.Or(htcExpSpec)).And(brandExpSpec);

非Linq用法:

public class PremiumSpecification<T> : CompositeSpecification<T>
{
    private int cost;
    public PremiumSpecification(int cost) {
        this.cost = cost;
    }
 
    public override bool IsSatisfiedBy(T o) {
        return (o as Mobile).Cost >= this.cost;
    }
}

组合用法:

ISpecification<Mobile> premiumSpecification = new PremiumSpecification<Mobile>(600);
ISpecification<Mobile> linqNonLinqExpSpec = NoSamsungExpSpec.And(premiumSpecification); 

探讨:与CQRS的冲突,该如何选择?

在《CQRS vs Specification pattern》中,作者指出,规约模式提倡将验证和查询复用同一个逻辑单元,而在CQRS中,验证是在Command中的逻辑,查询是在Query中的逻辑,CQRS提倡命令和查询进行分离,从而构建低耦合的系统。

那么该如何选择呢?是选择SRP还是放弃DRY?

参考资料

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 【转】Log4Net五步走

    原文链接:http://www.cnblogs.com/heroman/archive/2006/01/09/314053.html

    thz
  • [转]ASP.NET 缓存:方法和最佳实践

      原文链接:http://msdn.microsoft.com/zh-cn/library/aa478965.aspx

    thz
  • C#访问SFTP:Renci.SshNet.Async

    SFTP是SSH File Transfer Protocol的缩写,安全文件传送协议。安全文件传送协议。可以为传输文件提供一种安全的网络的加密方法。sftp ...

    thz
  • Sublime Text 3使用出现中文乱码

    Sublime Text 3 是一个非常不错的源代码及文本编辑器,但是不支持GB2312和GBK编码在很多情况下会非常麻烦。

    泰斗贤若如
  • 教你如何解决Sublime Text 3使用中出现的中文乱码问题

    Sublime Text 3 是一个非常不错的源代码及文本编辑器,但是不支持GB2312和GBK编码在很多情况下会非常麻烦。

    黑泽君
  • car_demo代码简介

    该程序是基于ros和gazebo的。ros简单来讲就是一个robot OS(机器人操作系统),它使你简单方便地制作机器人(具体优点就不说了,感兴趣的可以自己g...

    用户1908973
  • 诚邀您参加腾讯 2020 Techo Park 开发者大会区块链专场

    代码传递思想 技术创造回响 ? Techo Park开发者大会是由腾讯发起的面向全球开发者和技术爱好者的年度盛会,作为一个专注于前沿技术研讨盛会,大会致力于开...

    腾讯云计算产品团队
  • 『7.16-7.22』数字资产交易所情报纵览

    据火币公告显示,火币集团正式推出火币云业务,致力于提供数字资产交易所一站式解决方案,支持合作伙伴快速搭建安全、稳定的数字资产交易所。据悉,目前已有包括Dbank...

    金融科技先驱者
  • 1分钟链圈 | GitHub活跃度排名:EOS跃居第2,BTC第21;布比完成1亿元融资;SEC向80家数字货币公司发出传票

    区块链大本营
  • HTML5离线缓存攻击测试

    本实验采用局域网模拟,通过修改本地HOSTS文件来模拟域名以及DNS欺骗。合法网站使用Linux CentOS7的apache服务器搭建,IP为192.168....

    ascii0x03

扫码关注云+社区

领取腾讯云代金券