PHP扩展如何打包发布_PHP扩展打包发布流程【规范】

PHP扩展发布需遵循五步流程:一、规范源码结构,含config.m4/config.w32、头文件与实现文件;二、用phpize生成configure并编译测试;三、编写校验通过的package.xml;四、pear package打包并GPG签名;五、上传tgz及asc文件至PECL审核。

如果您开发了一个PHP扩展,需要将其打包并发布到PECL或其他分发渠道,则必须遵循标准化的构建与元数据规范。以下是完成PHP扩展打包发布的具体流程:

一、准备扩展源码结构

PHP扩展必须符合标准的目录组织方式,确保phpize和configure脚本能正确识别模块信息。核心文件包括config.m4(用于Unix/Linux)、config.w32(用于Windows)、php_*.h头文件以及主实现文件(如*.c)。

1、在扩展根目录下创建config.m4文件,使用PHP_ARG_ENABLE或PHP_ARG_WITH宏声明编译选项。

2、编写php_extensionname.h文件,包含PHP_MINIT、PHP_MSHUTDOWN等模块生命周期函数声明。

3、实现extensionname.c文件,定义模块入口结构体zend_module_entry,并注册函数、类及INI条目。

4、添加CREDITS和EXPERIMENTAL(如适用)文件,说明作者信息与稳定性等级。

二、生成配置与构建脚本

通过phpize工具生成configure脚本及构建环境支持文件,该步骤为跨平台编译提供基础支撑,且确保与目标PHP版本ABI兼容。

1、执行phpize命令,生成configure脚本及相关automake/autoconf辅助文件。

2、运行./configure --enable-extensionname,检查依赖项并生成Makefile。

3、执行make编译源码,生成.so(Linux/macOS)或.dll(Windows)动态库文件。

4、运行make test执行扩展内置的PHPUnit或PHP测试套件,验证功能正确性。

三、编写package.xml描述文件

PECL要求使用PEAR格式的package.xml文件定义扩展元数据、依赖关系、文件清单及发布信息,该文件是上传至pecl.php.net的必要凭证。

1、使用pear package-validate package.xml校验XML语法与必填字段完整性。

2、在节点中声明PHP版本约束(如8.1.0)及可选扩展依赖(如json)。

3、在节点内逐项列出所有分发文件,使用指定目标路径,例如

4、设置区块,按日期倒序记录每个版本的变更类型(fix、add、break)及对应条目。

四、构建归档包并签名

生成符合PECL命名规范的tar.gz归档包,并使用GPG密钥进行数字签名,以保证分发内容的完整性与来源可信性。

1、执行pear package命令,依据package.xml生成extensionname-1.0.0.tgz文件。

2、使用已注册的PECL GPG密钥对归档包签名:gpg --detach-sign --armor extensionname-1.0.0.tgz

3、确认签名文件extensionname-1.0.0.tgz.asc与归档包同名且位于同一目录。

4、校验签名有效性:gpg --verify extensionname-1.0.0.tgz.asc extensionname-1.0.0.tgz

五、提交至PECL仓库

通过PECL Web界面或命令行工具将归档包与签名文件上传至审核队列,需确保维护者账户已通过双因素认证并拥有扩展命名空间权限。

1、登录pecl.php.net账户,在“My Packages”页面点击“Upload New Release”。

2、选择生成的extensionname-1.0.0.tgz文件及对应的.asc签名文件。

3、填写版本号、稳定状态(stable/beta/alpha)、发布说明(Release Notes)及变更摘要。

4、提交后等待PECL管理员人工审核,审核通过后包将自动同步至https://pecl.php.net/package/extensionname。