Download the PHP package erikwang2013/etcd without Composer

On this page you can find all versions of the php package erikwang2013/etcd. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package etcd

erikwang2013/etcd

官网 / Website: https://package.erik.xyz/etcd/

简体中文 · English · 한국어 · Русский · Deutsch · Français · Español · Português · हिन्दी · العربية · বাংলা · Bahasa Indonesia · 日本語

Etchy · 头顶三节点 Raft 集群、鼻尖挂着 k/v 与 rev 的小象 ——
守着你的配置和租约:掉线自己重连,过期自己清理。

PHP etcd v3 客户端 —— 双模传输(HTTP 全功能 / gRPC 一元 RPC),覆盖 etcd v3 全部 API(KV / Watch / Lease / Auth / Cluster / Maintenance / Election / Lock),开箱适配 Laravel / Hyperf / ThinkPHP / Webman / Yii2 / Yii3。

要求

安装

裸 PHP(无框架)

不需要框架、不需要 PSR-18 实现、也不需要 ext-curl —— 加载了 ext-curl 就用它,缺失时自动回退到 PHP 自带的流封装。

强制指定通道用 'driver' => 'stream'(默认 auto);三条通道都不可用时,请求抛出可捕获的 ConnectionException 并说明如何启用。

快速开始

配置

环境变量

不传配置时自动读取环境变量:

变量 默认值 说明
ETCD_ENDPOINTS 127.0.0.1:2379 逗号分隔的多节点地址
ETCD_TRANSPORT auto auto / http / grpc
ETCD_TIMEOUT 5.0 请求超时(秒)
ETCD_SCHEME http http / https
ETCD_RETRY 2 连接重试次数
ETCD_DRIVER auto HTTP 通道:auto / curl / stream
ETCD_USER — etcd 用户名
ETCD_PASSWORD — etcd 密码

API 参考

KV — 键值操作

比较目标(target)常量: 0=VERSION, 1=CREATE, 2=MOD, 3=VALUE, 4=LEASE
比较结果(result)常量: 0=EQUAL, 1=GREATER, 2=LESS, 3=NOT_EQUAL

Watch — 变更监听

停止监听: watch() 会一直阻塞,给它一个 WatchHandle 就能从外部停(长驻进程按 SIGTERM 收尾的常规需求):

cancel() 之后 watch() 正常返回(不抛异常,不需要 catch)。空闲的 key 上也会在一秒内退出——curl 驱动靠 cURL 的周期回调发现,stream 驱动靠 200ms 的读超时空闲周期。

断线重连: Watch 连接断开时自动从 lastRevision + 1 续订(start_revision 是闭区间语义, 用原值续订会重放最后一个事件)。故障转移不丢事件,也不重复投递。

重试策略: 只有连接根本没建立(拒绝连接 / DNS 失败)才会重试,且只读接口(range、status、memberlist 等) 额外容忍 5xx 与超时。写操作遇到 5xx 或读超时不重试——那可能已经生效,重放会让 CAS 这类请求被应用两次, 甚至拿到一个"自信的错答案"(重试看到自己第一次写入的结果,报告 CAS 失败而它其实赢了)。

Lease — 租约

典型场景: 服务注册时创建租约 + 写入 key,定时调用 keepAlive() 心跳续约;服务停止后租约到期自动清理。

Auth — 认证与权限

认证是怎么发生的: etcd v3 不接受 HTTP Basic —— 它要求先用凭据换取 token (POST /v3/auth/authenticate),随后以裸 token 发送 Authorization: <token>(加 Bearer 前缀同样会被拒)。 配置了 auth.user / auth.password 后,客户端会自动完成这一步并缓存 token,401 时自动重新认证一次, 无需手工调用。也可以自己换:

发送凭据需要 scheme => 'https':明文 http 下构造函数会直接拒绝(避免密码裸奔)。

Cluster — 集群管理

Election — leader 选举

campaign() 在 HTTP 网关上是一个缓冲响应——当选之前不返回,所以用 $timeout 约束等待。需要长期跟踪 leader 变化用 observe()。

注意(实测的静默陷阱): proclaim() / resign() 需要完整的 leader 描述数组(name、key、rev 三者齐全)。少任何一个,etcd 会返回 HTTP 200 却什么都不做——看起来"释放成功",leader 其实还在。所以这两个方法会在发送前校验描述符,不完整直接抛异常;请一律使用 campaign() / leader() 的返回值,不要自己拼。

其它实测行为: 请求中途失败的竞选会被服务端撤回(所以 acquire() 超时可以安全地报告失败,不会变成"隐藏的持有者");无人当选时 leader() 返回 null(服务端回 500 election: no leader,属正常状态而非错误)。

Lock — 分布式锁

这是建在 Election 之上的客户端实现,不是服务端锁。 etcd 3.5 的 HTTP 网关不暴露 /v3/lock/*(实测 404),所以互斥由「Election 竞选 + 租约」提供——与 etcd 自家 Go 的 concurrency 包同一做法。持有者被 SIGKILL 时,租约到期后锁自动释放,无需人工清理。

Maintenance — 运维

传输模式

模式 状态 依赖 适用场景
HTTP 可用 ext-curl / 流封装 / PSR-18 任选其一 零扩展依赖,即刻可用
gRPC 一元 RPC ext-grpc + grpc/grpc + 生成的 protobuf 消息 高性能;流式与 Election 需走 HTTP
auto 默认 — 目前等同 http(见下)

auto 与 http 等价:gRPC 目前只覆盖一元 RPC,watch / snapshot 这类流式调用以及 Election 都还必须走 HTTP,自动切过去只会让装了扩展的用户突然少一半功能。显式传 'transport' => 'grpc' 才会选中它。

gRPC 传输的现状(请注意):

手动配置 PSR-18 HTTP 客户端

框架集成

Laravel

安装即用。composer.json 的 extra.laravel 自动发现 ServiceProvider 和 Facade。

发布配置文件:

.env 配置:

Hyperf

安装即用。Hyperf 自动发现 ConfigProvider。

发布配置:

ThinkPHP

  1. 安装后,在 app/service.php 中注册:

  2. 创建 config/etcd.php 配置文件。

使用:

Webman

安装即用,无需额外配置。

如需自定义配置,编辑 plugin/erikwang2013/etcd/config/etcd.php。

Yii2

安装即用。在应用配置里注册组件,extra.bootstrap 会自动把 EtcdClient 绑进 DI 容器,构造函数注入拿到的就是应用组件里那个实例(用 --no-plugins 装的把 Erikwang2013\Etcd\Adapter\Yii\Bootstrap::class 加进 bootstrap 数组)。

Yii3

安装即用。包里的 config-plugin 声明会被 yiisoft/config 合并进 params 与 di 两组,容器里就有 EtcdClient 了(yiisoft/di 只保留共享实例,注入多少次都是同一个客户端)。

异常处理

项目结构

测试

对真实集群验证(推荐):给同一个套件一个真 etcd 地址,它会跑同一批用例,并断言假网关与真网关的行为一致(分帧、信封、int64 编码):

为什么值得这么跑:本项目曾有一批缺陷(watch 完全不可用、9 个无参方法 400、keepAlive 必抛…) 在 40+ 个测试全绿的情况下存活,原因正是测试桩与真实网关在分帧与信封两方面都不同。 那批问题已修复,而这个差分模式就是防止同类问题再次溜过去的机制。

文档与设计图的一致性也由脚本守住:

CI(.github/workflows/ci.yml)会跑上面全部内容:单测 PHP 8.2/8.3 矩阵、PHP 8.0/8.1 的语法底线、 集成(含对服务容器里真实 etcd 的差分)、以及这三条文档校验。

架构与设计图

三张图按「结构 → 能力 → 时序」组织,可点击单独查看:

图 回答的问题 文件
架构设计 分成哪几层、依赖朝哪走、错误怎么分流 docs/architecture.svg
功能设计 每个子系统提供哪些方法、有哪些行为约定 docs/features.svg
生命周期 一次请求 / 一条监听 / 一个租约 各自怎么走完 docs/lifecycle.svg

架构设计

功能设计

生命周期

在代码里用 Etchy

图形随包发布,Mascot 是唯一取值入口,做管理面板 / 状态页时不必再拷一份:

Laravel 下可直接发布到 public/:

开源不易,欢迎支持 / Support This Project

微信 / WeChat 支付宝 / Alipay


License

MIT — Copyright (c) 2026 erik [email protected]

项目宠物表情形态 · Etchy


愤怒
:emoji-angry:

吐舌头
:emoji-tongue:

12 种彩色动态形态:笑 / 欢乐 / 哭 / 沮丧 / 惊恐 / 愤怒 / 撒娇 / 卖萌 / 讨好 / 敲打 / 捂脸 / 吐舌头。每个 SVG 自带表情、情绪特效与整体动效,并遵循 prefers-reduced-motion。

视觉资产授权 / Visual Assets License

本项目的项目宠物、图片、图标、表情(包括 docs/pet-expressions/ 等目录下的 SVG / PNG)不是开源资产,版权归作者所有。未经书面许可不得复制、修改、再分发或 用于商业用途;商业使用需取得商业授权,联系 [email protected]。详见 ASSETS-LICENSE.md。

代码部分仍遵循仓库原有 LICENSE;第三方素材(如明确标注的 Go Gopher 等)仍遵循其原许可证。


All versions of etcd with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package erikwang2013/etcd contains the following files

Loading the files please wait ...