Spring Data Domain Example搭配Auditable实体时Optional类型不匹配如何解决

Spring Data的Example查询默认会读取实体类所有可访问属性的getter返回值作为查询条件。你实现Auditable接口后，审计字段的getter返回值为Optional类型，你构造的查询模板实例中审计字段均为null，对应getter返回Optional.empty，Example会直接将这个Optional对象作为查询参数传入，而数据库对应字段的预期类型为LocalDateTime/String，类型不匹配触发报错。

方案1：临时指定ExampleMatcher忽略审计字段（全版本兼容） #

每次构造Example时指定匹配规则，手动排除四个审计字段，代码示例：

@Test
public void test()
{
    MyEntity entity = MyEntity.builder()
         .someField("someValue")
         .build();
    // 构造匹配器，忽略审计字段
    ExampleMatcher matcher = ExampleMatcher.matching()
            .withIgnorePaths("createdBy", "createdDate", "lastModifiedBy", "lastModifiedDate");
    List<MyEntity> entities = repository.findAll(Example.of(entity, matcher));
}

优点：无需修改实体类、不影响审计功能，适合临时查询场景，兼容所有Spring Data版本。

方案2：实体字段加@ExampleIgnore注解（Spring Data 2.7+ 推荐） #

Spring Data Commons 2.7及以上版本提供了@ExampleIgnore注解，标注的字段会自动被Example查询忽略，不需要每次手动配置匹配器。
修改实体类的审计字段：

// 审计字段
@Column(name = "my_table_created_by")
@CreatedBy
@org.springframework.data.repository.query.ExampleIgnore
private String createdBy;

@Column(name = "my_table_created_date")
@CreatedDate
@Type(type = "org.jadira.usertype.dateandtime.threeten.PersistentLocalDateTime")
@org.springframework.data.repository.query.ExampleIgnore
private LocalDateTime createdDate;

@Column(name = "my_table_last_modified_by")
@LastModifiedBy
@org.springframework.data.repository.query.ExampleIgnore
private String lastModifiedBy;

@Column(name = "my_table_last_modified_date")
@LastModifiedDate
@Type(type = "org.jadira.usertype.dateandtime.threeten.PersistentLocalDateTime")
@org.springframework.data.repository.query.ExampleIgnore
private LocalDateTime lastModifiedDate;

修改后原测试代码无需改动即可正常运行，审计功能也不受影响。

方案3：全局配置Example转换器处理Optional类型 #

如果项目中有大量实现了Auditable接口的实体，不想逐个配置忽略规则，可以给ExampleMatcher全局注册Optional类型转换器，自动提取Optional中的实际值：

ExampleMatcher matcher = ExampleMatcher.matching()
        .withIgnoreNullValues()
        .withTransformer(prop -> prop.map(val -> val instanceof Optional ? ((Optional<?>) val).orElse(null) : val));

所有Optional类型的返回值都会自动拆包，空Optional会被当成null处理，配合withIgnoreNullValues就会自动忽略未赋值的审计字段。

内容的提问来源于stack exchange，提问作者K.Vu