您的位置：首页 > Web前端

Liferay 6.1开发学习（十四）：在自己的Portlet中使用Liferay的全文检索【转】

2015-07-03 00:00 681 查看
摘要:在Liferay中的全文检索是使用的Lucene，方便我们的对内容进行全文检索。liferay中对文章、文档、博客、wiki、留言等实现了全文检索，如何在我们自己的Portlet中使用Liferay的全文检索呢？
实例场景如下：
我们自己实现了一个CMS，没有使用Liferay中的Journal类，比如存放新闻的类叫做CmsArticle。我们现在需要对这个新闻进行全文检索，可以检索新闻正文、标题、摘要、作者等，同时可以进行范围搜索，如只搜索标题、只需要正文或全部等。

一、建立索引类

继承BaseIndexer类，编写一个索引类，如叫做CmsArticleIndexer。重写里面的相关搜索方法。一般需要重写
getClassNames
getSummary
doDelete
doGetDocument
doReindex
getPortletId
等几个方法，其他的方法可以根据需要进行重写。
简单贴几个主要的方法的内容：
protectedDocumentdoGetDocument(Objectobj)throwsException{

CmsArticlearticle=(CmsArticle)obj;

longcompanyId=article.getCompanyId();

longgroupId=getParentGroupId(article.getGroupId());

longscopeGroupId=article.getGroupId();

……………………省略相关字段的获取和上面的一样

Documentdocument=newDocumentImpl();

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);

returndocument;

}

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

protectedvoiddoReindex(String[]ids)throwsException{

longcompanyId=GetterUtil.getLong(ids[0]);

reindexArticles(companyId);

}

//从传入的companyId里面依分页将数据取出添加到索引库里面

protectedvoidreindexArticles(longcompanyId)throwsException{


intcount=CmsArticleLocalServiceUtil.getCmsArticleCountByCompanyId(companyId,APPROVED_STATUS);

intpages=count/Indexer.DEFAULT_INTERVAL;

for(inti=0;i<=pages;i++){

intstart=(i*Indexer.DEFAULT_INTERVAL);

intend=start+Indexer.DEFAULT_INTERVAL;

reindexArticles(companyId,start,end);

}

}

//索引内容，在这里可以对新闻的状态等进行判断，如只索引审批或发布过的，未审批的不进行索引

protectedvoidreindexArticles(longcompanyId,intstart,intend)throwsException{

List<CmsArticle>articles=CmsArticleLocalServiceUtil.getCmsArticlesByCompanyId(companyId,APPROVED_STATUS,start,end);

if(articles.isEmpty()){

return;

}

Collection<Document>documents=newArrayList<Document>();

for(CmsArticlearticle:articles){

Documentdocument=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来管理索引，方便的进行统一的索引管理、重建等。

三、搜索
建立完了索引，工作只算完成了一小部分，还有搜索。搜索的过程比建立索引的过程要简单的多，核心代码只要两行。
//实例化索引类

Indexerindexer=IndexerRegistryUtil.getIndexer(CmsArticle.class);

//进行搜索

Hitsresults=indexer.search(searchContext);

//从结果里面取Document

Document[]docs=results.getDocs();

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

SearchContextsearchContext=SearchContextFactory.getInstance(request);

//start和end是分页用，如我们只要取前20条，为start=0,end=20searchContext.setStart(start);

searchContext.setEnd(end);

searchContext.setKeywords(keyWords);

既然有分页，则需要知道结果的总条数才可以，results.length()返回的就的命中的结果数量，也就是搜索结果的总数。根据start、end、总条数即可进行分页处理。
完整的搜索处理类核心代码
Indexerindexer=IndexerRegistryUtil.getIndexer(CmsArticle.class);

SearchContextsearchContext=SearchContextFactory.getInstance(request);

intstart=(pageNumber-1)*pageSize;

intend=pageNumber*pageSize;

//取消搜索权限，liferay的搜索权限是否过滤是根据searchContext里面是否能获取到的userId来区分的

searchContext.setUserId(0);


searchContext.setStart(start);

searchContext.setEnd(end);

searchContext.setKeywords(keyWords);

//这里是自定义的搜索范围，liferay默认是全部，这里是为了实现只搜索标题、只搜索正文等而添加的的

searchContext.setAttribute(ArticleSearchConstants.SEARCH_SCOPE,searchScope);

intcountResult=0;

try{

Hitsresults=indexer.search(searchContext);

//取得搜索关键词的分词词元

String[]terms=results.getQueryTerms();

//获取结果总数

countResult=results.getLength();

Document[]docs=results.getDocs();

for(inti=0;i<docs.length;i++){

Documentdocument=docs[i];

Stringtitle=document.get(Field.TITLE);

//对标题进行关键词高亮

StringhightLightTitle=StringUtil.highlight(title,terms);

//从索引中提取正文片段，如果找不到就取正文的前200个字

Stringsnippet=results.getSnippets()[i];

Stringcontent=snippet;

if(Validator.isNull(snippet)){

content=StringUtil.shorten(document.get(Field.CONTENT),200);

}

//高亮摘要

StringhigthLightContent=StringUtil.highlight(content,terms);

//取新闻的ID

StringarticleId=document.get(Field.ENTRY_CLASS_PK);

//取新闻的groupId

longgroupId=GetterUtil.getLong(document.get(Field.GROUP_ID));

//这里可以将数据的数据封装到相关的搜索结果类里面，进行界面上的显示，下面的搜索结果类的封装省略

}

}catch(SearchExceptione){

e.printStackTrace();

}


四、其他说明
1、如何在添加文章或内容时对内容建立索引？
可以另建立一个索引线程，在内容添加的时候将此类添加到索引中，删除时从索引中删除。核心的是使用下面的方法。
indexer.reindex(article);
indexer.delete(article);
2、如何重建所有索引？
可以在控制面板中，服务器-->插件安装-->找到此portlet，旁边有一个重建索引的按钮，点击即可完成对索引的重建。
3、索引文件存储于哪个地方？
默认存储于/data/lucene目录下面

在Tomcat7下面使用WebSocket
在没有webSocket之前，在浏览器上实现服务端和客户端的通信，一般是使用的iframe、短轮询、长连接、comet等，但这些方法都没有webSocket方便稳定。要实现WebSocket需要浏览器和服务端均支持。HTML5里面的webSocket是客户端的实现，应用服务器是服务端的实现。Tomcat在7.0.27版本中加入了对webSocket的支持。
WebSocket可以无刷新的实现服务端信息到客户端的推送，适于用聊天、信息推送、股票信息等需要服务端主动将信息提供给客户端的地方。

一、Tomcat服务端实现
下面是Tomcat里面websocket的服务端实现，按tomcat官方的说法是由于现在的websocket的规范还没有完全制定完成，所以tomcat里面关于websocket的实现的相关API可能随时会改变。http://tomcat.apache.org/tomcat-7.0-doc/web-socket-howto.html
以下代码参考tomcat发布包里面的examples下面的websocket
注意：在编译代码的时候可能会出现找不到相关类的情况，这个时候是由于没有将tomcat的相关包引入到工程的classpath里面，通常在MyEclipse里面会出现此问题，使用eclipse时，会将tomcat的lib包加入到工程的classpath里面。
@WebServlet("/DemoWebSocket")

publicclassDemoWebSocketextendsWebSocketServlet{

privatestaticfinallongserialVersionUID=1L;

privatefinalSet<DemoMessageInbound>connections=newCopyOnWriteArraySet<DemoMessageInbound>();

@Override

protectedStreamInboundcreateWebSocketInbound(StringsubProtocol,

HttpServletRequestrequest){

returnnewDemoMessageInbound();

}

privatefinalclassDemoMessageInboundextendsMessageInbound{

@Override

protectedvoidonOpen(WsOutboundoutbound){

connections.add(this);

Stringmessage="websocket已经打开";

broadcast(message);

}

@Override

protectedvoidonClose(intstatus){

connections.remove(this);

Stringmessage="webSocket关闭";

broadcast(message);

}

@Override

protectedvoidonBinaryMessage(ByteBuffermessage)throwsIOException{

//在这里处理二进制数据

}

@Override

protectedvoidonTextMessage(CharBuffermessage)throwsIOException{

//这里处理的是文本数据

StringfilteredMessage=message.toString();

broadcast(filteredMessage);

}


//将数据传回客户端

privatevoidbroadcast(Stringmessage){

for(DemoMessageInboundconnection:connections){

try{

CharBufferbuffer=CharBuffer.wrap(message);

connection.getWsOutbound().writeTextMessage(buffer);

}catch(IOExceptionignore){

//Ignore

}

}

}

}


二、浏览器客户端实现
下面的代码的实现，只是简单的兼容chrome浏览器，对于其他浏览器未做兼容性测试，所以在其他浏览器下面可能不能正常运行。
<inputtype="text"name="test"id="test"><inputtype="button"value="发送"onclick="send()"><br>

<divid="message"></div>

<scripttype="text/javascript">

//创建一个websocket的连接

varws=newWebSocket("ws://localhost:8080/websocket/DemoWebSocket");

//当连接打开时的事件

ws.onopen=function(evt){

console.log("Openenedconnectiontowebsocket");

};

//当连接有信息时的事件

ws.onmessage=function(msg){

$('#message').html(msg.data);

};

//向服务端发送信息

functionsend(){

ws.send($('#test').val());

}

</script>

                                            

                                        

                        
                        内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 点击这里给我发消息 
                    

                    

                    

                        

                         标签： 
                                                Liferay
                                                

                        

                    


                

            


            

                
相关文章推荐

                

                
            

        

        

            

            
            

                

                    
新的分享

                    

                        
                    

                

            


            

                

                    
章节导航