XunSearch（讯搜）的使用教程步骤 2013年7月12日 / 2条评论
XunSearch是一款很不错的中文全文检索工具使用xunsearch快速构建自己的PHP全文搜索引擎。
需要注意的是XunSearch只能在Linux和Unix下运行。官方发布了一个DEMO 直接下载 PHP-SDK 就可以开发测试。
安装服务端
1. 下载&解压安装包：http://www.xunsearch.com/site/download
2. 强烈推荐用 $HOME/xunsearch 或 /usr/local/xunsearch 作为安装目录 ( 以下简称 $prefix) 。无论您是首次安装
xunsearch 还是升级新版本，均只要直接执行我们提供的安装脚本，输入安装目录然后耐心等待即可。
cd xunsearch-full-1.3.3 ; sh setup.sh
3. 安装完毕后，您就可以通过自带的脚本 ($prefix/bin/xs-ctl.sh) 启动/关闭 xunsearch 服务端了。用法举例：
$prefix/bin/xs-ctl.sh start # 默认启动，绑定本地的 8383/8384 端口
$prefix/bin/xs-ctl.sh -b inet start # 绑定全部 IP ，适合 SDK/服务端 不同服务器的情况
$prefix/bin/xs-ctl.sh stop # 停止服务器，若启动时指定了 -b inet 此处也必须指定
4. 没错，安装就是这么简单。特别提示，搜索的所有索引数据将被保存到 $prefix/data 目录，因此如果您希望数据目录另行安排，请采用软连接形式确保 $prefix/data 链至真实数据目录。此外，如果服务端启动时使用了 -b inet 参数，那么请借助 iptables 或其它防火墙工具进行保护，xunsearch 本身出于性能考虑不做其它验证处理。
PHP-SDK
PHP-SDK 的代码默认包含在服务端安装目录中，即 $prefix/sdk/php 。目录结构如下：
|– doc/ — HTML 格式的文档、API手册
|– app/ — 搜索项目 ini 文件的默认存储目录
|– lib/XS.php — 搜索库唯一文件，所有搜索相关功能均必须引入此文件
— util/ — 辅助工具目录
|– RequireCheck.php — 检测您的 PHP 环境是否符合 xunsearch 运行条件
|– Quest.php — 搜索测试工具
— Indexer.php — 索引管理工具
1. 如果您的搜索应用和服务端在同一机器，则无需其它操作，只需在开发时直接引入$prefix/sdk/php/lib/XS.php 即可。
2. 如果您的搜索应用和服务端不在同一机器，则请复制 $prefix/sdk/php 目录到相应的搜索应用服务器，同时出于安全考虑，建议不要放到 WEB 可访问的目录。
3. 使用 SDK 中的 util 工具要求您的 php(cli) 位于可执行文件默认搜索路径中 ( 即用 which php 可以检测到)，如不在请做好软链接至 /usr/local/bin/php 。
检测运行环境
Xunsearch 要求 PHP 是 5.2.0 及以上版本，强烈推荐使用 5.3.x 系列的 PHP。请在安装完毕后直接执行$prefix/sdk/php/util/RequireCheck.php 看输出即可。如果您的终端编码不是 UTF-8 请在调用时加上 -c gbk 参数。
DEMO 服务器
某些情况下，部分用户未能自己部署安装服务端，而又想体验 xunsearch 。因此，我们从发布 1.3.3 版本起，提供了一台供用户测试的 DEMO 服务器。用户无需安装服务端，直接下载 PHP-SDK 就可以开发测试。特别提示，DEMO 服务器只用于
测试目的，并会不定期重置数据。
单独下载 PHP-SDK
如果您没有安装服务端，想直接体验 DEMO 服务器的，您只要从下面地址下载解压 SDK 压缩包即可。
http://www.xunsearch.com/download/xunsearch-sdk-latest.zip
解压后得到 xunsearch-sdk 目录，相应的搜索库文件为 xunsearch-sdk/php/lib/XS.php
服务器地址
索引服务器：demo.xunsearch.com 端口 9393
搜索服务器：demo.xunsearch.com 端口 9394
开发流程
• 为便于讲解说明，假定 PHP-SDK 代码目录为 $sdk 。
• 分析搜索需求，设计搜索应用必需的字段。
• 编写项目配置文件，项目配置 ini 文件存放在 $sdk/app 目录。
• 引入 $sdk/lib/XS.php 进行搜索功能和界面开发，借助 $sdk/util/*.php 工具进行测试或调试。
认识对象
• XS — 搜索项目总对象，所有相关操作均基于此对象及子方法。
• XSDocument — 搜索结果或索引文档，包括一组字段及值，相当于 SQL 表中的一条记录。
• XSIndex — 索引管理，通过 XS 对象的 index 属性取得。
• XSSearch — 搜索功能，通过 XS 对象的 search 属性取得。
• XSException — 异常类型，必须捕捉此异常以判断操作是否正确，例：
