歡迎光臨
每天分享高質量文章
當前位置：知識星球 > 後端 > 正文

.NET Core一行程式碼匯入匯出Excel生成Word

2019-06-20 分類：後端 閱讀(561) 評論(0)

作者：holdengong

連結：https://www.cnblogs.com/holdengong/p/10889838.html

簡介

Excel和Word操作在開發過程中經常需要使用，這類工作不涉及到核心業務，但又往往不可缺少。以往的開發方式在業務程式碼中直接引入NPOI、Aspose或者其他第三方庫，工作繁瑣，耗時多，擴充套件性差——比如基礎庫由NPOI修改為EPPlus，意味著業務程式碼需要全部修改。

 

由於工作需要，我在之前版本的基礎上，封裝了OfficeService，目的是最大化節省匯入匯出這種非核心功能開發時間，專註於業務實現，並且業務端與底層基礎元件完全解耦，即業務端完全不需要知道底層使用的是什麼基礎庫，使得重構代價大大降低。

 

EasyOffice提供了

 

  • Excel匯入：透過對模板類標記特性自動校驗資料（後期計劃支援FluentApi，即傳參決定校驗行為），並將有效資料轉換為指定型別，業務端只在拿到正確和錯誤資料後決定如何處理；

     

  • Excel匯出：透過對模板類標記特性自動渲染樣式（後期計劃支援FluentApi，即傳參決定匯出行為）；

     

  • Word根據模板生成：支援使用文字和圖片替換，佔位符只需定義模板類，製作Word模板，一行程式碼匯出docx檔案（後期計劃支援轉換為pdf）；

     

  • Word根據Table母版生成：只需定義模板類，製作表格模板，傳入資料，服務會根據資料條數自動複製表格母版，並填充資料；

     

  • Word從空白建立等功能：特別複雜的Word匯出任務，支援從空白建立；

EasyOffice底層庫目前使用NPOI,因此是完全免費的。

 

透過IExcelImportProvider等Provider介面實現了底層庫與實現的解耦，後期如果需要切換比如Excel匯入的基礎庫為EPPlus，只需要提供IExcelImportProvider介面的EPPlus實現，並且修改依賴註入程式碼即可。

依賴註入

提供了.NET Core自帶ServiceCollection註入和Autofac註入

// Autofac註入Office基礎服務
builder.AddOffice(new OfficeOptions());

//.NET Core自帶ServiceCollection註入
services.AddOffice(new OfficeOptions());

IExcelImportService – Excel通用匯入

定義Excel模板類

public class Car
{
    [ColName("車牌號")]  //對應Excel列名
    [Required] //校驗必填
    [Regex(RegexConstant.CAR_CODE_REGEX)] //正則運算式校驗,RegexConstant預置了一些常用的正則運算式，也可以自定義
    [Duplication] //校驗模板類該列資料是否重覆
    public string CarCode { get; set; }

    [ColName("手機號")]
    [Regex(RegexConstant.MOBILE_CHINA_REGEX)]
    public string Mobile { get; set; }

    [ColName("身份證號")]
    [Regex(RegexConstant.IDENTITY_NUMBER_REGEX)]
    public string IdentityNumber { get; set; }

    [ColName("姓名")]
    [MaxLength(10)] //最大長度校驗
    public string Name { get; set; }

    [ColName("性別")] 
    [Regex(RegexConstant.GENDER_REGEX)]
    public GenderEnum Gender { get; set; }

    [ColName("註冊日期")]
    [DateTime] //日期校驗
    public DateTime RegisterDate { get; set; }

    [ColName("年齡")]
    [Range(0, 150)] //數值範圍校驗
    public int Age { get; set; }
}

 

校驗資料

var _rows = _excelImportService.ValidateAsync(new ImportOption()
{
    FileUrl = fileUrl, //Excel檔案絕對地址
    DataRowStartIndex = 1, //資料起始行索引，預設1第二行
    HeaderRowIndex = 0,  //表頭起始行索引，預設0第一行
    MappingDictionary = null, //對映字典，可以將模板類與Excel列重新對映， 預設null
    SheetIndex = 0, //頁面索引，預設0第一個頁簽
    ValidateMode = ValidateModeEnum.Continue //校驗樣式，預設StopOnFirstFailure校驗錯誤後此行停止繼續校驗，Continue：校驗錯誤後繼續校驗
}).Result;

//得到錯誤行
var errorDatas = _rows.Where(x => !x.IsValid);
//錯誤行業務處理

//將有效資料行轉換為指定型別
var validDatas = _rows.Where(x=>x.IsValid).FastConvert();

//正確資料業務處理

 

轉換為DataTable

 

var dt = _excelImportService.ToTableAsync //模板型別
 (
 fileUrl,  //檔案絕對地址
 0,  //頁簽索引，預設0
 0,  //表頭行索引，預設0
 1, //資料行索引，預設1
 -1); //讀取多少條資料，預設-1全部
IExcelExportService - 通用Excel匯出服務

IExcelExportService – 通用Excel匯出服務

定義匯出模板類

 

[Header(Color = ColorEnum.BRIGHT_GREEN, FontSize = 22, IsBold = true)] //表頭樣式
[WrapText] //自動換行
public class ExcelCarTemplateDTO
{
    [ColName("車牌號")]
    [MergeCols] //相同資料自動合併單元格
    public string CarCode { get; set; }

    [ColName("手機號")]
    public string Mobile { get; set; }

    [ColName("身份證號")]
    public string IdentityNumber { get; set; }

    [ColName("姓名")]
    public string Name { get; set; }

    [ColName("性別")]
    public GenderEnum Gender { get; set; }

    [ColName("註冊日期")]
    public DateTime RegisterDate { get; set; }

    [ColName("年齡")]
    public int Age { get; set; }

 

匯出Excel

 

var bytes = await _excelExportService.ExportAsync(new ExportOption()
{
    Data = list,
    DataRowStartIndex = 1, //資料行起始索引，預設1
    ExcelType = Bayantu.Extensions.Office.Enums.ExcelTypeEnum.XLS,//匯出Excel型別，預設xls
    HeaderRowIndex = 0, //表頭行索引，預設0
    SheetName = "sheet1" //頁簽名稱，預設sheet1
});

File.WriteAllBytes(@"c:	est.xls", bytes);

 

IExcelImportSolutionService – Excel匯入解決方案服務(與前端控制元件配套的完整解決方案，可忽略)

 

首先定義模板類，參考通用Excel匯入

 

//獲取預設匯入模板
var templateBytes = await _excelImportSolutionService.GetImportTemplateAsync();

//獲取匯入配置
var importConfig = await _excelImportSolutionService.GetImportConfigAsync("uploadUrl","templateUrl");
//獲取預覽資料
var previewData = await _excelImportSolutionService.GetFileHeadersAndRowsAsync("fileUrl");
//匯入
var importOption = new ImportOption()
{
    FileUrl = "fileUrl",
    ValidateMode = ValidateModeEnum.Continue
};
object importSetData = new object(); //前端傳過來的對映資料
var importResult = await _excelImportSolutionService.ImportAsync
    (importOption
    , importSetData
    , BusinessAction //業務方法委託
    , CustomValidate //自定義校驗委託
    );
//獲取匯入錯誤訊息
var errorMsg = await _excelImportSolutionService.ExportErrorMsgAsync(importResult.Tag);

IWordExportService – Word通用匯出服務

CreateFromTemplateAsync – 根據模板生成Word

//step1 - 定義模板類
public class WordCarTemplateDTO
{
    //預設佔位符為{PropertyName}
    public string OwnerName { get; set; }

    [Placeholder("{Car_Type Car Type}")] //重寫佔位符
    public string CarType { get; set; }

    //使用Picture或IEnumerable型別可以將佔位符替換為圖片
    public IEnumerable CarPictures { get; set; }

public Picture CarLicense { get; set; }
}

//step2 - 製作word模板
//step3 - 匯出word
string templateUrl = @"c:	emplate.docx";
WordCarTemplateDTO car = new WordCarTemplateDTO()
{
    OwnerName = "劉德華",
    CarType = "豪華型賓利",
    CarPictures = new List() {
new Picture()
         {
              PictureUrl = pic1, //圖片絕對地址，如果設定了PictureData此項不生效
              FileName = "圖片1",//檔案名稱
              Height = 10,//圖片高度單位釐米預設8
              Width = 3,//圖片寬度單位釐米預設14
              PictureData = null,//圖片流資料，優先取這裡的資料，沒有則取url
              PictureType = PictureTypeEnum.JPEG //圖片型別，預設jpeg
         },
new Picture(){
              PictureUrl = pic2
         }
    },
    CarLicense = new Picture { PictureUrl = pic3 }
};

var word = await _wordExportService.CreateFromTemplateAsync(templateUrl, car);
File.WriteAllBytes(@"c:ile.docx", word.WordBytes);

 

CreateWordFromMasterTable-根據模板表格迴圈生成word

 

//step1 - 定義模板類，參考上面
//step2 - 定義word模板,製作一個表格,填好佔位符。
//step3 - 呼叫,如下示例,最終生成的word有兩個使用者表格
string templateurl = @"c:	emplate.docx";
var user1 = new UserInfoDTO()
{
    Name = "張三",
    Age = 15,
    Gender = "男",
    Remarks = "簡介簡介"
};
var user2 = new UserInfoDTO()
{
    Name = "李四",
    Age = 20,
    Gender = "女",
    Remarks = "簡介簡介簡介"
};

var datas = new List() { user1, user2 };

for (int i = 0; i < 10; i++)
{
    datas.Add(user1);
    datas.Add(user2);
}
var word = await _wordExportService.CreateFromMasterTableAsync(templateurl, datas);
File.WriteAllBytes(@"c:ile.docx", word.WordBytes);

CreateWordAsync – 從空白生成word

//step1 - 定義模板類，參考上面
//step2 - 定義word模板,製作一個表格,填好佔位符。
//step3 - 呼叫,如下示例,最終生成的word有兩個使用者表格
string templateurl = @"c:	emplate.docx";
var user1 = new UserInfoDTO()
{
    Name = "張三",
    Age = 15,
    Gender = "男",
    Remarks = "簡介簡介"
};
var user2 = new UserInfoDTO()
{
    Name = "李四",
    Age = 20,
    Gender = "女",
    Remarks = "簡介簡介簡介"
};

var datas = new List() { user1, user2 };
for (int i = 0; i < 10; i++)
{
    datas.Add(user1);
    datas.Add(user2);
}
var word = await _wordExportService.CreateFromMasterTableAsync(templateurl, datas);

File.WriteAllBytes(@"c:ile.docx", word.WordBytes);
CreateWordAsync - 從空白生成word
[Fact]
public async Task 匯出所有日程()
{
     //準備資料
     var date1 = new ScheduleDate()
     {
         DateTimeStr = "2019年5月5日 星期八",
         Addresses = new List
()
};

var address1 = new Address()
{
Name = “會場一”,
Categories = new List()
};

var cate1 = new Category()
{
Name = “分類1”,
Schedules = new List()
};

var schedule1 = new Schedule()
{
Name = “日程1”,
TimeString = “上午9：00 – 上午12：00”,
Speakers = new List()
};

var schedule2 = new Schedule()
{
Name = “日程2”,
TimeString = “下午13：00 – 下午14：00”,
Speakers = new List()
};

var speaker1 = new Speaker()
{
Name = “張三”,
Position = “總經理”
};
var speaker2 = new Speaker()
{
Name = “李四”,
Position = “副總經理”
};
schedule1.Speakers.Add(speaker1);
schedule1.Speakers.Add(speaker2);
cate1.Schedules.Add(schedule1);
cate1.Schedules.Add(schedule2);
address1.Categories.Add(cate1);
date1.Addresses.Add(address1);
var dates = new List() { date1,date1,date1 };
var tables = new List(); //新建一個表格 var table = new Table() { Rows = new List() }; foreach (var date in dates) { //新建一行 var rowDate = new TableRow() { Cells = new List() }; //新增單元格 rowDate.Cells.Add(new TableCell() { Color = “lightblue”, //設定單元格顏色 Paragraphs = new List() { //新增段落 new Paragraph() { //段落裡面新增文字域 Run = new Run() { Text = date.DateTimeStr,//文字域文字，Run還可以 Color = “red”, //設定文字顏色 FontFamily = “微軟雅黑”,//設定文字字型 FontSize = 12,//設定文字字號 IsBold = true,//是否粗體 Pictures = new List()//也可以插入圖片 }, Alignment = Alignment.CENTER //段落居中 } } }); table.Rows.Add(rowDate); //會場 foreach (var addr in date.Addresses) { //分類 foreach (var cate in addr.Categories) { var rowCate = new TableRow() { Cells = new List() }; //會場名稱 rowCate.Cells.Add(new TableCell() { Paragraphs = new List{ new Paragraph() { Run = new Run() { Text = addr.Name, } } } }); rowCate.Cells.Add(new TableCell() { Paragraphs = new List(){ new Paragraph() { Run = new Run() { Text = cate.Name, } } } }); table.Rows.Add(rowCate); //日程 foreach (var sche in cate.Schedules) { var rowSche = new TableRow() { Cells = new List() }; var scheCell = new TableCell() { Paragraphs = new List() { new Paragraph() { Run = new Run() { Text = sche.Name } }, { new Paragraph() { Run = new Run() { Text = sche.TimeString } } } } }; foreach (var speaker in sche.Speakers) { scheCell.Paragraphs.Add(new Paragraph() { Run = new Run() { Text = $”{speaker.Position}:{speaker.Name}” } }); } rowSche.Cells.Add(scheCell); table.Rows.Add(rowSche); } } } } tables.Add(table); var word = await _wordExportService.CreateWordAsync(tables); File.WriteAllBytes(fileUrl, word.WordBytes); } 

 

 

詳細例子請github下載程式碼後自行跑單元測試檢視

 

github地址：https://github.com/holdengong/EasyOffice

贊(0)
標籤：

相關推薦

熱門標籤

iOS (11238)微軟 (4955)Linux (4274)安全 (4180)Python (4161)效能 (3165)運維 (2774)最佳化 (2419).NET (2262)Google (2136)機器學習 (1795)併發 (1613)分散式 (1559)叢集 (1240)SQL (1174)Mysql (1060)區塊鏈 (1017)Docker (977)微服務 (922)面試 (919)Apache (743)NLP (725)Redis (719)Android (668)Git (640)架構師 (632)Nginx (630)Facebook (599)JVM (595)爬蟲 (476)

熱門文章

分享創造快樂