Главная Обзор Помощь
Вход
S.H.I.E.L.D.
/
wenda-php
2
0
Ответвить 0
Файлы Задачи 0 Запросы на слияние 0 Вики
Ветка: master
Ветки Метки
wenda-php
/
protected
/
plugin
/
xsearch
/
doc
/
guide
/
search.overview.html

search.overview.html 12 KB
Постоянная ссылка История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/html; charset=gbk" />
    5. 

  5. <meta name="language" content="zh-cn" />
    6. 

  6. <link rel="stylesheet" type="text/css" href="../api/css/style.css" />
    7. 

  7. <link rel="stylesheet" type="text/css" href="../api/css/guide.css" />
    8. 

  8. <link rel="stylesheet" type="text/css" href="../api/css/highlight.css" />
    9. 

  9. <title>搜索概述</title>
    10. 

  10. </head>
    11. 

  11. 

  12. <body>
    13. 

  13. <div id="apiPage">
    14. 

  14. 

  15. <div id="apiHeader">
    16. 

  16. <a href="http://www.xunsearch.com" target="_blank">Xunsearch PHP-SDK</a> v1.3.2 权威指南
    17. 

  17. </div><!-- end of header -->
    18. 

  18. 

  19. <div id="content" class="markdown">
    20. 

  20. 	<div class="toc"><ol><li><a href="#ch0">如何开始使用搜索？</a></li><li><a href="#ch1">典型搜索做法</a></li><li><a href="#ch2">关于快捷搜索</a></li><li><a href="#ch3">搜索中的串接操作</a></li><li><a href="#ch4">搜索日志</a></li><li><a href="#ch5">如何进行多库搜索？</a></li></ol></div><h1 id="-">搜索概述</h1>
    21. 

  21. 

  22. <p>在索引库建立完成后，现在开始学习使用搜索功能，这也是最核心的部分。</p>
    23. 

  23. 

  24. <h2 id="ch0">1. 如何开始使用搜索？<a name="ch0" class="anchor">?</a></h2>
    25. 

  25. 

  26. <p>在 <code>PHP-SDK</code> 中，搜索功能由类型为 <a href="../api/XSSearch.html">XSSearch</a> 的对象所维护。在 <a href="../api/XS.html">XS</a> 项目中，通过读取
    27. 

  27. <a href="../api/XS.html#search">XS::search</a> 属性来获取搜索操作对象，然后展开使用，而不是自行创建对象。后面章节中的
    28. 

  28. 相关测试代码如果没有特别编写，其中的 <code>$search</code> 均为通过类似以下的方式获取的索引对象：</p>
    29. 

  29. 

  30. <div class="hl-code"><div class="php-hl-main"><pre><span class="php-hl-reserved">require</span> <span class="php-hl-quotes">'</span><span class="php-hl-string">$prefix/sdk/php/lib/XS.php</span><span class="php-hl-quotes">'</span><span class="php-hl-code">;
    31. 

  31. </span><span class="php-hl-var">$xs</span><span class="php-hl-code"> = </span><span class="php-hl-reserved">new</span> <span class="php-hl-identifier">XS</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">demo</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 建立 XS 对象，项目名称为：demo</span>
    32. 

  32. <span class="php-hl-var">$search</span><span class="php-hl-code"> = </span><span class="php-hl-var">$xs</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">search</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 获取 搜索对象</span></pre></div></div>
    33. 

  33. 

  34. <blockquote class="info">
    35. 

  35. <p><strong>Info:</strong> 搜索对象内置了字符集智能转换，如果您使用的字符集和项目默认的字符集 <a href="../api/XS.html#defaultCharset">XS::defaultCharset</a>
    36. 

  36.   不一致，请调用 <a href="../api/XSSearch.html#setCharset">XSSearch::setCharset</a> 在开始其它搜索前设置正确的字符集。</p>
    37. 

  37. </blockquote>
    38. 

  38. 

  39. <h2 id="ch1">2. 典型搜索做法<a name="ch1" class="anchor">?</a></h2>
    40. 

  40. 

  41. <p>一个典型的搜索基本流程是把构建好的搜索语句，通过合适的 <code>API</code> 进行必要的修饰，
    42. 

  42. 再传递给底层的搜索服务器进行处理，然后把匹配的结果返回。具体包括以下步骤：</p>
    43. 

  43. 

  44. <ul>
    45. 

  45. <li>构建搜索查询语句 <code>query</code>，然后调用 <a href="../api/XSSearch.html#setQuery">XSSearch::setQuery</a> 设定它</li>
    46. 

  46. <li>根据需要设置附加的查询条件：通过 <a href="../api/XSSearch.html#addWeight">XSSearch::addWeight</a> 干扰排名权重，
    47. 

  47. 通过 <a href="../api/XSSearch.html#addRange">XSSearch::addRange</a> 添加字段搜索区间或范围，
    48. 

  48. 通过 <a href="../api/XSSearch.html#setFuzzy">XSSearch::setFuzzy</a> 开启模糊匹配，以获取更多搜索结果</li>
    49. 

  49. <li>进行必要的搜索结果限定：通过 <a href="../api/XSSearch.html#setLimit">XSSearch::setLimit</a> 设置搜索结果数量和偏移，
    50. 

  50. 通过 <a href="../api/XSSearch.html#setSort">XSSearch::setSort</a> 设置搜索结果的排序方式，等等</li>
    51. 

  51. <li>执行搜索，并获取搜索结果，关于搜索结果的处理详见后面的章节</li>
    52. 

  52. </ul>
    53. 

  53. 

  54. <p>代码如下：</p>
    55. 

  55. 

  56. <div class="hl-code"><div class="php-hl-main"><pre><span class="php-hl-var">$query</span><span class="php-hl-code"> = </span><span class="php-hl-quotes">'</span><span class="php-hl-string">项目测试</span><span class="php-hl-quotes">'</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 这里的搜索语句很简单，就一个短语</span>
    57. 

  57.  
    58. 

  58. <span class="php-hl-var">$search</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">setQuery</span><span class="php-hl-brackets">(</span><span class="php-hl-var">$query</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 设置搜索语句</span>
    59. 

  59. <span class="php-hl-var">$search</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">addWeight</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">subject</span><span class="php-hl-quotes">'</span><span class="php-hl-code">, </span><span class="php-hl-quotes">'</span><span class="php-hl-string">xunsearch</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 增加附加条件：提升标题中包含 'xunsearch' 的记录的权重</span>
    60. 

  60. <span class="php-hl-var">$search</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">setLimit</span><span class="php-hl-brackets">(</span><span class="php-hl-number">5</span><span class="php-hl-code">, </span><span class="php-hl-number">10</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 设置返回结果最多为 5 条，并跳过前 10 条</span>
    61. 

  61.  
    62. 

  62. <span class="php-hl-var">$docs</span><span class="php-hl-code"> = </span><span class="php-hl-var">$search</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">search</span><span class="php-hl-brackets">(</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 执行搜索，将搜索结果文档保存在 $docs 数组中</span>
    63. 

  63. <span class="php-hl-var">$count</span><span class="php-hl-code"> = </span><span class="php-hl-var">$search</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">count</span><span class="php-hl-brackets">(</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 获取搜索结果的匹配总数估算值</span></pre></div></div>
    64. 

  64. 

  65. <blockquote class="tip">
    66. 

  66. <p><strong>Tip:</strong> 除了调用 <a href="../api/XSSearch.html#search">XSSearch::search</a> 获取搜索结果外，在某些情况我们可能只想知道结果的命中数量，
    67. 

  67.   那么可以直接调用 <a href="../api/XSSearch.html#count">XSSearch::count</a> 来获取。但要指出的是，这个结果计数只是一个估算值。</p>
    68. 

  68. </blockquote>
    69. 

  69. 

  70. <h2 id="ch2">3. 关于快捷搜索<a name="ch2" class="anchor">?</a></h2>
    71. 

  71. 

  72. <p>除了上述的典型搜索方式外，我们还提供一种称为快捷搜索的方式。其实就是直接将 <code>query</code> 语句作为参数传递给相应的
    73. 

  73. <code>API</code> 调用 <a href="../api/XSSearch.html#count">XSSearch::count</a> 和 <a href="../api/XSSSearch.html#search">XSSSearch::search</a>。由于不经过 <code>setQuery</code> 因此有些其它辅助的功能受到
    74. 

  74. 限制，比如不能进行结果高亮、不能通过 <code>addWeight</code>、<code>addRange</code> 增加辅助搜索条件。</p>
    75. 

  75. 

  76. <div class="hl-code"><div class="php-hl-main"><pre><span class="php-hl-var">$count</span><span class="php-hl-code"> = </span><span class="php-hl-var">$search</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">count</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">项目测试</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; 
    77. 

  77. </span><span class="php-hl-var">$docs</span><span class="php-hl-code"> = </span><span class="php-hl-var">$search</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">search</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">项目测试</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">;</span></pre></div></div>
    78. 

  78. 

  79. <h2 id="ch3">4. 搜索中的串接操作<a name="ch3" class="anchor">?</a></h2>
    80. 

  80. 

  81. <p>由于 <code>Xunsearch PHP-SDK</code> 全面采用面向对象的编程思想，在搜索对象中对部分搜索语句构建、
    82. 

  82. 搜索结果修饰加入了串接操作支持。支持串接操作的方法有：</p>
    83. 

  83. 

  84. <ul>
    85. 

  85. <li><code>addDB($name)</code> - 用于多库搜索，添加数据库名称</li>
    86. 

  86. <li><code>addRange($field, $from, $to)</code> - 添加搜索过滤区间或范围</li>
    87. 

  87. <li><code>addWeight($field, $term)</code> - 添加权重索引词</li>
    88. 

  88. <li><code>setCharset($charset)</code> - 设置字符集</li>
    89. 

  89. <li><code>setCollapse($field, $num = 1)</code> - 设置搜索结果按字段值折叠</li>
    90. 

  90. <li><code>setDb($name)</code> - 设置搜索库名称，默认则为 <code>db</code></li>
    91. 

  91. <li><code>setFuzzy()</code> - 设置开启模糊搜索, 传入参数 false 可关闭模糊搜索</li>
    92. 

  92. <li><code>setLimit($limit, $offset = 0)</code> - 设置搜索结果返回的数量和偏移</li>
    93. 

  93. <li><code>setQuery($query)</code> - 设置搜索语句</li>
    94. 

  94. <li><code>setSort($field, $asc = false)</code> - 设置搜索结果按字段值排序</li>
    95. 

  95. </ul>
    96. 

  96. 

  97. <p>如果采用串接操作，那么上面的搜索语句可以改写如下，有种一气呵成的感觉：</p>
    98. 

  98. 

  99. <div class="hl-code"><div class="php-hl-main"><pre><span class="php-hl-var">$docs</span><span class="php-hl-code"> = </span><span class="php-hl-var">$search</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">setQuery</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">项目测试</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">addWeight</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">subject</span><span class="php-hl-quotes">'</span><span class="php-hl-code">, </span><span class="php-hl-quotes">'</span><span class="php-hl-string">xunsearch</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">setLimit</span><span class="php-hl-brackets">(</span><span class="php-hl-number">5</span><span class="php-hl-code">, </span><span class="php-hl-number">10</span><span class="php-hl-brackets">)</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">search</span><span class="php-hl-brackets">(</span><span class="php-hl-brackets">)</span><span class="php-hl-code">;</span></pre></div></div>
    100. 

  100. 

  101. <h2 id="ch4">5. 搜索日志<a name="ch4" class="anchor">?</a></h2>
    102. 

  102. 

  103. <p>在每一次正常搜索之后，系统内部均对相应的关键词做了记录和一并分析。但这个行为并不是实时的，
    104. 

  104. 而是积累一定的量后再统一分析和处理。</p>
    105. 

  105. 

  106. <p>搜索日志保存在 <code>$prefix/项目名/log_db</code> 中，它是一个独立的索引库，通过它实现了包括相关搜索、
    107. 

  107. 拼音搜索、纠错建议等功能。</p>
    108. 

  108. 

  109. <blockquote class="tip">
    110. 

  110. <p><strong>Tip:</strong> 如果您需要强制同步搜索日志库，请参见 <a href="util.indexer.html">Indexer 索引管理工具</a> 的 <code>--flush-log</code> 选项。<br />
    111. 

  111.   此外，只有当您的搜索代码中调用了 <a href="../api/XSSearch.html#setQuery">XSSearch::setQuery</a> 并配合不带参数的 <a href="../api/XSSearch.html#search">XSSearch::search</a> 调用，
    112. 

  112.   才会记录本次搜索关键词。</p>
    113. 

  113. </blockquote>
    114. 

  114. 

  115. <h2 id="ch5">6. 如何进行多库搜索？<a name="ch5" class="anchor">?</a></h2>
    116. 

  116. 

  117. <p>在<a href="index.overview.html">索引概述</a>中我们曾经提到，如果您的索引数据量非常大，那么应当适当
    118. 

  118. 考虑分割数据，在服务端采用多个库来保存索引数据。您可以调用 <a href="../api/XSSearch.html#addDb">XSSearch::addDb</a> 添加
    119. 

  119. 其它搜索库。</p>
    120. 

  120. 

  121. <p>关于超大数据量的多库搜索及分布式设计，由于涉及的知识和范围比较广。我们提供了专门的商业支持方案，
    122. 

  122. 在论坛中也会开辟专门的讨论，在此略过不述。</p>
    123. 

  123. 

  124. <div class="revision">$Id$</div>
    125. 

  125. 	<div class="clear"></div>
    126. 

  126. </div><!-- end of content -->
    127. 

  127. <div id="guideNav">
    128. 

  128. 		<div class="prev"><a href="index.dict.html">&laquo; 自定义SCWS词库</a></div>
    129. 

  129. 			<div class="next"><a href="search.query.html">构建搜索语句 &raquo;</a></div>
    130. 

  130. 		<div class="clear"></div>
    131. 

  131. </div><!-- end of nav -->
    132. 

  132. 

  133. <div id="apiFooter">
    134. 

  134. Copyright &copy; 2008-2011 by <a href="http://www.xunsearch.com" target="_blank">杭州云圣网络科技有限公司</a><br/>
    135. 

  135. All Rights Reserved.<br/>
    136. 

  136. </div><!-- end of footer -->
    137. 

  137. 

  138. </div><!-- end of page -->
    139. 

  139. 

  140. <div style="display:none;">
    141. 

  141. 	<img src="../api/css/info.gif" />
    142. 

  142. 	<img src="../api/css/tip.gif" />
    143. 

  143. 	<img src="../api/css/note.gif" />
    144. 

  144. </div>
    145. 

  145. 

  146. </body>
    147. 

  147. </html>
    148.