2019-09-16 01:17:35 +08:00
< p align = "center" > < img width = "650" src = "./excelize.svg" alt = "Excelize logo" > < / p >
2018-03-27 21:01:07 +08:00
2018-12-05 00:27:19 +08:00
< p align = "center" >
< a href = "https://travis-ci.org/360EntSecGroup-Skylar/excelize" > < img src = "https://travis-ci.org/360EntSecGroup-Skylar/excelize.svg?branch=master" alt = "Build Status" > < / a >
< a href = "https://codecov.io/gh/360EntSecGroup-Skylar/excelize" > < img src = "https://codecov.io/gh/360EntSecGroup-Skylar/excelize/branch/master/graph/badge.svg" alt = "Code Coverage" > < / a >
< a href = "https://goreportcard.com/report/github.com/360EntSecGroup-Skylar/excelize" > < img src = "https://goreportcard.com/badge/github.com/360EntSecGroup-Skylar/excelize" alt = "Go Report Card" > < / a >
2020-02-21 23:07:43 +08:00
< a href = "https://pkg.go.dev/github.com/360EntSecGroup-Skylar/excelize/v2?tab=doc" > < img src = "https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white" alt = "go.dev" > < / a >
2018-12-05 00:27:19 +08:00
< a href = "https://opensource.org/licenses/BSD-3-Clause" > < img src = "https://img.shields.io/badge/license-bsd-orange.svg" alt = "Licenses" > < / a >
2020-11-19 21:38:35 +08:00
< a href = "https://www.paypal.com/paypalme/xuri" > < img src = "https://img.shields.io/badge/Donate-PayPal-green.svg" alt = "Donate" > < / a >
2018-12-05 00:27:19 +08:00
< / p >
2018-03-27 21:01:07 +08:00
2018-12-05 00:27:19 +08:00
# Excelize
2018-03-27 21:01:07 +08:00
## 简介
2020-04-23 02:01:14 +08:00
Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库,基于 ECMA-376, ISO/IEC 29500 国际标准。可以使用它来读取、写入由 Microsoft Excel™ 2007 及以上版本创建的电子表格文档。支持 XLSX / XLSM / XLTM 等多种文档格式,高度兼容带有样式、图片(表)、透视表、切片器等复杂组件的文档,并提供流式读写 API, 用于处理包含大规模数据的工作簿。可应用于各类报表平台、云计算、边缘计算等系统。使用本类库要求使用的 Go 语言为 1.10 或更高版本,完整的 API 使用文档请访问 [go.dev ](https://pkg.go.dev/github.com/360EntSecGroup-Skylar/excelize/v2?tab=doc ) 或查看 [参考文档 ](https://xuri.me/excelize/ )。
2018-03-27 21:01:07 +08:00
## 快速上手
### 安装
2019-03-20 15:13:41 +08:00
```bash
2019-09-02 21:52:55 +08:00
go get github.com/360EntSecGroup-Skylar/excelize
2018-03-27 21:01:07 +08:00
```
2020-04-23 02:01:14 +08:00
- 如果您使用 [Go Modules ](https://blog.golang.org/using-go-modules ) 管理软件包,请使用下面的命令来安装最新版本。
```bash
go get github.com/360EntSecGroup-Skylar/excelize/v2
```
2018-03-27 21:01:07 +08:00
### 创建 Excel 文档
下面是一个创建 Excel 文档的简单例子:
```go
package main
2020-02-19 00:08:10 +08:00
import (
"fmt"
2020-12-14 09:56:42 +08:00
"github.com/360EntSecGroup-Skylar/excelize/v2"
2020-02-19 00:08:10 +08:00
)
2018-03-27 21:01:07 +08:00
func main() {
2019-04-20 14:57:50 +08:00
f := excelize.NewFile()
2018-03-27 21:01:07 +08:00
// 创建一个工作表
2019-04-20 14:57:50 +08:00
index := f.NewSheet("Sheet2")
2018-03-27 21:01:07 +08:00
// 设置单元格的值
2019-04-20 14:57:50 +08:00
f.SetCellValue("Sheet2", "A2", "Hello world.")
f.SetCellValue("Sheet1", "B2", 100)
2018-03-27 21:01:07 +08:00
// 设置工作簿的默认工作表
2019-04-20 14:57:50 +08:00
f.SetActiveSheet(index)
2018-03-27 21:01:07 +08:00
// 根据指定路径保存文件
2019-12-29 16:02:31 +08:00
if err := f.SaveAs("Book1.xlsx"); err != nil {
2020-02-19 00:08:10 +08:00
fmt.Println(err)
2018-03-27 21:01:07 +08:00
}
}
```
### 读取 Excel 文档
下面是读取 Excel 文档的例子:
```go
package main
2020-02-19 00:08:10 +08:00
import (
"fmt"
2020-12-14 09:56:42 +08:00
"github.com/360EntSecGroup-Skylar/excelize/v2"
2020-02-19 00:08:10 +08:00
)
2018-03-27 21:01:07 +08:00
func main() {
2019-12-29 16:02:31 +08:00
f, err := excelize.OpenFile("Book1.xlsx")
2018-03-27 21:01:07 +08:00
if err != nil {
2020-02-19 00:08:10 +08:00
fmt.Println(err)
2018-03-27 21:01:07 +08:00
return
}
// 获取工作表中指定单元格的值
2019-04-23 13:34:24 +08:00
cell, err := f.GetCellValue("Sheet1", "B2")
if err != nil {
2020-02-19 00:08:10 +08:00
fmt.Println(err)
2019-04-23 13:34:24 +08:00
return
}
2020-02-19 00:08:10 +08:00
fmt.Println(cell)
2018-03-27 21:01:07 +08:00
// 获取 Sheet1 上所有单元格
2019-04-20 14:57:50 +08:00
rows, err := f.GetRows("Sheet1")
2018-03-27 21:01:07 +08:00
for _, row := range rows {
for _, colCell := range row {
2020-02-19 00:08:10 +08:00
fmt.Print(colCell, "\t")
2018-03-27 21:01:07 +08:00
}
2020-02-19 00:08:10 +08:00
fmt.Println()
2018-03-27 21:01:07 +08:00
}
}
```
### 在 Excel 文档中创建图表
使用 Excelize 生成图表十分简单,仅需几行代码。您可以根据工作表中的已有数据构建图表,或向工作表中添加数据并创建图表。
2020-12-22 08:47:46 +08:00
< p align = "center" > < img width = "650" src = "./test/images/chart.png" alt = "使用 Excelize 在 Excel 电子表格文档中创建图表" > < / p >
2018-03-27 21:01:07 +08:00
```go
package main
2020-02-19 00:08:10 +08:00
import (
"fmt"
2020-12-14 09:56:42 +08:00
"github.com/360EntSecGroup-Skylar/excelize/v2"
2020-02-19 00:08:10 +08:00
)
2018-03-27 21:01:07 +08:00
func main() {
2020-12-22 08:47:46 +08:00
categories := map[string]string{
2020-12-27 00:18:54 +08:00
"A2": "Small", "A3": "Normal", "A4": "Large",
"B1": "Apple", "C1": "Orange", "D1": "Pear"}
2020-12-22 08:47:46 +08:00
values := map[string]int{
"B2": 2, "C2": 3, "D2": 3, "B3": 5, "C3": 2, "D3": 4, "B4": 6, "C4": 7, "D4": 8}
2019-04-20 14:57:50 +08:00
f := excelize.NewFile()
2018-03-27 21:01:07 +08:00
for k, v := range categories {
2019-04-20 14:57:50 +08:00
f.SetCellValue("Sheet1", k, v)
2018-03-27 21:01:07 +08:00
}
for k, v := range values {
2019-04-20 14:57:50 +08:00
f.SetCellValue("Sheet1", k, v)
}
2020-12-22 08:47:46 +08:00
if err := f.AddChart("Sheet1", "E1", `{
"type": "col3DClustered",
"series": [
{
"name": "Sheet1!$A$2",
"categories": "Sheet1!$B$1:$D$1",
"values": "Sheet1!$B$2:$D$2"
},
{
"name": "Sheet1!$A$3",
"categories": "Sheet1!$B$1:$D$1",
"values": "Sheet1!$B$3:$D$3"
},
{
"name": "Sheet1!$A$4",
"categories": "Sheet1!$B$1:$D$1",
"values": "Sheet1!$B$4:$D$4"
}],
"title":
{
"name": "Fruit 3D Clustered Column Chart"
}
}`); err != nil {
2020-02-19 00:08:10 +08:00
fmt.Println(err)
2019-04-20 14:57:50 +08:00
return
2018-03-27 21:01:07 +08:00
}
// 根据指定路径保存文件
2019-12-29 16:02:31 +08:00
if err := f.SaveAs("Book1.xlsx"); err != nil {
2020-02-19 00:08:10 +08:00
fmt.Println(err)
2018-03-27 21:01:07 +08:00
}
}
```
### 向 Excel 文档中插入图片
```go
package main
import (
2020-02-19 00:08:10 +08:00
"fmt"
2018-03-27 21:01:07 +08:00
_ "image/gif"
_ "image/jpeg"
_ "image/png"
2020-12-14 09:56:42 +08:00
"github.com/360EntSecGroup-Skylar/excelize/v2"
2018-03-27 21:01:07 +08:00
)
func main() {
2019-12-29 16:02:31 +08:00
f, err := excelize.OpenFile("Book1.xlsx")
2018-03-27 21:01:07 +08:00
if err != nil {
2020-02-19 00:08:10 +08:00
fmt.Println(err)
2018-03-27 21:01:07 +08:00
return
}
// 插入图片
2019-12-29 16:02:31 +08:00
if err := f.AddPicture("Sheet1", "A2", "image.png", ""); err != nil {
2020-02-19 00:08:10 +08:00
fmt.Println(err)
2018-03-27 21:01:07 +08:00
}
// 在工作表中插入图片,并设置图片的缩放比例
2020-12-22 08:47:46 +08:00
if err := f.AddPicture("Sheet1", "D2", "image.jpg",
`{"x_scale": 0.5, "y_scale": 0.5}` ); err != nil {
2020-02-19 00:08:10 +08:00
fmt.Println(err)
2018-03-27 21:01:07 +08:00
}
// 在工作表中插入图片,并设置图片的打印属性
2020-12-22 08:47:46 +08:00
if err := f.AddPicture("Sheet1", "H2", "image.gif", `{
"x_offset": 15,
"y_offset": 10,
"print_obj": true,
"lock_aspect_ratio": false,
"locked": false
}`); err != nil {
2020-02-19 00:08:10 +08:00
fmt.Println(err)
2018-03-27 21:01:07 +08:00
}
// 保存文件
2019-12-29 16:02:31 +08:00
if err = f.Save(); err != nil {
2020-02-19 00:08:10 +08:00
fmt.Println(err)
2018-03-27 21:01:07 +08:00
}
}
```
## 社区合作
欢迎您为此项目贡献代码,提出建议或问题、修复 Bug 以及参与讨论对新功能的想法。 XML 符合标准: [part 1 of the 5th edition of the ECMA-376 Standard for Office Open XML ](http://www.ecma-international.org/publications/standards/Ecma-376.htm )。
## 开源许可
本项目遵循 BSD 3-Clause 开源许可协议,访问 [https://opensource.org/licenses/BSD-3-Clause ](https://opensource.org/licenses/BSD-3-Clause ) 查看许可协议文件。
2019-01-01 13:20:14 +08:00
2019-01-05 10:55:43 +08:00
Excel 徽标是 [Microsoft Corporation ](https://aka.ms/trademarks-usage ) 的商标,项目的图片是一种改编。
gopher.{ai,svg,png} 由 [Takuya Ueda ](https://twitter.com/tenntenn ) 创作,遵循 [Creative Commons 3.0 Attributions license ](http://creativecommons.org/licenses/by/3.0/ ) 创作共用授权条款。