TNTSearch 项目教程

1. 项目目录结构及介绍

TNTSearch 项目的目录结构如下：

tntsearch/
├── src/
│   ├── Classifier/
│   ├── Command/
│   ├── Support/
│   ├── TNTSearch.php
│   └── ...
├── tests/
│   ├── ClassifierTest.php
│   ├── TNTSearchTest.php
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── composer.json
├── phpunit.php
└── phpunit.xml

目录结构介绍

• src/: 包含 TNTSearch 的核心代码，包括分类器、命令行工具、支持类和主文件 TNTSearch.php。
• tests/: 包含项目的单元测试文件，用于测试核心功能的正确性。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• CHANGELOG.md: 记录项目版本变更的历史。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 贡献指南，帮助开发者参与项目。
• LICENSE.md: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• composer.json: Composer 配置文件，定义项目的依赖和元数据。
• phpunit.php: PHPUnit 测试框架的配置文件。
• phpunit.xml: PHPUnit 测试框架的 XML 配置文件。

2. 项目的启动文件介绍

TNTSearch 项目的启动文件是 src/TNTSearch.php。这个文件是 TNTSearch 的核心类，提供了创建索引、执行搜索、更新索引等功能。

主要功能

• 创建索引: 通过 createIndex 方法创建全文搜索索引。
• 执行搜索: 通过 search 方法执行全文搜索。
• 更新索引: 通过 getIndex 方法获取索引实例，然后使用 insert, update, delete 方法更新索引。

示例代码

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();

3. 项目的配置文件介绍

TNTSearch 项目的配置文件主要是 composer.json 和 phpunit.xml。

composer.json

composer.json 是 Composer 的配置文件，定义了项目的依赖、元数据和脚本。

{
    "name": "teamtnt/tntsearch",
    "description": "A full-text search (FTS) engine written entirely in PHP",
    "require": {
        "php": ">=7.1",
        "ext-pdo": "*",
        "ext-sqlite3": "*",
        "ext-mbstring": "*"
    },
    "autoload": {
        "psr-4": {
            "TeamTNT\\TNTSearch\\": "src/"
        }
    },
    "scripts": {
        "test": "phpunit"
    }
}

phpunit.xml

phpunit.xml 是 PHPUnit 测试框架的配置文件，定义了测试的执行方式和覆盖率报告的生成。

<phpunit bootstrap="vendor/autoload.php" colors="true">
    <testsuites>
        <testsuite name="TNTSearch Test Suite">
            <directory>tests/</directory>
        </testsuite>
    </testsuites>
    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">src/</directory>
        </whitelist>
    </filter>
</phpunit>

通过这些配置文件，开发者可以轻松管理项目的依赖、运行测试并生成覆盖率报告。