初始化

This commit is contained in:
Shawn Jones 2024-09-12 10:06:22 +08:00
commit 6e0968378e

154
README.md Normal file
View File

@ -0,0 +1,154 @@
# Excel 操作库开发文档
## 概述
本库旨在提供一个用于操作 Excel 文件的工具,支持 `.xls``.xlsx` 两种常用文件格式。库中实现的功能涵盖从基础的工作簿管理、单元格读写到复杂的图表生成、数据验证等操作。通过该库,开发者可以高效、灵活地操作 Excel 文件,支持文件的读、写、创建、修改等操作。
## 目录
1. 文件格式与结构
2. 功能模块划分
- 文件管理
- 工作簿与工作表操作
- 单元格操作
- 样式与格式控制
- 图表与图形支持
- 高级功能
3. 数据类型处理
4. 测试与错误处理
5. 性能优化与流式处理
6. 详细 API 设计
7. 安全性与扩展性
8. 版本与环境支持
## 1. 文件格式与结构
### 1.1 文件格式支持
- **`.xls` 文件**:采用 BIFFBinary Interchange File Format为 Excel 97-2003 使用的二进制文件格式。
- **`.xlsx` 文件**:使用基于 Open XML 的结构,包含多个嵌套的 XML 文件与压缩包结构。
### 1.2 结构解析
- **Workbook**Excel 文件的根节点,包含多个 Sheet。
- **Sheet**:每个工作表是一张电子表格,包含行和列。
- **Row/Column**:行和列是 Excel 的基础单元,用来组织数据。
- **Cell**:单元格是最小的数据单位,支持各种数据类型(文本、数值、日期、布尔值、公式等)。
## 2. 功能模块划分
### 2.1 文件管理
- **加载文件**:从磁盘加载一个现有的 Excel 文件,解析其内容。
- **保存文件**:将内存中的修改保存到磁盘,可以选择保存为现有文件或另存为新文件。
- **新建文件**:创建一个空白的 Excel 文件,允许用户在其上操作。
- **关闭文件**:释放文件资源,防止内存泄漏。
### 2.2 工作簿与工作表操作
- **列出工作表**:返回文件中所有工作表的名称列表。
- **创建新工作表**:允许用户在文件中添加新的工作表,支持命名和初始化。
- **删除工作表**:从工作簿中移除指定的工作表。
- **重命名工作表**:修改工作表的名称。
- **切换工作表**:允许用户在不同的工作表之间进行操作。
### 2.3 单元格操作
- **读取单元格数据**:根据行号和列号,读取指定单元格中的内容,自动识别数据类型(文本、数值、日期等)。
- **写入单元格数据**:向指定单元格中写入数据,可以是文本、数值、公式等。
- **批量读取单元格数据**:通过指定一个范围,批量获取一组单元格的内容。
- **批量写入单元格数据**:向一个范围内的单元格批量写入数据,支持矩阵或表格形式的数据写入。
### 2.4 样式与格式控制
- **设置单元格样式**:允许用户设置字体、颜色、对齐方式、边框等。
- **条件格式**:支持基于单元格内容的条件格式,例如根据数值高低显示不同的背景色。
- **合并单元格**:允许用户将多个单元格合并成一个单元格,并设置其对齐方式。
- **自动调整列宽**:根据列中数据的长度自动调整列宽。
### 2.5 图表与图形支持
- **生成图表**:根据指定的数据生成图表,支持的图表类型包括柱状图、折线图、饼图等。
- **嵌入图表**:将生成的图表嵌入到工作表的指定位置。
- **插入图片**:支持将图片插入到工作表中,自动调整大小。
### 2.6 高级功能
- **数据验证**:允许为单元格设置数据验证规则,如数值范围、日期限制等。
- **数据筛选**:支持对工作表中的数据进行筛选,并只显示符合条件的行。
- **数据透视表**:提供创建数据透视表的功能,方便用户进行数据分析。
## 3. 数据类型处理
- **字符串**:所有文本数据均以字符串形式存储。
- **数值**:可以是整数或浮点数,需正确处理精度问题。
- **日期**读取和写入时需要支持日期格式提供转换工具将日期格式转换为Excel内部的日期表示。
- **布尔值**:用 `TRUE``FALSE` 表示。
- **公式**:在写入公式时需注意公式的正确语法,支持 Excel 公式语言。
## 4. 测试与错误处理
### 4.1 单元测试
- 针对各个功能模块编写单元测试,确保每个功能点都能正常工作。
- 测试应覆盖正常使用场景、边界条件和异常情况。
### 4.2 错误处理
- **文件错误**:文件格式不正确、文件损坏等情况应提供友好的错误提示。
- **数据错误**:如输入的数据类型不匹配、超出 Excel 支持的范围时,需抛出合适的异常。
- **用户操作错误**:如用户试图删除不存在的工作表或读取超出范围的单元格,应提示用户错误。
## 5. 性能优化与流式处理
- **大文件处理**:对于包含大量数据的 Excel 文件,采用流式读取和写入,避免一次性加载整个文件到内存中。
- **缓存机制**:在操作频繁的情况下使用缓存机制,减少文件的读写次数,提高性能。
## 6. 详细 API 设计
### 6.1 文件管理
- 打开文件
- 保存文件
- 新建文件
- 关闭文件
### 6.2 工作簿与工作表操作
- 获取所有工作表
- 创建新工作表
- 删除工作表
- 切换当前工作表
### 6.3 单元格操作
- 读取单元格数据
- 写入单元格数据
- 批量读取单元格
- 批量写入单元格
### 6.4 样式与格式控制
- 设置单元格样式
- 合并单元格
### 6.5 图表与图形支持
- 创建图表
- 插入图片
## 7. 安全性与扩展性
- **安全性**:避免文件读写操作中可能引发的安全漏洞,如路径注入、未验证的用户输入等。
- **扩展性**:代码模块化设计,便于将来扩展功能,如支持更多格式、添加新特性等。
## 8. 版本与环境支持
- 支持的操作系统跨平台支持Windows、Linux、Mac OS。
- 最低版本要求:依赖的库与语言版本要求在此处列出,确保与开发环境一致。
## 总结
通过本开发文档,可以按照模块化的设计实现一个操作 Excel 的库,该库能够在生产环境中应用,支持常见的 Excel 操作功能,并且具备良好的性能和可扩展性。