在上一篇 .net core下配置、数据库访问等操作实现主要介绍了读取配置,数据库操作的一些方法实例,本篇主要介绍下 .net core下针对Excel的相关操作。
对于后台相关的管理系统,Excel导出是基本的功能,下面就简单说下实现该功能的代码实现吧
EPPlus与NPOI的选择
相对于大名鼎鼎的NPOI来说,EPPlus的API更加友好,导出数据的能力也比NPOI更强大点,但在操作Excel的功能上还是NPOI强一点,如果你想导出比较复杂的Excel的话可以使用NPOI,但对于常规需求的话EPPlus基本满足了。
网上也有些两者对比的文章,可以参考下,比如C# NPOI导出Excel和EPPlus导出Excel比较
NPOI和EPPlus均已支持 .net core,看不同需求自行选择,这里主要讲下EPPlus的使用。
EPPlus的基本介绍
EPPlus是一个使用Open Office XML(xlsx)文件格式,能读写Excel 2007/2010 文件的开源组件,在导出Excel的时候不需要电脑上安装office。官网地址:http://epplus.codeplex.com/
使用的话直接NuGet上获取对应的dll即可。
但有一点注意,EPPlus不支持2003版本的Excel。
创建保存Excel
using (ExcelPackage package=new ExcelPackage())
{
ExcelWorksheet worksheet = package.Workbook.Worksheets.Add("Sheet1");//创建worksheet
package.Save();
}
单元格赋值
单元格赋值很简单,指定对应的单元格就可以直接赋值,价格遍历循环就可以进行批量的操作了
worksheet.Cells[1, 1].Value = "测试";//直接指定行列数进行赋值
worksheet.Cells["A1"].Value = "赋值";//直接指定单元格进行赋值
设置单元格样式
worksheet.Cells[1, 1].Style.HorizontalAlignment = ExcelHorizontalAlignment.Center;//水平居中
worksheet.Cells[1, 1].Style.VerticalAlignment = ExcelVerticalAlignment.Center;//垂直居中
worksheet.Cells[1, 4, 1, 5].Merge = true;//合并单元格
worksheet.Cells.Style.WrapText = true;//自动换行
设置字体
worksheet.Cells[1, 1].Style.Font.Bold = true;//字体为粗体
worksheet.Cells[1, 1].Style.Font.Color.SetColor(Color.White);//字体颜色
worksheet.Cells[1, 1].Style.Font.Name = "微软雅黑";//字体
worksheet.Cells[1, 1].Style.Font.Size = 12;//字体大小
设置单元格边框
worksheet.Cells[1, 1].Style.Border.BorderAround(ExcelBorderStyle.Thin, Color.FromArgb(191, 191, 191));//设置单元格所有边框
worksheet.Cells[1, 1].Style.Border.Bottom.Style = ExcelBorderStyle.Thin;//单独设置单元格底部边框样式和颜色(上下左右均可分开设置)
worksheet.Cells[1, 1].Style.Border.Bottom.Color.SetColor(Color.FromArgb(191, 191, 191));
设置单元格高和宽
worksheet.Cells.Style.ShrinkToFit = true;//单元格自动适应大小
worksheet.Row(1).Height = 15;//设置行高
worksheet.Row(1).CustomHeight = true;//自动调整行高
worksheet.Column(1).Width = 15;//设置列宽
设置单元格格式
worksheet.Cells[1, 1].Style.Numberformat.Format = "#,##0.00";//这是保留两位小数
设置sheet背景
worksheet.View.ShowGridLines = false;//去掉sheet的网格线
worksheet.Cells.Style.Fill.PatternType = ExcelFillStyle.Solid;
worksheet.Cells.Style.Fill.BackgroundColor.SetColor(Color.LightGray);//设置背景色
worksheet.BackgroundImage.Image = Image.FromFile(@"firstbg.jpg");//设置背景图片
隐藏sheet
worksheet.Hidden = eWorkSheetHidden.Hidden;//隐藏sheet
worksheet.Column(1).Hidden = true;//隐藏某一列
worksheet.Row(1).Hidden = true;//隐藏某一行
图片操作
有时候需求会将某个图片保存至Excel中,代码如下:
ExcelPicture picture = worksheet.Drawings.AddPicture("picture", Image.FromFile(@"firstbg.jpg"));//插入图片
picture.SetPosition(100, 100);//设置图片的位置
picture.SetSize(100, 100);//设置图片的大小
Excel加密和锁定
有时候导出的Excel不希望别人修改,可对Excel进行加密,代码如下:
worksheet.Protection.IsProtected = true;//设置是否进行锁定
worksheet.Protection.SetPassword("yk");//设置密码
worksheet.Protection.AllowAutoFilter = false;//下面是一些锁定时权限的设置
worksheet.Protection.AllowDeleteColumns = false;
worksheet.Protection.AllowDeleteRows = false;
worksheet.Protection.AllowEditScenarios = false;
worksheet.Protection.AllowEditObject = false;
worksheet.Protection.AllowFormatCells = false;
worksheet.Protection.AllowFormatColumns = false;
worksheet.Protection.AllowFormatRows = false;
worksheet.Protection.AllowInsertColumns = false;
worksheet.Protection.AllowInsertHyperlinks = false;
worksheet.Protection.AllowInsertRows = false;
worksheet.Protection.AllowPivotTables = false;
worksheet.Protection.AllowSelectLockedCells = false;
worksheet.Protection.AllowSelectUnlockedCells = false;
worksheet.Protection.AllowSort = false;
实际demo
首先定义一个通用创建ExcelPackage
的方法:
///
/// 创建ExcelPackage
///
///
/// 数据实体
/// 列名
/// 排除列
/// sheet名称
/// 标题
/// 是否加密
///
private static ExcelPackage CreateExcelPackage(List datas, Dictionary columnNames, List outOfColumns, string sheetName = "Sheet1",string title="",int isProtected=0)
{
var package = new ExcelPackage();
var worksheet = package.Workbook.Worksheets.Add(sheetName);
if(isProtected==1)
{
worksheet.Protection.IsProtected = true;//设置是否进行锁定
worksheet.Protection.SetPassword("xiangzhidaomimama");//设置密码
worksheet.Protection.AllowAutoFilter = false;//下面是一些锁定时权限的设置
worksheet.Protection.AllowDeleteColumns = false;
worksheet.Protection.AllowDeleteRows = false;
worksheet.Protection.AllowEditScenarios = false;
worksheet.Protection.AllowEditObject = false;
worksheet.Protection.AllowFormatCells = false;
worksheet.Protection.AllowFormatColumns = false;
worksheet.Protection.AllowFormatRows = false;
worksheet.Protection.AllowInsertColumns = false;
worksheet.Protection.AllowInsertHyperlinks = false;
worksheet.Protection.AllowInsertRows = false;
worksheet.Protection.AllowPivotTables = false;
worksheet.Protection.AllowSelectLockedCells = false;
worksheet.Protection.AllowSelectUnlockedCells = false;
worksheet.Protection.AllowSort = false;
}
var titleRow = 0;
if(!string.IsNullOrWhiteSpace(title))
{
titleRow = 1;
worksheet.Cells[1, 1, 1, columnNames.Count()].Merge = true;//合并单元格
worksheet.Cells[1, 1].Value = title;
worksheet.Cells.Style.WrapText = true;
worksheet.Cells[1, 1].Style.HorizontalAlignment = ExcelHorizontalAlignment.Center;//水平居中
worksheet.Cells[1, 1].Style.VerticalAlignment = ExcelVerticalAlignment.Center;//垂直居中
worksheet.Row(1).Height = 30;//设置行高
worksheet.Cells.Style.ShrinkToFit = true;//单元格自动适应大小
}
//获取要反射的属性,加载首行
Type myType = typeof(T);
List myPro = new List();
int i = 1;
foreach (string key in columnNames.Keys)
{
PropertyInfo p = myType.GetProperty(key);
myPro.Add(p);
worksheet.Cells[1+ titleRow, i].Value = columnNames[key];
i++;
}
int row = 2+ titleRow;
foreach (T data in datas)
{
int column = 1;
foreach (PropertyInfo p in myPro.Where(info => !outOfColumns.Contains(info.Name)))
{
worksheet.Cells[row, column].Value = p == null ? "" : Convert.ToString(p.GetValue(data, null));
column++;
}
row++;
}
return package;
}
然后将ExcelPackage
转换成Byte
类型,以流的方式进行导出:
public static Byte[] GetByteToExportExcel(List datas, Dictionary columnNames, List outOfColumn, string sheetName = "Sheet1",string title="",int isProtected=0)
{
using (var fs = new MemoryStream())
{
using (var package = CreateExcelPackage(datas, columnNames, outOfColumn, sheetName, title, isProtected))
{
package.SaveAs(fs);
return fs.ToArray();
}
}
}
最后就可以直接进行导出了:
public async Task GetExcel(UserModel entity,int isProtected=0)
{
var result = await ReportServices.GetAttendance(entity);
var columns = new Dictionary() {
{ "Id","序号"},
{ "UserName","用户名"},
{ "Remark","备注"}
};
var fs = ExcelHelper.GetByteToExportExcel(result.Collection.ToList(), columns, new List(),"Sheet1","", isProtected);
return File(fs, "application/vnd.android.package-archive", $"ExcelDemo.xlsx");
}
总结
EPPlus总的来说还是比较好用的,也能满足基本需求,导出效率也不错,大家可以尝试下