Skip to content

README-zh.md

Latest commit

 

History

History
executable file
·
156 lines (109 loc) · 6.61 KB

README-zh.md

File metadata and controls

executable file
·
156 lines (109 loc) · 6.61 KB

StaticPHP

Chinese readme English readme Releases CI License Discord

StaticPHP 是一个强大的工具，用于构建可移植的可执行文件，包括 PHP、扩展等。

Important

我们正准备发布 v3 版本，届时项目名称将从 static-php-cli 更改为 StaticPHP。 此分支对应 v3 版本。v2 版本请查看 v2 分支。 请更新您的参考资料，并关注正式版发布。

特性

  • 🐘 支持多个 PHP 版本 - PHP 8.1, 8.2, 8.3, 8.4, 8.5
  • 👜 构建零依赖的单文件 PHP 可执行程序
  • 🍔 构建 phpmicro 自解压可执行文件（将 PHP 二进制和源码合并为单个文件）
  • 💊 自动构建环境检查器，支持自动修复
  • ⚡ 支持 Linux、macOS、Windows
  • 🔧 通过 vendor 模式和自定义注册表实现便捷扩展
  • 📚 智能依赖管理
  • 📦 自包含 spc 可执行文件，便于自安装
  • 🔥 支持 100+ 热门 PHP 扩展
  • 💾 支持 UPX 压缩（二进制体积可缩小 30-50%）

单文件独立 php-cli：

out1

使用 phpmicro 将 PHP 代码与 PHP 解释器结合：

out2

快速开始

1. 下载 spc 二进制

# For Linux x86_64
curl -fsSL -o spc https://dl.static-php.dev/v3/spc-bin/nightly/spc-linux-x86_64
# For Linux aarch64
curl -fsSL -o spc https://dl.static-php.dev/v3/spc-bin/nightly/spc-linux-aarch64
# macOS x86_64 (Intel)
curl -fsSL -o spc https://dl.static-php.dev/v3/spc-bin/nightly/spc-macos-x86_64
# macOS aarch64 (Apple)
curl -fsSL -o spc https://dl.static-php.dev/v3/spc-bin/nightly/spc-macos-aarch64
# Windows (x86_64, win10 build 17063 or later, please install VS2022 first)
curl.exe -fsSL -o spc.exe https://dl.static-php.dev/v3/spc-bin/nightly/spc-windows-x64.exe

对于 macOS 和 Linux，请先添加可执行权限：

chmod +x ./spc

2. 构建静态 PHP

首先，创建 craft.yml 文件，并从 扩展列表 或 命令生成器 指定要包含的扩展：

# PHP version support: 8.1, 8.2, 8.3, 8.4, 8.5
php-version: 8.5
# Put your extension list here
extensions: "apcu,bcmath,calendar,ctype,curl,dba,dom,exif,fileinfo,filter,gd,iconv,mbregex,mbstring,mysqli,mysqlnd,opcache,openssl,pcntl,pdo,pdo_mysql,pdo_sqlite,phar,posix,readline,redis,session,simplexml,sockets,sodium,sqlite3,tokenizer,xml,xmlreader,xmlwriter,xsl,zip,zlib"
sapi:
  - cli
  - micro
download-options:
  parallel: 10

运行命令：

./spc craft

# 输出完整控制台日志
./spc craft -vvv

3. 静态 PHP 使用

现在你可以将 StaticPHP 构建的二进制复制到另一台机器并在无依赖环境下运行：

# php-cli
buildroot/bin/php -v

# phpmicro
echo '<?php echo "Hello world!\n";' > a.php
./spc micro:combine a.php -O my-app
./my-app

文档

当前 README 包含基础用法。有关 StaticPHP 的完整功能集， 请访问 https://static-php.dev。

直接下载

如果你暂时不想构建，或只想先测试，可以从 Actions 下载示例预编译产物，或从自托管服务器下载。

我们为每个 PHP 版本提供 2 种扩展集合：

  • gigantic：尽可能包含更多扩展，二进制大小约 100-150MB。
  • base：仅包含 StaticPHP 自身使用的少量扩展，二进制大小约 10MB。

WIP

在线构建（使用 GitHub Actions）

当上方直接下载的二进制无法满足你的需求时， 你可以使用 GitHub Actions 轻松构建静态编译的 PHP， 并同时自定义要编译的扩展列表。

  1. Fork 此仓库。
  2. 进入项目的 Actions 并选择 CI。
  3. 选择 Run workflow，填写你要编译的 PHP 版本、目标类型和扩展列表。（扩展用逗号分隔，例如 bcmath,curl,mbstring）
  4. 等待工作流执行完成后，进入对应运行记录并下载 Artifacts。

如果你启用 debug，构建时将输出所有日志，包括编译日志，便于排查问题。

我们也计划在未来提供可复用的 GitHub Actions 工作流， 这样你无需 fork 本项目，也能在自己的仓库中轻松构建 static PHP。

贡献

如果你需要的扩展缺失，可以创建 issue。 如果你熟悉本项目，也欢迎发起 pull request。

如果你想贡献文档，请直接编辑 docs/。

赞助本项目

你可以通过 GitHub Sponsor 赞助我或我的项目。你捐赠的一部分将用于维护 static-php.dev 服务器。

特别感谢以下赞助商：

Beyond Code Logo

NativePHP Logo

开源许可证

本项目本身采用 MIT 许可证。 一些新添加的扩展和依赖可能来自其他项目。 这些源码文件头部也可能包含额外的 LICENSE 和 AUTHOR 信息。

请在编译后使用 bin/spc dump-license 命令导出项目中使用的开源许可证， 并遵守对应项目的 LICENSE。