Elasticsearch Auditing（es的审计功能）

在Spring Data Elasticsearch中，提供了审计功能。即数据的创建人、创建时间、最后修改人等等，都是可以记录追踪的。本文示例如何使用Spring Data的审计功能。

目录

一、数据实体类实现Persistable接口

二、提供AuditorAware

三、激活审计功能

四、测试

---

一、数据实体类实现Persistable接口

package cn.jack.elasticsearchdemo.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.elasticsearch.client.security.user.User;
import org.springframework.data.annotation.*;
import org.springframework.data.domain.Persistable;
import org.springframework.data.elasticsearch.annotations.DateFormat;
import org.springframework.data.elasticsearch.annotations.Document;
import org.springframework.data.elasticsearch.annotations.Field;
import org.springframework.data.elasticsearch.annotations.FieldType;

import java.time.Instant;
import java.util.List;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Document(indexName = "jack_person")
@TypeAlias("human")
public class Person implements Persistable<String> {
    @Id
    private String id;
    @Field(fielddata = true)
    private String name;
    private String gender;

    private Book book;
    private List<String> hobbies;

    @Transient
    private String abc;

    // ========= 审计需要的相关字段 =========
    @Field(type = FieldType.Date, format = DateFormat.basic_date_time)
    @CreatedDate
    private Instant createdDate;
    @CreatedBy
    private User createdBy;
    @Field(type = FieldType.Date, format = DateFormat.basic_date_time)
    @LastModifiedDate
    private Instant lastModifiedDate;
    @LastModifiedBy
    private User lastModifiedBy;

    /**
     * to determine if an enitity is new in Elasticsearch
     * @return
     */
    @Override
    public boolean isNew() {
        return id == null
                || (createdDate == null && createdBy == null);
    }
}

二、提供AuditorAware

提供AuditorAware，让审计模块知道当前是谁在操作。

package cn.jack.elasticsearchdemo.config;

import org.elasticsearch.client.security.user.User;
import org.springframework.data.domain.AuditorAware;
import org.springframework.stereotype.Component;

import java.util.Arrays;
import java.util.Optional;

@Component  // 交由spring管理，否则无法获取用户信息
public class EsAuditorAware implements AuditorAware<User> {
    @Override
    public Optional<User> getCurrentAuditor() {
        // 模拟获取当前用户
        User user = new User("jack", Arrays.asList("ROLE_ADMIN"));

        return Optional.ofNullable(user);

        /**
         * 如果权限模块使用的是Spring Security，可以使用以下代码获取当前用户
         */
        /*return Optional.ofNullable(SecurityContextHolder.getContext())
                .map(SecurityContext::getAuthentication)
                .filter(Authentication::isAuthenticated)
                .map(Authentication::getPrincipal)
                .map(User.class::cast);*/
    }
}

三、激活审计功能

在java config配置类，或者application主类上，通过@EnableElasticsearchAuditing注解激活审计功能。

package cn.jack.elasticsearchdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.data.elasticsearch.client.ClientConfiguration;
import org.springframework.data.elasticsearch.client.reactive.ReactiveElasticsearchClient;
import org.springframework.data.elasticsearch.client.reactive.ReactiveRestClients;
import org.springframework.data.elasticsearch.config.EnableElasticsearchAuditing;
import org.springframework.data.elasticsearch.repository.config.EnableElasticsearchRepositories;
import org.springframework.http.HttpHeaders;

import java.time.Duration;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)		// 项目没有用到关系型数据库，排除此类，避免启动异常
@EnableElasticsearchRepositories(basePackages = "cn.jack.elasticsearchdemo.repository")	// dao所在包名，不加此配置则需要每个dao都加上@Repository注解交由spring管理
@EnableElasticsearchAuditing	// 激活审计功能
public class ElasticsearchdemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(ElasticsearchdemoApplication.class, args);
	}
}

四、测试

使用junit进行单元测试。

@RunWith(SpringRunner.class)
@SpringBootTest(classes = ElasticsearchdemoApplication.class)
@Slf4j
public class EsTest {
    @Autowired
    private PersonRepository personRepository;

    @Test
    public void testAuditing() {
        Person person = new Person();
        person.setName("审计测试5");
        this.personRepository.save(person);
        System.out.println(person);

        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }

        person.setHobbies(Arrays.asList("跳舞"));
        this.personRepository.save(person);
        System.out.println(person);
    }
}

通过控制台输出可以确定，审计功能生效。

Person(id=Ozxk_XQBrwRoe5ExL8Fn, name=审计测试5, gender=null, book=null, hobbies=null, abc=null, createdDate=2020-10-06T10:10:35.418001600Z, createdBy=User[username=jack,roles=[ROLE_ADMIN],metadata={},fullName=null,email=null], lastModifiedDate=2020-10-06T10:10:35.418001600Z, lastModifiedBy=User[username=jack,roles=[ROLE_ADMIN],metadata={},fullName=null,email=null])
Person(id=Ozxk_XQBrwRoe5ExL8Fn, name=审计测试5, gender=null, book=null, hobbies=[跳舞], abc=null, createdDate=2020-10-06T10:10:35.418001600Z, createdBy=User[username=jack,roles=[ROLE_ADMIN],metadata={},fullName=null,email=null], lastModifiedDate=2020-10-06T10:10:36.617001600Z, lastModifiedBy=User[username=jack,roles=[ROLE_ADMIN],metadata={},fullName=null,email=null])