TOC

Введение в JaVers

Введение в JaVers

1. обзор

В этой статье мы рассмотрим библиотекуJaVers.

Эта библиотека помогает программистам исследовать и обнаруживать изменения в состояниях простых объектов Java. Когда мы используем изменяемые объекты в нашем коде, каждый объект потенциально может быть изменен в различных местах приложения; JaVers would help us discover and audit these changes.

2. Maven Dependency

Для начала добавим зависимость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. Мы хотим сравнить их, чтобы выяснить, какие изменения произошли с объектом-человеком.

Мы можем сравнить эти два объекта, используя методcompare() из классаJaVers: 

@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; скажем, у нас есть список объектов, и мы удаляем один объект из этого списка.

Это изменение может быть нежелательным по какой-то причине, и мы хотим провести аудит изменений, которые произошли в этом списке. 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. Сравнение графов объектов

В реальных текстовых приложениях мы часто имеем дело с графами объектов. Допустим, у нас есть классPersonWithAddress, в котором есть список объектовAddress, и мы добавляем новый адрес для данного человека.

Мы можем легко найти тип произошедшего изменения: 

@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. Заключение

В этой быстрой статье мы использовали библиотеку JaVers, полезную библиотеку, которая предоставляет нам API для обнаружения изменений состояния в наших объектах. Он не только может обнаружить изменение в простом объекте POJO, но также может обнаружить более сложные изменения в коллекциях объектов или даже в графах объектов.

Как всегда доступен кодover on GitHub.

Related