Liferay 6.1开发学习(十四):在自己的Portlet中使用Liferay的全文检索

2012年11月17日 Liferay 评论 1 条 阅读 7,893 views 次

在Liferay中的全文检索是使用的Lucene,方便我们的对内容进行全文检索。liferay中对文章、文档、博客、wiki、留言等实现了全文检索,如何在我们自己的Portlet中使用Liferay的全文检索呢?

实例场景如下:

我们自己实现了一个CMS,没有使用Liferay中的Journal类,比如存放新闻的类叫做CmsArticle。我们现在需要对这个新闻进行全文检索,可以检索新闻正文、标题、摘要、作者等,同时可以进行范围搜索,如只搜索标题、只需要正文或全部等。

一、建立索引类

继承BaseIndexer类,编写一个索引类,如叫做CmsArticleIndexer。重写里面的相关搜索方法。一般需要重写

getClassNames

getSummary

doDelete

doGetDocument

doReindex

getPortletId

等几个方法,其他的方法可以根据需要进行重写。

简单贴几个主要的方法的内容:

protected Document doGetDocument(Object obj) throws Exception {
 CmsArticle article = (CmsArticle)obj;
long companyId = article.getCompanyId();
 long groupId = getParentGroupId(article.getGroupId());
 long scopeGroupId = article.getGroupId();
……………………省略相关字段的获取和上面的一样
Document document = new DocumentImpl();
document.addUID(PORTLET_ID, groupId, articleId);

 document.addKeyword(Field.COMPANY_ID, companyId);
 document.addKeyword(Field.PORTLET_ID, PORTLET_ID);
 document.addKeyword(Field.GROUP_ID, groupId);
 document.addKeyword(Field.SCOPE_GROUP_ID, scopeGroupId);
 document.addKeyword(Field.USER_ID, userId);
//将不同的字段添加到索引中
 document.addDate(Field.MODIFIED_DATE, modifedDate);
 document.addText(Field.TITLE, title);
 document.addText(Field.CONTENT, ArticleUtil.getArticleText(content));
 document.addText(Field.DESCRIPTION, description);
 document.addText(Field.USER_NAME, userName);
 document.addKeyword(Field.ENTRY_CLASS_NAME, CmsArticle.class.getName());
 document.addKeyword(Field.ENTRY_CLASS_PK, articleId);
//这个为必须的,否则会搜索不到内容
 document.addKeyword(Field.ROOT_ENTRY_CLASS_PK, resourcePrimKey);
 document.addKeyword(Field.TYPE, type);
return document;
 }

下面是重建索引的方法,方法很简单,根据传入的companyId或者也可以使用groupid,将某个范围下面的内容进行依次取出添加到索引库里面,这里使用了分页,如果数据量较小可以不用分页,但数据量大时务必分页,否则会将内存耗尽。

//索引调用的方法
protected void doReindex(String[] ids) throws Exception {
 long companyId = GetterUtil.getLong(ids[0]);
reindexArticles(companyId);
}
//从传入的companyId里面依分页将数据取出添加到索引库里面
protected void reindexArticles(long companyId) throws Exception {

 int count = CmsArticleLocalServiceUtil.getCmsArticleCountByCompanyId(companyId,APPROVED_STATUS);
int pages = count / Indexer.DEFAULT_INTERVAL;
for (int i = 0; i <= pages; i++) {
 int start = (i * Indexer.DEFAULT_INTERVAL);
 int end = start + Indexer.DEFAULT_INTERVAL;
 reindexArticles(companyId, start, end);
 }
 }
//索引内容,在这里可以对新闻的状态等进行判断,如只索引审批或发布过的,未审批的不进行索引
protected void reindexArticles(long companyId, int start, int end)throws Exception {
List<CmsArticle> articles = CmsArticleLocalServiceUtil.getCmsArticlesByCompanyId(companyId, APPROVED_STATUS,start, end);
if (articles.isEmpty()) {
 return;
 }
Collection<Document> documents = new ArrayList<Document>();
for (CmsArticle article : articles) {
 Document document = getDocument(article);
 documents.add(document);
 }
//更新索引
SearchEngineUtil.updateDocuments(getSearchEngineId(),companyId, documents);
 }

上面贴出来的是一些主要方法,可以根据不同的需求进行调整,不满足的可以参考Indexer相关类的实现,liferay里面有博客、wiki、文章等索引实现,的都是很好的学习参数资料,方法为在源码的Indexer类名上按ctrl+T,查看他的相关实现或继承类。

二、注册索引类

将上面写的索引类注册到portlet中。打开liferay-portlet.xml文件,在相关的portlet中添加

<indexer-class>xxx.xxx.xxx.cmsarticle.search.CmsArticleIndexer</indexer-class>

这样就将此索引类注册到portlet中了。

注册有什么好处呢?

1、可以在控制面板中的更新插件处,对某一个指定的portlet重建索引。

2、在控制面板中当点击重建所有搜索索引时,可以调用到此索引类进行索引重建立。

3、如果设置了portal在启动时更新索引,则liferay可以调到此类进行索引更新。

简而言之主是注册之后,可以让Liferay来管理索引,方便的进行统一的索引管理、重建等。

三、搜索

建立完了索引,工作只算完成了一小部分,还有搜索。搜索的过程比建立索引的过程要简单的多,核心代码只要两行。

//实例化索引类
Indexer indexer = IndexerRegistryUtil.getIndexer(CmsArticle.class);
//进行搜索
Hits results = indexer.search(searchContext);
//从结果里面取Document
Document[] docs = results.getDocs();

第一步不需要特别说明,就是对相关索引类进行初始化。第二步里面的搜索参数是一个searchContext,这是一个什么东西呢?这是Liferay包装的一个参数类,可以在里面设置一些常用的搜索参数,如关键词、搜索分页条件等。我们一般可以这样使用:

//实例化一个SearchContext
SearchContext searchContext = SearchContextFactory.getInstance(request);
//start和end是分页用,如我们只要取前20条,为start=0,end=20 searchContext.setStart(start);
 searchContext.setEnd(end);
 searchContext.setKeywords(keyWords);

既然有分页,则需要知道结果的总条数才可以,results.length()返回的就的命中的结果数量,也就是搜索结果的总数。根据start、end、总条数即可进行分页处理。

完整的搜索处理类核心代码

Indexer indexer = IndexerRegistryUtil.getIndexer(CmsArticle.class); 
 SearchContext searchContext = SearchContextFactory.getInstance(request);
int start = (pageNumber-1) * pageSize;
 int end = pageNumber * pageSize;
 //取消搜索权限,liferay的搜索权限是否过滤是根据searchContext里面是否能获取到的userId来区分的
 searchContext.setUserId(0);

 searchContext.setStart(start);
 searchContext.setEnd(end);
 searchContext.setKeywords(keyWords);
//这里是自定义的搜索范围,liferay默认是全部,这里是为了实现只搜索标题、只搜索正文等而添加的的
 searchContext.setAttribute(ArticleSearchConstants.SEARCH_SCOPE, searchScope);
 int countResult = 0;
 try {
 Hits results = indexer.search(searchContext);
//取得搜索关键词的分词词元
 String[] terms = results.getQueryTerms();
 //获取结果总数
 countResult = results.getLength();
 Document[] docs = results.getDocs();
 for (int i=0;i<docs.length;i++) {
 Document document = docs[i];
 String title = document.get(Field.TITLE);
 //对标题进行关键词高亮
 String hightLightTitle = StringUtil.highlight(title, terms);
 //从索引中提取正文片段,如果找不到就取正文的前200个字
 String snippet = results.getSnippets()[i];
 String content = snippet;
 if (Validator.isNull(snippet)) {
 content = StringUtil.shorten(document.get(Field.CONTENT), 200);
 }
 //高亮摘要
 String higthLightContent = StringUtil.highlight(content, terms);
 //取新闻的ID
 String articleId = document.get(Field.ENTRY_CLASS_PK);
 //取新闻的groupId
 long groupId = GetterUtil.getLong(document.get(Field.GROUP_ID));
//这里可以将数据的数据封装到相关的搜索结果类里面,进行界面上的显示,下面的搜索结果类的封装省略
 }
 } catch (SearchException e) {
 e.printStackTrace();
 }

四、其他说明

1、如何在添加文章或内容时对内容建立索引?

可以另建立一个索引线程,在内容添加的时候将此类添加到索引中,删除时从索引中删除。核心的是使用下面的方法。

indexer.reindex(article);

indexer.delete(article);

2、如何重建所有索引?

可以在控制面板中,服务器-->插件安装-->找到此portlet,旁边有一个重建索引的按钮,点击即可完成对索引的重建。

3、索引文件存储于哪个地方?

默认存储于/data/lucene目录下面

用户头像

1 条留言  访客:1 条  博主:0 条

  1. avatar jerrylsxu

    太感谢了,为什么我的是全部查询而不是模糊查询呢?需要设置什么吗?

给我留言

Copyright © IT人生录 保留所有权利.   主题设计 知更鸟 滇ICP备16001547号-1

用户登录

分享到: