【5.ABP框架+NPOI实现Excel导入功能】

5.ABP框架+NPOI实现Excel导入功能

---

---

背景

每个项目都会有Excel导入到表格的功能需求，本次项目也不例外，这个项目采用了NPOI的第三方组件来实现Excel导入功能。具体实现过程如下：

---

一、创建NpoiExcelImportHelper类，封装了Npoi的相关方法

  public class NpoiExcelImportHelper
    {
        private static NpoiExcelImportHelper _excelImportHelper;

        public static NpoiExcelImportHelper _
        {
            get => _excelImportHelper ?? (_excelImportHelper = new NpoiExcelImportHelper());
            set => _excelImportHelper = value;
        }

        /// <summary>
        /// 读取excel表格中的数据,将Excel文件流转化为dataTable数据源.
        /// 默认第一行为标题 .
        /// </summary>
        /// <param name="stream">excel文档文件流.</param>
        /// <param name="fileType">文档格式.</param>
        /// <param name="isSuccess">是否转化成功.</param>
        /// <param name="resultMsg">转换结果消息.</param>
        /// <returns>DataTable.</returns>
        public DataTable ExcelToDataTable(Stream stream, string fileType, out bool isSuccess, out string resultMsg)
        {
            isSuccess = false;
            resultMsg = "Excel文件流成功转化为DataTable数据源";
            var excelToDataTable = new DataTable();
            try
            {
                // Workbook对象代表一个工作簿,首先定义一个Excel工作薄
                IWorkbook workbook;

                // XSSFWorkbook 适用XLSX格式，HSSFWorkbook 适用XLS格式
                #region 判断Excel版本
                switch (fileType)
                {
                    // .XLSX是07版(或者07以上的)的Office Excel
                    case ".xlsx":
                        workbook = new XSSFWorkbook(stream);
                        break;

                    // .XLS是03版的Office Excel
                    case ".xls":
                        workbook = new HSSFWorkbook(stream);
                        break;
                    default:
                        throw new Exception("Excel文档格式有误");
                }
                #endregion

                var sheet = workbook.GetSheetAt(0);
                var rows = sheet.GetRowEnumerator();

                var headerRow = sheet.GetRow(0);
                int cellCount = headerRow.LastCellNum; // 最后一行列数（即为总列数）

                // 获取第一行标题列数据源,转换为dataTable数据源的表格标题名称
                for (var j = 0; j < cellCount; j++)
                {
                    var cell = headerRow.GetCell(j);
                    if (cell != null)
                    {
                        excelToDataTable.Columns.Add(cell.ToString());

                    }
                    else {
                        excelToDataTable.Columns.Add("");
                    }
                }

                // 获取Excel表格中除标题以为的所有数据源，转化为dataTable中的表格数据源
                for (var i = sheet.FirstRowNum + 1; i <= sheet.LastRowNum; i++)
                {
                    var dataRow = excelToDataTable.NewRow();
                    var row = sheet.GetRow(i);
                    if (row == null)
                    {
                        continue;  // 没有数据的行默认是null
                    }

                    for (int j = row.FirstCellNum; j < cellCount; j++)
                    {
                        if (row.GetCell(j) != null) // 单元格内容非空验证
                        {
                            #region NPOI获取Excel单元格中不同类型的数据
                            // 获取指定的单元格信息
                            var cell = row.GetCell(j);
                            switch (cell.CellType)
                            {
                                // 首先在NPOI中数字和日期都属于Numeric类型
                                // 通过NPOI中自带的DateUtil.IsCellDateFormatted判断是否为时间日期类型
                                case CellType.Numeric when DateUtil.IsCellDateFormatted(cell):
                                    dataRow[j] = cell.DateCellValue;
                                    break;
                                case CellType.Numeric:

                                    // 其他数字类型
                                    dataRow[j] = cell.NumericCellValue;
                                    break;

                                // 空数据类型
                                case CellType.Blank:
                                    dataRow[j] = string.Empty;
                                    break;

                                // 公式类型
                                case CellType.Formula:
                                    {
                                        HSSFFormulaEvaluator eva = new HSSFFormulaEvaluator(workbook);
                                        dataRow[j] = eva.Evaluate(cell).StringValue;
                                        break;
                                    }

                                // 布尔类型
                                case CellType.Boolean:
                                    dataRow[j] = row.GetCell(j).BooleanCellValue;
                                    break;

                                // 错误
                                case CellType.Error:
                                    dataRow[j] = "数据获取错误";
                                    break;

                                // 其他类型都按字符串类型来处理（未知类型CellType.Unknown，字符串类型CellType.String）
                                default:
                                    dataRow[j] = cell.StringCellValue;
                                    break;
                            }
                            #endregion
                        }
                    }

                    excelToDataTable.Rows.Add(dataRow);
                }

                isSuccess = true;
            }
            catch (Exception e)
            {
                resultMsg = e.Message;
            }

            return excelToDataTable;
        }
    }

二、服务端方法调用和接收前端传过来的文件流.

.NetCore为了方便接收文件类型参数,专门有一个数据类型为IFormFile,可以直接获得前端传送过来的文件form类型的数据.具体的代码如下:

     /// <summary>
        /// DataImport.
        /// </summary>
        /// <param name="file">file.</param>
        /// <returns>CommonResultDto.</returns>
        [UnitOfWork]
        public async Task<CommonResultDto> DataImport(IFormFile file)
        {
            CommonResultDto resultDto = new CommonResultDto();
            if (file == null)
            {
                resultDto.Success = false;
                resultDto.Message = this.L("No files uploaded");
                return resultDto;
            }

            var stopWatch = new Stopwatch(); // 时间计量

            stopWatch.Start();
            bool isSuccess = false;
            string resultMsg = string.Empty;

            // 将excel表格中的数据转化为dataTable数据
            var getDataTable = NpoiExcelImportHelper._.ExcelToDataTable(file.OpenReadStream(), Path.GetExtension(file.FileName), out isSuccess, out resultMsg);

            // 执行是否成功，成功的话，然后去遍历转化然后再执行判断，通过后插入到数据库
            if (isSuccess == true)
            {
                var TableToListResult = this.DateTableToList(getDataTable); // 把table转List
                if (TableToListResult.Success == true)
                {
                    foreach (var item in TableToListResult.BaseGoodsBrandBuList)
                    {
                        await this._baseGoodsBrandBuRepository.InsertAsync(item);
                    }
                }

                resultDto.Success = TableToListResult.Success;
                resultDto.Message = TableToListResult.Message; // 成功
            }

            return resultDto;
        }

三、前端传参和调用

const dataImport = async (jsonData: any) => {
  const json = jsonData.data;
  const res = await ajax.post('/api/services/app/BaseGoodsBrandBu/DataImport', json);

  return res;
};

  var files = this.fileob;
    var formData = new FormData(); //创建FormData对象，以键值对的方式拼接form表单数据（multipart/form-data，图片媒体文件）
    //拼接图片文件流信息
    //var fileslist = this.$refs.upload.fileList;
    //var files = fileslist[0];
    if (files == null || files.length == 0) {
      this.$Modal.error({
        title: this.L('Error'),
        content: this.L('No files uploaded')
      });
      return;
    }

    formData.append('file', files[0]);
    await this.$store.dispatch({
      type: 'basegoodsbrandbu/improtExcel',
      data: {
        file: formData
      }
    });

这边上传控件用的是IView的上传组件

        <Upload :before-upload="handleBeforeUpload" type="drag" ref="upload" action="">
          <div style="padding: 20px 0" v-if="fileob == null">
            <Icon type="ios-cloud-upload" size="52" style="color: #3399ff"></Icon>
            <p>this.L("Click or drag the file here to upload")</p>
          </div>
          <div style="padding: 20px 0" v-if="fileob != null">
            <Icon custom="iconfont icon-excel" size="48" style="color: #3399ff"></Icon>
            <p>{{fileob.name}}</p>
          </div>
        </Upload>

功能完成，结束