matchers.any_HamcrestMatchers的高级创建

matchers.any

介绍

上次&＃xff0c;我讨论了Hamcrest Matcher是什么&＃xff0c;它的用法以及制作方法。 在本文中&＃xff0c;我将解释创建Hamcrest Matchers的更多高级步骤。 首先&＃xff0c;我将分享如何使您的匹配器更易于类型安全&＃xff0c;然后介绍无状态匹配器的一些技术&＃xff0c;最后是如何减少测试类上的大量静态导入。 我还将给出一些有关命名静态工厂方法的快速提示。

类型安全匹配器

您可能已经在上次开发的matchs()方法中注意到了&＃xff0c;我在注释中指出&＃xff0c;我曾使用“ yoda条件”来避免null检查和类型检查。 首先&＃xff0c;自己对yoda条件进行一些研究不会有什么坏处(我可能有一天会发表一篇文章&＃xff0c;但不能保证)&＃xff0c;但是这里要注意的最大事情是某种类型检查和需要空检查。 这是因为matchs()方法接受一个对象&＃xff0c;而不是Generics参数中指定的类型。

如Hamcrest的文档中所述&＃xff1a;

此方法与Object匹配&＃xff0c;而不是与通用类型T匹配。这是因为Matcher的调用者在运行时不知道类型是什么(由于Java通用类型已擦除类型)。

因此&＃xff0c;我们需要确定要传入的对象的类型。此外&＃xff0c;我们还应确保没有传入空值(除非我们的特定Matcher可以这样做&＃xff0c;但这非常罕见)&＃xff0c;或者在至少要确保传入的null不会导致NullPointerException。

但是有一种更简单的方法&＃xff1a;TypeSafeMatcher。 如果扩展此类而不是BaseMatcher类&＃xff0c;它将为您执行类型检查和null检查&＃xff0c;然后将对象传递给仅采用泛型指定类型的匹配方法。

定义TypeSafeMatcher与我们上次定义Matcher的方法非常相似&＃xff0c;但有一些区别&＃xff1a;替代了match()&＃xff0c;而不是MatchsSafely()&＃xff0c;它接受了通用类型而不是Object&＃xff1b; 而不是覆盖describeMismatch()&＃xff0c;而是覆盖describeMismatchSafely()。 可能没有一个新的describeTo()可能令人惊讶&＃xff0c;但是看到它除了Description之外不包含其他任何内容&＃xff0c;因此不需要类型安全的版本。

否则&＃xff0c;创建TypeSafeMatcher几乎是相同的。

不过&＃xff0c;我不得不提我上周忘记的事情。 定义自己的匹配器的人不需要重写describeMismatch()或describeMismatchSafely()方法。 BaseMatcher和TypeSafeMatcher都具有那些方法的默认实现&＃xff0c;这些方法仅输出“ was item.toString() ”(如果TypeSafeMatcher获得的项目类型不正确&＃xff0c;则仅输出“ was itemClassName ( item.toString() )”)。

这些默认实现通常足够好&＃xff0c;但是如果使用的类型没有toString()的有用实现&＃xff0c;则使用您自己的不匹配消息来描述该项目的问题显然更有用。 即使该类具有不错的toString()实现&＃xff0c;我也总是这样做&＃xff0c;因为它可以更快地解决问题。

有关其他可扩展匹配器类的说明

Hamcrest核心库中还有其他几个Matcher类&＃xff0c;供用户从中扩展。 这些有几种口味。

首先&＃xff0c;有CustomMatcher和CustomTypeSafeMatcher。 这些设计用于通过匿名类创建一次性匹配器。 他们可能是有用的&＃xff0c;但我更愿意总是在情况下&＃xff0c;正确执行我曾经确实需要它一次。

接下来&＃xff0c;有DiagnosingMatcher和TypeSafeDiagnosingMatcher&＃xff0c;它们使您可以在match()方法中创建不匹配描述。 这似乎是用一块石头杀死两只鸟的好方法&＃xff0c;但是我有几块牛肉&＃xff1a;1)它违反了SRP 2)如果存在不匹配&＃xff0c;它再次调用matchs()方法只是为了填充在不匹配说明中。 因此&＃xff0c;第一个调用忽略获取描述&＃xff0c;第二个调用忽略匹配。

您可以扩展的最后一个特殊的Matcher是FeatureMatcher。 这可能非常有用&＃xff0c;但理解起来很复杂(我不确定我是否理解正确–直到我尝试自己动手做一个或阅读如何做一个为止)。 如果我弄清楚并获得了很好的理解&＃xff0c;我将在这里为您写另一篇文章。

无状态匹配器

不需要将任何内容传递到其构造函数(因此&＃xff0c;它是静态工厂方法)的任何Matcher都是无状态Matcher。 它们与其他Matcher相比有一个很小的优势&＃xff0c;因为您只需要在任何时候存在一个实例&＃xff0c;就可以在需要使用该Matcher的任何时间重用它。

这是一个非常简单的补充。 您需要做的就是创建该类的静态实例&＃xff0c;并使您的静态工厂返回该实例&＃xff0c;而不是调用构造函数。 库实际附带的IsEmptyString Matcher可以做到这一点(上一次我们的示例没有&＃xff0c;但这只是为了简单起见)。

减少静态进口数量

用Hamcrest Matchers编写了相当多的测试后&＃xff0c;您可能会注意到文件顶部有很多静态导入。 一段时间后&＃xff0c;这可能会成为很大的麻烦事&＃xff0c;因此&＃xff0c;让我们看一下可以减轻此问题的方法。

实际上&＃xff0c;这几乎与上一个解决方案一样简单。 您可以通过创建本质上为您完成的新类来减少静态导入。 这个新类具有烦人的静态导入&＃xff0c;但随后定义了自己的静态工厂方法&＃xff0c;这些方法委托给原始对象。 这是将一些核心Matchers组合到一个地方的示例&＃xff1a;

import org.hamcrest.core.IsEqual;
import org.hamcrest.core.IsNull;
import org.hamcrest.core.IsSame;
import org.hamcrest.Matcher;public class CoreMatchers
{public static Matcher equalTo(T object) {return IsEqual.equalTo(object);}public static Matcher notNullValue() {return IsNull.notNullValue();}public static Matcher notNullValue(Class type) {return IsNull.notNullValue(type);}public static Matcher nullValue() {return IsNull.nullValue();}public static Matcher nullValue(Class type) {return IsNull.nullValue(type);}public static Matcher sameInstance(T target) {return IsSame.sameInstance(target);}public static Matcher theInstance(T target) {return IsSame.theInstance(target);}
}

然后&＃xff0c;要使用任何或所有Matcher&＃xff0c;只需静态导入CoreMatchers。*还有一种生成这些组合Matcher类的方法&＃xff0c;如官方Hamcrest教程所示。 我不会继续讨论它&＃xff0c;因为它不在本文讨论范围之内&＃xff0c;而且我也不喜欢它。

结束提示&＃xff1a;命名

如果您阅读了官方的Hamcrest教程和/或查看了内置的Matchers&＃xff0c;您可能会注意到静态工厂方法的命名趋势。 通用语法匹配“断言testObject是factoryMethod ”。 方法名称的语法通常设计为可以在“ is”之前使用的当前时态动作。在命名自己的静态工厂方法时&＃xff0c;通常应遵循此约定&＃xff0c;但实际上我建议将“ is”放入名称中已经。 这样&＃xff0c;Matcher的用户无需将您的方法嵌套在is()方法内。 但是&＃xff0c;如果执行此操作&＃xff0c;则还需要创建反函数。 允许使用is()方法包装Matcher的原因是&＃xff0c;因此您也可以将其包装在not()方法中&＃xff0c;以测试已经测试的内容的逆函数。 这将导致类似“断言testObject不是factoryMethod ”的句子。如果您认为遵循约定对特定的Matcher来说过于严格&＃xff0c;则只需确保使用当前的时态动作测试即可。 例如&＃xff0c;我做了一个匹配器&＃xff0c;检查是否抛出了一个异常&＃xff0c;该异常的静态工厂方法是throwsA()。 我只是不喜欢将它命名为throwingA()以便与“ is”一起使用。 但是&＃xff0c;再次&＃xff0c;如果您违反了约定&＃xff0c;则必须确定要创建一个静态静态工厂方法。 例如&＃xff0c;如果您要实现自己的逆工厂&＃xff0c;最简单的方法通常是用not()包装正工厂。 因此&＃xff0c;我的nottThrowA()方法将返回not(throwsA())。 但是要小心&＃xff1a;有时候&＃xff0c;将正负错误简单地反转实际上并不能给出您想要的正确逆。

奥托罗

好吧&＃xff0c;这就是我为您准备的。 如果您想让我进一步了解Hamcrest Matchers&＃xff0c;请在评论中告诉我。 否则&＃xff0c;您可以在其github页面上的Hamcrest Matchers上进行自己的研究。下周&＃xff0c;我将讨论如何让您的Hamcrest Matchers以类似于AssertJ断言的流畅方式检查多个事情。

翻译自: https://www.javacodegeeks.com/2015/01/advanced-creation-of-hamcrest-matchers.html

matchers.any