php-ext-xlswriter

README

<div align=center>
<img alt="php-ext-xlswriter" height="214" src="https://web-code-img.oss-cn-shanghai.aliyuncs.com/readme/332eda1776b44f5073dd09b9.png"/>
</div>

<div align=center>
<a href="https://github.com/viest/php-ext-xlswriter/releases"><img alt="php-ext-xlswriter" src="https://img.shields.io/github/release/viest/php-ext-excel-export.svg"/></a>
</div>

<div align=center>
<a href="https://github.com/viest/php-ext-xlswriter"><img alt="php-ext-xlswriter" src="https://img.shields.io/badge/platform-macos%20%7C%20linux%20%7C%20windows-brightgreen.svg"/></a>
</div>

<div align=center>
<a href="https://gitee.com/viest/php-ext-xlswriter"><img alt="php-ext-xlswriter" src="https://gitee.com/viest/php-ext-xlswriter/badge/star.svg?theme=gvp"/></a>
<a href="https://gitcode.com/viest/php-ext-xlsxwriter"><img alt="php-ext-xlswriter" src="https://gitcode.com/viest/php-ext-xlsxwriter/star/badge.svg"/></a>
</div>

<div align=center>
<a href="https://github.com/viest/php-ext-xlswriter/actions"><img alt="php-ext-xlswriter" src="https://img.shields.io/github/actions/workflow/status/viest/php-ext-xlswriter/main.yml?branch=master&logo=github"></a>
<a href="https://ci.appveyor.com/project/viest/php-ext-xlswriter/branch/master"><img alt="php-ext-xlswriter" src="https://ci.appveyor.com/api/projects/status/w4cfjo9e4gsrs6rn/branch/master?svg=true"/></a>
<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fviest%2Fphp-ext-xlswriter?ref=badge_shield"><img alt="php-ext-xlswriter" src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fviest%2Fphp-ext-xlswriter.svg?type=shield"/></a>
</div>

<div align=center>
<a href="https://opencollective.com/php-ext-xlswriter"><img alt="php-ext-xlswriter" src="https://opencollective.com/php-ext-xlswriter/all/badge.svg?label=financial+contributors"/></a>
<a href="https://github.com/viest/php-ext-xlswriter"><img alt="php-ext-xlswriter" src="https://img.shields.io/badge/PHP-%3E%3D%207.0-brightgreen.svg"/></a>
<a href="https://github.com/viest/php-ext-xlswriter"><img alt="php-ext-xlswriter" src="https://img.shields.io/github/contributors/viest/php-ext-excel-export.svg"/></a>
<a href="https://github.com/viest/php-ext-xlswriter"><img alt="php-ext-xlswriter" src="https://img.shields.io/badge/license-BSD-green.svg"/></a>
<a href="https://github.com/viest/php-ext-xlswriter"><img alt="php-ext-xlswriter" src="https://img.shields.io/github/issues/viest/php-ext-excel-export.svg"/></a>
</div>

## 为什么使用xlswriter

下图对比了 xlswriter 与 PhpSpreadsheet（PHPExcel 的官方后续项目）导出 XLSX 的性能，数据量一直放大到 Excel 的行数上限。以 1,048,576 行 × 10 列为例，xlswriter 快约 20 倍；其固定内存模式无论写入多少行，峰值内存都稳定在约 30 MB，而纯 PHP 库的内存会随数据量持续增长（同一个文件约需 7 GB）。

![xlswriter 与 PhpSpreadsheet 性能对比](https://web-code-img.oss-cn-shanghai.aliyuncs.com/readme/d4481178aac53eaf72c8035c.png)

> 两种 xlswriter 模式的耗时相差约 10% 以内。固定内存模式之所以略快，是因为它把每一行直接流式写入磁盘并立即释放——单趟完成，不需要在内存里先建好整个工作表、最后再二次序列化。代价是：与普通模式不同，单元格一旦写出就无法再回头修改（且字符串以内联方式存储、不做去重，文件可能略大）。普通模式会把整个工作簿保留在内存中，正因如此你才能以任意顺序写入单元格、并在保存前重新设置样式。

xlswriter 是一个 PHP C 扩展，用于处理 Excel 2007+ XLSX 文件：向新文件写入文本、数字、公式、日期、图表、图片和超链接，打开已有文件进行编辑并保存结果，读取文件内容，以及将公式求值为计算结果。

它具备以下特性：

###### 一、写入

* 100％兼容的Excel XLSX文件
* 完整的Excel格式
* 合并单元格
* 定义工作表名称
* 过滤器
* 图表
* 数据验证和下拉列表
* 条件格式
* 富文本、批注与超链接
* 工作表PNG/JPEG图像
* 编辑已有文件——打开文件后修改单元格的值、样式、合并区域与行列尺寸，新增工作表、图片和图表，再保存结果
* 公式计算——对公式求值得到计算结果，也可在写入公式时附带预先算好的缓存值
* 用于写入大文件的内存优化模式
* 适用于Linux，FreeBSD，OpenBSD，OS X，Windows
* 编译为32位和64位
* FreeBSD许可证
* 唯一的依赖是zlib（编译期需要其开发头文件：Alpine `apk add zlib-dev`、Debian/Ubuntu `apt-get install zlib1g-dev`、RHEL/CentOS `yum install zlib-devel`）

###### 二、读取

* 完整读取与游标读取
* 按数据类型读取
* 读取单元格样式与数字格式
* 读取合并单元格
* 读取图片、图表与批注
* 读取公式及其缓存值

#### 安装

###### Unix

下面两种安装方式都是从源码编译，因此需要先装好 zlib 开发头文件（最小镜像通常缺失）：

```bash
# Debian / Ubuntu
apt-get install -y zlib1g-dev
# Alpine
apk add zlib-dev
# RHEL / CentOS / Fedora
yum install -y zlib-devel
```

然后用 **PECL** 或 **PIE** 任选其一安装：

**PECL**

```bash
pecl install xlswriter
```

**PIE**

[PIE](https://github.com/php/pie) 同样从源码编译，除上面的 zlib 开发头文件外，还需要
autotools 构建链（autoconf、make、编译器以及 **libtool**）。PIE 可以用
`--auto-install-build-tools` 自动安装缺失的构建工具，但无法安装 zlib——请先确保上面的
头文件已就位：

```bash
pie install --auto-install-build-tools viest/xlswriter
```

###### Windows

[下载 dll](https://github.com/viest/php-ext-xlswriter/releases)

#### 基准测试

测试环境: Macbook Pro 13 inch, Intel Core i5, 16GB 2133MHz LPDDR3 Memory, 128GB SSD Storage.

##### 导出

> 两种内存模式导出100万行数据（单行27列，数据类型均为字符串，单个字符串长度为19）

* 普通模式：耗时 `29S`，内存只需 `2083MB`；
* 固定内存模式：仅需 `52S`，内存仅需 `<1MB`；

##### 导入

> 100万行数据（单行1列，数据类型为INT）

* 全量模式：耗时 `3S`，内存仅 `558MB`；
* 游标模式：耗时 `2.8S`，内存仅 `<1MB`；

## 从这里开始

[文档|Documents](https://xlswriter-docs.viest.me/)

## PECL 仓库

[![pecl](https://gitee.com/viest/php-ext-xlswriter/blob/master/resource/pecl.png)](https://pecl.php.net/package/xlswriter)

## IDE Helper

```bash
composer require viest/php-ext-xlswriter-ide-helper:dev-master
```

## 交流群

<img width="160" src="https://web-code-img.oss-cn-shanghai.aliyuncs.com/readme/e95434327af4709db7a40633.jpg"/>

## 贡献者

### 代码贡献者

这个项目的存在要感谢所有贡献者。 [[Contribute](https://gitee.com/viest/php-ext-xlswriter/blob/master/CONTRIBUTING.md)].
<a href="https://github.com/viest/php-ext-xlswriter/graphs/contributors"><img src="https://opencollective.com/php-ext-xlswriter/contributors.svg?width=890&button=false" /></a>

### 财务捐赠者

成为财务捐赠者，并帮助我们维持我们的社区。[[Contribute](https://opencollective.com/php-ext-xlswriter/contribute)]

#### 个人

<a href="https://opencollective.com/php-ext-xlswriter"><img src="https://opencollective.com/php-ext-xlswriter/individuals.svg?width=890"></a>

#### 组织机构

与您的组织一起支持该项目。您的徽标将显示在此处，并带有指向您网站的链接。[[Contribute](https://opencollective.com/php-ext-xlswriter/contribute)]

<a href="https://opencollective.com/php-ext-xlswriter/organization/0/website"><img src="https://opencollective.com/php-ext-xlswriter/organization/0/avatar.svg"></a>
<a href="https://opencollective.com/php-ext-xlswriter/organization/1/website"><img src="https://opencollective.com/php-ext-xlswriter/organization/1/avatar.svg"></a>
<a href="https://openco