日常我们数据在需要导出为 Excel xlsx 文件时,实际上大部分需求就是将对应数据按照顺序一行行写入到 xlsx 表格中,具体的实现其实很容易,就是用 xlsx 相关库编码即可。这样的实现路径存在如下问题:
1、大量重复工作
但是如果你有多个数据需要导出为 xlsx 文件,每个数据都要单独写调用 xlsx 单元格写入 api,非常枯燥又效率低下。
2、大量重复代码
导出为 xlsx 文件,除了 xlsx 格式相关的代码外,还有文件保存,保存文件路径检测等各种需要处理。
3、无法聚焦数据差异性
实际导出 excel xlsx 文件时,主要是各种数据的差异性,xlsx 相关的写入是类似的,手工的实现,在考虑数据的差异性时,还得考虑 xlsx 的操作等,无法聚焦。
4、分组输出工作量大
无法自动按照某一数据字段,将数据分组输出到不同的 xlsx 文件,硬编码实现有大量文件初始化和写入逻辑需要处理。
本工具库帮助您聚焦数据导出到xlsx的编辑处理,可以在导出时自动按照某一字段对数据进行分割导出到不同的xlsx文件,同时支持xlsx加密、自动添加导出日期等功能。
主要由两部分组成:
```rust [dependencies.xlsxgroupwrite] version = "1"
feature = ["date","encrypt"] ```
支持灵活的自动分组导出和汇总导出数据
```rust use xlsxgroupwritemacroderive::XlsxGroupWriteQuicker;
// 快捷行数据写入定义
// 各列以逗号分隔,可使用两个函数参数:
// * line_index 为行号
// * &self 为待写入的数据
// 每个列数据定义为value:type
// * value 要写入的数据,可为表达式,如:line_index-1,表示当前待写入数据行号-1
// * type 数据类型,number/string,不指定则为string类型
line_writer_simple = "line_index-1:number,&self.name,&self.tel,&self.dep",
// 通过模板文件生成表头,设置列宽等
// 设置格式:模板文件位置,数据起始写入行行号(第一行序号从1开始)
// 与template_simple、template_getter互斥,template_simple优先
template_advance = "/home/feiy/Desktop/temp.xlsx,4",
// 通过函数获取模板信息
// 用于模板文件动态确定场景
// 与template_simple、template_advance互斥,template_simple优先、template_advance次之
// 该函数签名:fn get_template() -> xlsx_group_write::data::XlsxInitTemplet;
template_getter = "my_template_getter",
// 分组id指定,如无需分组输出xlsx文件,可不指定。示例为使用写入数据的dep属性,
group_maker = "&self.dep",
// 快捷表头设置,各列以逗号分隔
template_simple = "序号,姓名,手机,部门"
// 通过模板文件生成表头,设置列宽等
// 设置格式:模板文件位置,数据起始写入行行号(第一行序号从1开始)
// 与template_simple互斥,template_simple优先
template_advance = "/home/feiy/Desktop/temp.xlsx,4",
// 表格个性化信息添加器设置
// 在表格中添加自定义个性化信息
// 该函数签名:fn add_custom_info(sheet: &mut Worksheet, group_id: &str)
custom_info_adder = "add_custom_info",
// 输出的xlsx文件名前缀,含有完整路径,实际输出会自动添加.xlsx后缀
output_file_name_simple = "/tmp/test",
// 设置自动在输出文件名中添加当前日期
// 需与output_file_name_simple一起使用,
// 最终生成文件名称为类似:/tmp/test-2023-04-23.xlsx
output_file_name_add_date = "true"
// 个性化文件名称生成器,将调用指定的函数获取输出文件名称
// 该函数签名:fn get_output_file_name_advance(group_id: &str) -> String
output_file_name_advance = "get_output_file_name_advance"
)] ```
推荐使用xlsxgroupwritemacroderive
最快捷使用场景:自动生成表头,各行数据自动写入。
```rust use xlsxgroupwrite::prelude::*;
line_writer_simple = "line_index-1:number,&self.name,&self.tel,&self.dep",
group_maker = "&self.dep",
template_simple = "序号,姓名,手机,部门",
output_file_name_simple = "/tmp/test"
)] struct MySimpleData { pub name: String, pub tel: String, pub dep: String, } impl MySimpleData { pub fn new(name: &str, tel: &str, dep: &str) -> Self { Self { name: name.into(), tel: tel.into(), dep: dep.into(), } } }
fn testsimple() { // 初始化待导出数据 let data = vec![ MySimpleData::new("张三", "185xxxx2228", "网金部"), MySimpleData::new("李四", "185xxxx2229", "运管部"), MySimpleData::new("王二", "185xxxx2230", "网金部"), ]; // 导出数据到xlsx文件 // 自动按照部门分别导出,同时还汇总导出一个汇总xlsx文件 // 成功导出返回对应的文件信息和分组id let resp = MySimpleData::write2xlsxall(&data); println!("resp:{resp:#?}"); }
```
```rust use xlsxgroupwrite::*; use xlsxgroupwrite::data::XlsxColValueType;
/// 将要导出为xlsx文件的数据结构 struct MySimpleData { pub name: String, pub tel: String, pub dep: String, }
impl MySimpleData { pub fn new(name: &str, tel: &str, dep: &str) -> Self { Self { name: name.into(), tel: tel.into(), dep: dep.into(), } } } // 实现trait,以便快捷导出为xlsx impl XlsxGroupWrite for MySimpleData { /// 每行数据写入方式为简便模式 /// 即直接根据linewritersimple返回的对照表自动写入数据 /// 无需了解xlsx写入api const LINEWRITERMODEL: XlsxLineWriterModel = XlsxLineWriterModel::Simple;
/// 每一行写入四列数据,分别为:序号、姓名,手机和部门.
/// # 参数说明
///
/// * index 为正在写入行的行号,行号从1开始计数。
fn line_writer_simple(&self, index: u32) -> Vec<XlsxColValue> {
vec![
// 因为第一行是自动生成的表头,因此序号-1
XlsxColValue::new(index - 1, XlsxColValueType::NumberValue),
XlsxColValue::new(&self.name, XlsxColValueType::StringValue),
XlsxColValue::new(&self.tel, XlsxColValueType::StringValue),
XlsxColValue::new(&self.dep, XlsxColValueType::StringValue),
]
}
/// 设置分组id
///
/// 按照部门对数据进行分组
/// 如网金部,写入到网金部文件,运管部写入到运管部文件中。
fn group_make(&self) -> String {
self.dep.clone()
}
/// 设置表头内容
/// 列之间使用英文,分隔,将自动写入表格第一行。
///
/// 设置四列表头分别为:序号、姓名、手机和部门。
fn get_template() -> XlsxInitTemplet {
XlsxInitTemplet::new_header("序号,姓名,手机,部门")
}
/// 输出xlsx文件名设置
/// 生成的文件名称为:/tmp/test-分组id.xlsx
const OUTPUT_FILE_NAME_GETTER_SIMPLE: Option<OutputFileNameSimpleGetter> =
Some(OutputFileNameSimpleGetter::new(
"/tmp/test",
));
}
fn testsimpletemp() { // 初始化待导出数据 let data = vec![ MySimpleData::new("张三", "185xxxx2228", "网金部"), MySimpleData::new("李四", "185xxxx2229", "运管部"), MySimpleData::new("王二", "185xxxx2230", "网金部"), ]; // 导出数据到xlsx文件 // 自动按照部门分别导出,同时还汇总导出一个汇总xlsx文件 // 成功导出返回对应的文件信息和分组id let resp = MySimpleData::write2xlsxall( &data ); /* 输出: Ok( [ XlsxGroupWriteResp { groupid: "网金部", filename: "/tmp/test-网金部.xlsx", }, XlsxGroupWriteResp { groupid: "运管部", filename: "/tmp/test-运管部.xlsx", }, XlsxGroupWriteResp { groupid: "合并", file_name: "/tmp/test-合并.xlsx", }, ], ) */ println!("{resp:#?}"); } ```
我们可以自己先编辑好一个excel表格的样式,设置好标题、表头、字体等,然后以此xlsx文件为模板,生成表标题和表头,并在表格添加自定义信息,各行数据自动写入
```rust use umyaspreadsheet::Worksheet; use xlsxgroup_write::prelude::*;
line_writer_simple = "line_index-1:number,&self.name,&self.tel,&self.dep",
group_maker = "&self.dep",
template_advance = "/home/feiy/Desktop/temp.xlsx,4",
custom_info_adder = "Self::add_custom_info",
output_file_name_simple = "/tmp/test",
)] struct MySimpleDataWithTemplate { pub name: String, pub tel: String, pub dep: String, } impl MySimpleDataWithTemplate { pub fn new(name: &str, tel: &str, dep: &str) -> Self { Self { name: name.into(), tel: tel.into(), dep: dep.into(), } }
/// 对导出的xlsx文件进行一些个性化修改
/// 比如需要在第二行插入对应分组名称,插入报表日期等信息
///
/// 将在xlsx初始化完成后自动调用该方法
///
/// # 参数说明
///
/// * sheet 要修改的xlsx工作表
/// * group_id 该xlsx对应的分组id
fn add_custom_info(sheet: &mut Worksheet, group_id: &str) {
sheet
.get_cell_mut((&1, &2))
.set_value_string(&format!("{group_id},报表日期:2023年4月20日"));
}
}
fn testsimplewithtemplate() { // 初始化待导出数据 let data = vec![ MySimpleDataWithTemplate::new("张三", "185xxxx2228", "网金部"), MySimpleDataWithTemplate::new("李四", "185xxxx2229", "运管部"), MySimpleDataWithTemplate::new("王二", "185xxxx2230", "网金部"), ]; // 导出数据到xlsx文件 // 自动按照部门分别导出,同时还汇总导出一个汇总xlsx文件 // 成功导出返回对应的文件信息和分组id let resp = MySimpleDataWithTemplate::write2xlsxall(&data); println!("resp:{resp:#?}"); } ```
动态确定xlsx文件模板,生成表标题和表头,并在表格添加自定义信息,各行数据自动写入
```rust
line_writer_simple = "line_index-1:number,&self.name,&self.tel,&self.dep",
group_maker = "&self.dep",
template_getter = "Self::get_cur_template",
custom_info_adder = "Self::add_custom_info",
output_file_name_simple = "/tmp/test",
output_file_name_add_date = "true"
)] struct MySimpleDataWithTemplateGetter { pub name: String, pub tel: String, pub dep: String, } impl MySimpleDataWithTemplateGetter { pub fn new(name: &str, tel: &str, dep: &str) -> Self { Self { name: name.into(), tel: tel.into(), dep: dep.into(), } } /// 动态确定模板文件 fn getcurtemplate() -> XlsxInitTemplet{ XlsxInitTemplet::newadvance("/home/feiy/Desktop/template.xlsx", 3) } /// 对导出的xlsx文件进行一些个性化修改 /// 比如需要在第二行插入对应分组名称,插入报表数据范围等信息 /// /// 将在xlsx初始化完成后自动调用该方法 /// /// # 参数说明 /// /// * sheet 要修改的xlsx工作表 /// * groupid 该xlsx对应的分组id fn addcustominfo(sheet: &mut Worksheet, groupid: &str) { sheet .getcellmut((&1, &2)) .setvaluestring(&format!("{groupid},报表日期:2023年4月20日")); } }
fn testsimplewithtemplategetter() { // 初始化待导出数据 let data = vec![ MySimpleDataWithTemplateGetter::new("张三", "185xxxx2228", "网金部"), MySimpleDataWithTemplateGetter::new("李四", "185xxxx2229", "运管部"), MySimpleDataWithTemplateGetter::new("王二", "185xxxx2230", "网金部"), ]; // 导出数据到xlsx文件 // 自动按照部门分别导出,同时还汇总导出一个汇总xlsx文件 // 成功导出返回对应的文件信息和分组id let resp = MySimpleDataWithTemplateGetter::write2xlsx_all(&data); println!("resp:{resp:#?}"); } ```
```rust
use umyaspreadsheet::Worksheet; use xlsxgroup_write::prelude::*;
struct MyData { pub name: String, pub tel: String, pub dep: String, }
impl MyData { pub fn new(name: &str, tel: &str, dep: &str) -> Self { Self { name: name.into(), tel: tel.into(), dep: dep.into(), } } }
impl XlsxGroupWrite for MyData { const LINEWRITERMODEL: XlsxLineWriterModel = XlsxLineWriterModel::Simple;
fn line_writer_simple(&self, index: u32) -> Vec<XlsxColValue> {
vec![
XlsxColValue::new(index - 3, XlsxColValueType::NumberValue),
XlsxColValue::new(&self.name, XlsxColValueType::StringValue),
XlsxColValue::new(&self.tel, XlsxColValueType::StringValue),
XlsxColValue::new(&self.dep, XlsxColValueType::StringValue),
]
}
fn group_make(&self) -> String {
self.dep.clone()
}
/// 设置以/home/feiy/Desktop/temp.xlsx为模板创建导出xlsx文件,
/// 该模板中从第4行开始写入实际需要导出的数据。
fn get_template() -> XlsxInitTemplet {
XlsxInitTemplet::new_advance("/home/feiy/Desktop/temp.xlsx", 4)
}
/// 对生成的excel表格增加个性化信息
///
/// 在第二行加入,部门信息和导出日期信息
///
/// # 参数说明
///
/// * sheet 要修改的xlsx工作表
/// * group_id 该xlsx对应的分组id
fn add_custom_info_to_sheet(sheet: &mut Worksheet, group_id: &str) {
sheet
.get_cell_mut((&1, &2))
.set_value_string(&format!("{group_id},报表日期:2023年4月20日"));
}
const OUTPUT_FILE_NAME_GETTER_SIMPLE: Option<OutputFileNameSimpleGetter> =
Some(OutputFileNameSimpleGetter::new(
"/tmp/test",
));
}
fn testcustominfo() { let data = vec![ MyData::new("张三", "185xxxx2228", "网金部"), MyData::new("李四", "185xxxx2229", "运管部"), MyData::new("王二", "185xxxx2230", "网金部"), ]; // 只分组导出对应部门xlsx文件,不导出所有数据合并到一个文件的汇总文件 let resp = MyData::write2xlsxgrouponly( &data, ); println!("{resp:#?}"); } ```
自动生成表头,各行数据调用个性化写入函数writexlsxline写入 如果您的数据并不是一个字段写入一列的,需要合并写入,或者需要自定义单元格样式。
```rust use umyaspreadsheet::Worksheet; use xlsxgroup_write::prelude::*;
line_writer_advance = "Self::write_xlsx_line",
group_maker = "&self.dep",
template_simple = "序号,姓名,手机,部门",
output_file_name_simple = "/tmp/test",
)]
struct MyAdvanceData {
pub name: String,
pub tel: String,
pub dep: String,
}
impl MyAdvanceData {
pub fn new(name: &str, tel: &str, dep: &str) -> Self {
Self {
name: name.into(),
tel: tel.into(),
dep: dep.into(),
}
}
/// 个性化写入行数据
fn writexlsxline(
linedata:&MyAdvanceData,
sheet: &mut Worksheet,
lineindex: u32,
) -> Option
fn testadvancewrite() { // 初始化待导出数据 let data = vec![ MyAdvanceData::new("张三", "185xxxx2228", "网金部"), MyAdvanceData::new("李四", "185xxxx2229", "运管部"), MyAdvanceData::new("王二", "185xxxx2230", "网金部"), ]; // 导出数据到xlsx文件 // 自动按照部门分别导出,同时还汇总导出一个汇总xlsx文件 // 成功导出返回对应的文件信息和分组id let resp = MyAdvanceData::write2xlsx_all(&data); println!("resp:{resp:#?}"); } ```
```rust use xlsxgroupwrite::*; use xlsxgroupwrite::data::XlsxColValueType;
struct MyData3 { pub name: String, pub tel: String, pub dep: String, }
impl MyData3 { pub fn new(name: &str, tel: &str, dep: &str) -> Self { Self { name: name.into(), tel: tel.into(), dep: dep.into(), } } }
impl XlsxGroupWrite for MyData3 {
/// 行写入模式为高级写入模式,完全自定义
const LINEWRITERMODEL: XlsxLineWriterModel = XlsxLineWriterModel::Advance;
/// 使用xlsx api 写入每行的数据
fn linewriteradvance(
&self,
sheet: &mut Worksheet,
index: u32,
) -> Option
fn testadvancewrite() { let data = vec![ MyData3::new("张三", "185xxxx2228", "网金部"), MyData3::new("李四", "185xxxx2229", "运管部"), MyData3::new("王二", "185xxxx2230", "网金部"), ]; let resp = MyData3::write2xlsxmergeonly( &data ); println!("{resp:#?}"); } ```
自动生成表头,各行数据自动写入,输出文件名称通过函数获取
```rust use umyaspreadsheet::Worksheet; use xlsxgroup_write::prelude::*;
line_writer_simple = "line_index-1:number,&self.name,&self.tel,&self.dep",
group_maker = "&self.dep",
template_simple = "序号,姓名,手机,部门",
output_file_name_advance = "Self::get_output_file_name_advance",
)] struct MyFileNameData { pub name: String, pub tel: String, pub dep: String, } impl MyFileNameData { pub fn new(name: &str, tel: &str, dep: &str) -> Self { Self { name: name.into(), tel: tel.into(), dep: dep.into(), } }
/// 完全自定义的输出文件名称名称生成器
///
/// 参数说明:
///
/// * groupt_id :当期数据的分组id
#[allow(dead_code)]
fn get_output_file_name_advance(group_id: &str) -> String {
format!("/tmp/f-{group_id}.xlsx")
}
}
fn testadvancefilename() { // 初始化待导出数据 let data = vec![ MyFileNameData::new("张三", "185xxxx2228", "网金部"), MyFileNameData::new("李四", "185xxxx2229", "运管部"), MyFileNameData::new("王二", "185xxxx2230", "网金部"), ]; // 导出数据到xlsx文件 // 自动按照部门分别导出,同时还汇总导出一个汇总xlsx文件 // 成功导出返回对应的文件信息和分组id let resp = MyFileNameData::write2xlsxall(&data); println!("resp:{resp:#?}"); } ```
```rust use xlsxgroupwrite::*; use xlsxgroupwrite::data::XlsxColValueType;
struct MyData3 { pub name: String, pub tel: String, pub dep: String, }
impl MyData3 { pub fn new(name: &str, tel: &str, dep: &str) -> Self { Self { name: name.into(), tel: tel.into(), dep: dep.into(), } } }
impl XlsxGroupWrite for MyData3 { const LINEWRITERMODEL: XlsxLineWriterModel = XlsxLineWriterModel::Simple;
fn line_writer_simple(&self, index: u32) -> Vec<XlsxColValue> {
vec![
XlsxColValue::new(index - 1, XlsxColValueType::NumberValue),
XlsxColValue::new(&self.name, XlsxColValueType::StringValue),
XlsxColValue::new(&self.tel, XlsxColValueType::StringValue),
XlsxColValue::new(&self.dep, XlsxColValueType::StringValue),
]
}
/// 设置表头内容
/// 列之间使用英文,分隔,将自动写入表格第一行。
///
/// 设置四列表头分别为:序号、姓名、手机和部门。
fn get_template() -> XlsxInitTemplet {
XlsxInitTemplet::new_header("序号,姓名,手机,部门")
}
/// 输出文件位置和文件名称由函数自行控制,比如每个部门文件存放不同的路径中等
fn get_output_file_name_advance(groupt_id: &str) -> String {
format!("/tmp/advance-{groupt_id}.xlsx")
}
}
fn testadvancewrite() { let data = vec![ MyData3::new("张三", "185xxxx2228", "网金部"), MyData3::new("李四", "185xxxx2229", "运管部"), MyData3::new("王二", "185xxxx2230", "网金部"), ]; let resp = MyData3::write2xlsxmergeonly( &data ); println!("{resp:#?}"); } ```