JaVersの紹介

1. 概要

この記事では、JaVersライブラリについて説明します。

このライブラリは、プログラマが単純なJavaオブジェクトの状態の変化を調べて検出するのに役立ちます。コードで可変オブジェクトを使用すると、すべてのオブジェクトがアプリケーションのさまざまな場所で変更される可能性があります。 JaVers would help us discover and audit these changes。

2. メーベン依存

開始するには、javers-core Maven依存関係をpom.xmlに追加しましょう。


    org.javers
    javers-core
    3.1.0

最新バージョンはMaven Centralで見つけることができます。

3. POJO状態の変化の検出

単純なPersonクラスから始めましょう：

public class Person {
    private Integer id;
    private String name;

    // standard getters/constructors
}

アプリケーションの一部でPersonオブジェクトを作成し、コードベースの他の部分でthe person with the same idフィールドの名前が変更されたとします。それらを比較して、人物オブジェクトにどのような変更が発生したかを調べたいと思います。

JaVersクラスのcompare()メソッドを使用して、これら2つのオブジェクトを比較できます。

@Test
public void givenPersonObject_whenApplyModificationOnIt_thenShouldDetectChange() {
    // given
    Javers javers = JaversBuilder.javers().build();

    Person person = new Person(1, "Michael Program");
    Person personAfterModification = new Person(1, "Michael Java");

    // when
    Diff diff = javers.compare(person, personAfterModification);

    // then
    ValueChange change = diff.getChangesByType(ValueChange.class).get(0);

    assertThat(diff.getChanges()).hasSize(1);
    assertThat(change.getPropertyName()).isEqualTo("name");
    assertThat(change.getLeft()).isEqualTo("Michael Program");
    assertThat(change.getRight()).isEqualTo("Michael Java");
}

4. オブジェクトリストの状態変化の検出

オブジェクトのコレクションを操作している場合は、コレクション内の各要素を調べて、同様に状態の変化を調べる必要があります。時々、リストから特定のオブジェクトを追加または削除して、その状態を変更したいことがあります。

Let’s have a look at an example;オブジェクトのリストがあり、そのリストから1つのオブジェクトを削除するとします。

この変更は何らかの理由で望ましくない可能性があるため、このリストで発生した変更を監査する必要があります。 JaVersでは、compareCollections()メソッドを使用してこれを行うことができます。

@Test
public void givenListOfPersons_whenCompare_ThenShouldDetectChanges() {
    // given
    Javers javers = JaversBuilder.javers().build();
    Person personThatWillBeRemoved = new Person(2, "Thomas Link");
    List oldList =
      Lists.asList(new Person(1, "Michael Program"), personThatWillBeRemoved);
    List newList =
      Lists.asList(new Person(1, "Michael Not Program"));

    // when
    Diff diff = javers.compareCollections(oldList, newList, Person.class);

    // then
    assertThat(diff.getChanges()).hasSize(3);

    ValueChange valueChange =
      diff.getChangesByType(ValueChange.class).get(0);

    assertThat(valueChange.getPropertyName()).isEqualTo("name");
    assertThat(valueChange.getLeft()).isEqualTo("Michael Program");
    assertThat(valueChange.getRight()).isEqualTo("Michael Not Program");

    ObjectRemoved objectRemoved = diff.getChangesByType(ObjectRemoved.class).get(0);
    assertThat(
      objectRemoved.getAffectedObject().get().equals(personThatWillBeRemoved))
      .isTrue();

    ListChange listChange = diff.getChangesByType(ListChange.class).get(0);
    assertThat(listChange.getValueRemovedChanges().size()).isEqualTo(1);
}

5. オブジェクトグラフの比較

実際の単語アプリケーションでは、オブジェクトグラフを扱うことがよくあります。 Addressオブジェクトのリストを持つPersonWithAddressクラスがあり、指定された人の新しい住所を追加するとします。

発生した変更の種類を簡単に見つけることができます。

@Test
public void givenListOfPerson_whenPersonHasNewAddress_thenDetectThatChange() {
    // given
    Javers javers = JaversBuilder.javers().build();

    PersonWithAddress person =
      new PersonWithAddress(1, "Tom", Arrays.asList(new Address("England")));

    PersonWithAddress personWithNewAddress =
      new PersonWithAddress(1, "Tom",
        Arrays.asList(new Address("England"), new Address("USA")));


    // when
    Diff diff = javers.compare(person, personWithNewAddress);
    List objectsByChangeType = diff.getObjectsByChangeType(NewObject.class);

    // then
    assertThat(objectsByChangeType).hasSize(1);
    assertThat(objectsByChangeType.get(0).equals(new Address("USA")));
}

同様に、アドレスの削除が検出されます。

@Test
public void givenListOfPerson_whenPersonRemovedAddress_thenDetectThatChange() {
    // given
    Javers javers = JaversBuilder.javers().build();

    PersonWithAddress person =
      new PersonWithAddress(1, "Tom", Arrays.asList(new Address("England")));

    PersonWithAddress personWithNewAddress =
      new PersonWithAddress(1, "Tom", Collections.emptyList());


    // when
    Diff diff = javers.compare(person, personWithNewAddress);
    List objectsByChangeType = diff.getObjectsByChangeType(ObjectRemoved.class);

    // then
    assertThat(objectsByChangeType).hasSize(1);
    assertThat(objectsByChangeType.get(0).equals(new Address("England")));
}

6. 結論

この簡単な記事では、オブジェクトの状態変化を検出するためのAPIを提供する便利なライブラリであるJaVersライブラリを使用しました。単純なPOJOオブジェクトの変化を検出できるだけでなく、オブジェクトのコレクションやオブジェクトグラフのより複雑な変化も検出できます。

いつものように、コードはover on GitHubで利用できます。

TOC

JaVersの紹介