1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
//! # Xlsx-Group-Write
//!
//! ---
//!
//! # 解决问题
//!
//! 日常我们数据在需要导出为 Excel xlsx 文件时,实际上大部分需求就是将对应数据按照顺序一行行写入到 xlsx 表格中,具体的实现其实很容易,就是用 xlsx 相关库编码即可。这样的实现路径存在如下问题:
//!
//! 1、大量重复工作
//!
//! 但是如果你有多个数据需要导出为 xlsx 文件,每个数据都要单独写调用 xlsx 单元格写入 api,非常枯燥又效率低下。
//!
//! 2、大量重复代码
//!
//! 导出为 xlsx 文件,除了 xlsx 格式相关的代码外,还有文件保存,保存文件路径检测等各种需要处理。
//!
//! 3、无法聚焦数据差异性
//!
//! 实际导出 excel xlsx 文件时,主要是各种数据的差异性,xlsx 相关的写入是类似的,手工的实现,在考虑数据的差异性时,还得考虑 xlsx 的操作等,无法聚焦。
//!
//! 4、分组输出工作量大
//!
//! 无法自动按照某一数据字段,将数据分组输出到不同的 xlsx 文件,硬编码实现有大量文件初始化和写入逻辑需要处理。
//!
//! # 我们干什么
//!
//! 因此,这就有了 Xlsx-Group-Write 的出现了,主要实现如下功能:
//!
//! 1、聚焦数据处理
//!
//! 无需了解 xlsx 的写入 api,只需要聚焦数据如何写入到的哪一列。即可实现自动导出到xlsx,支持分类导出,支持加密导出等,比如有如下数据结构
//!
//! ```ignore
//!
//! struct MyDate{
//! name:String,
//! tel:String,
//! dep:String
//! }
//! ```
//!
//! 我们只需要维护各字段对应将写入到表格的第几列即可完成 xlsx 导出。示例如下:
//!
//! ```ignore
//! use xlsx_group_write::*;
//! use xlsx_group_write::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 {
//! /// 每行数据写入方式为简便模式
//! /// 即直接根据line_writer_simple返回的对照表自动写入数据
//! /// 无需了解xlsx写入api
//! const LINE_WRITER_MODEL: 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",
//! ));
//! }
//!
//! #[test]
//! fn test_simple_temp() {
//! // 初始化待导出数据
//! let data = vec![
//! MySimpleData::new("张三", "185xxxx2228", "网金部"),
//! MySimpleData::new("李四", "185xxxx2229", "运管部"),
//! MySimpleData::new("王二", "185xxxx2230", "网金部"),
//! ];
//! // 导出数据到xlsx文件
//! // 自动按照部门分别导出,同时还汇总导出一个汇总xlsx文件
//! // 成功导出返回对应的文件信息和分组id
//! let resp = MySimpleData::write2xlsx_all(
//! &data
//! );
//! /*
//!
//! Ok(
//! [
//! XlsxGroupWriteResp {
//! group_id: "网金部",
//! file_name: "/tmp/test-网金部.xlsx",
//! },
//! XlsxGroupWriteResp {
//! group_id: "运管部",
//! file_name: "/tmp/test-运管部.xlsx",
//! },
//! XlsxGroupWriteResp {
//! group_id: "合并",
//! file_name: "/tmp/test-合并.xlsx",
//! },
//! ],
//! )
//! */
//! println!("{resp:#?}");
//! }
//! ```
//!
//! 2、支持从某个xlsx文件模板生成导出数据
//!
//! 我们可以自己先编辑好一个excel表格的样式,设置好标题、表头、字体等,然后以此模板生成导出数据,例如:
//!
//!
//! ```ignore
//!
//! use xlsx_group_write::*;
//! use xlsx_group_write::data::XlsxColValueType;
//!
//! 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 LINE_WRITER_MODEL: 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",
//! ));
//! }
//!
//!
//! #[test]
//! fn test_custom_info() {
//! let data = vec![
//! MyData::new("张三", "185xxxx2228", "网金部"),
//! MyData::new("李四", "185xxxx2229", "运管部"),
//! MyData::new("王二", "185xxxx2230", "网金部"),
//! ];
//! // 只分组导出对应部门xlsx文件,不导出所有数据合并到一个文件的汇总文件
//! let resp = MyData::write2xlsx_group_only(
//! &data,
//! );
//! println!("{resp:#?}");
//! }
//! ```
//!
//! 3、灵活的自动分组导出和汇总导出数据
//!
//! * write2xlsx_group_only
//! * 只导出分组数据
//! * 按照分组id,将不同数据导出到不同的xlsx文件中
//! * write2xlsx_merge_only
//! * 所有数据导入到同一个汇总xlsx文件
//! * write2xlsx_all
//! * 以上同时导出
//!
//! 4、可实现完全个性化自行控制的行数据写入
//!
//! 如果您的数据并不是一个字段写入一列的,需要合并写入,或者需要自定义单元格样式,可以如下使用:
//!
//! ```ignore
//! use xlsx_group_write::*;
//! use xlsx_group_write::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 LINE_WRITER_MODEL: XlsxLineWriterModel = XlsxLineWriterModel::Advance;
//! /// 使用xlsx api 写入每行的数据
//! fn line_writer_advance(
//! &self,
//! sheet: &mut Worksheet,
//! index: u32,
//! ) -> Option<XlsxLineAdvanceWriterResult> {
//! xlsx_util::XlsxWriterTool::set_excel_cell_value_number(sheet, 1, index, index - 2);
//! xlsx_util::XlsxWriterTool::set_excel_cell_value_str(sheet, 2, index, &self.name);
//! xlsx_util::XlsxWriterTool::set_excel_cell_value_str(sheet, 3, index, &self.tel);
//! xlsx_util::XlsxWriterTool::set_excel_cell_value_str(sheet, 4, index, &self.dep);
//! None
//! }
//! fn get_template() -> XlsxInitTemplet {
//! XlsxInitTemplet::new_advance("/home/feiy/Desktop/temp.xlsx", 4)
//! }
//! /// 输出文件位置和文件名称由函数自行控制,比如每个部门文件存放不同的路径中等
//! fn get_output_file_name_advance(groupt_id: &str) -> String {
//! format!("/tmp/advance-{groupt_id}.xlsx")
//! }
//! 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日"));
//! }
//! }
//!
//! #[test]
//! fn test_advance_write() {
//! let data = vec![
//! MyData3::new("张三", "185xxxx2228", "网金部"),
//! MyData3::new("李四", "185xxxx2229", "运管部"),
//! MyData3::new("王二", "185xxxx2230", "网金部"),
//! ];
//! let resp = MyData3::write2xlsx_merge_only(
//! &data
//! );
//! println!("{resp:#?}");
//! }
//! ```
//!
//! # 个性化特性
//!
//! * date 自动在文件名称中加入导出日期
//! * encrypt 支持xlsx文件加密,添加该特性后,向接口会增加密码参数
//!
//! # 用法
//!
//! 1. 添加依赖
//!
//! ```ignore
//! [dependencies.xlsx_group_write]
//! version = "1"
//! # 根据需要添加对应特性
//! feature = ["date","encrypt"]
//! ```
//!
//! 2. 定义里的导出数据结构,并实现XlsxGroupWrite,并根据需要使用不同的方法和属性
//!
//! 3. 调用不同的write2xlsx_方法导出数据到xlsx文件。
use *;
use ;
use Worksheet;
/// xlsx写入的相关工具
/// 工具方法
/// 相关数据
/// xlsx文件分组输出器
///
/// 主要功能功能:
///
/// 1. 自动分组写入不同xlsx文件中
///
/// 自动对数据新分组,并按照不同的分组写入到不同的xlsx文件中///
///
/// 2. 提供灵活的数据写入模式
///
/// xlxs每行数据在写入时,可以通过两种模式进行自定义写入:
///
/// * 快捷模式 : 只需要提供将原始数据转换为待写入excel数据的函数即可,无需手工进行excel的写入操作
/// * 高级模式 : 完全有用户自行调用xlsx相关api进行数据写入,实现最大灵活性
///
/// 3. 可根据模板xlsx文件生成输出excel文件
///
/// 在模板文件中可优先编辑好表标题、表头等信息
///
/// 如果未使用模板,则需要提供TABLE_HEADER,一边自动生成表头
///
/// 4. 对xlsx文件进行加密
///
/// 写入时,支持对xlsx文件进行加密存储
///
/// 5. 可在分组时,同时保持包含所有数据的合并xlsx文件
///
/// 6. 可灵活确定文件存储名称
///
/// * OUTPUT_FILE_NAME_GETTER 完全自定义实现任意文件名写入
/// * DEFAULT_FILE_NAME_PREF 系统自动以该变量为基础生成文件名,可自动在导出文件名称中增加导出日期
///