solr拼写检查配置

拼写检查功能，能在搜索时，提供一个较好用户体验，所以，主流的搜索引擎都有这个功能。

那么什么是拼写检查，其实很好理解，就是你输入的搜索词，可能是你输错了，也有可能在它的检索库里面根本不存在这个词，但是这时候它能给你返回，相似或相近的结果来帮助你校正。
举个例子，假如你在百度里面输入在在线电瓶，可能它的索引库里面就没有，但是它有可能返回在线电影，在线电视，在线观看等等一些词，这些，就用到拼写检查的功能了。

solr是一个基于lucene开发接口实现的成熟的搜索系统，通过不同的控件（Component）实现不同的搜索功能，其中一个SpellCheckComponent实现了拼写检查功能。

要在搜索过程中添加拼写检查功能，必须在solr的solrconfig.xml中配置spellcheck控件，并在相关SearchHandler（select/query等）中添加拼写检查参数配置。

配置如下：

    <!-- Spell Check

         The spell check component can return a list of alternative spelling
         suggestions.

         http://wiki.apache.org/solr/SpellCheckComponent
      -->
   <searchComponent name="spellcheck" class="solr.SpellCheckComponent">

     <!-- 将输入关键词当做text_general类型进行处理 -->
     <str name="queryAnalyzerFieldType">text_general</str>

     <!-- Multiple "Spell Checkers" can be declared and used by this
          component
       -->

     <!-- a spellchecker built from a field of the main index -->
     <lst name="spellchecker">
       <!-- 拼写检查模块名 -->
       <str name="name">default</str>
       <!-- 对索引中的哪个字段进行拼写检查 -->
       <str name="field">text</str>
       <!-- 自定义拼写检查，可以用自定义拼写检查类代替默认类 -->
       <str name="classname">solr.DirectSolrSpellChecker</str>
       <!-- 拼写检查编辑距离, 默认使用internal levenshtein -->
       <str name="distanceMeasure">internal</str>
       <!-- minimum accuracy needed to be considered a valid spellcheck suggestion -->
       <float name="accuracy">0.5</float>
       <!-- 最大编辑距离，与输入字符串编辑距离小于等于2的字符串被检索出来作为纠错结果 -->
       <int name="maxEdits">2</int>
       <!-- 与输入字符串最少有一个字符相等，才能被检索出来 -->
       <int name="minPrefix">1</int>
       <!-- maximum number of inspections per result. 一次纠错探测最大数量 -->
       <int name="maxInspections">5</int>
       <!-- 纠错元词最小长度，元词长度小于4不进行纠错 -->
       <int name="minQueryLength">4</int>
       <!-- maximum threshold of documents a query term can appear to be considered for correction -->
       <float name="maxQueryFrequency">0.01</float>
       <!-- uncomment this to require suggestions to occur in 1% of the documents
           <float name="thresholdTokenFrequency">.01</float>
       -->
     </lst>

     <!-- a spellchecker that can break or combine words. 不同实现的拼写检查模块 -->
     <lst name="spellchecker">
       <str name="name">wordbreak</str>
       <str name="classname">solr.WordBreakSolrSpellChecker</str>
       <str name="field">text</str>
       <str name="combineWords">true</str>
       <str name="breakWords">true</str>
       <int name="maxChanges">10</int>
     </lst>

     <!-- 使用不同编辑距离的拼写检查模块 -->
     <!--
        <lst name="spellchecker">
          <str name="name">jarowinkler</str>
          <str name="field">spell</str>
          <str name="classname">solr.DirectSolrSpellChecker</str>
          <str name="distanceMeasure">
            org.apache.lucene.search.spell.JaroWinklerDistance
          </str>
        </lst>
      -->

     <!-- a spellchecker that use an alternate comparator

          comparatorClass be one of:
           1. score (default)
           2. freq (Frequency first, then score)
           3. A fully qualified class name
       -->
     <!--
        <lst name="spellchecker">
          <str name="name">freq</str>
          <str name="field">lowerfilt</str>
          <str name="classname">solr.DirectSolrSpellChecker</str>
          <str name="comparatorClass">freq</str>
       -->

     <!-- A spellchecker that reads the list of words from a file -->
     <!--
        <lst name="spellchecker">
          <str name="classname">solr.FileBasedSpellChecker</str>
          <str name="name">file</str>
          <str name="sourceLocation">spellings.txt</str>
          <str name="characterEncoding">UTF-8</str>
          <str name="spellcheckIndexDir">spellcheckerFile</str>
        </lst>
       -->
   </searchComponent>

配置好SpellCheckComponent组件后，需要配置相应的SearchHandler，在正式搜索系统应用中需要配置select和query，自己测试时可以自定义一个，如：spell，配置如下：

  <requestHandler name="/spell" class="solr.SearchHandler" startup="lazy">
    <lst name="defaults">
      <str name="df">text</str>
      <!-- 下边配置了两个拼写检查子模块，是前边定义好的default和wordbreak，solr会分别用两个模块对输入进行拼写检查，最终将结果整合到一块 -->
      <str name="spellcheck.dictionary">default</str>
      <str name="spellcheck.dictionary">wordbreak</str>
      <str name="spellcheck">on</str>
      <!-- 为纠错后的提示词添加额外信息，如在索引中的频率 -->
      <str name="spellcheck.extendedResults">true</str>
      <!-- 一次纠错返回结果数量 -->
      <str name="spellcheck.count">10</str>
      <!-- The maximum number of suggestions to return for terms that exist in the index -->
      <str name="spellcheck.alternativeTermCount">5</str>
      <!-- The maximum number of results the query can return while still triggering spelling suggestions -->
      <str name="spellcheck.maxResultsForSuggest">5</str>
      <!-- 是否添加校验结果 -->
      <str name="spellcheck.collate">true</str>
      <!-- 是否添加校验拓展结果 -->
      <str name="spellcheck.collateExtendedResults">true</str>
      <!-- The maximum # of collation possibilities to try before giving up. -->
      <str name="spellcheck.maxCollationTries">10</str>
      <!-- 返回校验结果的最大数目 -->
      <str name="spellcheck.maxCollations">5</str>
    </lst>

    <!-- 必须将拼写检查控件添加到搜索控件序列中，若无此项则不进行拼写检查 -->
    <arr name="last-components">
      <str>spellcheck</str>
    </arr>
  </requestHandler>

在solr中测试如下：