分享一个 ASP.NET Web Api 上传和读取 Excel的方案

简介: 分享一个 ASP.NET Web Api 上传和读取 Excel的方案

许多业务场景下需要处理和分析大量的数据,而 Excel 是业务人员常用的数据表格工具,因此,将 Excel 表格中内容上传并读取到网站,是一个很常见的功能,目前有许多成熟的开源或者商业的第三方库,比如 NPOI,EPPlus,Spire.Office for .NET 等等,今天分享一个使用 Magicodes.IE.Excel 上传和读取 Excel的方案,这是近年来一个比较受欢迎的开源的第三方库,下面我们用一个 Step By Step 例子来感受它的魅力。

  1. 安装 nuget 包

Magicodes.IE.Excel

Magicodes.IE.Core

2.创建一个 DTO 类

using Magicodes.ExporterAndImporter.Core;
namespace ExcelSample.BusinessEntities.Dtos
{
  public partial class ImportDto
  {
    /// <summary>
    /// ID
    /// </summary>
    [ImporterHeader(Name ="ID")]
    public string ItemGuid { get; set; }
    
    /// <summary>
    /// 巡检编号
    /// </summary>
    [ImporterHeader(Name = "巡检编号")]
    public string InspectionNumber { get; set; }
    
    /// <summary>
    /// 详细地址
    /// </summary>
    [ImporterHeader(Name = "详细位置")]
    public string FormattedAddress { get; set; }
    
    /// <summary>
    /// 开始日期
    /// </summary>
    [ImporterHeader(Name = "开始日期")]
    public string BeginDate { get; set; }
    
    /// <summary>
    /// 截止日期
    /// </summary>
    [ImporterHeader(Name = "结束日期")]
    public string EndDate { get; set; }
    
    /// <summary>
    /// 故障描述
    /// </summary>
    [ImporterHeader(Name = "故障描述")]
    public string FaultInfo { get; set; }
    
    /// <summary>
    /// 单位名称
    /// </summary>
    [ImporterHeader(Name = "单位")]
    public string CustomerName { get; set; }
    
    /// <summary>
    /// 维修说明
    /// </summary>
    [ImporterHeader(Name = "维修说明")]
    public string HandleMeasuresOther { get; set; }
  }
}

3.写公共读取 Export 文件内容方法

using Magicodes.ExporterAndImporter.Core;
using Magicodes.ExporterAndImporter.Core.Extension;
using Magicodes.ExporterAndImporter.Core.Models;
using Magicodes.ExporterAndImporter.Excel;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
namespace ExcelSample.Common
{
  /// <summary>
  /// excel 工具类
  /// </summary>
  public static class ExportHelper
  {
    /// <summary>
    /// 通用导入 excel 文件
    /// </summary>
    /// <param name="filePath">Excel 文件路径</param>
    public static async Task<ImportResult<T>> ImportExcel<T>(string filePath) where T : class, new()
    {
      IImporter importer = new ExcelImporter();
      var result = await importer.Import<T>(filePath);
      return result;
    }
  }
}

4.写上传 Excel 文件的业务方法

public string UploadFile()
{
  HttpFileCollection files = HttpContext.Current.Request.Files;
  if (files == null || files.Count == 0)
  {
    throw new Exception("没有上传文件");
  }
  
  HttpPostedFile file = files[0];
  string fileExt = Path.GetExtension(file.FileName);
  if (fileExt != ".xlsx" && fileExt != ".xls")
  {
    throw new Exception("不是Excel文件");
  }
  
  string dir = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "ExcelImport");
  if (!Directory.Exists(dir))
  {
    Directory.CreateDirectory(dir);
  }
  
  string fileName = Path.GetFileNameWithoutExtension(file.FileName);
  string fileSaveName = string.Format("{0}{1}.xlsx", fileName, DateTime.Now.ToFlowWaterDate()); 
  string fileSavePath = Path.Combine(dir, fileSaveName);
  _logger.Value.Info($"上传文件:[{fileSavePath}]");
  file.SaveAs(fileSavePath);
  return fileSavePath;
}

5.写具体的读取 Excel 文件内容的业务方法

public List<ImportDto> ReadExcel(string filePath)
{
  var importData = ExportHelper.ImportExcel<ImportDto>(filePath).Result;
  var list = importData.Data.ToList();
  if (list.HasData())
  {
    return list;
  }
  return null;
}

6.在控制器中写 API 向外提供上传和读取 Excel 的接口

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Text;
using System.Threading.Tasks;
using System.Web.Http;
using ExcelSample.Contracts.IService;
using ExcelSample.BusinessEntities.Dtos;
namespace ExcelSample.WebAPI.Controllers.V1
{
  [Authorize]
  [RoutePrefix("api/v1/excelSample")]
  public partial class ExcelSampleController : BaseController
  {
    // ......
    
    [HttpPost]
    [Route("uploadExcel")]
    public IHttpActionResult UploadExcel()
    {
      // 1. 上传文件
      string fileUpload = "";
      try
      {
        fileUpload = UploadFile();
      }
      catch (Exception ex)
      {
        _log.Value.Error(ex, "上传文件失败!");
        return BadRequest(ex.Message);
      }
      // 2. 读取数据
      var list = ReadExcel(fileUpload);
      if (list== null || list.Count == 0)
      {
        return BadRequest("文件没有数据或者数据格式不正确!");
      }
      // 3. 更新数据
      // 存储数据到数据库中
      
      return Ok(Success(result));
    }
    
    // ......
  }
}

7.运行项目并在 Postman 中进行测试


相关文章
|
2月前
|
编解码 前端开发 JavaScript
.NET_web前端框架_layui_栅格布局
【8月更文挑战第27天】
37 4
|
4天前
|
开发框架 监控 前端开发
在 ASP.NET Core Web API 中使用操作筛选器统一处理通用操作
【9月更文挑战第27天】操作筛选器是ASP.NET Core MVC和Web API中的一种过滤器,可在操作方法执行前后运行代码,适用于日志记录、性能监控和验证等场景。通过实现`IActionFilter`接口的`OnActionExecuting`和`OnActionExecuted`方法,可以统一处理日志、验证及异常。创建并注册自定义筛选器类,能提升代码的可维护性和复用性。
|
4天前
|
开发框架 .NET 中间件
ASP.NET Core Web 开发浅谈
本文介绍ASP.NET Core,一个轻量级、开源的跨平台框架,专为构建高性能Web应用设计。通过简单步骤,你将学会创建首个Web应用。文章还深入探讨了路由配置、依赖注入及安全性配置等常见问题,并提供了实用示例代码以助于理解与避免错误,帮助开发者更好地掌握ASP.NET Core的核心概念。
16 3
|
9天前
|
开发框架 前端开发 .NET
VB.NET中如何利用ASP.NET进行Web开发
在VB.NET中利用ASP.NET进行Web开发是一个常见的做法,特别是在需要构建动态、交互式Web应用程序时。ASP.NET是一个由微软开发的开源Web应用程序框架,它允许开发者使用多种编程语言(包括VB.NET)来创建Web应用程序。
35 5
|
2月前
|
开发框架 监控 .NET
开发者的革新利器:ASP.NET Core实战指南,构建未来Web应用的高效之道
【8月更文挑战第28天】本文探讨了如何利用ASP.NET Core构建高效、可扩展的Web应用。ASP.NET Core是一个开源、跨平台的框架,具有依赖注入、配置管理等特性。文章详细介绍了项目结构规划、依赖注入配置、中间件使用及性能优化方法,并讨论了安全性、可扩展性以及容器化的重要性。通过这些技术要点,开发者能够快速构建出符合现代Web应用需求的应用程序。
35 0
|
2月前
|
关系型数据库 MySQL Shell
不通过navicat工具怎么把查询数据导出到excel表中
不通过navicat工具怎么把查询数据导出到excel表中
32 0
|
24天前
|
数据采集 存储 数据挖掘
使用Python读取Excel数据
本文介绍了如何使用Python的`pandas`库读取和操作Excel文件。首先,需要安装`pandas`和`openpyxl`库。接着,通过`read_excel`函数读取Excel数据,并展示了读取特定工作表、查看数据以及计算平均值等操作。此外,还介绍了选择特定列、筛选数据和数据清洗等常用操作。`pandas`是一个强大且易用的工具,适用于日常数据处理工作。
|
2月前
|
SQL JSON 关系型数据库
n种方式教你用python读写excel等数据文件
n种方式教你用python读写excel等数据文件
|
2月前
|
存储 Java Apache
|
2月前
|
数据可视化 Python
我是如何把python获取到的数据写入Excel的?
我是如何把python获取到的数据写入Excel的?
39 2
下一篇
无影云桌面