Elasticsearch-PHP 客户端使用指南：从基础操作到实战技巧-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00536/article/details/148505714

Elasticsearch-PHP 客户端使用指南：从基础操作到实战技巧

elasticsearch-php 项目地址: https://gitcode.com/gh_mirrors/ela/elasticsearch-php

前言

Elasticsearch-PHP 是 Elasticsearch 官方提供的 PHP 客户端库，它允许 PHP 开发者轻松地与 Elasticsearch 集群进行交互。本文将深入解析该客户端的基本使用方法，帮助开发者快速上手并理解其核心功能。

客户端基础架构

Elasticsearch-PHP 客户端的设计遵循了直观的命名规则，与 Elasticsearch 的 REST API 端点保持高度一致。这种设计使得熟悉 Elasticsearch REST API 的开发者能够快速迁移到 PHP 客户端。

客户端的主要功能分为三个层次：

核心操作（索引、搜索、获取等）通过 $client 对象直接调用
索引管理通过 $client->indices() 对象调用
集群管理通过 $client->cluster() 对象调用

基础 API 操作详解

1. 获取集群信息

使用 info() 方法可以获取 Elasticsearch 实例的基本信息：

$response = $client->info();

响应对象 $response 是一个多功能对象，它实现了：

PSR-7 的 ResponseInterface 接口
ArrayAccess 接口（可以像数组一样访问）

这使得响应处理非常灵活：

// 获取HTTP状态码
echo $response->getStatusCode(); 

// 获取原始JSON响应体
echo (string) $response->getBody();

// 以数组形式访问响应数据
echo $response['version']['number'];

// 显式转换为数组
var_dump($response->asArray());

// 以对象形式访问
echo $response->version->number;

2. 文档索引操作

索引文档是 Elasticsearch 最基本的操作之一，需要指定三个关键参数：

index：目标索引名称
id：文档唯一标识
body：文档内容

$params = [
    'index' => 'my_index',
    'id'    => 'my_id',
    'body'  => ['testField' => 'abc']
];

$response = $client->index($params);

响应结果包含索引操作的元数据：

Array
(
    [_index] => my_index
    [_type] => _doc
    [_id] => my_id
    [_version] => 1
    [created] => 1
)

高级技巧：body 参数可以直接使用 JSON 字符串，这在从其他来源复制文档结构时特别有用：

$params = [
    'index' => 'my_index',
    'id'    => 'my_id',
    'body'  => '{"testField" : "abc"}'
];

3. 获取文档

获取已索引的文档非常简单，只需指定索引和文档ID：

$params = [
    'index' => 'my_index',
    'id'    => 'my_id'
];

$response = $client->get($params);

响应中包含文档元数据和原始内容（在 _source 字段中）：

Array
(
    [_index] => my_index
    [_type] => _doc
    [_id] => my_id
    [_version] => 1
    [found] => 1
    [_source] => Array
        (
            [testField] => abc
        )
)

4. 文档搜索

搜索是 Elasticsearch 的核心功能，下面是一个简单的匹配查询示例：

$params = [
    'index' => 'my_index',
    'body'  => [
        'query' => [
            'match' => [
                'testField' => 'abc'
            ]
        ]
    ]
];

$response = $client->search($params);

搜索结果包含丰富的元数据和命中文档：

Array
(
    [took] => 1
    [timed_out] =>
    [_shards] => Array(...)
    [hits] => Array
        (
            [total] => 1
            [max_score] => 0.30685282
            [hits] => Array
                (
                    [0] => Array(...) // 命中文档详情
                )
        )
)

5. 删除文档

删除文档的语法与获取文档类似，只是方法名不同：

$params = [
    'index' => 'my_index',
    'id'    => 'my_id'
];

$response = $client->delete($params);

响应确认删除操作：

Array
(
    [found] => 1
    [_index] => my_index
    [_type] => _doc
    [_id] => my_id
    [_version] => 2
)

索引管理操作

1. 删除索引

删除整个索引需要使用 indices()->delete() 方法：

$deleteParams = [
    'index' => 'my_index'
];
$response = $client->indices()->delete($deleteParams);

2. 创建索引

创建索引时可以指定自定义设置：

$params = [
    'index' => 'my_index',
    'body' => [
        'settings' => [
            'number_of_shards' => 2,   // 主分片数
            'number_of_replicas' => 0  // 副本数
        ]
    ]
];

$response = $client->indices()->create($params);