Yii 2 Elasticsearch 扩展使用教程

Yii 2 Elasticsearch 扩展使用教程

yii2-elasticsearchYii 2 Elasticsearch extension项目地址:https://gitcode.com/gh_mirrors/yi/yii2-elasticsearch

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

Yii 2 Elasticsearch 扩展的目录结构如下：

yiisoft/yii2-elasticsearch/
├── docs/
│   └── guide/
│       └── README.md
├── src/
│   ├── ActiveRecord.php
│   ├── Connection.php
│   ├── Query.php
│   └── ...
├── tests/
│   ├── bootstrap.php
│   ├── ActiveRecordTest.php
│   ├── ConnectionTest.php
│   └── ...
├── .editorconfig
├── .gitattributes
├── .gitignore
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── composer.json
└── phpunit.xml.dist

目录介绍

• docs/: 包含项目的文档，特别是 guide/ 目录下的 README.md 文件，提供了详细的安装和使用指南。
• src/: 包含扩展的核心代码，如 ActiveRecord.php、Connection.php 和 Query.php 等。
• tests/: 包含项目的测试代码，如 ActiveRecordTest.php 和 ConnectionTest.php 等。
• .editorconfig, .gitattributes, .gitignore: 配置文件，用于统一代码风格和版本控制。
• CHANGELOG.md: 记录项目的更新日志。
• LICENSE.md: 项目的许可证信息。
• README.md: 项目的主 README 文件，包含项目的基本信息和使用说明。
• composer.json: Composer 配置文件，用于管理项目的依赖。
• phpunit.xml.dist: PHPUnit 配置文件，用于配置测试环境。

2. 项目的启动文件介绍

Yii 2 Elasticsearch 扩展的启动文件主要是 src/Connection.php。这个文件定义了与 Elasticsearch 服务器的连接，并提供了配置选项。

src/Connection.php 文件介绍

namespace yii\elasticsearch;

class Connection extends \yii\base\Component
{
    public $nodes = [
        ['http_address' => '127.0.0.1:9200'],
        // 可以配置更多主机，如果你有一个集群
    ];
    public $dslVersion = 7; // 默认是 5

    // 其他配置和方法
}

• nodes: 配置 Elasticsearch 节点的地址。
• dslVersion: 配置 Elasticsearch 的 DSL 版本。

3. 项目的配置文件介绍

Yii 2 Elasticsearch 扩展的配置文件主要是 composer.json 和应用程序的配置文件。

composer.json 文件介绍

{
    "name": "yiisoft/yii2-elasticsearch",
    "description": "Elasticsearch extension for Yii 2",
    "keywords": ["yii2", "elasticsearch"],
    "license": "BSD-3-Clause",
    "support": {
        "issues": "https://github.com/yiisoft/yii2-elasticsearch/issues?state=open",
        "forum": "http://www.yiiframework.com/forum/",
        "wiki": "http://www.yiiframework.com/wiki/",
        "irc": "irc://irc.freenode.net/yii",
        "source": "https://github.com/yiisoft/yii2-elasticsearch"
    },
    "require": {
        "yiisoft/yii2": "~2.0.0",
        "elasticsearch/elasticsearch": "~7.0"
    },
    "autoload": {
        "psr-4": {
            "yii\\elasticsearch\\": ""
        }
    }
}

• name: 包的名称。
• description: 包的描述。
• keywords: 关键词。
• license: 许可证。
• require: 依赖的其他包。
• autoload: 自动加载配置。

应用程序配置文件介绍

在应用程序的配置文件中，你需要配置 elasticsearch 组件：

return [
    'components' => [
        'elasticsearch' => [
            'class' => 'yii\elasticsearch\Connection',
            'nodes' => [
                ['http_address' => '127.0.0.1:9

yii2-elasticsearchYii 2 Elasticsearch extension项目地址:https://gitcode.com/gh_mirrors/yi/yii2-elasticsearch