使用Spring Data Elasticsearch时,@Document映射对象返回为null
异常问题
使用spring-data-elasticsearch
集成至spring时,使用@Document声明索引及文档信息,已确保返回数据不为空,但在json字符串与Java对象转换时,字段属性都为null。
问题分析
@Document是属于Meta Model Object Mapping
对象转换方案,因此要将Elasticsearch Object Mapping
中的EntityMapper
接口具体实现指定为Meta Model Object Mapping
。
可在org.springframework.data.elasticsearch.core.ElasticsearchEntityMapper
的方法下设置断点查看具体_source
返回的字符串:
@Override
public <T> T mapToObject(String source, Class<T> clazz) throws IOException {
return read(clazz, objectReader.readValue(source));
}
解决方案
1. 更换集成版本为:spring-data-elasticsearch.jar:4.0.1.RELEASE
。
在Object Mapping的方案中,已经移除Jackson2
实现,默认使用ElasticsearchEntityMapper
。
2. 配置Object Mapping的方案,改为ElasticsearchEntityMapper
,默认是Jackson2
实现。
当前引用的jar包spring-data-elasticsearch.jar:3.2.0.RELEASE
默认使用的Object Mapping方式:
AbstractElasticsearchConfiguration already defines a Jackson2 based entityMapper via ElasticsearchConfigurationSupport.
需要将Object Mapping具体实现改为ElasticsearchEntityMapper
,让@Document与Elasticsearch的“_source”的内容映射匹配。参考AbstractElasticsearchConfiguration.entityMapper()
方法:
@Slf4j
@Configuration
@EnableElasticsearchRepositories(basePackages = "com.example.demo.dao")
public class RestClientConfig extends AbstractElasticsearchConfiguration {
@Value("${es.address-port:}")
String esAddressPort;
@Override
public RestHighLevelClient elasticsearchClient() {
// 密钥控制
String keystorePassword = "xxx";
String user = "xxx";
String password = "xxx";
try {
// linux 对应路径 /truststore.jks
File keystoreFilesContent = new ClassPathResource("/truststore.jks").getFile();
final SSLContext sslContext = SSLContexts.custom()
.loadTrustMaterial(keystoreFilesContent, keystorePassword.toCharArray(), new TrustSelfSignedStrategy()).build();
CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
credentialsProvider.setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(user, password));
if (StringUtils.isEmpty(esAddressPort)){
throw new IllegalArgumentException("param: es.address-port is invalid");
}
String[] address = esAddressPort.split(",");
final ClientConfiguration clientConfiguration = ClientConfiguration.builder()
.connectedTo(address)
.usingSsl(sslContext)
.withBasicAuth(user,password)
.build();
RestHighLevelClient client = RestClients.create(clientConfiguration).rest();
return client;
} catch (IOException | NoSuchAlgorithmException | KeyStoreException | CertificateException | KeyManagementException e) {
e.printStackTrace();
log.error("证书错误:{}", e.getMessage());
}
return null;
}
/**
* @Title: 自定义Object与json实体转换
* @Desc: 使用ElasticsearchEntityMapper转换对象
* @Author: heaventzhuo
* @Date: 2021-06-15 16:55:17
* @Param: []
* @Return: org.springframework.data.elasticsearch.core.EntityMapper
**/
@Bean
@Override
public EntityMapper entityMapper() {
ElasticsearchEntityMapper entityMapper = new ElasticsearchEntityMapper(elasticsearchMappingContext(), new DefaultConversionService());
entityMapper.setConversions(elasticsearchCustomConversions());
return entityMapper;
}
}
可能存在问题
如果确保Meta Model Object Mapping
已正确配置,依然返回对象为null的问题,请检查Java对象属性使用@Field
定义的es数据类型(type)、json映射名称(name/value)是否与Elasticsearch的mapping定义一致。