Lucene索引阶段设置Document Boost和Field Boost 实现合理打分

在索引阶段设置Document Boost和Field Boost，存储在(.nrm)文件中。

如果希望某些文档和某些域比其他的域更重要，如果此文档和此域包含所要查询的词则应该得分较高，则可以在索引阶段设定文档的boost和域的boost值。

这些值是在索引阶段就写入索引文件的，存储在标准化因子(.nrm)文件中，一旦设定，除非删除此文档，否则无法改变。

如果不进行设定，则Document Boost和Field Boost默认为1。

Document Boost及FieldBoost的设定方式如下：

Document doc = new Document();

Field f = new Field("contents", "hello world", Field.Store.NO, Field.Index.ANALYZED);

f.setBoost(100);

doc.add(f);

doc.setBoost(100);

两者是如何影响Lucene的文档打分的呢？

让我们首先来看一下Lucene的文档打分的公式：

score(q,d)   =   coord(q,d)  ·  queryNorm(q)  ·  ∑( tf(t in d)  ·  idf(t)²  ·  t.getBoost() ·  norm(t,d) )

                                                                       t in q

Document Boost和Field Boost影响的是norm(t, d)，其公式如下：

norm(t,d)   =   doc.getBoost()  ·  lengthNorm(field)  ·  ∏f.getBoost()

field f in d named as t

它包括三个参数：

• Document boost：此值越大，说明此文档越重要。
• Field boost：此域越大，说明此域越重要。
• lengthNorm(field) = (1.0 / Math.sqrt(numTerms))：一个域中包含的Term总数越多，也即文档越长，此值越小，文档越短，此值越大。

其中第三个参数可以在自己的Similarity中影响打分，下面会论述。

当然，也可以在添加Field的时候，设置Field.Index.ANALYZED_NO_NORMS或Field.Index.NOT_ANALYZED_NO_NORMS，完全不用norm，来节约空间。

根 据Lucene的注释，No norms means that index-time field and document boosting and field length normalization are disabled.  The benefit is less memory usage as norms take up one byte of RAM per indexed field for every document in the index, during searching.  Note that once you index a given field with norms enabled, disabling norms will have no effect. 没有norms意味着索引阶段禁用了文档boost和域的boost及长度标准化。好处在于节省内存，不用在搜索阶段为索引中的每篇文档的每个域都占用一 个字节来保存norms信息了。但是对norms信息的禁用是必须全部域都禁用的，一旦有一个域不禁用，则其他禁用的域也会存放默认的norms值。因为 为了加快norms的搜索速度，Lucene是根据文档号乘以每篇文档的norms信息所占用的大小来计算偏移量的，中间少一篇文档，偏移量将无法计算。 也即norms信息要么都保存，要么都不保存。

下面几个试验可以验证norms信息的作用：

试验一：Document Boost的作用

public void testNormsDocBoost() throws Exception { 
  File indexDir = new File("testNormsDocBoost"); 
  IndexWriter writer = new IndexWriter(FSDirectory.open(indexDir), new StandardAnalyzer(Version.LUCENE_CURRENT), true, IndexWriter.MaxFieldLength.LIMITED); 
  writer.setUseCompoundFile(false); 
  Document doc1 = new Document(); 
  Field f1 = new Field("contents", "common hello hello", Field.Store.NO, Field.Index.ANALYZED); 
  doc1.add(f1); 
  doc1.setBoost(100); 
  writer.addDocument(doc1); 
  Document doc2 = new Document(); 
  Field f2 = new Field("contents", "common common hello", Field.Store.NO, Field.Index.ANALYZED_NO_NORMS); 
  doc2.add(f2); 
  writer.addDocument(doc2); 
  Document doc3 = new Document(); 
  Field f3 = new Field("contents", "common common common", Field.Store.NO, Field.Index.ANALYZED_NO_NORMS); 
  doc3.add(f3); 
  writer.addDocument(doc3); 
  writer.close();

  IndexReader reader = IndexReader.open(FSDirectory.open(indexDir)); 
  IndexSearcher searcher = new IndexSearcher(reader); 
  TopDocs docs = searcher.search(new TermQuery(new Term("contents", "common")), 10); 
  for (ScoreDoc doc : docs.scoreDocs) { 
    System.out.println("docid : " + doc.doc + " score : " + doc.score); 
  } 
}

如果第一篇文档的域f1也为Field.Index.ANALYZED_NO_NORMS的时候，搜索排名如下：

docid : 2 score : 1.2337708 
docid : 1 score : 1.0073696 
docid : 0 score : 0.71231794

如果第一篇文档的域f1设为Field.Index.ANALYZED，则搜索排名如下：

docid : 0 score : 39.889805 
docid : 2 score : 0.6168854 
docid : 1 score : 0.5036848

试验二：Field Boost的作用

如果我们觉得title要比contents要重要，可以做一下设定。

public void testNormsFieldBoost() throws Exception { 
  File indexDir = new File("testNormsFieldBoost"); 
  IndexWriter writer = new IndexWriter(FSDirectory.open(indexDir), new StandardAnalyzer(Version.LUCENE_CURRENT), true, IndexWriter.MaxFieldLength.LIMITED); 
  writer.setUseCompoundFile(false); 
  Document doc1 = new Document(); 
  Field f1 = new Field("title", "common hello hello", Field.Store.NO, Field.Index.ANALYZED); 
  f1.setBoost(100); 
  doc1.add(f1); 
  writer.addDocument(doc1); 
  Document doc2 = new Document(); 
  Field f2 = new Field("contents", "common common hello", Field.Store.NO, Field.Index.ANALYZED_NO_NORMS); 
  doc2.add(f2); 
  writer.addDocument(doc2); 
  writer.close();

  IndexReader reader = IndexReader.open(FSDirectory.open(indexDir)); 
  IndexSearcher searcher = new IndexSearcher(reader); 
  QueryParser parser = new QueryParser(Version.LUCENE_CURRENT, "contents", new StandardAnalyzer(Version.LUCENE_CURRENT)); 
  Query query = parser.parse("title:common contents:common"); 
  TopDocs docs = searcher.search(query, 10); 
  for (ScoreDoc doc : docs.scoreDocs) { 
    System.out.println("docid : " + doc.doc + " score : " + doc.score); 
  } 
}

如果第一篇文档的域f1也为Field.Index.ANALYZED_NO_NORMS的时候，搜索排名如下：

docid : 1 score : 0.49999997 
docid : 0 score : 0.35355338

如果第一篇文档的域f1设为Field.Index.ANALYZED，则搜索排名如下：

docid : 0 score : 19.79899 
docid : 1 score : 0.49999997

试验三：norms中文档长度对打分的影响

public void testNormsLength() throws Exception { 
  File indexDir = new File("testNormsLength"); 
  IndexWriter writer = new IndexWriter(FSDirectory.open(indexDir), new StandardAnalyzer(Version.LUCENE_CURRENT), true, IndexWriter.MaxFieldLength.LIMITED); 
  writer.setUseCompoundFile(false); 
  Document doc1 = new Document(); 
  Field f1 = new Field("contents", "common hello hello", Field.Store.NO, Field.Index.ANALYZED_NO_NORMS); 
  doc1.add(f1); 
  writer.addDocument(doc1); 
  Document doc2 = new Document(); 
  Field f2 = new Field("contents", "common common hello hello hello hello", Field.Store.NO, Field.Index.ANALYZED_NO_NORMS); 
  doc2.add(f2); 
  writer.addDocument(doc2); 
  writer.close();

  IndexReader reader = IndexReader.open(FSDirectory.open(indexDir)); 
  IndexSearcher searcher = new IndexSearcher(reader); 
  QueryParser parser = new QueryParser(Version.LUCENE_CURRENT, "contents", new StandardAnalyzer(Version.LUCENE_CURRENT)); 
  Query query = parser.parse("title:common contents:common"); 
  TopDocs docs = searcher.search(query, 10); 
  for (ScoreDoc doc : docs.scoreDocs) { 
    System.out.println("docid : " + doc.doc + " score : " + doc.score); 
  } 
}

当norms被禁用的时候，包含两个common的第二篇文档打分较高：

docid : 1 score : 0.13928263 
docid : 0 score : 0.09848769

当norms起作用的时候，虽然包含两个common的第二篇文档，由于长度较长，因而打分较低：

docid : 0 score : 0.09848769 
docid : 1 score : 0.052230984

试验四：norms信息要么都保存，要么都不保存的特性

public void testOmitNorms() throws Exception { 
  File indexDir = new File("testOmitNorms"); 
  IndexWriter writer = new IndexWriter(FSDirectory.open(indexDir), new StandardAnalyzer(Version.LUCENE_CURRENT), true, IndexWriter.MaxFieldLength.LIMITED); 
  writer.setUseCompoundFile(false); 
  Document doc1 = new Document(); 
  Field f1 = new Field("title", "common hello hello", Field.Store.NO, Field.Index.ANALYZED); 
  doc1.add(f1); 
  writer.addDocument(doc1); 
  for (int i = 0; i < 10000; i++) { 
    Document doc2 = new Document(); 
    Field f2 = new Field("contents", "common common hello hello hello hello", Field.Store.NO, Field.Index.ANALYZED_NO_NORMS); 
    doc2.add(f2); 
    writer.addDocument(doc2); 
  } 
  writer.close(); 
}

当我们添加10001篇文档，所有的文档都设为Field.Index.ANALYZED_NO_NORMS的时候，我们看索引文件，发现.nrm文件只有1K，也即其中除了保持一定的格式信息，并无其他数据。

当我们把第一篇文档设为Field.Index.ANALYZED，而其他10000篇文档都设为Field.Index.ANALYZED_NO_NORMS的时候，发现.nrm文件又10K，也即所有的文档都存储了norms信息，而非只有第一篇文档。

在搜索语句中，设置Query Boost.

在搜索中，我们可以指定，某些词对我们来说更重要，我们可以设置这个词的boost：

common^4 hello

使得包含common的文档比包含hello的文档获得更高的分数。

由于在Lucene中，一个Term定义为Field:Term，则也可以影响不同域的打分：

title:common^4 content:common

使得title中包含common的文档比content中包含common的文档获得更高的分数。

实例：

public void testQueryBoost() throws Exception { 
  File indexDir = new File("TestQueryBoost"); 
  IndexWriter writer = new IndexWriter(FSDirectory.open(indexDir), new StandardAnalyzer(Version.LUCENE_CURRENT), true, IndexWriter.MaxFieldLength.LIMITED); 
  Document doc1 = new Document(); 
  Field f1 = new Field("contents", "common1 hello hello", Field.Store.NO, Field.Index.ANALYZED); 
  doc1.add(f1); 
  writer.addDocument(doc1); 
  Document doc2 = new Document(); 
  Field f2 = new Field("contents", "common2 common2 hello", Field.Store.NO, Field.Index.ANALYZED); 
  doc2.add(f2); 
  writer.addDocument(doc2); 
  writer.close();

  IndexReader reader = IndexReader.open(FSDirectory.open(indexDir)); 
  IndexSearcher searcher = new IndexSearcher(reader); 
  QueryParser parser = new QueryParser(Version.LUCENE_CURRENT, "contents", new StandardAnalyzer(Version.LUCENE_CURRENT)); 
  Query query = parser.parse("common1 common2"); 
  TopDocs docs = searcher.search(query, 10); 
  for (ScoreDoc doc : docs.scoreDocs) { 
    System.out.println("docid : " + doc.doc + " score : " + doc.score); 
  } 
}

根据tf/idf，包含两个common2的第二篇文档打分较高：

docid : 1 score : 0.24999999 
docid : 0 score : 0.17677669

如果我们输入的查询语句为："common1^100 common2"，则第一篇文档打分较高：

docid : 0 score : 0.2499875 
docid : 1 score : 0.0035353568

那Query Boost是如何影响文档打分的呢？

根据Lucene的打分计算公式：

score(q,d)   =   coord(q,d)  ·  queryNorm(q)  · ∑( tf(t in d)  ·  idf(t)²  ·  t.getBoost() ·  norm(t,d) )

                                                                      t in q

注：在queryNorm的部分，也有q.getBoost()的部分，但是对query向量的归一化(见向量空间模型与Lucene的打分机制[http://forfuture1978.javaeye.com/blog/588721])。

继承并实现自己的Similarity

Similariy是计算Lucene打分的最主要的类，实现其中的很多借口可以干预打分的过程。

(1) float computeNorm(String field, FieldInvertState state)

(2) float lengthNorm(String fieldName, int numTokens)

(3) float queryNorm(float sumOfSquaredWeights)

(4) float tf(float freq)

(5) float idf(int docFreq, int numDocs)

(6) float coord(int overlap, int maxOverlap)

(7) float scorePayload(int docId, String fieldName, int start, int end, byte [] payload, int offset, int length)

它们分别影响Lucene打分计算的如下部分：

score(q,d)   =   (6)coord(q,d)  ·  (3)queryNorm(q)  · ∑( (4)tf(t in d)  ·  (5)idf(t)²  ·  t.getBoost() ·  (1)norm(t,d) )

t in q

norm(t,d)   =   doc.getBoost()  ·  (2)lengthNorm(field)  ·  ∏f.getBoost()

                                                                           field f in d named as t

下面逐个进行解释：

(1) float computeNorm(String field, FieldInvertState state)

影响标准化因子的计算，如上述，他主要包含了三部分：文档boost，域boost，以及文档长度归一化。此函数一般按照上面norm(t, d)的公式进行计算。

(2) float lengthNorm(String fieldName, int numTokens)

主要计算文档长度的归一化，默认是1.0 / Math.sqrt(numTerms)。

因 为在索引中，不同的文档长度不一样，很显然，对于任意一个term，在长的文档中的tf要大的多，因而分数也越高，这样对小的文档不公平，举一个极端的例 子，在一篇1000万个词的鸿篇巨著中，"lucene"这个词出现了11次，而在一篇12个词的短小文档中，"lucene"这个词出现了10次，如果 不考虑长度在内，当然鸿篇巨著应该分数更高，然而显然这篇小文档才是真正关注"lucene"的。

因而在此处是要除以文档的长度，从而减少因文档长度带来的打分不公。

然而现在这个公式是偏向于首先返回短小的文档的，这样在实际应用中使得搜索结果也很难看。

于 是在实践中，要根据项目的需要，根据搜索的领域，改写lengthNorm的计算公式。比如我想做一个经济学论文的搜索系统，经过一定时间的调研，发现大 多数的经济学论文的长度在8000到10000词，因而lengthNorm的公式应该是一个倒抛物线型的，8000到10000词的论文分数最高，更短 或更长的分数都应该偏低，方能够返回给用户最好的数据。

(3) float queryNorm(float sumOfSquaredWeights)

这是按照向量空间模型，对query向量的归一化。此值并不影响排序，而仅仅使得不同的query之间的分数可以比较。

(4) float tf(float freq)

freq是指在一篇文档中包含的某个词的数目。tf是根据此数目给出的分数，默认为Math.sqrt(freq)。也即此项并不是随着包含的数目的增多而线性增加的。

(5) float idf(int docFreq, int numDocs)

idf是根据包含某个词的文档数以及总文档数计算出的分数，默认为(Math.log(numDocs/(double)(docFreq+1)) + 1.0)。

由于此项计算涉及到总文档数和包含此词的文档数，因而需要全局的文档数信息，这给跨索引搜索造成麻烦。

从下面的例子我们可以看出，用MultiSearcher来一起搜索两个索引和分别用IndexSearcher来搜索两个索引所得出的分数是有很大差异的。

究其原因是MultiSearcher的docFreq(Term term)函数计算了包含两个索引中包含此词的总文档数，而IndexSearcher仅仅计算了每个索引中包含此词的文档数。当两个索引包含的文档总数是有很大不同的时候，分数是无法比较的。

public void testMultiIndex() throws Exception{ 
  MultiIndexSimilarity sim = new MultiIndexSimilarity(); 
  File indexDir01 = new File("TestMultiIndex/TestMultiIndex01"); 
  File indexDir02 = new File("TestMultiIndex/TestMultiIndex02"); 
  IndexReader reader01 = IndexReader.open(FSDirectory.open(indexDir01)); 
  IndexReader reader02 = IndexReader.open(FSDirectory.open(indexDir02)); 
  IndexSearcher searcher01 = new IndexSearcher(reader01); 
  searcher01.setSimilarity(sim); 
  IndexSearcher searcher02 = new IndexSearcher(reader02); 
  searcher02.setSimilarity(sim); 
  MultiSearcher multiseacher = new MultiSearcher(searcher01, searcher02); 
  multiseacher.setSimilarity(sim); 
  QueryParser parser = new QueryParser(Version.LUCENE_CURRENT, "contents", new StandardAnalyzer(Version.LUCENE_CURRENT)); 
  Query query = parser.parse("common"); 
  TopDocs docs = searcher01.search(query, 10); 
  System.out.println("----------------------------------------------"); 
  for (ScoreDoc doc : docs.scoreDocs) { 
    System.out.println("docid : " + doc.doc + " score : " + doc.score); 
  } 
  System.out.println("----------------------------------------------"); 
  docs = searcher02.search(query, 10); 
  for (ScoreDoc doc : docs.scoreDocs) { 
    System.out.println("docid : " + doc.doc + " score : " + doc.score); 
  } 
  System.out.println("----------------------------------------------"); 
  docs = multiseacher.search(query, 20); 
  for (ScoreDoc doc : docs.scoreDocs) { 
    System.out.println("docid : " + doc.doc + " score : " + doc.score); 
  }

结果为：

------------------------------- 
docid : 0 score : 0.49317428 
docid : 1 score : 0.49317428 
docid : 2 score : 0.49317428 
docid : 3 score : 0.49317428 
docid : 4 score : 0.49317428 
docid : 5 score : 0.49317428 
docid : 6 score : 0.49317428 
docid : 7 score : 0.49317428 
------------------------------- 
docid : 0 score : 0.45709616 
docid : 1 score : 0.45709616 
docid : 2 score : 0.45709616 
docid : 3 score : 0.45709616 
docid : 4 score : 0.45709616 
------------------------------- 
docid : 0 score : 0.5175894 
docid : 1 score : 0.5175894 
docid : 2 score : 0.5175894 
docid : 3 score : 0.5175894 
docid : 4 score : 0.5175894 
docid : 5 score : 0.5175894 
docid : 6 score : 0.5175894 
docid : 7 score : 0.5175894 
docid : 8 score : 0.5175894 
docid : 9 score : 0.5175894 
docid : 10 score : 0.5175894 
docid : 11 score : 0.5175894 
docid : 12 score : 0.5175894

如果几个索引都是在一台机器上，则用MultiSearcher或者MultiReader就解决问题了，然而有时候索引是分布在多台机器上的，虽然Lucene也提供了RMI，或用NFS保存索引的方法，然而效率和并行性一直是一个问题。

一个可以尝试的办法是在Similarity中，idf返回1，然后多个机器上的索引并行搜索，在汇总结果的机器上，再融入idf的计算。

如下面的例子可以看出，当idf返回1的时候，打分可以比较了：

class MultiIndexSimilarity extends Similarity {

  @Override 
  public float idf(int docFreq, int numDocs) { 
    return 1.0f; 
  }

----------------------------- 
docid : 0 score : 0.559017 
docid : 1 score : 0.559017 
docid : 2 score : 0.559017 
docid : 3 score : 0.559017 
docid : 4 score : 0.559017 
docid : 5 score : 0.559017 
docid : 6 score : 0.559017 
docid : 7 score : 0.559017 
----------------------------- 
docid : 0 score : 0.559017 
docid : 1 score : 0.559017 
docid : 2 score : 0.559017 
docid : 3 score : 0.559017 
docid : 4 score : 0.559017 
----------------------------- 
docid : 0 score : 0.559017 
docid : 1 score : 0.559017 
docid : 2 score : 0.559017 
docid : 3 score : 0.559017 
docid : 4 score : 0.559017 
docid : 5 score : 0.559017 
docid : 6 score : 0.559017 
docid : 7 score : 0.559017 
docid : 8 score : 0.559017 
docid : 9 score : 0.559017 
docid : 10 score : 0.559017 
docid : 11 score : 0.559017 
docid : 12 score : 0.559017

(6) float coord(int overlap, int maxOverlap)

一次搜索可能包含多个搜索词，而一篇文档中也可能包含多个搜索词，此项表示，当一篇文档中包含的搜索词越多，则此文档则打分越高。

public void TestCoord() throws Exception { 
  MySimilarity sim = new MySimilarity(); 
  File indexDir = new File("TestCoord"); 
  IndexWriter writer = new IndexWriter(FSDirectory.open(indexDir), new StandardAnalyzer(Version.LUCENE_CURRENT), true, IndexWriter.MaxFieldLength.LIMITED); 
  Document doc1 = new Document(); 
  Field f1 = new Field("contents", "common hello world", Field.Store.NO, Field.Index.ANALYZED); 
  doc1.add(f1); 
  writer.addDocument(doc1); 
  Document doc2 = new Document(); 
  Field f2 = new Field("contents", "common common common", Field.Store.NO, Field.Index.ANALYZED); 
  doc2.add(f2); 
  writer.addDocument(doc2); 
  for(int i = 0; i < 10; i++){ 
    Document doc3 = new Document(); 
    Field f3 = new Field("contents", "world", Field.Store.NO, Field.Index.ANALYZED); 
    doc3.add(f3); 
    writer.addDocument(doc3); 
  } 
  writer.close();

  IndexReader reader = IndexReader.open(FSDirectory.open(indexDir)); 
  IndexSearcher searcher = new IndexSearcher(reader); 
  searcher.setSimilarity(sim); 
  QueryParser parser = new QueryParser(Version.LUCENE_CURRENT, "contents", new StandardAnalyzer(Version.LUCENE_CURRENT)); 
  Query query = parser.parse("common world"); 
  TopDocs docs = searcher.search(query, 2); 
  for (ScoreDoc doc : docs.scoreDocs) { 
    System.out.println("docid : " + doc.doc + " score : " + doc.score); 
  } 
}

class MySimilarity extends Similarity {

  @Override 
  public float coord(int overlap, int maxOverlap) { 
    return 1; 
  }

}

如上面的实例，当coord返回1，不起作用的时候，文档一虽然包含了两个搜索词common和world，但由于world的所在的文档数太多，而文档二包含common的次数比较多，因而文档二分数较高：

docid : 1 score : 1.9059997 
docid : 0 score : 1.2936771

而当coord起作用的时候，文档一由于包含了两个搜索词而分数较高：

class MySimilarity extends Similarity {

  @Override 
  public float coord(int overlap, int maxOverlap) { 
    return overlap / (float)maxOverlap; 
  }

}

docid : 0 score : 1.2936771 
docid : 1 score : 0.95299983

(7) float scorePayload(int docId, String fieldName, int start, int end, byte [] payload, int offset, int length)

由于Lucene引入了payload，因而可以存储一些自己的信息，用户可以根据自己存储的信息，来影响Lucene的打分。

由 payload的定义我们知道，索引是以倒排表形式存储的，对于每一个词，都保存了包含这个词的一个链表，当然为了加快查询速度，此链表多用跳跃表进行存 储。Payload信息就是存储在倒排表中的，同文档号一起存放，多用于存储与每篇文档相关的一些信息。当然这部分信息也可以存储域里(stored Field)，两者从功能上基本是一样的，然而当要存储的信息很多的时候，存放在倒排表里，利用跳跃表，有利于大大提高搜索速度。

Payload的存储方式如下图：

 

由payload的定义，我们可以看出，payload可以存储一些不但与文档相关，而且与查询词也相关的信息。比如某篇文档的某个词有特殊性，则可以在这个词的这个文档的position信息后存储payload信息，使得当搜索这个词的时候，这篇文档获得较高的分数。

要利用payload来影响查询需要做到以下几点，下面举例用<b></b>标记的词在payload中存储1，否则存储0：

首先要实现自己的Analyzer从而在Token中放入payload信息：

class BoldAnalyzer extends Analyzer {

  @Override
  public TokenStream tokenStream(String fieldName, Reader reader) {
    TokenStream result = new WhitespaceTokenizer(reader);
    result = new BoldFilter(result);
    return result;
  }

}

class BoldFilter extends TokenFilter {
  public static int IS_NOT_BOLD = 0;
  public static int IS_BOLD = 1;

  private TermAttribute termAtt;
  private PayloadAttribute payloadAtt;

  protected BoldFilter(TokenStream input) {
    super(input);
    termAtt = addAttribute(TermAttribute.class);
    payloadAtt = addAttribute(PayloadAttribute.class);
  }

  @Override
  public boolean incrementToken() throws IOException {
    if (input.incrementToken()) {

      final char[] buffer = termAtt.termBuffer();
      final int length = termAtt.termLength();

      String tokenstring = new String(buffer, 0, length);
      if (tokenstring.startsWith("<b>") && tokenstring.endsWith("</b>")) {
        tokenstring = tokenstring.replace("<b>", "");
        tokenstring = tokenstring.replace("</b>", "");
        termAtt.setTermBuffer(tokenstring);
        payloadAtt.setPayload(new Payload(int2bytes(IS_BOLD)));
      } else {
        payloadAtt.setPayload(new Payload(int2bytes(IS_NOT_BOLD)));
      }
      return true;
    } else
      return false;
  }

  public static int bytes2int(byte[] b) {
    int mask = 0xff;
    int temp = 0;
    int res = 0;
    for (int i = 0; i < 4; i++) {
      res <<= 8;
      temp = b[i] & mask;
      res |= temp;
    }
    return res;
  }

  public static byte[] int2bytes(int num) {
    byte[] b = new byte[4];
    for (int i = 0; i < 4; i++) {
      b[i] = (byte) (num >>> (24 - i * 8));
    }
    return b;
  }

}

然后，实现自己的Similarity，从payload中读出信息，根据信息来打分。

class PayloadSimilarity extends DefaultSimilarity {

  @Override
  public float scorePayload(int docId, String fieldName, int start, int end, byte[] payload, int offset, int length) {
    int isbold = BoldFilter.bytes2int(payload);
    if(isbold == BoldFilter.IS_BOLD){
      System.out.println("It is a bold char.");
    } else {
      System.out.println("It is not a bold char.");
    }
    return 1;
  }
}

最后，查询的时候，一定要用PayloadXXXQuery(在此用PayloadTermQuery，在Lucene 2.4.1中，用BoostingTermQuery)，否则scorePayload不起作用。

public void testPayloadScore() throws Exception {
  PayloadSimilarity sim = new PayloadSimilarity();
  File indexDir = new File("TestPayloadScore");
  IndexWriter writer = new IndexWriter(FSDirectory.open(indexDir), new BoldAnalyzer(), true, IndexWriter.MaxFieldLength.LIMITED);
  Document doc1 = new Document();
  Field f1 = new Field("contents", "common hello world", Field.Store.NO, Field.Index.ANALYZED);
  doc1.add(f1);
  writer.addDocument(doc1);
  Document doc2 = new Document();
  Field f2 = new Field("contents", "common <b>hello</b> world", Field.Store.NO, Field.Index.ANALYZED);
  doc2.add(f2);
  writer.addDocument(doc2);
  writer.close();

  IndexReader reader = IndexReader.open(FSDirectory.open(indexDir));
  IndexSearcher searcher = new IndexSearcher(reader);
  searcher.setSimilarity(sim);
  PayloadTermQuery query = new PayloadTermQuery(new Term("contents", "hello"), new MaxPayloadFunction());
  TopDocs docs = searcher.search(query, 10);
  for (ScoreDoc doc : docs.scoreDocs) {
    System.out.println("docid : " + doc.doc + " score : " + doc.score);
  }
}

如果scorePayload函数始终是返回1，则结果如下，<b></b>不起作用。

It is not a bold char.
It is a bold char.
docid : 0 score : 0.2101998
docid : 1 score : 0.2101998

如果scorePayload函数如下：

class PayloadSimilarity extends DefaultSimilarity {

  @Override
  public float scorePayload(int docId, String fieldName, int start, int end, byte[] payload, int offset, int length) {
    int isbold = BoldFilter.bytes2int(payload);
    if(isbold == BoldFilter.IS_BOLD){
      System.out.println("It is a bold char.");
      return 10;
    } else {
      System.out.println("It is not a bold char.");
      return 1;
    }
  }
}

则结果如下，同样是包含hello，包含加粗的文档获得较高分：

It is not a bold char.
It is a bold char.
docid : 1 score : 2.101998
docid : 0 score : 0.2101998

继承并实现自己的collector

以上各种方法，已经把Lucene score计算公式的所有变量都涉及了，如果这还不能满足您的要求，还可以继承实现自己的collector。

在Lucene 2.4中，HitCollector有个函数public abstract void collect(int doc, float score)，用来收集搜索的结果。

其中TopDocCollector的实现如下：

public void collect(int doc, float score) {
  if (score > 0.0f) {
    totalHits++;
    if (reusableSD == null) {
      reusableSD = new ScoreDoc(doc, score);
    } else if (score >= reusableSD.score) {
      reusableSD.doc = doc;
      reusableSD.score = score;
    } else {
      return;
    }
    reusableSD = (ScoreDoc) hq.insertWithOverflow(reusableSD);
  }
}

此函数将docid和score插入一个PriorityQueue中，使得得分最高的文档先返回。

我们可以继承HitCollector，并在此函数中对score进行修改，然后再插入PriorityQueue，或者插入自己的数据结构。

比如我们在另外的地方存储docid和文档创建时间的对应，我们希望当文档时间是一天之内的分数最高，一周之内的分数其次，一个月之外的分数很低。

我们可以这样修改：

public static long milisecondsOneDay = 24L * 3600L * 1000L;

public static long millisecondsOneWeek = 7L * 24L * 3600L * 1000L;

public static long millisecondsOneMonth = 30L * 24L * 3600L * 1000L;

public void collect(int doc, float score) {
  if (score > 0.0f) {

    long time = getTimeByDocId(doc);

    if(time < milisecondsOneDay) {

        score = score * 1.0;

    } else if (time < millisecondsOneWeek){

        score = score * 0.8;

    } else if (time < millisecondsOneMonth) {

        score = score * 0.3;

    } else {

        score = score * 0.1;

    }

    totalHits++;
    if (reusableSD == null) {
      reusableSD = new ScoreDoc(doc, score);
    } else if (score >= reusableSD.score) {
      reusableSD.doc = doc;
      reusableSD.score = score;
    } else {
      return;
    }
    reusableSD = (ScoreDoc) hq.insertWithOverflow(reusableSD);
  }
}

 

在Lucene 3.0中，Collector接口为void collect(int doc)，TopScoreDocCollector实现如下：

public void collect(int doc) throws IOException {
  float score = scorer.score();
  totalHits++;
  if (score <= pqTop.score) {
    return;
  }
  pqTop.doc = doc + docBase;
  pqTop.score = score;
  pqTop = pq.updateTop();
}

同样可以用上面的方式影响其打分。