The Problem
We use spring-data-solr in our project - as we like its conversion feature which can convert string to enum, entity to json data and etc, and vice versa, and recently we need use Solr's nested documents feature which spring-data-solr doesn't support.
Issues in Spring-data-solr
SolrInputDocument class contains a Map _fields AND List _childDocuments.
Spring-data-solr converts java entity class to SolrDocument. It provides two converters: MappingSolrConverter and SolrJConverter.
MappingSolrConverter converts the entity to a Map: MappingSolrConverter.write(Object, Map, SolrPersistentEntity)
SolrJConverter uses solr's DocumentObjectBinder to convert entity to SolrInputDocument,
it will convert field that is annotated with @Field(child = true) to child documents.
- This also means that spring-data-solt's convert features will not work with SolrJConverter
BUT SolrJConverter still just thinks SolrInputDocument is a map and add all into the destination: Map sink
- SolrJConverter.write(Object, Map)
After this, the child documents is discarded.
The Fix
We still want to use spring-data-solr's conversion functions - partly because we don't want to rewrite everything to use SolrJ directly.
So when save to solr: we uses spring-data-solr's MappingSolrConverter to convert parent entity as solrInputDocument, then convert child entities as solrInputDocuments and add them into parent's solrInputDocument.
When read from solr, we read the SolrDocument as parent entity, then read its child documents as child entities and add them into parent entity.
Mix Spring Data Solr and SolrJ in Solr Cloud 5
SolrJ: Support Converter and make it easier to extend DocumentObjectBinder
We use spring-data-solr in our project - as we like its conversion feature which can convert string to enum, entity to json data and etc, and vice versa, and recently we need use Solr's nested documents feature which spring-data-solr doesn't support.
Issues in Spring-data-solr
SolrInputDocument class contains a Map
MappingSolrConverter converts the entity to a Map: MappingSolrConverter.write(Object, Map, SolrPersistentEntity)
SolrJConverter uses solr's DocumentObjectBinder to convert entity to SolrInputDocument,
it will convert field that is annotated with @Field(child = true) to child documents.
- This also means that spring-data-solt's convert features will not work with SolrJConverter
BUT SolrJConverter still just thinks SolrInputDocument is a map and add all into the destination: Map sink
- SolrJConverter.write(Object, Map)
After this, the child documents is discarded.
The Fix
We still want to use spring-data-solr's conversion functions - partly because we don't want to rewrite everything to use SolrJ directly.
So when save to solr: we uses spring-data-solr's MappingSolrConverter to convert parent entity as solrInputDocument, then convert child entities as solrInputDocuments and add them into parent's solrInputDocument.
When read from solr, we read the SolrDocument as parent entity, then read its child documents as child entities and add them into parent entity.
public class ParentEntity {
@Field(child = true)
private List<ChildEntity> children;
}
@Autowired
protected SolrClient solrClient;
// we add our own converters into MappingSolrConverter
// for more, please check
// http://lifelongprogrammer.blogspot.com/2015/09/mix-spring-data-solr-and-solrj-in-solr.html
@Autowired
protected MyMappingSolrConverter solrConverter;
public void save(@Nonnull final ParentEntity parentEntity) {
final SolrInputDocument solrInputDocument = solrConverter.createAndWrite(parentEntity);
daddChildDocuemnts(parentEntity, solrInputDocument);
try {
solrClient.add(getCollection(), solrInputDocument);
solrClient.commit(getCollection());
} catch (SolrServerException | IOException e) {
throw new BusinessException(e, "failed to save " + parentEntity);
}
}
protected void daddChildDocuemnts(@Nonnull final ParentEntity parentEntity,
@Nonnull final SolrInputDocument solrInputDocument) {
solrInputDocument.addChildDocuments(parentEntity.getChildren().stream()
.map(child -> solrConverter.createAndWrite(child)).collect(Collectors.toList()));
}
public List<T> querySolr(final SolrParams query) {
try {
final QueryResponse response = solrClient.query(getCollection(), query);
return convertFromSolrDocs(response.getResults());
} catch (final Exception e) {
throw new BusinessException("data retrieve failed." + query);
}
}
/*
* Also return child documents in solr response as ChildEntity if it exists
*/
protected List<ParentEntity> convertFromSolrDocs(final SolrDocumentList docList) {
List<ParentEntity> result = new ArrayList<>();
if (docList != null) {
result = docList.stream().map(solrDoc -> {
final ParentEntity parentEntity = solrConverter.read(ParentEntity.class, solrDoc);
final List<SolrDocument> childDocs = solrDoc.getChildDocuments();
if (childDocs != null) {
ParentEntity.setChildren(
childDocs.stream().map(childSolrDoc -> solrConverter.read(ChildEntity.class, solrDoc))
.collect(Collectors.toList()));
}
return parentEntity;
}).collect(Collectors.toList());
}
return result;
}
Related
Mix Spring Data Solr and SolrJ in Solr Cloud 5
SolrJ: Support Converter and make it easier to extend DocumentObjectBinder
