Hamcrest: 编写你自己的Matcher

自从Junit3引进Hamcrest匹配器框架以来，对用Java写单元测试在2个方面有极大的帮助，一个是测试的可读性，一个对失败测试的信息展示。

注：Hamcrest是一个开源的编写匹配器的框架，支持多种语言，Java，Python， Object-C和Ruby。你可以在Github看到所有的源代码：https://github.com/hamcrest

Hamcrest本身自带了很多常用的Matcher, 比方说 equalTo()， notNullValue()等等， 详细的信息可以在Hamcrest的官网查询到。 除了自带的Matcher以外，Hamcrest最大优势还在于你可以轻松的编写自己需要的matcher,以增加测试代码的可读性。例如：

假设你有一个Record对象，从中你可以析取出很多的对象，你想测试析取出对象的属性都来自于这个Record对象， 按照以前的做法，我们需要获取析取出的对象的每一个属性，然后去和原Record的对性属性值比较是否相等，当面对你一个有大量属性的对象时，毫无疑问会有一大堆的get方法，一大堆的equalTo， 我们为什么不能把这样的逻辑封装起来呢？ 下面我们就来看一下如何编写一个自己的Matcher。

首先，假设有如下的一个Record对象：

public class MyRecord {
    private String name;
    private int age;
    private String gender;

    private String address;
    private String phone;
    private String email;

我们会把该对象的address，phone，email属性，析取成一个Contact对象：

public Contact generateContact() {
        Contact contact = new Contact();
        contact.setEmail(email);
        contact.setPhone(phone);
        contact.setAddress(address);
        return contact;
    }

我希望的测试能够测试该析取方法，我的测试代码如下：

        @Test
        public void ContactShouldGenerateFromMyRecord() throws Exception {
            Contact contact = record.generateContact();
            assertThat(contact, is(generateFrom(record)));
        }
    
        @Test
        public void newCreateContactShouldNotGenerateFromMyRecord() throws Exception {
            Contact contact = new Contact();
            assertThat(contact, is(generateFrom(record)));
        }

这儿的generateFrom就是我定制的一个Matcher。实现一个Matcher很简单，只需要继承TypeSafeMatcher之类的Hamcrest开发出来的类，然后实现其中的abstract方法就行了。

public class GenerateFrom extends TypeSafeMatcher<Contact> {
        private MyRecord record;

        public GenerateFrom(MyRecord record) {
            this.record = record;
        }

        @Override
        public boolean matchesSafely(Contact item) {
            return StringUtils.equals(item.getAddress(),record.getAddress())
                    && StringUtils.equals(item.getEmail(),record.getEmail())
                    && StringUtils.equals(item.getPhone(),record.getPhone());
        }

        @Override
        public void describeTo(Description description) {
            description.appendValue("not extract from record");
        }

        @Factory
        public static Matcher<Contact> generateFrom(MyRecord record){
            return   new GenerateFrom(record);
        }
    }