Spring Data Envers：使用实体修订进行审计

朴灿烈づ我的快乐病毒、 2023-09-25 13:42 35阅读 0赞

使用Spring Data Envers演示实体修订的示例应用程序。

## 背景 ##

[Spring Data Jpa][]提供粗略的审计信息。但是，如果您正在寻找确切的变化是什么 制作到一个实体，你可以用[Spring Data Envers][] 这样做。

顾名思义，[Spring Data][Spring Data Envers]Envers利用并简化了[Hibernate Envers][]的使用。

## 依赖关系和配置 ##

为了启用 Envers 功能，我们首先将**spring-data-envers**作为依赖项包含在内。

<dependency>
      <groupId>org.springframework.data</groupId>
      <artifactId>spring-data-envers</artifactId>
    </dependency>

接下来是通知Spring Boot我们希望启用Envers的功能。这可以通过注释 aclass with 来完成。`@Configuration``@EnableJpaRepositories(repositoryFactoryBeanClass = EnversRevisionRepositoryFactoryBean.class)`

示例可以在[存储库配置][Link 1]中看到：

@Configuration
    @EnableJpaRepositories(
            repositoryFactoryBeanClass = EnversRevisionRepositoryFactoryBean.class
    )
    public class RepositoryConfiguration {
    }

### 启用实体审核 ###

通过注释anwith，我们通知Spring我们希望对各自的实体进行审计。 以下示例显示我们希望审核与[Book][]相关的所有活动：`@Entity``@Audited`

@Entity
    @Audited
    public class Book {
    
        @Id
        @GeneratedValue
        private Long id;
    
        @NotBlank
        private String author;
    
        @NotBlank
        private String title;
    
    }

接下来是扩展 aclass，以便允许我们利用审计修订功能。这可以通过将[RevisionRepository][]接口扩展到我们的类来完成。在[BookRepository][] 中可以看到一个例子：`Repository``Repository`

public interface BookRepository extends JpaRepository<Book, Long>, RevisionRepository<Book, Long, Integer> {
    
    }

### 验证 ###

我们将利用来验证我们的实施是否有效。`@SpringBootTest`

#### 创建时创建初始修订 ####

@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())
                    );
        }
    }

#### 修订号将增加，最新版本可用 ####

@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")
                    );
        }
    }

#### 删除后，除其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)
                    );
        }
    }

以上所有测试都可以在[BookRepositoryRevisionsTest][] 中找到。

[Spring Data Jpa]: https://projects.spring.io/spring-data-jpa/
[Spring Data Envers]: http://projects.spring.io/spring-data-envers/
[Hibernate Envers]: http://hibernate.org/orm/envers/
[Link 1]: https://github.com/rashidi/spring-data-envers-audit-entity/blob/master/src/main/java/rz/demo/boot/data/envers/RepositoryConfiguration.java
[Book]: https://github.com/rashidi/spring-data-envers-audit-entity/blob/master/src/main/java/rz/demo/boot/data/envers/book/Book.java
[RevisionRepository]: https://github.com/spring-projects/spring-data-commons/blob/master/src/main/java/org/springframework/data/repository/history/RevisionRepository.java
[BookRepository]: https://github.com/rashidi/spring-data-envers-audit-entity/blob/master/src/main/java/rz/demo/boot/data/envers/book/BookRepository.java
[BookRepositoryRevisionsTest]: https://github.com/rashidi/spring-data-envers-audit-entity/blob/master/src/test/java/rz/demo/boot/data/envers/book/BookRepositoryRevisionsTest.java