Hibernate Envers审核数据反向排序，分页Thymeleaf示例

Myth丶恋晨 2023-09-25 13:38 53阅读 0赞

**Hibernate Envers**是一个**实现持久实体的审核和版本控制的**模块。审计和版本控制是构建生产级[Spring 启动微服务][Spring]的关键组件。Hibernate Envers与Spring Boot无缝集成以实现相同的目标。

在这篇文章中，我们将在我们的[Spring Boot Starter][]应用程序中集成Hibernate Envers。

**数据库审核**对于合规性非常重要。此外，很多时候，必须分析生产问题。对于这样的分析，审计数据非常有用。

### Hibernate Envers POM Dependency ###

将 Hibernate Envers 与 Spring Boot 一起使用的第一步是将依赖项包含在 POM 文件中。

<dependency>
    			<groupId>org.hibernate</groupId>
    			<artifactId>hibernate-envers</artifactId>
    			<version>5.3.1.Final</version>
    </dependency>

### 为休眠实体启用审核 ###

下一步是简单地为所需实体启用审核。这可以通过使用**@Audited**注释轻松完成。

@Entity
    @Table(name = "vehicle")
    @Audited
    public class Vehicle {
    
        @Id
        private UUID id;
    
        private String vehicleIdentityNumber;
    
        private String make;
    
        private String model;
    
        private String status;
    
        public Vehicle() {
        }
    
        public UUID getId() {
            return id;
        }
    
        public void setId(UUID id) {
            this.id = id;
        }
    
        public String getVehicleIdentityNumber() {
            return vehicleIdentityNumber;
        }
    
        public void setVehicleIdentityNumber(String vehicleIdentityNumber) {
            this.vehicleIdentityNumber = vehicleIdentityNumber;
        }
    
        public String getMake() {
            return make;
        }
    
        public void setMake(String make) {
            this.make = make;
        }
    
        public String getModel() {
            return model;
        }
    
        public void setModel(String model) {
            this.model = model;
        }
    
        public String getStatus() {
            return status;
        }
    
        public void setStatus(String status) {
            this.status = status;
        }
    
        @Override
        public String toString() {
            return "Vehicle{" +
                    "id=" + id +
                    ", vehicleIdentityNumber='" + vehicleIdentityNumber + '\'' +
                    ", make='" + make + '\'' +
                    ", model='" + model + '\'' +
                    ", status='" + status + '\'' +
                    '}';
        }
    }

只需对实体类进行注释，**Envers Hibernate**就会为**审计**注册此类类。换句话说，这意味着除了主表之外，还将为此类实体创建审计表。

但是，要创建实际表，最直接的方法是使用休眠设置。这是通过使用*hibernate.hbm2ddl.auto*选项并将其设置为*创建*。

此设置在*应用程序属性*文件中完成。

spring.datasource.url=jdbc:h2:mem:mytestdb
    spring.datasource.driverClassName=org.h2.Driver
    spring.datasource.username=sa
    spring.datasource.password=
    spring.jpa.hibernate.ddl-auto=create

> 请注意，休眠自动创建选项对于生产不安全。

### 休眠者在行动 ###

我们可以通过启动 Spring Boot 应用程序来查看休眠审核日志记录的运行情况。应用程序启动后，我们可以访问*h2控制台*

![8d7dfea810a0d95bc2c498155a867416.png][]

这到底是怎么回事呢？

如您所见，我们有预期的**车辆**表。除此之外，我们还有一个名为**VEHICLE\_AUD**的新表。审核表包含原始表中的所有字段。

但是，还添加了两个新字段。首先是 REVTYPE 字段。其中包含“0”表示*添加*，“1”表示*更新*，“2”表示*删除。*另一个字段是 REV 字段。

生成另一个表。它被称为**REVINFO。**它包含两个字段*REV*和*REVTSTMP*。**VEHICLE\_AUD**中的 *REV*字段基本上是**REVINFO**表中*REV*字段的外键。**REVINFO**表跟踪每个事务。

### 休眠者在行动 ###

为了测试Hibernate Envers和审计日志记录，我们可以使用我们的载具端点触发一些事务。

当我们使用 POST 操作之类的操作创建新记录，然后使用 PUT 操作对其进行更新时，我们会在 VEHICLE\_AUD 表中得到两条记录。

![011878fe419e937b6eb9b2e7315f9b92.png][]

如您所见，ID 是***c7a2ac1750fd4e12877efc76b3743646。***

有两条记录具有此 ID。一个的 REVTYPE 为 0（创建），而另一个的 REVTYPE 为 1（更新）。

![f3421143f34a6a834153474f95333622.png][]

**REVINFO**表跟踪所有修订。如果您仔细观察，**VEHICLE\_AUD**表中的*REV*字段是**REVINFO**表中*REV*字段的外键。

### 审核数据反向排序，分页，在Thymeleaf中展示 ###

控制器

package com.example;
    
    import jakarta.persistence.EntityManager;
    import jakarta.persistence.PersistenceContext;
    import java.util.ArrayList;
    import java.util.List;
    import org.hibernate.envers.AuditReader;
    import org.hibernate.envers.AuditReaderFactory;
    import org.hibernate.envers.RevisionType;
    import org.hibernate.envers.query.AuditEntity;
    import org.hibernate.envers.query.AuditQuery;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    
    @Controller
    public class RevisionController {
    
        @Autowired
        ProductRepository repository;
    
        @PersistenceContext
        private EntityManager entityManager;
    
        @RequestMapping("/revision/user")
    
        public String getAll(Model model, @RequestParam(required = false) String keyword,
                @RequestParam(defaultValue = "1") int page, @RequestParam(defaultValue = "10") int size) {
    
            List<UserRevisionDTO> listUserRevisionDTOs = new ArrayList();
            AuditReader reader = AuditReaderFactory.get(entityManager);
    
            int numberOfElements;
            Long totalItems;
            Long totalPages;
            AuditQuery queryCount;
            AuditQuery query;
            if (keyword == null || keyword.isBlank()) {
                System.out.println("!!keyword=null");
                queryCount = reader.createQuery()
                        .forRevisionsOfEntity(User.class, false, true)
                        .addProjection(AuditEntity.revisionNumber().count());
                totalItems = (Long) queryCount.getSingleResult();
                System.out.println("!!totalItems=" + totalItems);
    
                if (totalItems % size == 0) {
                    totalPages = totalItems / size;
                } else {
                    totalPages = totalItems / size + 1;
                }
    
                System.out.println("!!totalPages=" + totalPages);
                query = reader.createQuery()
                        .forRevisionsOfEntity(User.class, false, true)
                        .setFirstResult((page - 1) * size)
                        .setMaxResults(size)
                        .addOrder(AuditEntity.revisionNumber().desc());
    
    //        query.add(AuditEntity.revisionProperty("username").eq("admin"));
                //This return a list of array triplets of changes concerning the specified revision.
                // The array triplet contains the entity, entity revision information and at last the revision type.
                List<Object[]> revs = (List<Object[]>) query.getResultList();
                numberOfElements = revs.size();
                for (Object[] rev : revs) {
                    UserRevisionDTO userRevisionDTO = new UserRevisionDTO();
                    userRevisionDTO.setUser((User) rev[0]);
                    userRevisionDTO.setUserRevEntity((UserRevEntity) rev[1]);
                    userRevisionDTO.setRevisionType((RevisionType) rev[2]);
                    listUserRevisionDTOs.add(userRevisionDTO);
                    System.out.println(((User) rev[0]).getUsername());
                    User user = (User) rev[0];
                    UserRevEntity userRevEntity = (UserRevEntity) rev[1];
                    RevisionType type = (RevisionType) rev[2];
                    System.out.println(user);
                    System.out.println(userRevEntity);
                    System.out.println(userRevEntity.getId());
                    System.out.println(userRevEntity.getRevisionDate());
                    System.out.println(userRevEntity.getUsername());
                    System.out.println(type.name());
                }
    
            } else {
                System.out.println("!!keyword!=null");
                queryCount = reader.createQuery()
                        .forRevisionsOfEntity(User.class, false, true)
                        .add(AuditEntity.property("username").like("%" + keyword + "%"))
                        .addProjection(AuditEntity.revisionNumber().count());
                totalItems = (Long) queryCount.getSingleResult();
                System.out.println("!!totalItems=" + totalItems);
    
                if (totalItems % size == 0) {
                    totalPages = totalItems / size;
                } else {
                    totalPages = totalItems / size + 1;
                }
    
                System.out.println("!!totalPages=" + totalPages);
                query = reader.createQuery()
                        .forRevisionsOfEntity(User.class, false, true)
                        .add(AuditEntity.property("username").like("%" + keyword + "%"))
                        .setFirstResult((page - 1) * size)
                        .setMaxResults(size)
                        .addOrder(AuditEntity.revisionNumber().desc());
    
    //        query.add(AuditEntity.revisionProperty("username").eq("admin"));
                //This return a list of array triplets of changes concerning the specified revision.
                // The array triplet contains the entity, entity revision information and at last the revision type.
                List<Object[]> revs = (List<Object[]>) query.getResultList();
                numberOfElements = revs.size();
                for (Object[] rev : revs) {
                    UserRevisionDTO userRevisionDTO = new UserRevisionDTO();
                    userRevisionDTO.setUser((User) rev[0]);
                    userRevisionDTO.setUserRevEntity((UserRevEntity) rev[1]);
                    userRevisionDTO.setRevisionType((RevisionType) rev[2]);
                    listUserRevisionDTOs.add(userRevisionDTO);
                    System.out.println(((User) rev[0]).getUsername());
                    User user = (User) rev[0];
                    UserRevEntity userRevEntity = (UserRevEntity) rev[1];
                    RevisionType type = (RevisionType) rev[2];
                    System.out.println(user);
                    System.out.println(userRevEntity);
                    System.out.println(userRevEntity.getId());
                    System.out.println(userRevEntity.getRevisionDate());
                    System.out.println(userRevEntity.getUsername());
                    System.out.println(type.name());
                }
    
                model.addAttribute("keyword", keyword);
            }
    
            System.out.println();
            model.addAttribute("listUserRevisionDTOs", listUserRevisionDTOs);
    
            model.addAttribute("currentPage", page);
            model.addAttribute("totalItems", totalItems);
            model.addAttribute("totalPages", totalPages);
            model.addAttribute("pageSize", size);
            model.addAttribute("numberOfElements", numberOfElements);
    
            return "revision/list_user_revision";
        }
    
    }

页面模板

<!DOCTYPE html>
    <html xmlns:th="http://www.thymeleaf.org" xmlns:sec="http://www.thymeleaf.org">
        <head>
            <meta charset="utf-8">
            <meta content="width=device-width, initial-scale=1.0" name="viewport">
            <title>Dashboard - Admin Bootstrap Template</title>
            <meta name="robots" content="noindex, nofollow">
            <meta content="" name="description">
            <meta content="" name="keywords">
            <link rel="icon" th:href="@{/assets/img/favicon.png}"  />
            <link rel="stylesheet" type="text/css" th:href="@{/webjars/bootstrap/css/bootstrap.min.css}" />
            <link rel="stylesheet" type="text/css" th:href="@{/webjars/font-awesome/css/all.min.css}"/>
            <link rel="stylesheet" type="text/css" th:href="@{/webjars/bootstrap-icons/font/bootstrap-icons.css}"/>
            <link rel="stylesheet" type="text/css" th:href="@{/assets/css/style.css}" />
            <link rel="stylesheet" type="text/css" th:href="@{/css/style.css}" />
    
            <link rel="stylesheet" type="text/css" th:href="@{/webjars/tabulator-tables/dist/css/tabulator.min.css}" />
            <script type="text/javascript" th:src="@{/webjars/tabulator-tables/dist/js/tabulator.min.js}"></script>
        </head>
        <body>
            <header id="header" class="header fixed-top d-flex align-items-center" th:replace="fragments/header :: header">
            </header>
            <aside id="sidebar" class="sidebar" th:replace="fragments/sidebar :: sidebar">
            </aside>
            <main id="main" class="main">
                <div class="pagetitle">
                    <nav>
                        <ol class="breadcrumb">
                            <li class="breadcrumb-item"><a href="index.html">主页</a></li>
                            <li class="breadcrumb-item active">用户审计</li>
                        </ol>
                    </nav>
                </div>
                <section class="section dashboard">
                    <div class="row">
                        <div class="col-lg-12">
                            <div class="card">
                                <div class="card-body">
    
                                    <br/>
                                    <br/>
                                    <div class="table-title">
                                        <div class="row">
                                            <div class="col-sm-6">
                                                <h2><b>用户审计</b></h2>
                                            </div>
                                        </div>
                                    </div>
    
                                    <div class="my-3 ">
    
                                        <div class="row d-flex flex-row">
                                            <form th:action="@{/revision/user}" id="searchForm" >
                                                <div class="row">
                                                    <div class="col-sm-8">
                                                        <div class="col-md-12 mt-2">
                                                            <div class="search">
                                                                <i class="fa fa-search"></i>
                                                                <input id="keyword" type="search" name="keyword" th:value="${keyword}" required class="form-control"
                                                                       placeholder="Enter keyword">
                                                                <button type="submit" class="btn btn-secondary">搜索</button>
                                                            </div>
                                                        </div>
                                                    </div>
                                                    <div class="col-sm-3">
                                                        <div class="col-md-12 input-group mt-2">
                                                            <div class="input-group-prepend">
                                                                <label class="input-group-text" for="pageSize">每页显示行数:</label>
                                                            </div>
                                                            <select form="searchForm" name="size" th:value="${pageSize}" onchange="changePageSize()" class="size-select"
                                                                    id="pageSize">
                                                                <option th:each="s : ${ {10, 25, 50} }" th:value="${s}" th:text="${s}" th:selected="${s == pageSize}"></option>
                                                            </select>
                                                        </div>
                                                    </div>
                                                    <div class="col-sm-1">
                                                        <div class="col-md-12 mt-2">
                                                            <button id="btnClear" class="btn btn-info">重置</button>
                                                        </div>
                                                    </div>
                                                </div>
                                            </form>
                                        </div>
    
                                    </div>
    
                                    <table id="revision-table" class="table table-striped table-hover">
                                        <thead>
                                            <tr>
                                                <th>用户ID</th>
                                                <th>用户账号</th>
                                                <th>密码</th>
                                                <th>启用</th>
                                                <th>账号未过期</th>
                                                <th>密码未过期</th>
                                                <th>账号未锁定</th>
                                                <th>E-mail</th>
                                                <th>姓名</th>
                                                <th>主页</th>
                                                <th>角色</th>
                                                <th>密码更改时间</th>
                                                <th>登录失败次数</th>
                                                <th>账号锁定时间</th>
                                                <th>REVID</th>
                                                <th>操作账号</th>
                                                <th>操作类型</th>
                                                <th>操作时间</th>
                                            </tr>
                                        </thead>
                                        <tbody>
                                            <tr th:each="userRevisionDTO : ${listUserRevisionDTOs}">
                                                <td th:text="${userRevisionDTO.user.id}">User ID</td>
                                                <td th:text="${userRevisionDTO.user.username}">User Name</td>
                                                <td th:text="${userRevisionDTO.user.password}">password</td>
                                                <td th:text="${userRevisionDTO.user.enabled}">enabled</td>
                                                <td th:text="${userRevisionDTO.user.accountNonExpired}">accountNonExpired</td>
                                                <td th:text="${userRevisionDTO.user.credentialsNonExpired}">credentialsNonExpired</td>
                                                <td th:text="${userRevisionDTO.user.accountNonLocked}">accountNonLocked</td>
                                                <td th:text="${userRevisionDTO.user.email}">E-mail</td>
                                                <td th:text="${userRevisionDTO.user.name}">Name</td>
                                                <td th:text="${userRevisionDTO.user.homepage}">Home Page</td>
                                                <td th:text="${userRevisionDTO.user.roles}">Roles</td>
                                                <td th:text="${#calendars.format(userRevisionDTO.user.passwordChangedTime,'yyyy-MM-dd HH:mm:ss.SSS')}">passwordChangedTime</td>
                                                <td th:text="${userRevisionDTO.user.failedAttempt}">failedAttempt</td>
                                                <td th:text="${userRevisionDTO.user.lockTime}">lockTime</td>
                                                <td th:text="${userRevisionDTO.userRevEntity.id}">REVID</td>
                                                <td th:text="${userRevisionDTO.userRevEntity.username}">操作账号</td>
                                                <td th:text="${userRevisionDTO.revisionType.name()}">操作类型</td>
                                                <td th:text="${#dates.format(userRevisionDTO.userRevEntity.revisionDate,'yyyy-MM-dd HH:mm:ss.SSS')}">操作时间</td>
                                            </tr>
    
    
                                        </tbody>
                                    </table>
    
                                    <script>
                                        var table = new Tabulator("#revision-table", {});
                                    </script>
    
                                    <div class="row">
                                        <div class="col-sm-6">
                                            <div th:if="${totalPages > 0}">
                                                总计<span th:text="${totalItems}">99</span>行，当前显示<span th:text="(${currentPage} - 1)*${pageSize} +1">1</span> -
                                                <span th:text="(${currentPage} - 1)*${pageSize} +${numberOfElements}">5</span>行   总计<span th:text="${totalPages}">99</span>页
                                            </div>
                                        </div>
                                        <div class="col-sm-6">
                                            <nav aria-label="Pagination" th:if="${totalPages > 0}">
                                                <ul class="pagination justify-content-center">
                                                    <li class="page-item" th:classappend="${currentPage == 1} ? 'disabled'">
                                                        <a class="page-link"
                                                           th:href="@{'/revision/user?' + ${keyword!=null && keyword!=''? 'keyword=' + keyword + '&' : ''} + 'page=' +'1'+ '&size=' + ${pageSize}}"
                                                           title="First Page" rel="First Page">
                                                            最前页
                                                        </a>
                                                    </li>
                                                    <li class="page-item font-weight-bold" th:classappend="${currentPage == 1} ? 'disabled'">
                                                        <a class="page-link"
                                                           th:href="@{'/revision/user?' + ${keyword!=null && keyword!=''? 'keyword=' + keyword + '&' : ''} + 'page=' + ${currentPage - 1} + '&size=' + ${pageSize}}"
                                                           title="Previous Page" rel="Previous Page">
                                                            前一页
                                                        </a>
                                                    </li>
                                                    <li class="page-item disabled" th:if="${currentPage - 2 > 1}">
                                                        <a class="page-link" href="#">...</a>
                                                    </li>
                                                    <li class="page-item" th:classappend="${page == currentPage} ? 'active'"
                                                        th:each="page : ${#numbers.sequence(currentPage > 2 ? currentPage - 2 : 1, currentPage + 2 < totalPages ? currentPage + 2 : totalPages)}">
                                                        <a class="page-link"
                                                           th:href="@{'/revision/user?' + ${keyword!=null && keyword!=''? 'keyword=' + keyword + '&' : ''} + 'page=' + ${page} + '&size=' + ${pageSize}}"
                                                           th:title=${page} th:rel=${page}>
                                                            [[${page} ]]
                                                        </a>
                                                    </li>
                                                    <li class="page-item disabled" th:if="${currentPage + 2 < totalPages}">
                                                        <a class="page-link" href="#">...</a>
                                                    </li>
                                                    <li class="page-item font-weight-bold" th:classappend="${currentPage == totalPages} ? 'disabled'">
                                                        <a class="page-link"
                                                           th:href="@{'/revision/user?' + ${keyword!=null && keyword!=''? 'keyword=' + keyword + '&' : ''} + 'page=' + ${currentPage + 1} + '&size=' + ${pageSize}}"
                                                           title="Next Page" rel="Next Page">
                                                            后一页
                                                        </a>
                                                    </li>
                                                    <li class="page-item" th:classappend="${currentPage == totalPages} ? 'disabled'">
                                                        <a class="page-link"
                                                           th:href="@{'/revision/user?' + ${keyword!=null && keyword!=''? 'keyword=' + keyword + '&' : ''} + 'page=' +${totalPages}+ '&size=' + ${pageSize}}"
                                                           title="Last Page" rel="Last Page">
                                                            最后页
                                                        </a>
                                                    </li>
                                                </ul>
                                            </nav>
                                        </div>
                                    </div>
                                </div>
                            </div>
                        </div>
                    </div>
                </section>
            </main>
            <footer id="footer" class="footer" th:replace="fragments/footer :: footer">
                <div class="copyright"> © Copyright <strong><span>Compnay Name</span></strong>. All Rights Reserved</div>
                <div class="credits"> with love <a href="https://freeetemplates.com/">FreeeTemplates</a></div>
            </footer>
            <a href="#" class="back-to-top d-flex align-items-center justify-content-center"><i
                    class="bi bi-arrow-up-short"></i></a>
            <script type="text/javascript" th:src="@{/webjars/jquery/jquery.min.js}"></script>
            <script type="text/javascript" th:src="@{/webjars/bootstrap/js/bootstrap.bundle.min.js}"></script>
            <script type="text/javascript" th:src="@{/assets/js/main.js}" ></script>
            <script type="text/javascript">
                $(document).ready(function () {
                    $(".btn-delete").on("click", function (e) {
                        e.preventDefault();
                        link = $(this);
    
                        tutorialTitle = link.attr("tutorialTitle");
                        $("#yesBtn").attr("href", link.attr("href"));
                        $("#confirmText").html("Do you want to delete the Tutorial \<strong\>" + tutorialTitle + "\<\/strong\>?");
                        var myModal = new bootstrap.Modal(document.getElementById('confirmModal'), {
                            keyboard: false
                        });
                        myModal.toggle();
                    });
    
                    $("#btnClear").on("click", function (e) {
                        e.preventDefault();
                        $("#keyword").text("");
                        window.location = "[[@{/revision/user}]]";
                    });
                });
    
                function changePageSize() {
                    $("#searchForm").submit();
                }
            </script>
        </body>
    </html>

### ![065e49647a864a25a56ff78cd11dd033.png][] ###

![83830f17ba0f4b1f894eb45d227e87c9.png][]

![aed5248010ef4e7ba40caa868c6dbd34.png][]

![5af28a132b2d40e1a6c3f687aa9435ca.png][]

![6e9af68de4e04bf4be69fbb61a14d51c.png][]

###  ###

### 结论 ###

**Hibernate Envers**是一个非常强大的解决方案，可以满足Spring应用程序中的审计日志记录需求。

它也与Spring Boot无缝契合。这允许为*Spring 引导微服务*启用**休眠审核日志记录**。只需使用注释并将依赖项包含在 POM 文件中，即可轻松设置它。

这篇文章的代码现在可以在[Github][]上找到。

[Spring]: https://progressivecoder.com/2019/03/spring-boot-microservices-fastest-production-ready-microservices/
[Spring Boot Starter]: https://github.com/dashsaurabh/spring-boot-starter
[8d7dfea810a0d95bc2c498155a867416.png]: https://img-blog.csdnimg.cn/img_convert/8d7dfea810a0d95bc2c498155a867416.png
[011878fe419e937b6eb9b2e7315f9b92.png]: https://img-blog.csdnimg.cn/img_convert/011878fe419e937b6eb9b2e7315f9b92.png
[f3421143f34a6a834153474f95333622.png]: https://img-blog.csdnimg.cn/img_convert/f3421143f34a6a834153474f95333622.png
[065e49647a864a25a56ff78cd11dd033.png]: https://img-blog.csdnimg.cn/065e49647a864a25a56ff78cd11dd033.png
[83830f17ba0f4b1f894eb45d227e87c9.png]: https://img-blog.csdnimg.cn/83830f17ba0f4b1f894eb45d227e87c9.png
[aed5248010ef4e7ba40caa868c6dbd34.png]: https://img-blog.csdnimg.cn/aed5248010ef4e7ba40caa868c6dbd34.png
[5af28a132b2d40e1a6c3f687aa9435ca.png]: https://img-blog.csdnimg.cn/5af28a132b2d40e1a6c3f687aa9435ca.png
[6e9af68de4e04bf4be69fbb61a14d51c.png]: https://img-blog.csdnimg.cn/6e9af68de4e04bf4be69fbb61a14d51c.png
[Github]: https://github.com/dashsaurabh/spring-boot-starter/tree/hibernate-envers-basic