Spring Data Envers: Audit With Entity Revisions
Sample application that demonstrates entity revisions with Spring Data Envers.
Background
Spring Data Jpa provides rough audit information. However if you are looking for what are the exact changes being made to an entity you can do so with Spring Data Envers.
As the name has suggested Spring Data Envers utilises and simplifies the usage of Hibernate Envers.
Dependency and Configuration
In order to enable Envers features we will first include spring-data-envers as dependency.
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-envers</artifactId>
</dependency>Next is to inform Spring Boot that we would like do enable Envers' features. This can be done by annotating a @Configuration
class with @EnableJpaRepositories(repositoryFactoryBeanClass = EnversRevisionRepositoryFactoryBean.class).
Example can be seen in RepositoryConfiguration:
@Configuration
@EnableJpaRepositories(
repositoryFactoryBeanClass = EnversRevisionRepositoryFactoryBean.class
)
public class RepositoryConfiguration {
}Enable Entity Audit
By annotating an @Entity with @Audited, we are informing Spring that we would like respective entity to be audited.
The following example shows that we want all activities related to Book to be audited:
@Entity
@Audited
public class Book {
@Id
@GeneratedValue
private Long id;
@NotBlank
private String author;
@NotBlank
private String title;
}Next is to extend a Repository class in order to allow us to utilise audit revision features. This can be done by extending
RevisionRepository interface to our Repository class. An example can be seen in BookRepository:
public interface BookRepository extends JpaRepository<Book, Long>, RevisionRepository<Book, Long, Integer> {
}Verification
We will be utilising on @SpringBootTest to verify that our implementation works.
Upon Creation an Initial Revision is Created
@SpringBootTest
class BookRepositoryRevisionsTest {
@Autowired
private BookRepository repository;
@Test
void initialRevision() {
Book book = repository.save(
Book.builder().author("Rudyard Kipling").title("Jungle Book").build()
);
Revisions<Integer, Book> revisions = repository.findRevisions(book.getId());
assertThat(revisions)
.isNotEmpty()
.allSatisfy(revision -> assertThat(revision.getEntity())
.extracting(Book::getId, Book::getAuthor, Book::getTitle)
.containsExactly(book.getId(), book.getAuthor(), book.getTitle())
);
}
}Revision Number Will Be Increase and Latest Revision is Available
@SpringBootTest
class BookRepositoryRevisionsTest {
@Autowired
private BookRepository repository;
@Test
void updateIncreasesRevisionNumber() {
Book book = repository.save(
Book.builder().author("Rudyard Kipling").title("Jungle Book").build()
);
book.setTitle("If");
repository.save(book);
Optional<Revision<Integer, Book>> revision = repository.findLastChangeRevision(book.getId());
assertThat(revision)
.isPresent()
.hasValueSatisfying(rev ->
assertThat(rev.getRevisionNumber()).hasValue(2)
)
.hasValueSatisfying(rev ->
assertThat(rev.getEntity())
.extracting(Book::getTitle)
.containsOnly("If")
);
}
}Upon Deletion All Entity Information Will be Removed Except its ID
@SpringBootTest
class BookRepositoryRevisionsTest {
@Autowired
private BookRepository repository;
@Test
void deletedItemWillHaveRevisionRetained() {
Book book = repository.save(
Book.builder().author("Rudyard Kipling").title("Jungle Book").build()
);
repository.delete(book);
Revisions<Integer, Book> revisions = repository.findRevisions(book.getId());
assertThat(revisions).hasSize(2);
Iterator<Revision<Integer, Book>> iterator = revisions.iterator();
Revision<Integer, Book> initialRevision = iterator.next();
Revision<Integer, Book> finalRevision = iterator.next();
assertThat(initialRevision)
.satisfies(rev ->
assertThat(rev.getEntity())
.extracting(Book::getId, Book::getAuthor, Book::getTitle)
.containsExactly(book.getId(), book.getAuthor(), book.getTitle())
);
assertThat(finalRevision)
.satisfies(rev -> assertThat(rev.getEntity())
.extracting(Book::getId, Book::getTitle, Book::getAuthor)
.containsExactly(book.getId(), null, null)
);
}
}All tests above can be found in BookRepositoryRevisionsTest.
License
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <http://unlicense.org/>