TNTSearch 使用教程

1. 项目介绍

TNTSearch 是一个完全用 PHP 编写的全文搜索引擎（FTS）。它旨在为 PHP 开发者提供一个原生的解决方案，能够无缝集成到他们的项目中。TNTSearch 提供了强大的全文搜索功能，支持模糊搜索、实时搜索、地理位置搜索、文本分类、词干提取、自定义分词器、Bm25 排名算法、布尔搜索、结果高亮显示以及动态索引更新等功能。

2. 项目快速启动

2.1 安装

首先，确保你的系统满足以下要求：

• PHP >= 7.1
• PDO PHP Extension
• SQLite PHP Extension
• mbstring PHP Extension

使用 Composer 安装 TNTSearch：

composer require teamtnt/tntsearch

2.2 创建索引

创建索引是使用 TNTSearch 进行全文搜索的第一步。以下是一个简单的示例：

use TeamTNT\TNTSearch\TNTSearch;

$tnt = new TNTSearch;

$tnt->loadConfig([
    'driver' => 'mysql',
    'host' => 'localhost',
    'database' => 'dbname',
    'username' => 'user',
    'password' => 'pass',
    'storage' => '/var/www/tntsearch/examples/',
    'stemmer' => \TeamTNT\TNTSearch\Stemmer\PorterStemmer::class // 可选
]);

$indexer = $tnt->createIndex('articles.index');
$indexer->query('SELECT id, article FROM articles');
$indexer->run();

2.3 执行搜索

创建索引后，你可以执行搜索并获取相关结果：

use TeamTNT\TNTSearch\TNTSearch;

$tnt = new TNTSearch;
$tnt->loadConfig($config);
$tnt->selectIndex("articles.index");

$res = $tnt->search("This is a test search", 12);
print_r($res); // 返回一个包含12个最佳匹配文档ID的数组

3. 应用案例和最佳实践

3.1 模糊搜索

TNTSearch 支持模糊搜索，可以通过调整以下参数来优化模糊搜索的效果：

$tnt->fuzzy_prefix_length = 2;
$tnt->fuzzy_max_expansions = 50;
$tnt->fuzzy_distance = 2; // 代表Levenshtein距离

3.2 布尔搜索

TNTSearch 支持布尔搜索，允许你使用逻辑运算符来组合搜索条件：

$res = $tnt->searchBoolean("romeo -juliet"); // 返回包含romeo但不包含juliet的文档
$res = $tnt->searchBoolean("romeo or hamlet"); // 返回包含romeo或hamlet的文档

3.3 地理位置搜索

TNTSearch 还支持地理位置搜索，可以用于查找附近的地点：

$currentLocation = [
    'longitude' => 11.576124,
    'latitude' => 48.137154
];
$distance = 2; // km

$candyShopIndex = new TNTGeoSearch();
$candyShopIndex->loadConfig($config);
$candyShopIndex->selectIndex('candyShops.index');

$candyShops = $candyShopIndex->findNearest($currentLocation, $distance, 10);

4. 典型生态项目

4.1 TNTSearch Driver for Laravel Scout

TNTSearch 提供了与 Laravel Scout 的集成，使得在 Laravel 项目中使用 TNTSearch 变得更加简单。你可以通过以下步骤集成：

1. 安装 Laravel Scout：

composer require laravel/scout

2. 安装 TNTSearch Driver：

composer require teamtnt/laravel-scout-tntsearch-driver

3. 配置 Laravel Scout：

// config/app.php
'providers' => [
    // ...
    Laravel\Scout\ScoutServiceProvider::class,
    TeamTNT\Scout\TNTSearchScoutServiceProvider::class,
],

4. 配置 TNTSearch：

// config/scout.php
'tntsearch' => [
    'storage' => storage_path(), // 索引文件存储位置
    'fuzziness' => env('TNTSEARCH_FUZZINESS', false),
    'fuzzy' => [
        'prefix_length' => 2,
        'max_expansions' => 50,
        'distance' => 2,
    ],
    'asYouType' => false,
    'searchBoolean' => env('TNTSEARCH_BOOLEAN', false),
],

5. 使用 Scout 进行搜索：

use Laravel\Scout\Searchable;

class Post extends Model
{
    use Searchable;

    public function toSearchableArray()
    {
        return $this->toArray();
    }
}

Post::search('Bugs Bunny')->get();

通过以上步骤，你可以在 Laravel 项目中轻松集成 TNTSearch，并利用其强大的全文搜索功能。