You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

183 lines
6.5 KiB

1 year ago
1 year ago
1 year ago
  1. <p align="center"><img width="650" src="./excelize.svg" alt="Excelize logo"></p>
  2. <p align="center">
  3. <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>
  4. <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>
  5. <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>
  6. <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>
  7. <a href="https://opensource.org/licenses/BSD-3-Clause"><img src="https://img.shields.io/badge/license-bsd-orange.svg" alt="Licenses"></a>
  8. <a href="https://www.paypal.me/xuri"><img src="https://img.shields.io/badge/Donate-PayPal-green.svg" alt="Donate"></a>
  9. </p>
  10. # Excelize
  11. ## 简介
  12. Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库,基于 ECMA-376,ISO/IEC 29500 国际标准。可以使用它来读取、写入由 Microsoft Excel&trade; 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/)。
  13. ## 快速上手
  14. ### 安装
  15. ```bash
  16. go get github.com/360EntSecGroup-Skylar/excelize
  17. ```
  18. - 如果您使用 [Go Modules](https://blog.golang.org/using-go-modules) 管理软件包,请使用下面的命令来安装最新版本。
  19. ```bash
  20. go get github.com/360EntSecGroup-Skylar/excelize/v2
  21. ```
  22. ### 创建 Excel 文档
  23. 下面是一个创建 Excel 文档的简单例子:
  24. ```go
  25. package main
  26. import (
  27. "fmt"
  28. "github.com/360EntSecGroup-Skylar/excelize"
  29. )
  30. func main() {
  31. f := excelize.NewFile()
  32. // 创建一个工作表
  33. index := f.NewSheet("Sheet2")
  34. // 设置单元格的值
  35. f.SetCellValue("Sheet2", "A2", "Hello world.")
  36. f.SetCellValue("Sheet1", "B2", 100)
  37. // 设置工作簿的默认工作表
  38. f.SetActiveSheet(index)
  39. // 根据指定路径保存文件
  40. if err := f.SaveAs("Book1.xlsx"); err != nil {
  41. fmt.Println(err)
  42. }
  43. }
  44. ```
  45. ### 读取 Excel 文档
  46. 下面是读取 Excel 文档的例子:
  47. ```go
  48. package main
  49. import (
  50. "fmt"
  51. "github.com/360EntSecGroup-Skylar/excelize"
  52. )
  53. func main() {
  54. f, err := excelize.OpenFile("Book1.xlsx")
  55. if err != nil {
  56. fmt.Println(err)
  57. return
  58. }
  59. // 获取工作表中指定单元格的值
  60. cell, err := f.GetCellValue("Sheet1", "B2")
  61. if err != nil {
  62. fmt.Println(err)
  63. return
  64. }
  65. fmt.Println(cell)
  66. // 获取 Sheet1 上所有单元格
  67. rows, err := f.GetRows("Sheet1")
  68. for _, row := range rows {
  69. for _, colCell := range row {
  70. fmt.Print(colCell, "\t")
  71. }
  72. fmt.Println()
  73. }
  74. }
  75. ```
  76. ### 在 Excel 文档中创建图表
  77. 使用 Excelize 生成图表十分简单,仅需几行代码。您可以根据工作表中的已有数据构建图表,或向工作表中添加数据并创建图表。
  78. <p align="center"><img width="650" src="./test/images/chart.png" alt="Excelize"></p>
  79. ```go
  80. package main
  81. import (
  82. "fmt"
  83. "github.com/360EntSecGroup-Skylar/excelize"
  84. )
  85. func main() {
  86. categories := map[string]string{"A2": "Small", "A3": "Normal", "A4": "Large", "B1": "Apple", "C1": "Orange", "D1": "Pear"}
  87. values := map[string]int{"B2": 2, "C2": 3, "D2": 3, "B3": 5, "C3": 2, "D3": 4, "B4": 6, "C4": 7, "D4": 8}
  88. f := excelize.NewFile()
  89. for k, v := range categories {
  90. f.SetCellValue("Sheet1", k, v)
  91. }
  92. for k, v := range values {
  93. f.SetCellValue("Sheet1", k, v)
  94. }
  95. 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 {
  96. fmt.Println(err)
  97. return
  98. }
  99. // 根据指定路径保存文件
  100. if err := f.SaveAs("Book1.xlsx"); err != nil {
  101. fmt.Println(err)
  102. }
  103. }
  104. ```
  105. ### 向 Excel 文档中插入图片
  106. ```go
  107. package main
  108. import (
  109. "fmt"
  110. _ "image/gif"
  111. _ "image/jpeg"
  112. _ "image/png"
  113. "github.com/360EntSecGroup-Skylar/excelize"
  114. )
  115. func main() {
  116. f, err := excelize.OpenFile("Book1.xlsx")
  117. if err != nil {
  118. fmt.Println(err)
  119. return
  120. }
  121. // 插入图片
  122. if err := f.AddPicture("Sheet1", "A2", "image.png", ""); err != nil {
  123. fmt.Println(err)
  124. }
  125. // 在工作表中插入图片,并设置图片的缩放比例
  126. if err := f.AddPicture("Sheet1", "D2", "image.jpg", `{"x_scale": 0.5, "y_scale": 0.5}`); err != nil {
  127. fmt.Println(err)
  128. }
  129. // 在工作表中插入图片,并设置图片的打印属性
  130. 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 {
  131. fmt.Println(err)
  132. }
  133. // 保存文件
  134. if err = f.Save(); err != nil {
  135. fmt.Println(err)
  136. }
  137. }
  138. ```
  139. ## 社区合作
  140. 欢迎您为此项目贡献代码,提出建议或问题、修复 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)。
  141. ## 开源许可
  142. 本项目遵循 BSD 3-Clause 开源许可协议,访问 [https://opensource.org/licenses/BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause) 查看许可协议文件。
  143. Excel 徽标是 [Microsoft Corporation](https://aka.ms/trademarks-usage) 的商标,项目的图片是一种改编。
  144. gopher.{ai,svg,png} 由 [Takuya Ueda](https://twitter.com/tenntenn) 创作,遵循 [Creative Commons 3.0 Attributions license](http://creativecommons.org/licenses/by/3.0/) 创作共用授权条款。