Comment exporter des fichiers Excel depuis Blazor avec IronXL

Création du projet Blazor Server

Commencez par créer un nouveau projet Blazor Server dans Visual Studio 2022 ou version ultérieure, ciblant .NET 10. Une fois le projet prêt, installez IronXL via la console du gestionnaire de packages NuGet :

Install-Package IronXl.Excel

IronXL fonctionne avec .NET 6 et versions ultérieures, les projets Blazor existants peuvent donc l'adopter sans avoir à mettre à niveau le framework. Pour connaître les autres méthodes d'installation, telles que l'interface utilisateur NuGet ou l'interface de ligne de commande, consultez le guide d'installation IronXL .

Ajout de l'assistant de téléchargement JavaScript

Blazor Server s'exécute côté serveur, donc le déclenchement du téléchargement d'un fichier nécessite un petit pont JavaScript . Dans votre dossier wwwroot, ajoutez un fichier appelé excelExport.js :

window.downloadFileFromStream = async (fileName, contentStreamReference) => {
    const arrayBuffer = await contentStreamReference.arrayBuffer();
    const blob = new Blob([arrayBuffer]);
    const url = URL.createObjectURL(blob);
    const anchorElement = document.createElement('a');
    anchorElement.href = url;
    anchorElement.download = fileName ?? 'export.xlsx';
    anchorElement.click();
    anchorElement.remove();
    URL.revokeObjectURL(url);
}

window.downloadFileFromStream = async (fileName, contentStreamReference) => {
    const arrayBuffer = await contentStreamReference.arrayBuffer();
    const blob = new Blob([arrayBuffer]);
    const url = URL.createObjectURL(blob);
    const anchorElement = document.createElement('a');
    anchorElement.href = url;
    anchorElement.download = fileName ?? 'export.xlsx';
    anchorElement.click();
    anchorElement.remove();
    URL.revokeObjectURL(url);
}

Incluez ce script dans votre fichier _Host.cshtml (ou App.razor dans .NET 8+) :

<script src="~/excelExport.js"></script>

<script src="~/excelExport.js"></script>

Cette fonction convertit le flux d'octets provenant de Blazor en une URL blob temporaire, déclenche le téléchargement par le navigateur, puis nettoie l'objet URL pour éviter les fuites de mémoire. Il est volontairement minimal – le gros du travail est effectué en C# sur le serveur.

Commencez avec IronXL maintenant.

Commencer gratuitement

Création du service d'exportation Excel

Créer un nouveau fichier Services/ExcelExportService.cs:

using IronXL;
using System.IO;
using ExportExcel.Models;

public class ExcelExportService
{
    public byte[] GenerateSalesReport(List<SalesData> salesData)
    {
        var workbook = WorkBook.Create(ExcelFileFormat.XLSX);
        workbook.Metadata.Author = "Sales Department";

        var worksheet = workbook.CreateWorkSheet("Monthly Sales");

        // Add column headers
        worksheet["A1"].Value = "Date";
        worksheet["B1"].Value = "Product";
        worksheet["C1"].Value = "Quantity";
        worksheet["D1"].Value = "Revenue";
        worksheet["E1"].Value = "Profit Margin";

        // Style the header row
        var headerRange = worksheet["A1:E1"];
        headerRange.Style.Font.Bold = true;
        headerRange.Style.BackgroundColor = "#4472C4";
        headerRange.Style.Font.Color = "#FFFFFF";

        // Populate data rows
        int row = 2;
        foreach (var sale in salesData)
        {
            worksheet[$"A{row}"].Value = sale.Date.ToString("yyyy-MM-dd");
            worksheet[$"B{row}"].Value = sale.Product ?? "Unknown";
            worksheet[$"C{row}"].Value = sale.Quantity;
            worksheet[$"D{row}"].Value = sale.Revenue;
            worksheet[$"E{row}"].Value = $"=D{row}*0.15";
            row++;
        }

        worksheet.AutoSizeColumn(0, true);

        using var ms = workbook.ToStream();
        return ms.ToArray();
    }
}

using IronXL;
using System.IO;
using ExportExcel.Models;

public class ExcelExportService
{
    public byte[] GenerateSalesReport(List<SalesData> salesData)
    {
        var workbook = WorkBook.Create(ExcelFileFormat.XLSX);
        workbook.Metadata.Author = "Sales Department";

        var worksheet = workbook.CreateWorkSheet("Monthly Sales");

        // Add column headers
        worksheet["A1"].Value = "Date";
        worksheet["B1"].Value = "Product";
        worksheet["C1"].Value = "Quantity";
        worksheet["D1"].Value = "Revenue";
        worksheet["E1"].Value = "Profit Margin";

        // Style the header row
        var headerRange = worksheet["A1:E1"];
        headerRange.Style.Font.Bold = true;
        headerRange.Style.BackgroundColor = "#4472C4";
        headerRange.Style.Font.Color = "#FFFFFF";

        // Populate data rows
        int row = 2;
        foreach (var sale in salesData)
        {
            worksheet[$"A{row}"].Value = sale.Date.ToString("yyyy-MM-dd");
            worksheet[$"B{row}"].Value = sale.Product ?? "Unknown";
            worksheet[$"C{row}"].Value = sale.Quantity;
            worksheet[$"D{row}"].Value = sale.Revenue;
            worksheet[$"E{row}"].Value = $"=D{row}*0.15";
            row++;
        }

        worksheet.AutoSizeColumn(0, true);

        using var ms = workbook.ToStream();
        return ms.ToArray();
    }
}

Enregistrement du service

Ajoutez le service au conteneur DI dans Program.cs :

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddServerSideBlazor();
builder.Services.AddScoped<ExcelExportService>();

var app = builder.Build();
app.MapBlazorHub();
app.MapFallbackToPage("/_Host");
app.Run();

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddServerSideBlazor();
builder.Services.AddScoped<ExcelExportService>();

var app = builder.Build();
app.MapBlazorHub();
app.MapFallbackToPage("/_Host");
app.Run();

Ce service illustre plusieurs fonctionnalités clés IronXL . Vous pouvez créer de nouveaux classeurs et feuilles de calcul avec un seul appel de méthode, appliquer des en-têtes stylisés, remplir des lignes à partir de n'importe quelle source de données et intégrer des formules Excel telles que =D2*0.15. L'appel AutoSizeColumn garantit que les colonnes sont suffisamment larges pour afficher correctement leur contenu, quelle que soit la longueur des données. Pour plus d'options de mise en forme, consultez le guide de style des cellules .

Écriture du composant Razor

Créez une page à Pages/ExcelExportDashboard.razor :

@page "/excel-export"
@using ExportExcel.Models
@inject ExcelExportService ExcelService
@inject IJSRuntime JS

<h3>Excel Export Dashboard</h3>

<div class="export-section">
    <button class="btn btn-primary" @onclick="ExportSalesReport" disabled="@isExporting">
        @if (isExporting)
        {
            <span>Generating...</span>
        }
        else
        {
            <span>Export Sales Report</span>
        }
    </button>

    @if (!string.IsNullOrEmpty(errorMessage))
    {
        <div class="alert alert-danger mt-2">@errorMessage</div>
    }
</div>

@code {
    private bool isExporting = false;
    private string errorMessage = "";

    private async Task ExportSalesReport()
    {
        try
        {
            isExporting = true;
            errorMessage = "";

            var salesData = GetSalesData();
            var fileBytes = ExcelService.GenerateSalesReport(salesData);

            using var stream = new MemoryStream(fileBytes);
            using var streamRef = new DotNetStreamReference(stream);
            await JS.InvokeVoidAsync(
                "downloadFileFromStream",
                $"SalesReport_{DateTime.Now:yyyyMMdd}.xlsx",
                streamRef
            );
        }
        catch (Exception)
        {
            errorMessage = "Export failed. Please try again.";
        }
        finally
        {
            isExporting = false;
        }
    }

    private List<SalesData> GetSalesData()
    {
        return new List<SalesData>
        {
            new() { Date = DateTime.Now, Product = "Widget A", Quantity = 100, Revenue = 5000 },
            new() { Date = DateTime.Now.AddDays(-1), Product = "Widget B", Quantity = 75, Revenue = 3750 }
        };
    }
}

@page "/excel-export"
@using ExportExcel.Models
@inject ExcelExportService ExcelService
@inject IJSRuntime JS

<h3>Excel Export Dashboard</h3>

<div class="export-section">
    <button class="btn btn-primary" @onclick="ExportSalesReport" disabled="@isExporting">
        @if (isExporting)
        {
            <span>Generating...</span>
        }
        else
        {
            <span>Export Sales Report</span>
        }
    </button>

    @if (!string.IsNullOrEmpty(errorMessage))
    {
        <div class="alert alert-danger mt-2">@errorMessage</div>
    }
</div>

@code {
    private bool isExporting = false;
    private string errorMessage = "";

    private async Task ExportSalesReport()
    {
        try
        {
            isExporting = true;
            errorMessage = "";

            var salesData = GetSalesData();
            var fileBytes = ExcelService.GenerateSalesReport(salesData);

            using var stream = new MemoryStream(fileBytes);
            using var streamRef = new DotNetStreamReference(stream);
            await JS.InvokeVoidAsync(
                "downloadFileFromStream",
                $"SalesReport_{DateTime.Now:yyyyMMdd}.xlsx",
                streamRef
            );
        }
        catch (Exception)
        {
            errorMessage = "Export failed. Please try again.";
        }
        finally
        {
            isExporting = false;
        }
    }

    private List<SalesData> GetSalesData()
    {
        return new List<SalesData>
        {
            new() { Date = DateTime.Now, Product = "Widget A", Quantity = 100, Revenue = 5000 },
            new() { Date = DateTime.Now.AddDays(-1), Product = "Widget B", Quantity = 75, Revenue = 3750 }
        };
    }
}

Fonctionnement du composant

L'indicateur isExporting désactive le bouton pendant la génération, empêchant ainsi les requêtes en double. Le wrapper DotNetStreamReference gère efficacement le flux binaire du flux mémoire .NET vers la fonction JavaScript , évitant ainsi les chaînes base64 volumineuses qui augmenteraient la taille de la charge utile. Les noms de fichiers horodatés, tels que SalesReport_20260228.xlsx, permettent d'organiser les téléchargements sans configuration supplémentaire.

Lorsque vous accédez à /excel-export dans le navigateur, la page du tableau de bord se charge avec un bouton d'exportation :

Cliquer sur le bouton génère la feuille de calcul et le navigateur télécharge automatiquement le fichier :

Mise en forme conditionnelle des rapports d'inventaire

Le service suivant met en évidence en rouge les articles en faible stock – une exigence courante pour les applications de gestion d'entrepôt ou d'inventaire :

using IronXL;
using ExportExcel.Models;
using System.IO;

public class InventoryExportService
{
    public byte[] GenerateInventoryReport(List<InventoryItem> items)
    {
        var workbook = WorkBook.Create();
        var details = workbook.CreateWorkSheet("Inventory Details");

        // Column headers
        details["A1"].Value = "SKU";
        details["B1"].Value = "Name";
        details["C1"].Value = "Quantity";
        details["D1"].Value = "Reorder Level";
        details["E1"].Value = "Status";

        var headerRange = details["A1:E1"];
        headerRange.Style.Font.Bold = true;
        headerRange.Style.BackgroundColor = "#2E75B6";
        headerRange.Style.Font.Color = "#FFFFFF";

        for (int i = 0; i < items.Count; i++)
        {
            int row = i + 2;
            var item = items[i];

            details[$"A{row}"].Value = item.SKU;
            details[$"B{row}"].Value = item.Name;
            details[$"C{row}"].Value = item.Quantity;
            details[$"D{row}"].Value = item.ReorderLevel;
            details[$"E{row}"].Value = item.Quantity < item.ReorderLevel
                ? "Reorder Required"
                : "OK";

            if (item.Quantity < item.ReorderLevel)
            {
                // Highlight the entire row for low-stock items
                details[$"A{row}:E{row}"].Style.BackgroundColor = "#FFB6B6";
                details[$"C{row}"].Style.Font.Bold = true;
            }
        }

        details.AutoSizeColumn(0, true);
        details.AutoSizeColumn(1, true);

        using var stream = workbook.ToStream();
        return stream.ToArray();
    }
}

using IronXL;
using ExportExcel.Models;
using System.IO;

public class InventoryExportService
{
    public byte[] GenerateInventoryReport(List<InventoryItem> items)
    {
        var workbook = WorkBook.Create();
        var details = workbook.CreateWorkSheet("Inventory Details");

        // Column headers
        details["A1"].Value = "SKU";
        details["B1"].Value = "Name";
        details["C1"].Value = "Quantity";
        details["D1"].Value = "Reorder Level";
        details["E1"].Value = "Status";

        var headerRange = details["A1:E1"];
        headerRange.Style.Font.Bold = true;
        headerRange.Style.BackgroundColor = "#2E75B6";
        headerRange.Style.Font.Color = "#FFFFFF";

        for (int i = 0; i < items.Count; i++)
        {
            int row = i + 2;
            var item = items[i];

            details[$"A{row}"].Value = item.SKU;
            details[$"B{row}"].Value = item.Name;
            details[$"C{row}"].Value = item.Quantity;
            details[$"D{row}"].Value = item.ReorderLevel;
            details[$"E{row}"].Value = item.Quantity < item.ReorderLevel
                ? "Reorder Required"
                : "OK";

            if (item.Quantity < item.ReorderLevel)
            {
                // Highlight the entire row for low-stock items
                details[$"A{row}:E{row}"].Style.BackgroundColor = "#FFB6B6";
                details[$"C{row}"].Style.Font.Bold = true;
            }
        }

        details.AutoSizeColumn(0, true);
        details.AutoSizeColumn(1, true);

        using var stream = workbook.ToStream();
        return stream.ToArray();
    }
}

IronXL applique une mise en forme au niveau des cellules en fonction des valeurs des données lors de leur génération. Vous pouvez également appliquer des règles de mise en forme conditionnelle de manière déclarative ou gérer plusieurs feuilles de calcul au sein d'un même classeur ; par exemple, une feuille pour le stock actuel et une autre pour l'historique des commandes.

Ajout de plusieurs feuilles de calcul à une seule exportation

Le fait de séparer les données en feuilles logiques améliore la lisibilité sans nécessiter de téléchargements séparés :

public byte[] GenerateMultiSheetReport(
    List<SalesData> sales,
    List<InventoryItem> inventory)
{
    var workbook = WorkBook.Create(ExcelFileFormat.XLSX);

    // Sheet 1 -- Sales summary
    var salesSheet = workbook.CreateWorkSheet("Sales");
    salesSheet["A1"].Value = "Date";
    salesSheet["B1"].Value = "Revenue";
    salesSheet["A1:B1"].Style.Font.Bold = true;

    for (int i = 0; i < sales.Count; i++)
    {
        salesSheet[$"A{i + 2}"].Value = sales[i].Date.ToString("yyyy-MM-dd");
        salesSheet[$"B{i + 2}"].Value = sales[i].Revenue;
    }

    // Sheet 2 -- Inventory snapshot
    var invSheet = workbook.CreateWorkSheet("Inventory");
    invSheet["A1"].Value = "SKU";
    invSheet["B1"].Value = "Name";
    invSheet["C1"].Value = "Quantity";
    invSheet["A1:C1"].Style.Font.Bold = true;

    for (int i = 0; i < inventory.Count; i++)
    {
        invSheet[$"A{i + 2}"].Value = inventory[i].SKU;
        invSheet[$"B{i + 2}"].Value = inventory[i].Name;
        invSheet[$"C{i + 2}"].Value = inventory[i].Quantity;
    }

    using var stream = workbook.ToStream();
    return stream.ToArray();
}

public byte[] GenerateMultiSheetReport(
    List<SalesData> sales,
    List<InventoryItem> inventory)
{
    var workbook = WorkBook.Create(ExcelFileFormat.XLSX);

    // Sheet 1 -- Sales summary
    var salesSheet = workbook.CreateWorkSheet("Sales");
    salesSheet["A1"].Value = "Date";
    salesSheet["B1"].Value = "Revenue";
    salesSheet["A1:B1"].Style.Font.Bold = true;

    for (int i = 0; i < sales.Count; i++)
    {
        salesSheet[$"A{i + 2}"].Value = sales[i].Date.ToString("yyyy-MM-dd");
        salesSheet[$"B{i + 2}"].Value = sales[i].Revenue;
    }

    // Sheet 2 -- Inventory snapshot
    var invSheet = workbook.CreateWorkSheet("Inventory");
    invSheet["A1"].Value = "SKU";
    invSheet["B1"].Value = "Name";
    invSheet["C1"].Value = "Quantity";
    invSheet["A1:C1"].Style.Font.Bold = true;

    for (int i = 0; i < inventory.Count; i++)
    {
        invSheet[$"A{i + 2}"].Value = inventory[i].SKU;
        invSheet[$"B{i + 2}"].Value = inventory[i].Name;
        invSheet[$"C{i + 2}"].Value = inventory[i].Quantity;
    }

    using var stream = workbook.ToStream();
    return stream.ToArray();
}

Pour une documentation complète de l'API couvrant les propriétés des classeurs, les opérations sur les plages et la prise en charge des graphiques, consultez la documentation de l'API IronXL .

Gestion des erreurs dans la couche de service

En intégrant la logique de génération dans le service (plutôt que dans le composant), on assure une gestion des erreurs cohérente pour tous les appelants. Le modèle recommandé consiste à laisser les exceptions IronXL se propager, puis à les encapsuler dans une exception spécifique au domaine avec un contexte sur le rapport ayant échoué :

Placez un bloc try/catch autour de la génération du classeur dans GenerateSalesReport, en interceptant Exception et en le relançant comme InvalidOperationException("Failed to generate sales report", ex). Dans le composant Blazor , interceptez l'erreur InvalidOperationException et affichez un message convivial sans exposer les détails internes. Consignez l'exception interne en utilisant ILogger<t> injecté dans le constructeur du service, afin que l'équipe de développement puisse retracer les échecs jusqu'à une opération spécifique du classeur. Ne jamais exposer les messages d'exception bruts aux utilisateurs finaux : les chemins d'accès aux fichiers, les adresses mémoire ou les traces de pile peuvent révéler le fonctionnement interne du serveur.

Consultez les bonnes pratiques de gestion des erreurs dans la documentation officielle de Microsoft pour obtenir des conseils sur la journalisation structurée des erreurs dans Blazor. Pour plus d'informations sur la création de services testables dans .NET, la documentation Microsoft sur l'injection de dépendances explique comment enregistrer et résoudre les services à portée limitée, ce qui correspond exactement au modèle utilisé ici avec ExcelExportService.

Considérations relatives aux performances pour les grands ensembles de données

Pour les ensembles de données comportant plus de quelques milliers de lignes, envisagez les approches suivantes :

La méthode ToStream() d'IronXL écrit directement dans un flux de sortie sans charger au préalable l'intégralité du fichier dans un tableau d'octets, ce qui réduit l'utilisation de la mémoire pour les classeurs volumineux. Pour plus d'informations sur les performances, consultez la section lecture et écriture de fichiers Excel volumineux avec IronXL.

Formules, plages nommées et mise en forme des nombres

Vous pouvez intégrer n'importe quelle formule Excel en utilisant la même syntaxe que celle que vous saisiriez directement dans une cellule. IronXL évalue les formules au moment de la lecture, de sorte que les utilisateurs du fichier généré voient les résultats calculés dès qu'ils ouvrent la feuille de calcul. Les plages nommées rendent les formules plus lisibles et plus faciles à maintenir dans le temps :

// Aggregate formulas on a summary row
worksheet["E2"].Value = "=SUM(D2:D100)";
worksheet["F2"].Value = "=AVERAGE(C2:C100)";
worksheet["G2"].Value = "=COUNTIF(B2:B100,\"Widget A\")";

// Named ranges improve formula readability
worksheet["D2:D100"].Name = "RevenueColumn";
worksheet["E2"].Value = "=SUM(RevenueColumn)";

// Number and date formatting prevents type misinterpretation
worksheet["D2"].Value = 12345.67m;
worksheet["D2"].FormatString = "#,##0.00";
worksheet["A2"].Value = DateTime.Now;
worksheet["A2"].FormatString = "dd/MM/yyyy";

// Aggregate formulas on a summary row
worksheet["E2"].Value = "=SUM(D2:D100)";
worksheet["F2"].Value = "=AVERAGE(C2:C100)";
worksheet["G2"].Value = "=COUNTIF(B2:B100,\"Widget A\")";

// Named ranges improve formula readability
worksheet["D2:D100"].Name = "RevenueColumn";
worksheet["E2"].Value = "=SUM(RevenueColumn)";

// Number and date formatting prevents type misinterpretation
worksheet["D2"].Value = 12345.67m;
worksheet["D2"].FormatString = "#,##0.00";
worksheet["A2"].Value = DateTime.Now;
worksheet["A2"].FormatString = "dd/MM/yyyy";

Pour définir des plages nommées et définir explicitement le format numérique , IronXL expose les deux en tant que propriétés de l'objet plage. Cela empêche Excel de traiter les valeurs monétaires comme du texte brut, un problème courant lors de l'exportation de données financières à partir de bases de données qui stockent les valeurs sous forme de chaînes de caractères.

Formats de fichiers Excel pris en charge

IronXL peut lire et écrire plusieurs formats Excel, notamment .xlsx, .xls, .csv et .tsv. Le format est déterminé lors de l'enregistrement, de sorte que la même classe de service peut prendre en charge les exportations Excel et CSV avec une simple modification de paramètre :

// Export as CSV for systems that consume flat files
workbook.SaveAs("report.csv");

// Or stream as CSV for download
using var ms = workbook.ToStream(ExcelFileFormat.CSV);

// Export as CSV for systems that consume flat files
workbook.SaveAs("report.csv");

// Or stream as CSV for download
using var ms = workbook.ToStream(ExcelFileFormat.CSV);

Cette flexibilité est importante dans les intégrations où les systèmes en aval — tels que les plateformes ERP ou les entrepôts de données — attendent un format de fichier spécifique. Pour une comparaison complète des fonctionnalités IronXL avec celles d'autres bibliothèques Excel, consultez la page des fonctionnalités IronXL .

Microsoft fournit une bonne référence pour comprendre les formats de fichiers OOXML si vous avez besoin de comprendre la structure interne des fichiers .xlsx lors du débogage d'une sortie inattendue. Le package NuGet pour IronXL est également répertorié sur NuGet avec l'historique complet des versions et les notes de compatibilité.