NCF 如何导入Excel数据

简介

学了上一节的WebApi之后，我们会发现一片新天地

本节跟大家聊一聊，如何把本地的Excel数据导入到NCF中

仓库地址：https://github.com/NeuCharFramework/NCF

欢迎收藏，欢迎Star哦

步骤

1.首先在页面上需要增加可以操作导入的按钮

2.在页面上增加点击导入按钮后需要弹出的窗口

3.在窗口中增加下载导入数据的模板

4.在窗口中增加点击上传的数据的文件进行上传

5.在js中增加对应的窗口中需要处理的方法

6.引入NPOI

7.建立ExcelHelper类用来读取Excel文件内容

8.在api中增加上传数据文件的接收方法

9.在Service中处理上传的文件的数据

实施

1.首先在页面上需要增加可以操作导入的按钮

<el-button class="filter-item" size="mini" type="primary" @@click="handleEdit('','','import')">导入</el-button>

2.在页面上增加点击导入按钮后需要弹出的窗口

@*导入*@
<el-dialog :title="dialogImport.title"
            :visible.sync="dialogImport.visible"
            :close-on-click-modal="false"
            width="700px">
    
    <el-form ref="dataFormImport"
                :rules="dialogImport.rules"
                :model="dialogImport.data"
                :disabled="dialogImport.disabled"
                label-position="left"
                label-width="100px"
                style="max- 200px; margin-left:50px;">
        <el-button @@click="downloadTemplate">下载导入模板</el-button>
        <el-form-item label="导入的文件">
            <el-upload class="upload-demo"
                        action="@Model.UpFileUrl"
                        accept=".xls,.xlsx"
                        :on-success="uploadSuccess"
                        :on-preview="handlePreview"
                        :on-remove="handleRemove"
                        :before-remove="beforeRemove"
                        multiple
                        :limit="3"
                        :on-exceed="handleExceed"
                        :file-list="fileList"
                        ref="my-upload">
                <el-button size="small" type="primary">点击上传</el-button>
                <div slot="tip" class="el-upload__tip">只能上传excel文件</div>
            </el-upload>
            <el-input class="hidden" v-model="dialogImport.data.file" clearable placeholder="文件" />
        </el-form-item>
    </el-form>
    <div slot="footer" class="dialog-footer">
        <el-button @@click="dialogImport.visible=false">取消</el-button>
        <el-button :loading="dialogImport.updateLoading" :disabled="dialogImport.disabled" type="primary" @@click="dialogImport.visible=false">确认</el-button>
    </div>
</el-dialog>

js中的代码

dialogImport:
{
    title: '导入数据',
    visible: false,
    data:
    {
        file: ''
    },
    updateLoading: false,
    disabled: false,
    checkStrictly: true // 是否严格的遵守父子节点不互相关联
}

3.在窗口中增加下载导入数据的模板

这里可以本地编辑一个Excel的文件，字段可以根据自己实际的随便写

4.在窗口中增加点击上传的数据的文件进行上传

el-upload控件则是用来上传文件的

5.在js中增加对应的窗口中需要处理的方法

downloadTemplate() {
    window.open("https://aaa.oss-cn-beijing.aliyuncs.com/ImportData.xls", '_blank')
}

6.引入NPOI

<PackageReference Include="NPOI" Version="2.5.3" />

7.建立ExcelHelper类用来读取Excel文件内容

using NPOI.SS.UserModel;
using System;
using System.Collections.Generic;
using System.Data;
using System.IO;
using System.Text;

namespace Senparc.Xncf.Admin.Utils
{
    public class ExcelHeler
    {
        /// <summary>
        /// 读取Excel多Sheet数据
        /// </summary>
        /// <param name="filePath">文件路径</param>
        /// <param name="sheetName">Sheet名</param>
        /// <returns></returns>
        public static DataSet ReadExcelToDataSet(string filePath, string sheetName = null)
        {
            if (!File.Exists(filePath))
            {
                //logger.LogError($"未找到文件{filePath}");
                return null;
            }
            //获取文件信息
            FileStream fs = new FileStream(filePath, FileMode.Open, FileAccess.Read);
            IWorkbook workbook = WorkbookFactory.Create(fs);
            //获取sheet信息
            ISheet sheet = null;
            DataSet ds = new DataSet();
            if (!string.IsNullOrEmpty(sheetName))
            {
                sheet = workbook.GetSheet(sheetName);
                if (sheet == null)
                {
                    //logger.LogError($"{filePath}未找到sheet:{sheetName}");
                    return null;
                }
                DataTable dt = ReadExcelFunc(workbook, sheet);
                ds.Tables.Add(dt);
            }
            else
            {
                //遍历获取所有数据
                int sheetCount = workbook.NumberOfSheets;
                for (int i = 0; i < sheetCount; i++)
                {
                    sheet = workbook.GetSheetAt(i);
                    if (sheet != null)
                    {
                        DataTable dt = ReadExcelFunc(workbook, sheet);
                        if (dt != null) ds.Tables.Add(dt);
                    }
                }
            }
            return ds;
        }

        /// <summary>
        /// 读取Excel多Sheet数据
        /// </summary>
        /// <param name="filePath">文件路径</param>
        /// <param name="sheetName">Sheet名</param>
        /// <returns></returns>
        public static DataSet ReadExcelToDataSet(FileStream fs, string sheetName = null)
        {
            IWorkbook workbook = WorkbookFactory.Create(fs);
            //获取sheet信息
            ISheet sheet = null;
            DataSet ds = new DataSet();
            if (!string.IsNullOrEmpty(sheetName))
            {
                sheet = workbook.GetSheet(sheetName);
                if (sheet == null)
                {
                    //logger.LogError($"{filePath}未找到sheet:{sheetName}");
                    return null;
                }
                DataTable dt = ReadExcelFunc(workbook, sheet);
                ds.Tables.Add(dt);
            }
            else
            {
                //遍历获取所有数据
                int sheetCount = workbook.NumberOfSheets;
                for (int i = 0; i < sheetCount; i++)
                {
                    sheet = workbook.GetSheetAt(i);
                    if (sheet != null)
                    {
                        DataTable dt = ReadExcelFunc(workbook, sheet);
                        if (dt != null)
                            ds.Tables.Add(dt);
                    }
                }
            }
            return ds;
        }

        /// <summary>
        /// 读取Excel信息
        /// </summary>
        /// <param name="workbook">工作区</param>
        /// <param name="sheet">sheet</param>
        /// <returns></returns>
        private static DataTable ReadExcelFunc(IWorkbook workbook, ISheet sheet)
        {
            DataTable dt = new DataTable();
            //获取列信息
            IRow cells = sheet.GetRow(sheet.FirstRowNum);
            //空数据化返回
            if (cells == null) return null;
            int cellsCount = cells.PhysicalNumberOfCells;
            //空列返回
            if (cellsCount == 0) return null;
            int emptyCount = 0;
            int cellIndex = sheet.FirstRowNum;
            List<string> listColumns = new List<string>();
            bool isFindColumn = false;
            while (!isFindColumn)
            {
                emptyCount = 0;
                listColumns.Clear();
                for (int i = 0; i < cellsCount; i++)
                {
                    if (string.IsNullOrEmpty(cells.GetCell(i).StringCellValue))
                    {
                        emptyCount++;
                    }
                    listColumns.Add(cells.GetCell(i).StringCellValue);
                }
                //这里根据逻辑需要，空列超过多少判断
                if (emptyCount == 0)
                {
                    isFindColumn = true;
                }
                cellIndex++;
                cells = sheet.GetRow(cellIndex);
            }

            foreach (string columnName in listColumns)
            {
                if (dt.Columns.Contains(columnName))
                {
                    //如果允许有重复列名，自己做处理
                    continue;
                }
                dt.Columns.Add(columnName, typeof(string));
            }
            //开始获取数据
            int rowsCount = sheet.PhysicalNumberOfRows;
            var rowIndex = 1;
            DataRow dr = null;
            //空数据化返回
            if (rowsCount <= 1) { return null; }
            for (int i = rowIndex; i < rowsCount; i++)
            {
                cells = sheet.GetRow(i);
                dr = dt.NewRow();
                for (int j = 0; j < dt.Columns.Count; j++)
                {
                    //这里可以判断数据类型
                    switch (cells.GetCell(j).CellType)
                    {
                        case CellType.String:
                            dr[j] = cells.GetCell(j).StringCellValue;
                            break;
                        case CellType.Numeric:
                            dr[j] = cells.GetCell(j).NumericCellValue.ToString();
                            break;
                        case CellType.Unknown:
                            dr[j] = cells.GetCell(j).StringCellValue;
                            break;
                    }
                }
                dt.Rows.Add(dr);
            }
            return dt;
        }
    }
}

8.在api中增加上传数据文件的接收方法

/// <summary>
/// 上传数据
/// </summary>
/// <param name="file">文件信息</param>
/// <returns></returns>
[HttpPost]
public IActionResult ImportExcelData([FromForm] IFormFile file)
{
    string prefixPath = string.Empty;
    try
    {
        var file_data = this.Request.Form.Files[0];
        if (file_data == null)
        {
            return Fail("文件参数无效，请提供name值为file_data的文件");
        }
        //验证文件扩展名
        var extension = Path.GetExtension(file_data.FileName);
        if (!AllowFileExtension.FileExtension.Contains(extension))
        {
            return Fail("不支持此扩展名文件的上传！");
        }
        //基础存储路径
        var basePath = "default"; // sysKeyModel.Name;
        //验证文件前缀路径有效性
        if (!string.IsNullOrWhiteSpace(prefixPath))
        {
            if (prefixPath.IndexOfAny(Path.GetInvalidPathChars()) > -1)//验证路径有效性
            {
                return Fail("无效路径！");
            }
            //进一步规范路径
            var invalidPattern = new Regex(@"[\/:*?42<>|]");
            prefixPath = invalidPattern.Replace(prefixPath, "");

            prefixPath = prefixPath.Replace("_", "\");//使用下划线“_”代替斜杠“”
            basePath = Path.Combine(basePath, prefixPath);
        }
        //物理文件路径
        var pathMp = Path.Combine(_webHostEnvironment.ContentRootPath, staticResourceSetting.CurrentValue.RootDir, basePath);
        if (!Directory.Exists(pathMp)) Directory.CreateDirectory(pathMp);

        string strFileName = file_data.FileName.Split('\').LastOrDefault();

        var filename = $"{DateTime.Now:yyyyMMddHHmmss}-{UniqueHelper.LongId()}{extension}";
        string strFileHash = string.Empty;
        string strFilePath = string.Empty;
        using (var fs = new FileStream(Path.Combine(pathMp, filename), FileMode.CreateNew))
        {
            file_data.CopyTo(fs);
            strFileHash = HashHelper.SHA1File(fs);//赋值文件Hash值
            fs.Flush();
        }
        //开始解析Excel
        //调用ExcelHelper方法
        DataSet ds = ExcelHeler.ReadExcelToDataSet(Path.Combine(pathMp, filename));
        SenparcTrace.Log($"{pathMp}----{filename}");
        dataService.ImportDataAsync(ds);
        return Success("导入成功");
    }
    catch (Exception ex)
    {
        return Fail(ex.Message);
    }
}

9.在Service中处理上传的文件的数据

public void ImportDataAsync(DataSet ds)
{
    if (ds != null)
    {
        DataTable dt = ds.Tables[0];
        if (dt.Rows.Count > 0)
        {
            List<DataEntity> lstData = new List<DataEntity>();
            for (int i = 0; i < dt.Rows.Count; i++)
            {
                int iRows = GetCount(_ => _.Name.Equals(dt.Rows[i][0].ToString()));
                if (iRows > 0)
                {
                    continue;
                }
                DataEntity dataItem = new DataEntity()
                {
                    Name = dt.Rows[i][0].ToString()
                };
                lstData.Add(dataItem);
            }
            SaveObjectListAsync(lstData);
        }
    }
}

有疑问随时欢迎交流