Liferay 7.3.5GA6 自定义索引搜索和ddmFieldArray
Liferay 7.3.5GA6 custom index search and ddmFieldArray
我正在尝试使用 SearchContext、IndexSearcherHelperUtil 和所有其他东西为 Liferay 7.3.5 GA6 开发自定义 Web 内容搜索 portlet。
我有一些具有不同字段的 DDMStructure，从我在 elasticsearch 索引上看到的，这些字段在嵌套文档中索引，如下所示：
"ddmFieldArray": [
{
"ddmFieldName": "ddm__text__37702__nome_it_IT",
"ddmValueFieldName": "ddmFieldValueText_it_IT",
"ddmFieldValueText_it_IT": "Nome esempio",
"ddmFieldValueText_it_IT_String_sortable": "nome esempio"
}
,
{
"ddmFieldName": "ddm__text__37702__descrizione_breve_it_IT",
"ddmValueFieldName": "ddmFieldValueText_it_IT",
"ddmFieldValueText_it_IT": "Esempio di descrizione breve da indicizzare",
"ddmFieldValueText_it_IT_String_sortable": "esempio di descrizione breve da indicizzare"
}
]
这与我过去知道的旧方法不同，自定义字段的索引方式如 ddm__[keyword/text]__[structure_id]__[field_name]
现在，我知道这种不同的索引方式是为了避免弹性问题（已超过总字段限制）而进行的改进，但是...执行搜索后，没有 ddmFieldArray 在 com.liferay.portal.kernel.search.Document .getFields 中，所以我无法从弹性搜索索引中获取 ddmstructure 字段值。
代码如下：
long journalArticleClassId = ClassNameLocalServiceUtil.getClassNameId(JournalArticle.class.getName());
SearchContext searchContext = new SearchContext();
searchContext.setClassTypeIds(new long[] {journalArticleClassId});
searchContext.setCompanyId(companyId);
searchContext.setStart(QueryUtil.ALL_POS);
searchContext.setEnd(QueryUtil.ALL_POS);
BooleanQuery query = new BooleanQueryImpl();
MatchQuery approvedQuery = new MatchQuery(Field.STATUS, String.valueOf(WorkflowConstants.STATUS_APPROVED));
query.add(approvedQuery, BooleanClauseOccur.MUST.getName());
Hits resultHits = IndexSearcherHelperUtil.search(searchContext, query);
for (Document doc: resultHits.getDocs()) {
doc.getFields().forEach((k, v) -> _log.debug(k)); //No ddm structure field
}
这仍然是一种改进还是只是一种意外行为？
有什么方法可以解决或扩展这个问题吗？
谢谢
“ddmFieldArray”字段是嵌套字段，默认不返回。
您必须从存储在 Elasticsearch 内部“_source”字段中的文档源字段中获取它（参见 https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-fields.html ）
为了在 Liferay 中执行此操作，您必须使用旧 portal-kernel 搜索 类 中不可用的一些搜索方法，您必须使用位于 modules/apps/portal-search[=45 中的 portal-search-api 模块中可用的新搜索 类 =]
这些是您必须对代码应用的更改：
- 在执行搜索之前，您必须在搜索中添加“fetchSource”标志并添加以下代码：
searchRequestBuilderFactory.builder(
searchContext
).fetchSource(
true
).build();
- 执行搜索后，您必须从 SearchResponse 对象中获取 Document 对象。此 SearchResponse 在 searchContext 中可用，使用此代码：
/* Execute search */
IndexSearcherHelperUtil.search(searchContext, query);
/* Get results from search response */
SearchResponse searchResponse = searchContext.getAttribute("search.response");
List<SearchHit> resultHits = searchResponse.getSearchHits().getSearchHits();
/* Iterate */
for (SearchHit searchHit : resultHits) {
Document doc = searchHit.getDocument();
...your stuff...
}
您在以下 Liferay 类:
中有一些关于获取源和获取 SearchResponse 的示例
- com.liferay.document.library.search.test.DLSearchFixture，请参阅方法 searchOnlyOneSearchHit，其中设置了 fetchSource(true) 并且 SearchResponse 对象是从 searchContext
中获取的
- com.liferay.account.internal.retriever.AccountOrganizationRetrieverImpl 其中一些搜索是使用 SearchRequest 和 SearchResponse 完成的。
- com.liferay.asset.internal.util.AssetHelperImpl 使用 searchRequestBuilderFactory 的地方。
我还实现了一个 groovy 脚本示例，您可以从以下位置执行它：控制面板 => 服务器管理 => 脚本
import com.liferay.registry.*;
import com.liferay.portal.kernel.search.*;
import com.liferay.portal.kernel.search.generic.*;
import com.liferay.portal.search.legacy.searcher.SearchRequestBuilderFactory;
import com.liferay.portal.search.searcher.SearchResponse;
import com.liferay.portal.search.hits.SearchHit;
import com.liferay.portal.search.document.Document;
/* Get SearchRequestBuilderFactory reference using RegistryUtil, because we cannot use "@Reference" in a groovy script */
Registry registry = RegistryUtil.getRegistry();
SearchRequestBuilderFactory searchRequestBuilderFactory = registry.getService(registry.getServiceReference(SearchRequestBuilderFactory.class.getName()));
/* Create SearchContext */
SearchContext searchContext = new SearchContext();
searchContext.setCompanyId(com.liferay.portal.kernel.util.PortalUtil.getCompany(actionRequest).getCompanyId());
searchContext.setStart(-1);
searchContext.setEnd(-1);
/* Line to fetch stored source of documents */
searchRequestBuilderFactory.builder(
searchContext
).fetchSource(
true
).build();
/* Get journal articles that are approved (status = 0) */
MatchQuery approvedQuery = new MatchQuery(Field.STATUS, String.valueOf(0));
MatchQuery journalArticleQuery = new MatchQuery("entryClassName", com.liferay.journal.model.JournalArticle.class.getName());
BooleanQuery query = new BooleanQueryImpl();
query.add(approvedQuery, BooleanClauseOccur.MUST.getName());
query.add(journalArticleQuery, BooleanClauseOccur.MUST.getName());
/* Execute search */
IndexSearcherHelperUtil.search(searchContext, query);
/* Get results from search response */
SearchResponse searchResponse = searchContext.getAttribute("search.response");
List<SearchHit> resultHits = searchResponse.getSearchHits().getSearchHits();
/* Iterate */
for (SearchHit searchHit : resultHits) {
Document doc = searchHit.getDocument();
out.println("entryClassPK: " + doc.getValue("entryClassPK"));
out.println("ddmFieldArray: " + doc.getValues("ddmFieldArray"));
out.println("");
}
在您的代码中，您应该将 RegistryUtil 用法替换为“@Reference”注释。
如果您对我的示例有任何疑问，请告诉我。
我正在尝试使用 SearchContext、IndexSearcherHelperUtil 和所有其他东西为 Liferay 7.3.5 GA6 开发自定义 Web 内容搜索 portlet。
我有一些具有不同字段的 DDMStructure，从我在 elasticsearch 索引上看到的，这些字段在嵌套文档中索引，如下所示：
"ddmFieldArray": [
{
"ddmFieldName": "ddm__text__37702__nome_it_IT",
"ddmValueFieldName": "ddmFieldValueText_it_IT",
"ddmFieldValueText_it_IT": "Nome esempio",
"ddmFieldValueText_it_IT_String_sortable": "nome esempio"
}
,
{
"ddmFieldName": "ddm__text__37702__descrizione_breve_it_IT",
"ddmValueFieldName": "ddmFieldValueText_it_IT",
"ddmFieldValueText_it_IT": "Esempio di descrizione breve da indicizzare",
"ddmFieldValueText_it_IT_String_sortable": "esempio di descrizione breve da indicizzare"
}
]
这与我过去知道的旧方法不同，自定义字段的索引方式如 ddm__[keyword/text]__[structure_id]__[field_name]
现在，我知道这种不同的索引方式是为了避免弹性问题（已超过总字段限制）而进行的改进，但是...执行搜索后，没有 ddmFieldArray 在 com.liferay.portal.kernel.search.Document .getFields 中，所以我无法从弹性搜索索引中获取 ddmstructure 字段值。
代码如下：
long journalArticleClassId = ClassNameLocalServiceUtil.getClassNameId(JournalArticle.class.getName());
SearchContext searchContext = new SearchContext();
searchContext.setClassTypeIds(new long[] {journalArticleClassId});
searchContext.setCompanyId(companyId);
searchContext.setStart(QueryUtil.ALL_POS);
searchContext.setEnd(QueryUtil.ALL_POS);
BooleanQuery query = new BooleanQueryImpl();
MatchQuery approvedQuery = new MatchQuery(Field.STATUS, String.valueOf(WorkflowConstants.STATUS_APPROVED));
query.add(approvedQuery, BooleanClauseOccur.MUST.getName());
Hits resultHits = IndexSearcherHelperUtil.search(searchContext, query);
for (Document doc: resultHits.getDocs()) {
doc.getFields().forEach((k, v) -> _log.debug(k)); //No ddm structure field
}
这仍然是一种改进还是只是一种意外行为？
有什么方法可以解决或扩展这个问题吗？
谢谢
“ddmFieldArray”字段是嵌套字段，默认不返回。 您必须从存储在 Elasticsearch 内部“_source”字段中的文档源字段中获取它（参见 https://www.elastic.co/guide/en/elasticsearch/reference/7.9/search-fields.html ）
为了在 Liferay 中执行此操作，您必须使用旧 portal-kernel 搜索 类 中不可用的一些搜索方法，您必须使用位于 modules/apps/portal-search[=45 中的 portal-search-api 模块中可用的新搜索 类 =]
这些是您必须对代码应用的更改：
- 在执行搜索之前，您必须在搜索中添加“fetchSource”标志并添加以下代码：
searchRequestBuilderFactory.builder(
searchContext
).fetchSource(
true
).build();
- 执行搜索后，您必须从 SearchResponse 对象中获取 Document 对象。此 SearchResponse 在 searchContext 中可用，使用此代码：
/* Execute search */
IndexSearcherHelperUtil.search(searchContext, query);
/* Get results from search response */
SearchResponse searchResponse = searchContext.getAttribute("search.response");
List<SearchHit> resultHits = searchResponse.getSearchHits().getSearchHits();
/* Iterate */
for (SearchHit searchHit : resultHits) {
Document doc = searchHit.getDocument();
...your stuff...
}
您在以下 Liferay 类:
中有一些关于获取源和获取 SearchResponse 的示例- com.liferay.document.library.search.test.DLSearchFixture，请参阅方法 searchOnlyOneSearchHit，其中设置了 fetchSource(true) 并且 SearchResponse 对象是从 searchContext 中获取的
- com.liferay.account.internal.retriever.AccountOrganizationRetrieverImpl 其中一些搜索是使用 SearchRequest 和 SearchResponse 完成的。
- com.liferay.asset.internal.util.AssetHelperImpl 使用 searchRequestBuilderFactory 的地方。
我还实现了一个 groovy 脚本示例，您可以从以下位置执行它：控制面板 => 服务器管理 => 脚本
import com.liferay.registry.*;
import com.liferay.portal.kernel.search.*;
import com.liferay.portal.kernel.search.generic.*;
import com.liferay.portal.search.legacy.searcher.SearchRequestBuilderFactory;
import com.liferay.portal.search.searcher.SearchResponse;
import com.liferay.portal.search.hits.SearchHit;
import com.liferay.portal.search.document.Document;
/* Get SearchRequestBuilderFactory reference using RegistryUtil, because we cannot use "@Reference" in a groovy script */
Registry registry = RegistryUtil.getRegistry();
SearchRequestBuilderFactory searchRequestBuilderFactory = registry.getService(registry.getServiceReference(SearchRequestBuilderFactory.class.getName()));
/* Create SearchContext */
SearchContext searchContext = new SearchContext();
searchContext.setCompanyId(com.liferay.portal.kernel.util.PortalUtil.getCompany(actionRequest).getCompanyId());
searchContext.setStart(-1);
searchContext.setEnd(-1);
/* Line to fetch stored source of documents */
searchRequestBuilderFactory.builder(
searchContext
).fetchSource(
true
).build();
/* Get journal articles that are approved (status = 0) */
MatchQuery approvedQuery = new MatchQuery(Field.STATUS, String.valueOf(0));
MatchQuery journalArticleQuery = new MatchQuery("entryClassName", com.liferay.journal.model.JournalArticle.class.getName());
BooleanQuery query = new BooleanQueryImpl();
query.add(approvedQuery, BooleanClauseOccur.MUST.getName());
query.add(journalArticleQuery, BooleanClauseOccur.MUST.getName());
/* Execute search */
IndexSearcherHelperUtil.search(searchContext, query);
/* Get results from search response */
SearchResponse searchResponse = searchContext.getAttribute("search.response");
List<SearchHit> resultHits = searchResponse.getSearchHits().getSearchHits();
/* Iterate */
for (SearchHit searchHit : resultHits) {
Document doc = searchHit.getDocument();
out.println("entryClassPK: " + doc.getValue("entryClassPK"));
out.println("ddmFieldArray: " + doc.getValues("ddmFieldArray"));
out.println("");
}
在您的代码中，您应该将 RegistryUtil 用法替换为“@Reference”注释。
如果您对我的示例有任何疑问，请告诉我。