匹配神器Hamcrest

认识Hamcrest

Hamcrest是一个匹配工具，提供了常用的匹配的工具方法，主要在自动化测试匹配场景中使用，不过也可以用在其他场景下。下面是判断两个对象是否相等（如果是数组，则数组里面的元素需要全部相等并且顺序相同）的一个例子。

再看一个测试场景下的使用

个人认为hamcrest主要带来了两个好处

1. 算法的沉淀，将一些通用的匹配算法沉淀起来（其他人也可以扩展自己的匹配算法），可以方便的进行复用

2. 提供了更好的语义，可读性更强

内置的匹配器

从hamcrest包结构看主要有如下不同功能的内置匹配器

beans：主要包含属性匹配；属性值匹配等

collection：集合相关的匹配，例如是否包含某个元素，数组里的元素顺序等

comparator：比较器算法

core：提供了一些基础的匹配器，例如is，equals，any，all，contains等

io：文件的基本匹配

number：简单的数据比较

object：对象的一些匹配算法

text：字符串相关的匹配算法

xml：xmlpath的匹配算法

具体的每个匹配器可以通过源码查看https://github.com/hamcrest/JavaHamcrest

Hamcrest的结构

整体的架构

不过从功能来划分个人觉得新增一个matchers的包结构更清晰些

主要的接口与类

Matcher

其中matches方法并没有使用泛型而是Object，作者主要是想把匹配器（Matcher）与被匹配对象（matchee）分开，匹配器可以与被匹配对象类型不一致，具体的匹配类型校验由匹配器逻辑去控制，类似Object.equals，详见https://github.com/hamcrest/JavaHamcrest/pull/200#ref-pullrequest-548558670

另外_dont_implement_Matcher___instead_extend_BaseMatcher_这个方法是因为之前接口不支持default方法，为了方便之后扩展，因此加了这个方法提醒大家不要直接实现Matcher，而是通过继承BaseMatcher

函数的柯里化

另外Matcher也使用了函数的curry化，使用方法与java中的正则表达式匹配方式比较类似，将一部分参数作为匹配器的属性，然后去对参数对象进行匹配，这样的好处主要是：

1、可以减少参数数量，同时使每个匹配器（matcher）职责更单一，如果使用工具方法（例如MatcherUtil.equals(Object a, Object b)）,则该工具方法会膨胀的很快；

2、通过接口的统一，使用更方便，而且可以通过组合实现丰富的功能

3、可以对部分参数进行预处理，提高后续处理匹配的效率

可以参考下函数的curry化

Condition

Condition主要用在处理链中，下一步的输入是上一步的结果，就跟linux中的管道一样。Condition有两个核心方法，3个内部子类型（2个内部类，1个内部接口）

其中Step类似linux中的一个个命令，Condition与Matched，NotMatched组成了一个管道将各个Step串联起来，方式也跟之前说的curry化类似。

例如有一个场景：输入一个整数

1、第一步假如值大于1，值加1，否则匹配失败

2、第二步假如第一步值大于5，乘以2，否则匹配失败

3、第三步判断第二步值大于10，小于20

那我们实现一个Matcher如下

Condition主要可以沉淀Step操作，达到复用的效果（不然直接使用一个大方法简单明了，不需要绕来绕去了）

TypeSafeMatcher

由于Matcher接口的match方法是Object，在一些需要特定类型匹配的场景下为了防止类型转换异常，因此提供了TypeSafeMatcher,该类会根据matchesSafely方法的参数类型先做一次类型判断，只有类型判断通过才执行后续匹配操作，例如IsEmptyString；需要注意的是由于类型擦除，通过泛型计算出来的expectedType都是Object，例如HasProperty,因此其实通过泛型声明的匹配器依然不是类型安全的，例如下例中的整数1还是会被HasProperty的matchesSafely方法执行到。

另外还有一点值得注意是TypeSafeMatcher无法匹配null，如果需要匹配null需要自行处理。

欢迎关注 HelloWorld4J