高亮显示
- public SolrDocumentList query(String str) {
- SolrQuery query = new SolrQuery(str);
- //设置高亮,以下两种方式都行(相当于开启高亮功能)
- //query.setHighlight(true);
- query.setParam("hl", "true"); //highlighting
- //设置高亮显示的请求,高亮显示的内容由该参数决定,但是返回结果还是由SolrQuery决定
- //query.setParam("hl.q", "email:zhang@ppstream.com");
- /*
- * 那些字段高亮显示,可以用空格或者逗号分隔(有一个域的时候正常,两个及以上没测试通过)
- * 老版本使用query.addHighlightField("name");query.addHighlightField("description");给多个字段开启高亮功能
- */
- query.setParam("hl.fl", "name");
- //高亮显示字段前后添加html代码
- query.setHighlightSimplePre("<font color=\"red\">");
- query.setHighlightSimplePost("</font>");
- SolrDocumentList list = new SolrDocumentList();
- SolrDocument document = null;
- QueryResponse response=new QueryResponse();
- try {
- SolrDocumentList documents = response.getResults();
- //第一个Map的键是文档的ID,第二个Map的键是高亮显示的字段名
- Map<String, Map<String, List<String>>> map = response.getHighlighting();
- for(int i=0;i<documents.size();i++) {
- document = documents.get(i);
- document.setField("name", map.get(document.getFieldValue("id")).get("name"));
- /*document.setField("email", map.get(document.getFieldValue("id")).get("email"));*/
- list.add(document);
- }
- } catch (Exception e) {
- }
- return list;
- }
另外的方法,配置solrconfig.xml
solr是在lucene的基础上做的开发,那么在某些功能的实现上,与lucene也会有相似之处。
solr的高亮显示(包括自动摘要),是通过hl这个param,以及其相关变量来实现的,hl是hightlight的简写。lucene中是通过highlighter来操作高亮和摘要的。
配
置高亮的相关属性,是在solrconfig.xml中配置的。在 <requestHandler name="search"
class="solr.SearchHandler"
default="true">下进行配置。solrconfig.xml文件中包含多个requestHandler的标签,但是只有在上述的名
为search的标签中配置才有效。现将配置的案列公布如下:
- <requestHandler name="search" class="solr.SearchHandler" default="true">
- <!-- default values for query parameters can be specified, these
- will be overridden by parameters in the request
- -->
- <lst name="defaults">
- <str name="echoParams">explicit</str>
- <int name="rows">10</int>
- <str name="df">text</str>
- <str name="hl">true</str>
- <str name="hl.fl">content</str>
- <str name="f.name.hl.fragsize">50</str>
- <str name="hl.simple.pre"><font color="red></str>
- <str name="hl.simple.post"></font></str>
- </lst>
- </requestHandler>
其中,hl是指定是否使用高亮;hl.fl,指定对哪些域进行高亮,对多个域进行高亮的话,好像是用逗号隔 开;f.name.hl.fragsize是指摘要的长度,默认0代表不做摘要。而hl.simple.pre和hl.simple.post则是指定高 亮时显示的格式,默认是<em></em>。详细内容请参见:http://wiki.apache.org/solr/HighlightingParameters。设置完成后,
在solrj中,通过QueryResponse对象的getHighlighting()方法获得。该方法返回 Map<String,Map<String,List<String>>>类型的数据。其中第一个Map中的 key是id,第二个Map中的key是field,List<String>中封装的就是高亮与摘要处理过后的内容了
Map<String, Map<String, List<String>>> map = response.getHighlighting();
通过这个api的方法就可以得到高亮的内容,高亮的内容通过 key 跟索引的document部分关联起来
这个key就是document 的id
参数详细说明:
?hl.fl:
用空格或逗号隔开的字段列表。要启用某个字段的highlight功能,就得保证该字段在schema中是stored。如果该参数未被给出,那么就会高
亮默认字段 standard
handler会用df参数,dismax字段用qf参数。你可以使用星号去方便的高亮所有字段。如果你使用了通配符,那么要考虑启用
hl.requiredFieldMatch选项。
?hl.requireFieldMatch:
如果置为true,除非该字段的查
询结果不为空才会被高亮。它的默认值是false,意味着它可能匹配某个字段却高亮一个不同的字段。如果hl.fl使用了通配符,那么就要启用该参数。尽
管如此,如果你的查询是all字段(可能是使用copy-field
指令),那么还是把它设为false,这样搜索结果能表明哪个字段的查询文本未被找到
?hl.usePhraseHighlighter:
如果一个查询中含有短语(引号框起来的)那么会保证一定要完全匹配短语的才会被高亮。
?hl.highlightMultiTerm
如果使用通配符和模糊搜索,那么会确保与通配符匹配的term会高亮。默认为false,同时hl.usePhraseHighlighter要为true。
?hl.snippets:
这是highlighted片段的最大数。默认值为1,也几乎不会修改。如果某个特定的字段的该值被置为0(如f.allText.hl.snippets=0),这就表明该字段被禁用高亮了。你可能在hl.fl=*时会这么用。
?hl.fragsize:
每个snippet返回的最大字符数。默认是100.如果为0,那么该字段不会被fragmented且整个字段的值会被返回。大字段时不会这么做。
?hl.mergeContiguous:
如果被置为true,当snippet重叠时会merge起来。
?hl.maxAnalyzedChars:
会搜索高亮的最大字符,默认值为51200,如果你想禁用,设为-1
?hl.alternateField:
如果没有生成snippet(没有terms 匹配),那么使用另一个字段值作为返回。
?hl.maxAlternateFieldLength:
如果hl.alternateField启用,则有时需要制定alternateField的最大字符长度,默认0是即没有限制。所以合理的值是应该为
?hl.snippets * hl.fragsize这样返回结果的大小就能保持一致。
?hl.formatter:
一个提供可替换的formatting算法的扩展点。默认值是simple,这是目前仅有的选项。显然这不够用,你可以看看
org.apache.solr.highlight.HtmlFormatter.java 和
solrconfig.xml中highlighting元素是如何配置的。
注意在不论原文中被高亮了什么值的情况下,如预先已存在的em tags,也不会被转义,所以在有时会导致假的高亮。
?hl.fragmenter:
这
个是solr制定fragment算法的扩展点。gap是默认值。regex是另一种选项,这种选项指明highlight的边界由一个正则表达式确定。
这是一种非典型的高级选项。为了知道默认设置和fragmenters (and
formatters)是如何配置的,可以看看solrconfig.xml中的highlight段。
regex 的fragmenter有如下选项:
?hl.regex.pattern:正则表达式的pattern
?hl.regex.slop:这是hl.fragsize能变化以适应正则表达式的因子。默认值是0.6,意思是如果hl.fragsize=100那么fragment的大小会从40-160.