Laravel Scout TNTSearch 驱动使用教程

Laravel Scout TNTSearch 驱动使用教程

laravel-scout-tntsearch-driverDriver for Laravel Scout search package based on https://github.com/teamtnt/tntsearch项目地址:https://gitcode.com/gh_mirrors/la/laravel-scout-tntsearch-driver

1. 项目的目录结构及介绍

Laravel Scout TNTSearch 驱动项目的目录结构如下：

laravel-scout-tntsearch-driver/
├── src/
│   ├── TNTSearchScoutServiceProvider.php
│   └── TNTSearchEngine.php
├── tests/
│   └── TNTSearchEngineTest.php
├── .gitignore
├── .travis.yml
├── LICENSE.txt
├── README.md
├── composer.json
├── phpunit.xml

目录结构介绍

• src/: 包含项目的主要源代码文件。
  • TNTSearchScoutServiceProvider.php: 服务提供者文件，用于注册和引导 TNTSearch 服务。
  • TNTSearchEngine.php: TNTSearch 引擎的核心实现文件。
• tests/: 包含项目的测试文件。
  • TNTSearchEngineTest.php: TNTSearch 引擎的测试文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目说明文档。
• composer.json: Composer 依赖管理文件。
• phpunit.xml: PHPUnit 测试配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/TNTSearchScoutServiceProvider.php。这个文件负责注册和引导 TNTSearch 服务。

TNTSearchScoutServiceProvider.php

namespace TeamTNT\Scout;

use Illuminate\Support\ServiceProvider;
use Laravel\Scout\EngineManager;
use TeamTNT\TNTSearch\TNTSearch;

class TNTSearchScoutServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->app[EngineManager::class]->extend('tntsearch', function ($app) {
            $tnt = new TNTSearch;
            $driver = new TNTSearchEngine($tnt);
            return $driver;
        });
    }

    public function register()
    {
        // 注册服务
    }
}

功能介绍

• boot(): 引导方法，用于扩展 Scout 引擎管理器，注册 TNTSearch 引擎。
• register(): 注册方法，用于注册服务。

3. 项目的配置文件介绍

项目的配置文件主要是 config/scout.php，在这个文件中配置 TNTSearch 的相关参数。

config/scout.php

return [
    'driver' => env('SCOUT_DRIVER', 'tntsearch'),
    'tntsearch' => [
        'storage' => storage_path(), // 索引文件存储路径
        'fuzziness' => env('TNTSEARCH_FUZZINESS', false),
        'fuzzy' => [
            'prefix_length' => 2,
            'max_expansions' => 50,
            'distance' => 2,
            'no_limit' => true,
        ],
        'asYouType' => false,
        'searchBoolean' => env('TNTSEARCH_BOOLEAN', false),
        'maxDocs' => env('TNTSEARCH_MAX_DOCS', 500),
    ],
];

配置项介绍

• driver: 指定 Scout 使用的驱动，默认是 tntsearch。
• tntsearch: TNTSearch 的具体配置。
  • storage: 索引文件存储路径。
  • fuzziness: 是否启用模糊搜索。
  • fuzzy: 模糊搜索的参数配置。
  • asYouType: 是否启用实时搜索。
  • searchBoolean: 是否启用布尔搜索。
  • maxDocs: 最大文档数。

以上是 Laravel Scout TNTSearch 驱动的目录结构、启动文件和配置文件的详细介绍。希望对你有所帮助。

laravel-scout-tntsearch-driverDriver for Laravel Scout search package based on https://github.com/teamtnt/tntsearch项目地址:https://gitcode.com/gh_mirrors/la/laravel-scout-tntsearch-driver