sphinx+scws 全文检索使用之 安装配置篇

写在前面：

公司要做全文索引，调研了一些方案，由于coreseek的官网访问不了，准备使用sphinx+scws方案，安装的原文地址为http://blog.51yip.com/mysql/1659.html，我这里在安装过程中会有写出入，稍微有些改动！

评测：

一、Coreseek 为国人基于Sphinx开发的方案，目前最稳定版，是基于经典的Sphinx0.9.9版

优点：有成熟的文档、以及社区；其分词mmseg为目前国内最为好用分词，索引和搜索分词都可以用到；
缺点：深度开发、版本更新较慢；索引较慢
策略：一个词库管理后台，维护词库；定期生成字典；此套件会自动分词索引；
适用场景：普通青年、搭建差不多的搜索，适用于普遍网站

二、Sphinx-for-chinaese 为国人2基于经典的Sphinx0.9.9版开发的扩展版
优点：部署简单，易操作，内嵌分词和词库，索引和搜索分词都可以用到；
缺点:版本更新较慢；分词较弱；索引相对较慢
策略：同一
适用场景：普通青年、快速搭建搜索的小站

三、Sphinx+Scws 为两套独立系统，单独部署，所谓高内聚低耦合，强烈推荐
优点：两套系统，相对独立，各自单独Server；分词可以做其他用途；版本更新较快；
缺点：部署稍复杂，使用稍复杂；索引分词只能用一元分词，数据量较大
策略：词库管理外；使用时，先调用分词服务，后调用搜索
适用场景：文艺青年、搭建像样点的搜索；好吧文艺青年

sphinx简介

Sphinx是由俄罗斯人Andrew Aksyonoff开发的一个全文检索引擎。意图为其他应用提供高速、低空间占用、高结果 相关度的全文搜索功能。Sphinx可以非常容易的与SQL数据库和脚本语言集成。当前系统内置MySQL和PostgreSQL 数据库数据源的支持，也支持从标准输入读取特定格式 的XML数据。

sphinx特性

Sphinx 的主要特性：
索引和搜索性能优异；
先进的索引和查询工具 (灵活且功能丰富的文本分析器，查询语言，以及多种不同的排序方式等等);
先进的结果集分析处理 (SELECT 可以使用表达式, WHERE, ORDER BY, GROUP BY 等对全文搜索结果集进行过滤)；
实践证实可扩展性支持数十亿文档记录，TB级别的数据，以及每秒数千次查询;
易于集成SQL和XML数据源，并可使用SphinxAPI、SphinxQL或者SphinxSE搜索接口
易于通过分布式搜索进行扩展
Sphinx 的详细特性：
高速的索引建立(在当代CPU上，峰值性能可达到10 ~ 15MB/秒);
高性能的搜索 (在1.2G文本，100万条文档上进行搜索，支持高达每秒150~250次查询);
高扩展性 (最大的索引集群超过30亿条文档，最繁忙时刻的查询峰值达到每天5千万次);
提供了优秀的相关度算法，基于短语相似度和统计（BM25）的复合Ranking方法;
支持分布式搜索功能;
提供文档片段（摘要以及高亮）生成功能;
内建支持SphinxAPI和SphinxQL搜索箭口，也可作为MySQL的存储引擎提供搜索服务;
支持布尔、短语、词语相似度等多种检索模式;
文档支持多个全文检索字段(缺省配置下，最大不超过32个);
文档支持多个额外的属性信息(例如：分组信息，时间戳等);
支持查询停止词;
支持词形学处理;
支持特殊词汇处理;
支持单一字节编码和UTF-8编码;
内建支持英语、俄语、捷克语词干化处理; 对 法语，西班牙语，葡萄牙语，意大利语，罗马尼亚语，德国，荷兰，瑞典，挪威，丹麦，芬兰，匈牙利等语言 的支持可通过第三方的 libstemmer 库 建立);
原生的MySQL支持(同时支持MyISAM 、InnoDB、NDB、Archive等所有类型的数据表 );
原生的PostgreSQL 支持;
原生的ODBC兼容数据库支持 (MS SQL, Oracle, 等) ;
…多达50多项其他功能没有在此一一列出，请参阅API和配置手册！

scws简介

SCWS 是 Simple Chinese Word Segmentation 的首字母缩写（即：简易中文分词系统）。

这是一套基于词频词典的机械式中文分词引擎，它能将一整段的中文文本基本正确地切分成词。 词是中文的最小语素单位，但在书写时并不像英语会在词之间用空格分开， 所以如何准确并快速分词一直是中文分词的攻关难点。

SCWS 采用纯 C 语言开发，不依赖任何外部库函数，可直接使用动态链接库嵌入应用程序， 支持的中文编码包括 GBK、UTF-8 等。此外还提供了 PHP 扩展模块， 可在 PHP 中快速而方便地使用分词功能。

分词算法上并无太多创新成分，采用的是自己采集的词频词典，并辅以一定的专有名称，人名，地名， 数字年代等规则识别来达到基本分词，经小范围测试准确率在 90% ~ 95% 之间， 基本上能满足一些小型搜索引擎、关键字提取等场合运用。首次雏形版本发布于 2005 年底。

1.下载文件

sphinx下载地址：http://sphinxsearch.com/downloads/release/
sphinx php扩展下载地址：http://pecl.php.net/package/sphinx
scws下载地址：http://www.xunsearch.com/scws/download.php
scws词库下载地址：http://www.xunsearch.com/scws/down/scws-dict-chs-utf8.tar.bz2

2. 安装sphinx,scws,以及php扩展

安装sphinx

# tar zxvf sphinx-2.2.5-release.tar.gz  
# cd sphinx-2.2.5-release  
# ./configure --prefix=/usr/local/sphinx2 --with-mysql=/usr/local/mysql  
# make && make install 

注意出现错误：

src/sphinx.cpp:20719: undefined reference to `libiconv_open' 
sphinx.cpp:20737: undefined reference to `libiconv' 
sphinx.cpp:20743: undefined reference to `libiconv_close'

编辑：
./src/MakeFile文件
将
LIBS = -lm -lexpat -L/usr/local/lib
改成
LIBS = -lm -lexpat -liconv -L/usr/local/lib

安装sphinx客户端

# cd api/libsphinxclient   //sphinx-2.2.5-release目录下  
# ./configure --prefix=/usr/local/sphinx2/libsphinxclient  
# make && make install  

安装sphinx php扩展

# tar zxvf sphinx-1.3.1.tgz  
# cd sphinx-1.3.1  
# phpize  
# ./configure --with-sphinx=/usr/local/sphinx2/libsphinxclient --with-php-config=/usr/bin/php-config  
# make && make install 

安装scws

# tar xvjf scws-1.2.2.tar.bz2  
# mkdir /usr/local/scws  
# cd scws-1.2.2  
# ./configure --prefix=/usr/local/scws/  
# make && make install  

安装scws php扩展

# cd ./phpext/  
# phpize  
# ./configure  --with-scws=/usr/local/scws  --with-php-config=/usr/bin/php-config  
# make && make install

3.配置sphinx,scws,php等

创建测试表和数据

mysql> desc users;  
+----------+-------------+------+-----+---------+----------------+  
| Field | Type | Null | Key | Default | Extra |  
+----------+-------------+------+-----+---------+----------------+  
| user_id | int(11) | NO | PRI | NULL | auto_increment |  
| username | varchar(20) | NO | | NULL | |  
+----------+-------------+------+-----+---------+----------------+  
2 rows in set (0.00 sec)  

mysql> select * from users;  
+------------+------------+  
| user_id | username |  
+------------+------------+  
| 1311895262 | 张三 |  
| 1311895263 | tank张二 |  
| 1311895264 | tank张一 |  
| 1311895265 | tank张 |  
+------------+------------+  
4 rows in set (0.00 sec)  
mysql> desc orders;  
+--------------+-------------+------+-----+---------+----------------+  
| Field | Type | Null | Key | Default | Extra |  
+--------------+-------------+------+-----+---------+----------------+  
| id | int(11) | NO | PRI | NULL | auto_increment |  
| user_id | int(11) | NO | | NULL | |  
| create_time | datetime | NO | | NULL | |  
| product_name | varchar(20) | NO | | NULL | |  
| summary | text | NO | | NULL | |  
+--------------+-------------+------+-----+---------+----------------+  
5 rows in set (0.00 sec)  

mysql> select * from orders;  
+----+------------+---------------------+----------------+--------------+  
| id | user_id | create_time | product_name | summary |  
+----+------------+---------------------+----------------+--------------+  
| 9 | 1311895262 | 2014-08-01 00:24:54 | tank is 坦克 | 技术总监 |  
| 10 | 1311895263 | 2014-08-01 00:24:54 | tank is 坦克 | 技术经理 |  
| 11 | 1311895264 | 2014-08-01 00:24:54 | tank is 坦克 | DNB经理 |  
| 12 | 1311895265 | 2014-08-01 00:24:54 | tank is 坦克 | 运维总监 |  
+----+------------+---------------------+----------------+--------------+  
4 rows in set (0.00 sec)  

配置sphinx.conf，加上以下内容

source myorder  
{  
 type = mysql  
 sql_host = localhost  
 sql_user = root  
 sql_pass = 233238 
 sql_db = test  
 sql_query_pre = SET NAMES utf8  
 sql_query_pre = SET SESSION query_cache_type=OFF  
 sql_query = \  
 SELECT a.id, a.user_id,b.username, UNIX_TIMESTAMP(a.create_time) AS create_time, a.product_name, a.summary \  
 FROM orders a left join users b on a.user_id = b.user_id  
 sql_attr_uint = user_id  
 sql_field_string = username  
 sql_field_string = product_name  
 sql_attr_timestamp = create_time  

 sql_ranged_throttle = 0  
 #sql_query_info = SELECT * FROM orders WHERE id=$id  
}  

index myorder  
{  
 source = myorder  
 path = /opt/modules/sphinx/var/data/myorder  
 docinfo = extern  
 mlock = 0  
 morphology = none  
 min_word_len = 1  
 #charset_type = zh_cn.utf-8  
 html_strip = 1  
 charset_table = U+FF10..U+FF19->0..9, 0..9, U+FF41..U+FF5A->a..z, U+FF21..U+FF3A->a..z,A..Z->a..z, a..z, U+0149, U+017F, U+0138, U+00DF, U+00FF, U+00C0..U+00D6->U+00E0..U+00F6,U+00E0..U+00F6, U+00D8..U+00DE->U+00F8..U+00FE, U+00F8..U+00FE, U+0100->U+0101, U+0101,U+0102->U+0103, U+0103, U+0104->U+0105, U+0105, U+0106->U+0107, U+0107, U+0108->U+0109,U+0109, U+010A->U+010B, U+010B, U+010C->U+010D, U+010D, U+010E->U+010F, U+010F,U+0110->U+0111, U+0111, U+0112->U+0113, U+0113, U+0114->U+0115, U+0115, U+0116->U+0117,U+0117, U+0118->U+0119, U+0119, U+011A->U+011B, U+011B, U+011C->U+011D, U+011D,U+011E->U+011F, U+011F, U+0130->U+0131, U+0131, U+0132->U+0133, U+0133, U+0134->U+0135,U+0135, U+0136->U+0137, U+0137, U+0139->U+013A, U+013A, U+013B->U+013C, U+013C,U+013D->U+013E, U+013E, U+013F->U+0140, U+0140, U+0141->U+0142, U+0142, U+0143->U+0144,U+0144, U+0145->U+0146, U+0146, U+0147->U+0148, U+0148, U+014A->U+014B, U+014B,U+014C->U+014D, U+014D, U+014E->U+014F, U+014F, U+0150->U+0151, U+0151, U+0152->U+0153,U+0153, U+0154->U+0155, U+0155, U+0156->U+0157, U+0157, U+0158->U+0159, U+0159,U+015A->U+015B, U+015B, U+015C->U+015D, U+015D, U+015E->U+015F, U+015F, U+0160->U+0161,U+0161, U+0162->U+0163, U+0163, U+0164->U+0165, U+0165, U+0166->U+0167, U+0167,U+0168->U+0169, U+0169, U+016A->U+016B, U+016B, U+016C->U+016D, U+016D, U+016E->U+016F,U+016F, U+0170->U+0171, U+0171, U+0172->U+0173, U+0173, U+0174->U+0175, U+0175,U+0176->U+0177, U+0177, U+0178->U+00FF, U+00FF, U+0179->U+017A, U+017A, U+017B->U+017C,U+017C, U+017D->U+017E, U+017E, U+0410..U+042F->U+0430..U+044F, U+0430..U+044F,U+05D0..U+05EA, U+0531..U+0556->U+0561..U+0586, U+0561..U+0587, U+0621..U+063A, U+01B9,U+01BF, U+0640..U+064A, U+0660..U+0669, U+066E, U+066F, U+0671..U+06D3, U+06F0..U+06FF,U+0904..U+0939, U+0958..U+095F, U+0960..U+0963, U+0966..U+096F, U+097B..U+097F,U+0985..U+09B9, U+09CE, U+09DC..U+09E3, U+09E6..U+09EF, U+0A05..U+0A39, U+0A59..U+0A5E,U+0A66..U+0A6F, U+0A85..U+0AB9, U+0AE0..U+0AE3, U+0AE6..U+0AEF, U+0B05..U+0B39,U+0B5C..U+0B61, U+0B66..U+0B6F, U+0B71, U+0B85..U+0BB9, U+0BE6..U+0BF2, U+0C05..U+0C39,U+0C66..U+0C6F, U+0C85..U+0CB9, U+0CDE..U+0CE3, U+0CE6..U+0CEF, U+0D05..U+0D39, U+0D60,U+0D61, U+0D66..U+0D6F, U+0D85..U+0DC6, U+1900..U+1938, U+1946..U+194F, U+A800..U+A805,U+A807..U+A822, U+0386->U+03B1, U+03AC->U+03B1, U+0388->U+03B5, U+03AD->U+03B5,U+0389->U+03B7, U+03AE->U+03B7, U+038A->U+03B9, U+0390->U+03B9, U+03AA->U+03B9,U+03AF->U+03B9, U+03CA->U+03B9, U+038C->U+03BF, U+03CC->U+03BF, U+038E->U+03C5,U+03AB->U+03C5, U+03B0->U+03C5, U+03CB->U+03C5, U+03CD->U+03C5, U+038F->U+03C9,U+03CE->U+03C9, U+03C2->U+03C3, U+0391..U+03A1->U+03B1..U+03C1,U+03A3..U+03A9->U+03C3..U+03C9, U+03B1..U+03C1, U+03C3..U+03C9, U+0E01..U+0E2E,U+0E30..U+0E3A, U+0E40..U+0E45, U+0E47, U+0E50..U+0E59, U+A000..U+A48F, U+4E00..U+9FBF,U+3400..U+4DBF, U+20000..U+2A6DF, U+F900..U+FAFF, U+2F800..U+2FA1F, U+2E80..U+2EFF,U+2F00..U+2FDF, U+3100..U+312F, U+31A0..U+31BF, U+3040..U+309F, U+30A0..U+30FF,U+31F0..U+31FF, U+AC00..U+D7AF, U+1100..U+11FF, U+3130..U+318F, U+A000..U+A48F,U+A490..U+A4CF  
 ngram_len = 1  
 ngram_chars = U+4E00..U+9FBF, U+3400..U+4DBF, U+20000..U+2A6DF, U+F900..U+FAFF,U+2F800..U+2FA1F, U+2E80..U+2EFF, U+2F00..U+2FDF, U+3100..U+312F, U+31A0..U+31BF,U+3040..U+309F, U+30A0..U+30FF,U+31F0..U+31FF, U+AC00..U+D7AF, U+1100..U+11FF,U+3130..U+318F, U+A000..U+A48F, U+A490..U+A4CF  
}  
searchd
{
        listen                  = 9312
        log                     = /usr/local/sphinx2/var/log/searchd.log
        query_log               = /usr/local/sphinx2/var/log/query.log
        read_timeout            = 5
        max_children            = 30
        pid_file                = /usr/local/sphinx2/var/log/searchd.pid
        #max_matches            = 1000
        seamless_rotate         = 1
        preopen_indexes         = 1
        unlink_old              = 1
        workers                 = threads # for RT to work
        binlog_path             = /usr/local/sphinx2/var/data
}

注意：WARNING: key ‘sql_query_info’ was permanently removed from Sphinx configuration. Refer to documentation for details.出现类似这种错误可能都是sphinx新版本已经不支持了

安装scws词库

[hightman@d1 ~/scws-1.2.3]$ cd /usr/local/scws/etc
[hightman@d1 /usr/local/scws/etc]$ wget http://www.xunsearch.com/scws/down/scws-dict-chs-gbk.tar.bz2
[hightman@d1 /usr/local/scws/etc]$ wget http://www.xunsearch.com/scws/down/scws-dict-chs-utf8.tar.bz2
[hightman@d1 /usr/local/scws/etc]$ tar xvjf scws-dict-chs-gbk.tar.bz2
[hightman@d1 /usr/local/scws/etc]$ tar xvjf scws-dict-chs-utf8.tar.bz2

在这里一定要加权限，也就是说让php-fpm或者php-cgi的运行用户，拥有dict.utf8.xdb的所有权限。如果不这么做的话，php 扩展调用词库会报如下错误：
Warning: SimpleCWS::add_dict(): Failed to add the dict file

chmod 777 dict.utf8.xdb

配置php.ini

# vim /etc/php.ini  
[sphinx]  
extension = sphinx.so  

[scws]  
extension = scws.so  
scws.default.charset = utf-8  
scws.default.fpath = /usr/local/scws/etc  

启动sphinx,php-fpm

启动sphinx

# /usr/local/sphinx2/bin/indexer --config /usr/local/sphinx2/etc/sphinx.conf --all  
# /usr/local/sphinx2/bin/searchd --config /usr/local/sphinx2/etc/sphinx.conf  

重启php-fpm

/etc/init.d/php-fpm restart

测试sphinx全文检索

命令行的测试

[root@localhost phpext]# mysql -h 127.0.0.1 -P 9306  
Welcome to the MySQL monitor. Commands end with ; or \g.  
Your MySQL connection id is 1  
Server version: 2.2.5-id64-release (r4825)  

Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.  

Oracle is a registered trademark of Oracle Corporation and/or its  
affiliates. Other names may be trademarks of their respective  
owners.  

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.  

mysql> select * from myorder where match('张');  
+------+------------+------------+-------------+----------------+  
| id | user_id | username | create_time | product_name |  
+------+------------+------------+-------------+----------------+  
| 9 | 1311895262 | 张三 | 1406823894 | tank is 坦克 |  
| 10 | 1311895263 | tank张二 | 1406823894 | tank is 坦克 |  
| 11 | 1311895264 | tank张一 | 1406823894 | tank is 坦克 |  
| 12 | 1311895265 | tank张 | 1406823894 | tank is 坦克 |  
+------+------------+------------+-------------+----------------+  
4 rows in set (0.00 sec)  

利用php 扩展

  
 header("Content-type: text/html; charset=utf-8");  
 $b_time = microtime(true);  
 echo '
'.$b_time.'
';  
 $key = "张三";  
 $index = "myorder";  
 //========================================分词  

 $so = scws_new();  
 $so->set_charset('utf-8');  
 //默认词库  
 $so->add_dict(ini_get('scws.default.fpath') . '/dict.utf8.xdb');  
 //自定义词库  
// $so->add_dict('./dd.txt',SCWS_XDICT_TXT);  
 //默认规则  
 $so->set_rule(ini_get('scws.default.fpath') . '/rules.utf8.ini');  

 //设定分词返回结果时是否去除一些特殊的标点符号  
 $so->set_ignore(true);  

 //设定分词返回结果时是否复式分割，如“中国人”返回“中国＋人＋中国人”三个词。  
 // 按位异或的 1 | 2 | 4 | 8 分别表示: 短词 | 二元 | 主要单字 | 所有单字  
 //1,2,4,8 分别对应常量 SCWS_MULTI_SHORT SCWS_MULTI_DUALITY SCWS_MULTI_ZMAIN SCWS_MULTI_ZALL  
 $so->set_multi(false);  

 //设定是否将闲散文字自动以二字分词法聚合  
 $so->set_duality(false);  

 //设定搜索词  
 $so->send_text($key);  
 $words_array = $so->get_result();  
 $words = "";  
 foreach($words_array as $v)  
 {  
 $words = $words.'|('.$v['word'].')';  
 }  

 //加入全词  
 #$words = '('.$key.')'.$words;  
 $words = trim($words,'|');  
 $so->close();  
 echo '
输入：'.$key.'
';  
 echo '
分词：'.$words.'
';  
//========================================搜索  
 $sc = new SphinxClient();  
 $sc->SetServer('127.0.0.1',9312);  
 #$sc->SetMatchMode(SPH_MATCH_ALL);  
 $sc->SetMatchMode(SPH_MATCH_EXTENDED);  
 $sc->SetArrayResult(TRUE);  
 $res = $sc->Query($words,$index);  
 print_r($res);  
 $e_time = microtime(true);  
 $time = $e_time - $b_time;  
 echo '
'.$e_time.'
';  

 echo '
'.$time.'
';  
 exit;  
?>  

结果如下：

1415214126.9106
输入：张三
分词：(张三)
Array  
(  
 [error] =>  
 [warning] =>  
 [status] => 0  
 [fields] => Array  
 (  
 [0] => username  
 [1] => product_name  
 [2] => summary  
 )  

 [attrs] => Array  
 (  
 [user_id] => 1  
 [username] => 7  
 [create_time] => 2  
 [product_name] => 7  
 )  

 [matches] => Array  
 (  
 [0] => Array  
 (  
 [id] => 9  
 [weight] => 2500  
 [attrs] => Array  
 (  
 [user_id] => 1311895262  
 [username] => 张三  
 [create_time] => 1406823894  
 [product_name] => tank is 坦克  
 )  

 )  

 )  

 [total] => 1  
 [total_found] => 1  
 [time] => 0  
 [words] => Array  
 (  
 [张] => Array  
 (  
 [docs] => 4  
 [hits] => 4  
 )  

 [三] => Array  
 (  
 [docs] => 1  
 [hits] => 1  
 )  

 )  

)  
1415214126.9516
0.041085958480835