开源NPOI控件的封装辅助类NPOIHelper

作者: 05b0963bb480 | 来源:发表于2018-12-14 08:12 被阅读2次

开源NPOI控件的封装辅助类NPOIHelper
文件或者文件夹压缩辅助类ZipUtility
推荐一个有用的Excel操作类库 LinqToExcel
android6.0以上获取权限简单封装
『与善仁』Appium基础 — 35.APP模拟手势高级操作（一
UIBarItem
UI-Xib
SYUIInitialize初始化UI集成方法
React Native 一个开始
商品详情和购物车数量控件封装(造轮子QuantityView）

引言

在实际开发过程中，会遇到各种导出数据的情况，导出Excel是软件中很常用的功能，如果使用微软自带的类库来实现，则系统必须安装Office，根据开发的Office版本不同，客户端必须安装对应版本的Office。这给软件部署带来不便，客户体验降低。而开源的NPOI 控件则很好的解决了这个问题，今天为大家介绍封装辅助类NPOIHelper的使用。

实现效果

本辅助类主要用来简化对开源控件NPOI的使用，提供导出Excel文档的操作。
使用 NPOI 能够帮助开发者在没有安装微软Office的情况下读写 Office 97-2003的文件，支持的文件格式包括 xls, doc, ppt等。
可以直接对Excel进行读或写，而不依赖Office 的 Excel，这不管对于ASP.net或Winform都非常有利，不用担心Excel进程的释放问题，服务器安全。

实现步骤

在项目中引用NPOI.dll类库。
在代码引用相关的代码实现动态调用。

实现代码

辅助类提供的方法接口如下所示。

/// <summary>
/// 导出表格数据到Excel文档中
/// </summary>
public static void ExportEasy(DataTable dtSource, string strFileName)
/// <summary>
/// DataTable导出到Excel文件
/// </summary>
public static void Export(DataTable dtSource, string strHeaderText, string strFileName)
/// <summary>
/// DataTable导出到Excel的MemoryStream
/// </summary>
public static MemoryStream Export(DataTable dtSource, string strHeaderText)
/// <summary>
/// DataTable导出到Excel的MemoryStream
/// </summary>
public static MemoryStream Export(DataTable dtSource, string strHeaderText, DocumentSummaryInformation dsi, SummaryInformation si)
/// <summary>
/// 用于Web导出Excel
/// </summary>
public static void ExportByWeb(DataTable dtSource, string strHeaderText, string strFileName)
/// <summary>
/// 读取excel
/// 默认第一行为标头
/// </summary>
public static DataTable Import(string strFileName)

NPOI控件简单的使用代码，如下所示。

HSSFWorkbook workbook = new HSSFWorkbook();
HSSFSheet sheet = workbook.CreateSheet();
//填充表头
HSSFRow dataRow = sheet.CreateRow(0);
foreach (DataColumn column in dtSource.Columns)
{
dataRow.CreateCell(column.Ordinal).SetCellValue(column.ColumnName);
}
//填充内容
for (int i = 0; i < dtSource.Rows.Count; i++)
{
dataRow = sheet.CreateRow(i + 1);
for (int j = 0; j < dtSource.Columns.Count; j++)
{
dataRow.CreateCell(j).SetCellValue(dtSource.Rows[i][j].ToString());
}
}
//保存
using (FileStream fs = new FileStream(strFileName, FileMode.Create, FileAccess.Write))
{
workbook.Write(fs);
}
workbook.Dispose();
private void button2_Click(object sender, EventArgs e)
{
HSSFWorkbook workbook = new HSSFWorkbook();
ISheet sheet = workbook.CreateSheet("My Sheet");
ICellStyle style1 = workbook.CreateCellStyle();
style1.FillForegroundColor = NPOI.HSSF.Util.HSSFColor.BLUE.index2;
style1.FillPattern = FillPatternType.SOLID_FOREGROUND;
ICellStyle style2 = workbook.CreateCellStyle();
style2.FillForegroundColor = NPOI.HSSF.Util.HSSFColor.YELLOW.index2;
style2.FillPattern = FillPatternType.SOLID_FOREGROUND;
ICell cell = sheet.CreateRow(0).CreateCell(0);
cell.CellStyle = style1;
cell.SetCellValue(0);
cell = sheet.CreateRow(1).CreateCell(0);
cell.CellStyle = style2;
cell.SetCellValue(1);
cell = sheet.CreateRow(2).CreateCell(0);
cell.CellStyle = style1;
cell.SetCellValue(2);
cell = sheet.CreateRow(3).CreateCell(0);
cell.CellStyle = style2;
cell.SetCellValue(3);
cell = sheet.CreateRow(4).CreateCell(0);
cell.CellStyle = style1;
cell.SetCellValue(4);
string saveFile = FileDialogHelper.SaveExcel("test.xls");
if (!string.IsNullOrEmpty(saveFile))
{
SaveToFile(workbook, saveFile);
if (MessageUtil.ShowYesNoAndTips("保存成功，是否打开文件？") == System.Windows.Forms.DialogResult.Yes)
{
System.Diagnostics.Process.Start(saveFile);
}
}
workbook.CloneSheet(0);
}
private void SaveToFile(HSSFWorkbook workbook, string fileName)
{
using (MemoryStream ms = new MemoryStream())
{
using (FileStream fs = new FileStream(fileName, FileMode.Create, FileAccess.Write))
{
workbook.Write(fs);
}
}
}
private void SaveToWeb(HSSFWorkbook workbook, string fileName)
{
using (MemoryStream ms = new MemoryStream())
{
workbook.Write(ms);
HttpContext curContext = HttpContext.Current;
curContext.Response.AddHeader("Content-Disposition", string.Format("attachment; filename=EmptyWorkbook.xls"));
curContext.Response.BinaryWrite(ms.ToArray());
}
}

附上源码

/// <summary>
/// 利用NPOI类库，实现对Excel进行操作的辅助类
/// </summary>
public class NPOIHelper
{
        /// <summary>
        /// 导出表格数据到Excel文档中
        /// </summary>
        /// <param name="dtSource">表格数据</param>
        /// <param name="strFileName">Excel文件路径</param>
        /// <remarks>NPOI认为Excel的第一个单元格是：(0，0)</remarks>
        public static void ExportEasy(DataTable dtSource, string strFileName)
        {
            HSSFWorkbook workbook = new HSSFWorkbook();
            ISheet sheet = workbook.CreateSheet();

            //填充表头
            IRow dataRow = sheet.CreateRow(0);
            foreach (DataColumn column in dtSource.Columns)
            {
                dataRow.CreateCell(column.Ordinal).SetCellValue(column.ColumnName);
            }
            
            //填充内容
            for (int i = 0; i < dtSource.Rows.Count; i++)
            {
                dataRow = sheet.CreateRow(i + 1);
                for (int j = 0; j < dtSource.Columns.Count; j++)
                {
                    dataRow.CreateCell(j).SetCellValue(dtSource.Rows[i][j].ToString());
                }
            }

            //保存
            using (MemoryStream ms = new MemoryStream())
            {
                using (FileStream fs = new FileStream(strFileName, FileMode.Create, FileAccess.Write))
                {
                    workbook.Write(fs);
                }
            }
        }

        /// <summary>
        /// DataTable导出到Excel文件
        /// </summary>
        /// <param name="dtSource">源DataTable</param>
        /// <param name="strHeaderText">表头文本</param>
        /// <param name="strFileName">保存位置</param>
        public static void Export(DataTable dtSource, string strHeaderText, string strFileName)
        {
            using (MemoryStream ms = Export(dtSource, strHeaderText))
            {
                using (FileStream fs = new FileStream(strFileName, FileMode.Create, FileAccess.Write))
                {
                    byte[] data = ms.ToArray();
                    fs.Write(data, 0, data.Length);
                    fs.Flush();
                }
            }
        }
                 
        /// <summary>
        /// DataTable导出到Excel的MemoryStream
        /// </summary>
        /// <param name="dtSource">源DataTable</param>
        /// <param name="strHeaderText">表头文本</param>
        public static MemoryStream Export(DataTable dtSource, string strHeaderText)
        {
            DocumentSummaryInformation dsi = PropertySetFactory.CreateDocumentSummaryInformation();
            dsi.Company = "";
            
            SummaryInformation si = PropertySetFactory.CreateSummaryInformation();
            si.Author = ""; //填加xls文件作者信息
            si.ApplicationName = ""; //填加xls文件创建程序信息
            si.LastAuthor = ""; //填加xls文件最后保存者信息
            si.Comments = ""; //填加xls文件作者信息
            si.Title = ""; //填加xls文件标题信息
            si.Subject = "";//填加文件主题信息
            si.CreateDateTime = DateTime.Now;

            return Export(dtSource, strHeaderText, dsi, si);
        }

        /// <summary>
        /// DataTable导出到Excel的MemoryStream
        /// </summary>
        /// <param name="dtSource">源DataTable</param>
        /// <param name="strHeaderText">表头文本</param>
        public static MemoryStream Export(DataTable dtSource, string strHeaderText, DocumentSummaryInformation dsi, SummaryInformation si)
        {
            HSSFWorkbook workbook = new HSSFWorkbook();
            ISheet sheet = workbook.CreateSheet();

            if (dsi != null)
            {
                workbook.DocumentSummaryInformation = dsi;
            }
            if (si != null)
            {
                workbook.SummaryInformation = si;
            }

            ICellStyle dateStyle = workbook.CreateCellStyle();
            IDataFormat format = workbook.CreateDataFormat();
            dateStyle.DataFormat = format.GetFormat("yyyy-mm-dd");

            //取得列宽
            int[] arrColWidth = new int[dtSource.Columns.Count];
            foreach (DataColumn item in dtSource.Columns)
            {
                arrColWidth[item.Ordinal] = Encoding.GetEncoding(936).GetBytes(item.ColumnName.ToString()).Length;
            }
            for (int i = 0; i < dtSource.Rows.Count; i++)
            {
                for (int j = 0; j < dtSource.Columns.Count; j++)
                {
                    int intTemp = Encoding.GetEncoding(936).GetBytes(dtSource.Rows[i][j].ToString()).Length;
                    if (intTemp > arrColWidth[j])
                    {
                        arrColWidth[j] = intTemp;
                    }
                }
            }            

            int rowIndex = 0;
            foreach (DataRow row in dtSource.Rows)
            {
                #region 新建表，填充表头，填充列头，样式
                if (rowIndex == 65535 || rowIndex == 0)
                {
                    if (rowIndex != 0)
                    {
                        sheet = workbook.CreateSheet();
                    }

                    #region 表头及样式
                    {
                        IRow headerRow = sheet.CreateRow(0);
                        headerRow.HeightInPoints = 25;
                        headerRow.CreateCell(0).SetCellValue(strHeaderText);

                        ICellStyle headStyle = workbook.CreateCellStyle();
                        headStyle.Alignment = NPOI.SS.UserModel.HorizontalAlignment.CENTER;
                        IFont font = workbook.CreateFont();
                        font.FontHeightInPoints = 20;
                        font.Boldweight = 700;
                        headStyle.SetFont(font);

                        headerRow.GetCell(0).CellStyle = headStyle;

                        sheet.AddMergedRegion(new CellRangeAddress(0, 0, 0, dtSource.Columns.Count - 1));
                    }
                    #endregion

                    #region 列头及样式
                    {
                        IRow headerRow = sheet.CreateRow(1);

                        ICellStyle headStyle = workbook.CreateCellStyle();
                        headStyle.Alignment = NPOI.SS.UserModel.HorizontalAlignment.CENTER;
                        IFont font = workbook.CreateFont();
                        font.FontHeightInPoints = 10;
                        font.Boldweight = 700;
                        headStyle.SetFont(font);
                        
                        foreach (DataColumn column in dtSource.Columns)
                        {
                            headerRow.CreateCell(column.Ordinal).SetCellValue(column.ColumnName);
                            headerRow.GetCell(column.Ordinal).CellStyle = headStyle;

                            //设置列宽
                            sheet.SetColumnWidth(column.Ordinal, (arrColWidth[column.Ordinal] + 1) * 256);
                        }
                    }
                    #endregion

                    rowIndex = 2;
                }
                #endregion

                #region 填充内容
                IRow dataRow = sheet.CreateRow(rowIndex);
                foreach (DataColumn column in dtSource.Columns)
                {
                    ICell newCell = dataRow.CreateCell(column.Ordinal);                    
                    string drValue = row[column].ToString();
                    switch (column.DataType.ToString())
                    {
                        case "System.String"://字符串类型
                            newCell.SetCellValue(drValue);
                            break;
                        case "System.DateTime"://日期类型
                            DateTime dateV;
                            DateTime.TryParse(drValue, out dateV);
                            newCell.SetCellValue(dateV);

                            newCell.CellStyle = dateStyle;//格式化显示
                            break;
                        case "System.Boolean"://布尔型
                            bool boolV = false;
                            bool.TryParse(drValue, out boolV);
                            newCell.SetCellValue(boolV);
                            break;
                        case "System.Int16"://整型
                        case "System.Int32":
                        case "System.Int64":
                        case "System.Byte":
                            int intV = 0;
                            int.TryParse(drValue, out intV);
                            newCell.SetCellValue(intV);
                            break;
                        case "System.Decimal"://浮点型
                        case "System.Double":
                            double doubV = 0;
                            double.TryParse(drValue, out doubV);
                            newCell.SetCellValue(doubV);
                            break;
                        case "System.DBNull"://空值处理
                            newCell.SetCellValue("");
                            break;
                        default:
                            newCell.SetCellValue("");
                            break;
                    }
                }
                #endregion

                rowIndex++;
            }

            using (MemoryStream ms = new MemoryStream())
            {
                workbook.Write(ms);
                ms.Flush();
                ms.Position = 0;

                //workbook.Dispose();//一般只用写这一个就OK了，他会遍历并释放所有资源，但当前版本有问题所以只释放sheet
                return ms;
            }
        }

        /// <summary>
        /// 用于Web导出Excel
        /// </summary>
        /// <param name="dtSource">源DataTable</param>
        /// <param name="strHeaderText">表头文本</param>
        /// <param name="strFileName">文件名</param>
        public static void ExportByWeb(DataTable dtSource, string strHeaderText, string strFileName)
        {
            HttpContext curContext = HttpContext.Current;

            // 设置编码和附件格式
            curContext.Response.ContentType = "application/vnd.ms-excel";
            curContext.Response.ContentEncoding = Encoding.UTF8;
            curContext.Response.Charset = "";
            curContext.Response.AppendHeader("Content-Disposition",
                "attachment;filename=" + HttpUtility.UrlEncode(strFileName, Encoding.UTF8));

            curContext.Response.BinaryWrite(Export(dtSource, strHeaderText).GetBuffer());
            curContext.Response.End();
        }


        /// <summary>
        /// 读取excel
        /// 默认第一行为标头
        /// </summary>
        /// <param name="strFileName">excel文档路径</param>
        /// <returns></returns>
        public static DataTable Import(string strFileName)
        {
            DataTable dt = new DataTable();
            HSSFWorkbook hssfworkbook;
            using (FileStream file = new FileStream(strFileName, FileMode.Open, FileAccess.Read))
            {
                hssfworkbook = new HSSFWorkbook(file);
            }
            ISheet sheet = hssfworkbook.GetSheetAt(0);
            System.Collections.IEnumerator rows = sheet.GetRowEnumerator();

            IRow headerRow = sheet.GetRow(0);
            int cellCount = headerRow.LastCellNum;

            for (int j = 0; j < cellCount; j++)
            {
                ICell cell = headerRow.GetCell(j);
                dt.Columns.Add(cell.ToString());
            }

            for (int i = (sheet.FirstRowNum + 1); i <= sheet.LastRowNum; i++)
            {
                IRow row = sheet.GetRow(i);
                DataRow dataRow = dt.NewRow();

                for (int j = row.FirstCellNum; j < cellCount; j++)
                {
                    if (row.GetCell(j) != null)
                        dataRow[j] = row.GetCell(j).ToString();
                }

                dt.Rows.Add(dataRow);
            }
            return dt;
        }
}

开源NPOI控件的封装辅助类NPOIHelper
引言在实际开发过程中，会遇到各种导出数据的情况，导出Excel是软件中很常用的功能，如果使用微软自带的类库来实现...
文件或者文件夹压缩辅助类ZipUtility
实现效果本辅助类主要是用来方便实现文件（包括文件夹）压缩的辅助操作。本类库使用了第三方开源控件ICSharpC...
推荐一个有用的Excel操作类库 LinqToExcel
GitHub: LinqToExcel 以前项目中对Excel进行信息读取，我都是使用的NPOI的封装类，给定一个...
android6.0以上获取权限简单封装
权限辅助类，无需反射，简单封装在Base中封装使用继承BasePermissionActivity，调用re...
『与善仁』Appium基础 — 35.APP模拟手势高级操作（一
APP模拟手势的动作都被封装在TouchAction类中，TouchAction是AppiumDriver的辅助类...
UIBarItem
UIBarItem 父类是NSObject UIBarItem常用属性模型与控件按照封装的思路，一般将所有控件...
UI-Xib
Xib的加载方法1 方法2 自定义控件view的步骤新建自定义控件类修改xib中view的类名封装xib的...
SYUIInitialize初始化UI集成方法
SYUIInitialize关于UI控件初始化方法集成封装类。代码示例注意：SYUIInitMethod类是M...
React Native 一个开始
React Native是Facebook开源的一个移动端开发框架。Facebook用js封装了大量的原生控件，让...
商品详情和购物车数量控件封装(造轮子QuantityView）
使用效果如下：在商城类软件中，�数量控件可以说是必备控件之一，网上开源的数量控件也有很多，但是还是想通过自己实现...