用php做搜索引擎,用 PHP 构建自定义搜索引擎

你的名字 2022-11-13 06:29 152阅读 0赞

转自：http://www.ibm.com/developerworks/cn/opensource/os-php-sphinxsearch/index.html

搜索车身零件

假定 Body-Parts.com 出售车身零件 —— 挡泥板、铬、缓冲器等 —— 用于珍贵且值得收藏的汽车。正如在现实世界中，Body Parts 站点的访问者很可能按制造商(比如保时捷或制造同类零件的第三方制造商)、零件号、产地、车型、年份、条件(二手、全新、翻新)以及描述或者这些属性的某种组合来搜索零件。

要构建 Body Parts 搜索功能，让我们使用 MySQL V5.0 作为数据存储并使用 Sphinx search 守护程序来提供快速而精确的文本搜索。MySQL V5.0 是一个功能强大的数据库，但是它的增强型全文本搜索功能并不特别丰富。实际上，它仅限于 MyISAM 表 —— 不支持外键的一种表格式，因此使用有限。

清单 1 至清单 4 显示了与此示例相关的 Body Parts 模式的部分代码。您将分别看到 Model(清单 1)、Assembly(清单 2)、Inventory(清单 3)和 Schematic(清单 4)表。

Model 表

清单 1 中所示的 Model 表十分简单：label 列将列举车型的名称 (“Corvette”)；description 使用客户友好方式进行描述(“两门跑车；第一年引入”)；而 begin\_production 和 end\_production 分别表示开始生产和结束生产该车型的年份。由于前述列中的值并不惟一，因此使用一个独立 ID 表示每四个这样的元素(label、description、begin\_production、end\_production)，并且是其他表中的外键。

清单 1. 车身零件 Model 表

CREATE TABLE Model (

id int(10) unsigned NOT NULL auto\_increment,

label varchar(7) NOT NULL,

description varchar(256) NOT NULL,

begin\_production int(4) NOT NULL,

end\_production int(4) NOT NULL,

PRIMARY KEY (id)

) ENGINE=InnoDB;

下面是 Model 表的一些样例数据：

INSERT INTO Model

(\`id\`, \`label\`, \`description\`, \`begin\_production\`, \`end\_production\`)

VALUES

(1,'X Sedan','Four-door performance sedan',1998,1999),

(3,'X Sedan','Four door performance sedan, 1st model year',1995,1997),

(4,'J Convertible','Two-door roadster, metal retracting roof',2002,2005),

(5,'J Convertible','Two-door roadster',2000,2001),

(7,'W Wagon','Four-door, all-wheel drive sport station wagon',2007,0);

Assembly 表

assembly 是一个子系统，例如汽车上安装的传动装置或所有玻璃。车主使用部件图及相关零件列表来查找备件。清单 2 中所示的 Assembly 表也十分简单：它将把一个惟一 ID 与部件标签和描述关联起来。

清单 2. Assembly 表

CREATE TABLE Assembly (

id int(10) unsigned NOT NULL auto\_increment,

label varchar(7) NOT NULL,

description varchar(128) NOT NULL,

PRIMARY KEY (id)

) ENGINE=InnoDB;

继续示例，下面是 Assembly 表的一些样例数据：

INSERT INTO Assembly

(\`id\`, \`label\`, \`description\`)

VALUES

(1,'5-00','Seats'),

(2,'4-00','Electrical'),

(3,'3-00','Glasses'),

(4,'2-00','Frame'),

(5,'1-00','Engine'),

(7,'101-00','Accessories');

Inventory 表

Inventory 表是汽车零件的典范列表。零件 —— 例如螺钉或灯泡 —— 可能用于每辆汽车和多个部件中，但是零件只在 Inventory 表中显示一次。Inventory 表中的每行包含：

使用了惟一的 32 位整数 serialno 标识行。

字母数字零件号(此零件号惟一并且可以用作主键。但是，由于它可以包含字母数字字符，因此它不适于与 Sphinx 结合使用，Sphinx 要求索引的每条记录都有一个惟一的 32 位整型键)。

文本描述。

价格。

Inventory 表的规范如清单 3 中所示：

清单 3. Inventory 表

CREATE TABLE Inventory (

id int(10) unsigned NOT NULL auto\_increment,

partno varchar(32) NOT NULL,

description varchar(256) NOT NULL,

price float unsigned NOT NULL default '0',

PRIMARY KEY (id),

UNIQUE KEY partno USING BTREE (partno)

) ENGINE=InnoDB;

零件的(部分)列表可能如下面所示：

INSERT INTO \`Inventory\`

(\`id\`, \`partno\`, \`description\`, \`price\`)

VALUES

(1,'WIN408','Portal window',423),

(2,'ACC711','Jack kit',110),

(3,'ACC43','Rear-view mirror',55),

(4,'ACC5409','Cigarette lighter',20),

(5,'WIN958','Windshield, front',500),

(6,'765432','Bolt',0.1),

(7,'ENG001','Entire engine',10000),

(8,'ENG088','Cylinder head',55),

(9,'ENG976','Large cylinder head',65);

Schematic 表

Schematic 表将把零件与部件和车型版本绑定在一起。因此，将使用 Schematic 表来查找组装 1979 J Class 敞篷车引擎的所有零件。Schematic 表中的每行都有一个惟一 ID，一个引用 Inventory 表行的外键，一个标识部件的外键，以及用于引用 Model 表中特定型号和版本的另一个键。各行如清单 4 所示：

清单 4. Schematic 表

CREATE TABLE Schematic (

id int(10) unsigned NOT NULL auto\_increment,

partno\_id int(10) unsigned NOT NULL,

assembly\_id int(10) unsigned NOT NULL,

model\_id int(10) unsigned NOT NULL,

PRIMARY KEY (id),

KEY partno\_index USING BTREE (partno\_id),

KEY assembly\_index USING BTREE (assembly\_id),

KEY model\_index USING BTREE (model\_id),

FOREIGN KEY (partno\_id) REFERENCES Inventory(id),

FOREIGN KEY (assembly\_id) REFERENCES Assembly(id),

FOREIGN KEY (model\_id) REFERENCES Model(id)

) ENGINE=InnoDB;

为了强化表的意图，下面是 Schematic 中的一张小型行列表：

INSERT INTO \`Schematic\`

(\`id\`, \`partno\_id\`, \`assembly\_id\`, \`model\_id\`)

VALUES

(1,6,5,1),

(2,8,5,1),

(3,1,3,1),

(4,5,3,1),

(5,8,5,7),

(6,6,5,7),

(7,4,7,3),

(8,9,5,3);

搜索表

定义了这些表后，就可以轻松地响应很多搜索：

显示特定型号的所有版本

列出装配特殊型号和版本所需的所有部件

显示构成特定型号和版本的特殊部件的所有零件

但是很多搜索代价较大：

查找所有模型和版本中出现零件号开头为 “WIN” 的所有零件

查找描述中有 “lacquer” 或 “paint” 的那些零件

查找描述中有 “black leather” 的所有零件

查找描述中有 “paint” 的所有 2002 J 系列零件

这些搜索中的每个搜索都要求使用长篇的 JOIN 子句或代价高昂的 LIKE 子句，尤其是在 Inventory 表和 Schematic 表十分大时更是如此。而且，复杂的文本搜索完全超出了 MySQL 的能力。要搜索大量文本数据，请考虑构建和使用 Sphinx 索引。

回页首

集成 Sphinx 软件

要应用 Sphinx 来解决问题，您必须定义一个或多个数据源以及一个或多个索引。

source 将标识数据库来建立索引，提供验证信息，并且定义查询用以构造每行。数据源可以随意地标识一列或多列作为过滤器，Sphinx 将之称为组。您将使用组来过滤结果。例如，单词描述可能得到 900 个匹配。如果只对特定型号的汽车匹配感兴趣，则可以进一步使用型号组进行过滤。

index 将要求获得数据源(即一组数据行)并定义应当如何为已从数据源中提取出来的数据编目。

您将在 sphinx.conf 文件中定义数据源和索引。Body Parts 的数据源是 MySQL 数据库。清单 5 显示了名为 catalog 的数据源的部分定义 —— 指定连接的数据库以及如何建立连接(主机、套接字、用户和密码)的代码片段。

清单 5. 用于访问 MySQL 数据库的设置

source catalog

type                            = mysql

sql\_host                        = localhost

sql\_user                        = reaper

sql\_pass                        = s3cr3t

sql\_db                          = body\_parts

sql\_sock                        =  /var/run/mysqld/mysqld.sock

sql\_port                        = 3306

接下来，创建一个查询以生成要被索引的行。通常，将创建 SELECT 子句，可能需要把许多表 JOIN 在一起才能得到行。但这里存在一个问题：搜索型号和年份必须使用 Assembly 表，但是零件号和零件描述只能在 Inventory 表中找到。为此，Sphinx 必须能够把搜索结果与 32 位整型主键绑定在一起。

要获得右侧表单中的数据，需要创建一个视图 —— MySQL V5 中的新结构，它将把来自其他表的列整合到单独的合成虚拟表中。使用视图，各类搜索所需的所有数据都在一个位置，但是活动数据实际上存在于其他表中。清单 6 显示了定义 Catalog 视图的 SQL。

清单 6. Catalog 视图将把数据整合到虚拟表中

CREATE OR REPLACE VIEW Catalog AS

SELECT

Inventory.id,

Inventory.partno,

Inventory.description,

Assembly.id AS assembly,

Model.id AS model

FROM

Assembly, Inventory, Model, Schematic

WHERE

Schematic.partno\_id=Inventory.id

AND Schematic.model\_id=Model.id

AND Schematic.assembly\_id=Assembly.id;

如果用前面所示的表和数据创建名为 body\_parts 的数据库，则 Catalog 视图应当类似以下内容：

mysql> use body\_parts;

Database changed

mysql> select \* from Catalog;

\+----+---------+---------------------+----------+-------+

\+----+---------+---------------------+----------+-------+

|  6 | 765432  | Bolt                |        5 |    1 |

|  8 | ENG088  | Cylinder head      |        5 |    1 |

|  1 | WIN408  | Portal window      |        3 |    1 |

|  5 | WIN958  | Windshield, front  |        3 |    1 |

|  4 | ACC5409 | Cigarette lighter  |        7 |    3 |

|  9 | ENG976  | Large cylinder head |        5 |    3 |

|  8 | ENG088  | Cylinder head      |        5 |    7 |

|  6 | 765432  | Bolt                |        5 |    7 |

\+----+---------+---------------------+----------+-------+

8 rows in set (0.00 sec)

在视图中，字段 id 将指回 Inventory 表中的零件条目。partno 和 description 列是要搜索的主要文本，而 assembly 和 model 列用作进一步过滤结果的组。视图就绪后，构造数据源查询就是小事一桩。清单 7 显示了 catalog 数据源定义的其余部分。

清单 7. 查询创建待索引的行

\# indexer query

\# document\_id MUST be the very first field

\# document\_id MUST be positive (non-zero, non-negative)

\# document\_id MUST fit into 32 bits

\# document\_id MUST be unique

sql\_query                      = \\

SELECT \\

id, partno, description, \\

assembly, model \\

FROM \\

Catalog;

sql\_group\_column                = assembly

sql\_group\_column                = model

\# document info query

\# ONLY used by search utility to display document information

\# MUST be able to fetch document info by its id, therefore

\# MUST contain '$id' macro

sql\_query\_info          = SELECT \* FROM Inventory WHERE id=$id

sql\_query 必须包括后续查找需要使用的主键，并且它必须包括需要索引和用作组的所有字段。两个 sql\_group\_column 条目将声明 Assembly 和 Model 可用于过滤结果。并且 search 实用程序将使用 sql\_query\_info 来查找匹配记录。在查询中，$id 被替换为 searchd 返回的每个主键。

最后一个配置步骤是构建索引。清单 8 显示了数据源 catalog 的索引。

清单 8. 描述 catalog 数据源的一个可能的索引

index catalog

source                  = catalog

path                    = /var/data/sphinx/catalog

morphology              = stem\_en

min\_word\_len            = 3

min\_prefix\_len          = 0

min\_infix\_len          = 3

第 1 行将指向 sphinx.conf 文件中的指定数据源。第 2 行将定义存储索引数据的位置；按照约定，Sphinx 索引将被存储到 /var/data/sphinx 中。第 3 行将允许索引使用英文词法。并且第 5 行至第 7 行将告诉索引器只索引含有三个字符或更多字符的那些单词，并且为每个这样的字符的子字符串创建中缀索引(为了便于引用，清单 9 显示了 Body Parts 的完整示例 sphinx.conf 文件)。

清单 9. Body Parts 的示例 sphinx.conf

source catalog

type                            = mysql

sql\_host                        = localhost

sql\_user                        = reaper

sql\_pass                        = s3cr3t

sql\_db                          = body\_parts

sql\_sock                        =  /var/run/mysqld/mysqld.sock

sql\_port                        = 3306

\# indexer query

\# document\_id MUST be the very first field

\# document\_id MUST be positive (non-zero, non-negative)

\# document\_id MUST fit into 32 bits

\# document\_id MUST be unique

sql\_query                      = \\

SELECT \\

id, partno, description, \\

assembly, model \\

FROM \\

Catalog;

sql\_group\_column                = assembly

sql\_group\_column                = model

\# document info query

\# ONLY used by search utility to display document information

\# MUST be able to fetch document info by its id, therefore

\# MUST contain '$id' macro

sql\_query\_info          = SELECT \* FROM Inventory WHERE id=$id

index catalog

source                  = catalog

path                    = /var/data/sphinx/catalog

morphology              = stem\_en

min\_word\_len            = 3

min\_prefix\_len          = 0

min\_infix\_len          = 3

searchd

port= 3312

log= /var/log/searchd/searchd.log

query\_log= /var/log/searchd/query.log

pid\_file= /var/log/searchd/searchd.pid

底部的 searchd 部分将配置 searchd 守护程序本身。该部分中的条目不言自明。query.log 尤为有用：它将在运行时显示每次搜索并显示结果，例如搜索的文档数和匹配总数。

回页首

构建和测试索引

您现在已经准备好为 Body Parts 应用程序构建索引。为此，需要执行以下步骤：

键入 $ sudo mkdir -p /var/data/sphinx 创建目录结构 /var/data/sphinx

假定 MySQL 正在运行，使用如下所示的代码运行索引器来创建索引。

清单 10. 创建索引

$ sudo /usr/local/bin/indexer --config /usr/local/etc/sphinx.conf --all

Sphinx 0.9.7

using config file '/usr/local/etc/sphinx.conf'...

indexing index 'catalog'...

collected 8 docs, 0.0 MB

sorted 0.0 Mhits, 82.8% done

total 8 docs, 149 bytes

total 0.010 sec, 14900.00 bytes/sec, 800.00 docs/sec

注：-all 参数将重构 sphinx.conf 中列出的所有索引。如果不需要重构所有索引，您可以使用其他参数只对部分索引进行重构。

您现在可以使用如下所示的代码用 search 实用程序测试索引(不必运行 searchd 即可使用 search)。

清单 11. 用 search 测试索引

$ /usr/local/bin/search --config /usr/local/etc/sphinx.conf ENG

Sphinx 0.9.7

index 'catalog': query 'ENG ': returned 2 matches of 2 total in 0.000 sec

displaying matches:

1. document=8, weight=1, assembly=5, model=7

id=8

partno=ENG088

description=Cylinder head

price=55

2. document=9, weight=1, assembly=5, model=3

id=9

partno=ENG976

description=Large cylinder head

price=65

words:

1. 'eng': 2 documents, 2 hits

$ /usr/local/bin/search --config /usr/local/etc/sphinx.conf wind

Sphinx 0.9.7

index 'catalog': query 'wind ': returned 2 matches of 2 total in 0.000 sec

displaying matches:

1. document=1, weight=1, assembly=3, model=1

id=1

partno=WIN408

description=Portal window

price=423

2. document=5, weight=1, assembly=3, model=1

id=5

partno=WIN958

description=Windshield, front

price=500

words:

1. 'wind': 2 documents, 2 hits

$ /usr/local/bin/search \\ --config /usr/local/etc/sphinx.conf --filter model 3 ENG

Sphinx 0.9.7

index 'catalog': query 'ENG ': returned 1 matches of 1 total in 0.000 sec

displaying matches:

1. document=9, weight=1, assembly=5, model=3

id=9

partno=ENG976

description=Large cylinder head

price=65

words:

1. 'eng': 2 documents, 2 hits

第一条命令 /usr/local/bin/search --config /usr/local/etc/sphinx.conf ENG 在零件号中找到了两个含有 ENG 的结果。第二条命令 /usr/local/bin/search --config /usr/local/etc/sphinx.conf wind 在两个零件描述中找到了子字符串 wind。而第三条命令把结果限定为 model 为 3 的条目。

回页首

编写代码

最后，您可以编写 PHP 代码来调用 Sphinx 搜索引擎。Sphinx PHP API 非常小并且易于掌握。清单 12 是一个小型 PHP 应用程序，用于调用 searchd 以得到使用上面所示的最后一条命令得到的相同结果(“在属于型号 3 的名称中找到含有 ‘cylinder’ 的所有零件”)。

清单 12. 从 PHP 调用 Sphinx 搜索引擎

SetServer( "localhost", 3312 );

$cl->SetMatchMode( SPH\_MATCH\_ANY  );

$cl->SetFilter( 'model', array( 3 ) );

$result = $cl->Query( 'cylinder', 'catalog' );

if ( $result === false ) \{

echo "Query failed: " . $cl->GetLastError() . ".\\n";

else \{

if ( $cl->GetLastWarning() ) \{

echo "WARNING: " . $cl->GetLastWarning() . "

if ( ! empty($result\["matches"\]) ) \{

foreach ( $result\["matches"\] as $doc => $docinfo ) \{

echo "$doc\\n";

print\_r( $result );

exit;

要测试代码，需要为 Sphinx 创建 log 目录，启动 searchd，然后运行 PHP 应用程序，如下所示：

清单 13. PHP 应用程序

$ sudo mkdir -p /var/log/searchd

$ sudo /usr/local/bin/searchd --config /usr/local/etc/sphinx.conf

$ php search.php

Array

(

\[fields\] => Array

(

\[0\] => partno

\[1\] => description

)

\[attrs\] => Array

(

\[assembly\] => 1

\[model\] => 1

)

\[matches\] => Array

(

\[9\] => Array

(

\[weight\] => 1

\[attrs\] => Array

(

\[assembly\] => 5

\[model\] => 3

)

\[total\] => 1

\[total\_found\] => 1

\[time\] => 0.000

\[words\] => Array

(

\[cylind\] => Array

(

\[docs\] => 2

\[hits\] => 2

)

输出为 9：匹配的单行的正确主键。如果 Sphinx 找到匹配，相关数组 $result 将包含名为 results 的元素。浏览 print\_r() 的输出以查看返回的其他内容。

注意事项：total\_found 是在索引中找到的匹配总数，而 found 是返回的结果数。这两者可能不同，因为您可以更改每次返回多少个匹配结果以及要返回哪批匹配结果，哪个结果利于对冗长的结果列表分页。请查看 API 调用 SetLimits()。一个分页示例是用 $cl->SetLimits( ( $page - 1 ) \* SPAN, SPAN ) 调用搜索引擎返回第一批、第二批、第三批(依此类推)SPAN 匹配结果，这取决于显示哪个页面。