C# 开发应用篇——C# 基于WPF实现数据记录导出excel详解

目录

引言        

一、基于 EPPlus 库实现WPF导出EXCEL功能

项目准备

创建 WPF 界面

后端代码

EPPlus  LicenseContext 属性设置

关键点说明

二、基于 ClosedXML 库实现WPF导出EXCEL功能

安装 ClosedXML

使用 ClosedXML 创建和操作 Excel 文件

读取 Excel 文件

常见操作

注意事项

三、 ClosedXML 与 EPPlus使用场景和优缺点对比

ClosedXML

EPPlus​​​​​​​

适用场景

总结

引言        

        实现基于C#的WPF应用程序导出数据到 Excel 的功能，可以使用一个流行的库，比如 EPPlus 或 ClosedXML。这些库可以将 DataTable 数据导出为 Excel 文件，并提供简单易用的 API。 下面是使用 EPPlus 库实现导出功能的示例实现过程介绍。

       为了更详细说明实现过程，在 C# WPF 应用程序中，我们可以创建一个学生成绩查询系统，该系统从数据库中提取数据，在界面上显示，并允许用户将数据导出为 Excel 文件。我们将使用 DataGrid 显示数据，并使用 EPPlus 库和ClosedXML库实现导出功能。以下是实现该功能的详细步骤。

一、基于 EPPlus 库实现WPF导出EXCEL功能

项目准备

步骤 1：设置数据库

假设我们使用 SQLite 数据库，其中有一个名为 StudentScores 的表。该表具有以下结构：

步骤 2：安装 NuGet 包

在项目中安装以下 NuGet 包：

• System.Data.SQLite：用于连接 SQLite 数据库。（根据实际应用中选择数据库，本文仅以 SQLite 数据库为例）
• EPPlus：用于导出数据到 Excel。

Install-Package System.Data.SQLite
Install-Package EPPlus

创建 WPF 界面

在 XAML 文件中，创建一个简单的界面，包括一个 DataGrid 和一个导出按钮。

<Window x:Class="StudentScoreApp.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="学生成绩查询" Height="400" Width="600">
    <Grid>
        <DataGrid x:Name="scoreDataGrid" AutoGenerateColumns="True" HeadersVisibility="Column" IsReadOnly="True" 
                  Margin="10,10,10,50" />
        <Button Content="导出" Width="100" Height="30" VerticalAlignment="Bottom" HorizontalAlignment="Right" Margin="10" Click="ExportScore_Click"/>
    </Grid>
</Window>

后端代码

步骤 1：从数据库加载数据

在代码后面，编写从数据库加载数据的方法。

using System;
using System.Data;
using System.Data.SQLite;
using System.Windows;

namespace StudentScoreApp
{
    public partial class MainWindow : Window
    {
        private DataTable _scoreTable;

        public MainWindow()
        {
            InitializeComponent();
            LoadData();
        }

        private void LoadData()
        {
            string connectionString = "Data Source=StudentScores.db;Version=3;";
            using (SQLiteConnection connection = new SQLiteConnection(connectionString))
            {
                connection.Open();
                string query = "SELECT StudentID, Name, Subject, Score FROM StudentScores";
                SQLiteDataAdapter adapter = new SQLiteDataAdapter(query, connection);
                _scoreTable = new DataTable();
                adapter.Fill(_scoreTable);
                scoreDataGrid.ItemsSource = _scoreTable.DefaultView;
            }
        }
    }
}

步骤 2：导出数据到 Excel

实现 ExportScore_Click 方法，用于将数据导出到 Excel 文件。

using OfficeOpenXml;
using Microsoft.Win32;
using System.IO;

namespace StudentScoreApp
{
    public partial class MainWindow : Window
    {
        // 其他代码...

        private void ExportScore_Click(object sender, RoutedEventArgs e)
        {
            if (_scoreTable == null || _scoreTable.Rows.Count == 0)
            {
                MessageBox.Show("没有数据可导出。");
                return;
            }

            SaveFileDialog saveFileDialog = new SaveFileDialog
            {
                Filter = "Excel Files|*.xlsx",
                Title = "保存为 Excel 文件",
                FileName = "StudentScores.xlsx"
            };

            if (saveFileDialog.ShowDialog() == true)
            {
                try
                {
                    using (ExcelPackage package = new ExcelPackage())
                    {
                        ExcelWorksheet worksheet = package.Workbook.Worksheets.Add("Scores");

                        // 将 DataTable 写入 Excel
                        worksheet.Cells["A1"].LoadFromDataTable(_scoreTable, true);

                        // 保存到文件
                        FileInfo fileInfo = new FileInfo(saveFileDialog.FileName);
                        package.SaveAs(fileInfo);

                        MessageBox.Show("成绩已成功导出到 Excel 文件。");
                    }
                }
                catch (Exception ex)
                {
                    MessageBox.Show("导出时发生错误: " + ex.Message);
                }
            }
        }
    }
}

EPPlus  LicenseContext 属性设置

        由于EPPlus 5.0 及以上版本引入了一个商业许可模式，它需要在代码中明确声明使用的许可上下文。对于大多数非商业用途，可以将许可上下文设置LicenseContext.NonCommercial。这个非常重要，如果未设置将会在运行时报错：

在ExcelPackage package = new ExcelPackage()报错：Please set the ExcelPackage.LicenseContext property. See https://epplussoftware.com/developers/licenseexception

需要在代码中设置 ExcelPackage.LicenseContext 属性。这个非常重要，以下是解决上面问题的代码示例：

// 在您的应用程序入口点，如 Main 方法或者其他初始化代码中执行以下设置
ExcelPackage.LicenseContext = LicenseContext.NonCommercial; // 设置为非商业使用

关键点说明

1. 数据库连接：使用 System.Data.SQLite 库进行数据库连接和数据检索。确保连接字符串正确，并且数据库文件可访问。

2. 数据绑定：将 DataTable 绑定到 DataGrid 的 ItemsSource，以便在界面上显示数据。

3. EPPlus 导出：使用 EPPlus 库将 DataTable 数据导出到 Excel。使用 LoadFromDataTable 方法可以轻松将表格加载到 Excel 工作表中。

4. 用户体验：使用 SaveFileDialog 允许用户选择保存位置，并提供导出成功与否的反馈。

通过这些步骤，您可以在 WPF 应用程序中实现从数据库读取、显示学生成绩，并能够将数据导出到 Excel 文件的功能。这种方法不仅简单而且高效，能够处理大多数常见的需求。

二、基于 ClosedXML 库实现WPF导出EXCEL功能

ClosedXML 是一个开源库，用于简化对 Excel 文件的操作。根据其在 GitHub 上的项目页面及 NuGet 包信息，ClosedXML 是在 MIT 许可下分发的，可以完全免费使用。 使用 ClosedXML 来处理 Excel 文件是一个相对简单的过程。它建立在 OpenXML SDK 之上，但提供了一个更易于使用的 API。下面是如何在项目中使用 ClosedXML.Excel 动态库的指南。

安装 ClosedXML

首先，你需要通过 NuGet 包管理器将 ClosedXML 添加到你的项目中。你可以在 Visual Studio 的包管理控制台中使用以下命令：

Install-Package ClosedXML

或者在 .NET CLI 中使用：

dotnet add package ClosedXML

使用 ClosedXML 创建和操作 Excel 文件

以下是一个使用 ClosedXML 创建简单 Excel 文件的示例代码。

using System;
using ClosedXML.Excel;

class Program
{
    static void Main()
    {
        // 创建一个新的 Excel 工作簿
        using (var workbook = new XLWorkbook())
        {
            // 添加一个新的工作表
            var worksheet = workbook.Worksheets.Add("Sample Sheet");

            // 插入数据
            worksheet.Cell(1, 1).Value = "Hello";
            worksheet.Cell(1, 2).Value = "World";

            // 应用一些基本格式
            worksheet.Cell(1, 1).Style.Font.Bold = true;

            // 保存到文件
            workbook.SaveAs("Sample.xlsx");

            Console.WriteLine("Excel file created successfully!");
        }
    }
}

读取 Excel 文件

ClosedXML 也支持读取 Excel 文件，这里是如何读取 Excel 文件并输出一些信息的示例：

using System;
using ClosedXML.Excel;

class Program
{
    static void Main()
    {
        // 打开一个现有的 Excel 文件
        using (var workbook = new XLWorkbook("Sample.xlsx"))
        {
            // 获取第一个工作表
            var worksheet = workbook.Worksheet(1);

            // 读取并输出单元格内容
            Console.WriteLine(worksheet.Cell(1, 1).Value); // 输出：Hello
            Console.WriteLine(worksheet.Cell(1, 2).Value); // 输出：World
        }
    }
}

常见操作

• 添加公式：

  worksheet.Cell("C1").FormulaA1 = "=A1 & \" \" & B1";

• 格式化单元格：

  worksheet.Cell("A1").Style.Font.Bold = true;
  worksheet.Cell("A1").Style.Fill.BackgroundColor = XLColor.Cyan;
  

• 遍历单元格：

  foreach (var cell in worksheet.RangeUsed().Cells())
  {
      Console.WriteLine(cell.Address + " - " + cell.Value);
  }
  

注意事项

• ClosedXML 是基于 OpenXML SDK 的，所以可以处理 .xlsx 文件格式，而不支持 .xls（旧版 Excel 格式）。
• 处理大型文件时要注意内存使用，尽量避免在内存中加载过大数据量的 Excel 文件。

        通过这些示例和说明，你应该能够开始使用 ClosedXML 来处理基本的 Excel 操作。根据需求，你可以探索更多库提供的功能，比如图表处理、数据透视表等。

使用 ClosedXML 替代 EPPlus 来实现前面导出数据到 Excel 文件的功能， ClosedXML 提供了易于使用的 API。以下是如何将前面基于 EPPlus 来实现导出数据到 Excel 文件的代码转换为使用 ClosedXML 的版本示例：

using ClosedXML.Excel;
using Microsoft.Win32;
using System.Data;
using System.Windows;

namespace StudentScoreApp
{
    public partial class MainWindow : Window
    {
        // 其他代码...

        private void ExportScore_Click(object sender, RoutedEventArgs e)
        {
            if (_scoreTable == null || _scoreTable.Rows.Count == 0)
            {
                MessageBox.Show("没有数据可导出。");
                return;
            }

            SaveFileDialog saveFileDialog = new SaveFileDialog
            {
                Filter = "Excel Files|*.xlsx",
                Title = "保存为 Excel 文件",
                FileName = "StudentScores.xlsx"
            };

            if (saveFileDialog.ShowDialog() == true)
            {
                try
                {
                    // 创建一个新的 Excel 工作簿
                    using (var workbook = new XLWorkbook())
                    {
                        // 添加一个新的工作表
                        var worksheet = workbook.Worksheets.Add("Scores");

                        // 使用 DataTable 填充工作表
                        worksheet.Cell(1, 1).InsertTable(_scoreTable);

                        // 保存到文件
                        workbook.SaveAs(saveFileDialog.FileName);

                        MessageBox.Show("成绩已成功导出到 Excel 文件。");
                    }
                }
                catch (Exception ex)
                {
                    MessageBox.Show("导出时发生错误: " + ex.Message);
                }
            }
        }
    }
}

1. 创建工作簿和工作表：

   • 使用 XLWorkbook 创建一个新的工作簿。
   • 使用 workbook.Worksheets.Add("Scores") 创建一个新的工作表。

2. 插入表格：

   • 使用 worksheet.Cell(1, 1).InsertTable(_scoreTable) 将 DataTable 的内容添加到工作表中。

3. 保存文件：

   • 使用 workbook.SaveAs(saveFileDialog.FileName) 方法保存 Excel 文件。

ClosedXML 的 API 设计为更易于使用，特别是对于从 DataTable 导出数据的场景。确保你的项目已经通过 NuGet 引入 ClosedXML 包后，你就可以使用这段代码进行 Excel 操作。

三、 ClosedXML 与 EPPlus使用场景和优缺点对比

        选择 ClosedXML 和 EPPlus 之间的库来处理 Excel 文件，取决于你的具体需求和偏好。以下是这两个库的优缺点对比，以帮助你做出决定：

ClosedXML

优点：

• 易于使用：API 设计简洁，使用起来非常直观，适合快速开发。
• 功能全面：支持绝大多数 Excel 的基本功能，例如单元格格式化、图表、表格等。
• 灵活性：支持 Excel 的各种操作，包括读取和写入。
• 开源：基于 MIT 许可证，允许自由使用和修改。

缺点：

• 性能：在处理非常大的 Excel 文件时，性能可能不如 EPPlus 高效。
• 依赖 OpenXML SDK：需要对 OpenXML SDK 有一点了解才能利用全部功能。

EPPlus

优点：

• 性能高：通常在处理大型 Excel 文件时更高效。
• 丰富的功能集：支持高级功能如数据透视表、条件格式化等。
• 支持最新的 Excel 功能：积极更新以支持最新的 Excel 功能。

缺点：

• 许可证限制：从版本 5 开始，EPPlus 改为商业许可，但仍提供 LGPL 许可证供非商业用途使用。
• 学习曲线稍陡：对于简单操作，API 可能不如 ClosedXML 简单直观。

适用场景

• 选择 ClosedXML：

  • 如果你需要一个简单、易于使用的库来进行快速开发，特别是处理小到中型的 Excel 文件。
  • 适合初学者和不需要复杂 Excel 操作的项目。

• 选择 EPPlus：

  • 如果你需要处理大型 Excel 文件或需要使用一些高级功能。
  • 适用于需要高性能和商业支持的企业级应用。

总结

        如果你的项目是小型或中型规模，并且需要快速实现基本的 Excel 操作，ClosedXML 可能是更合适的选择。如果你需要处理复杂或大型文件，并且需要最大限度的性能，EPPlus 会是更好的选择。在选择库之前，也可以考虑项目的许可证要求和预算。