萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

ASP.NET 匯出 GridView 資料至 Excel 完整解決方案 (解決 VerifyRenderingInServerForm 錯誤)

經典問題:Control 'GridView' must be placed inside a form tag with runat=server

呼叫 `GridView.RenderControl()` 時,ASP.NET 會檢查控制項是否在 `

` 內。若在非標準流程 (如匯出 Excel) 執行,需**重寫 `VerifyRenderingInServerForm`** 略過檢查。

完整可重複使用的匯出助手類別


using System;
using System.Data;
using System.IO;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

public static class ExcelExportHelper
{
    /// 
    /// 將 IList 匯出為 Excel (.xls HTML 格式)
    /// 
    public static void ExportToExcel(IList dataList, string[] fields, string[] headers, string title = "")
    {
        var gv = new GridView();
        
        if (fields.Length > 0 && fields.Length == headers.Length)
        {
            gv.AutoGenerateColumns = false;
            for (int i = 0; i < fields.Length; i++)
            {
                gv.Columns.Add(new BoundField 
                { 
                    DataField = fields[i], 
                    HeaderText = headers[i] 
                });
            }
        }
        else
        {
            gv.AutoGenerateColumns = true;
        }

        ApplyStyle(gv);
        gv.DataSource = dataList;
        gv.DataBind();

        RenderAndExport(gv, title);
    }

    /// 
    /// 直接匯出 DataTable
    /// 
    public static void ExportDataTable(DataTable dt, string title = "")
    {
        var gv = new GridView { AutoGenerateColumns = true, DataSource = dt };
        gv.DataBind();
        RenderAndExport(gv, title);
    }

    private static void ApplyStyle(GridView gv)
    {
        gv.Font.Name = "Microsoft JhengHei";
        gv.BorderStyle = BorderStyle.Solid;
        gv.HeaderStyle.BackColor = System.Drawing.Color.LightCyan;
        gv.HeaderStyle.ForeColor = System.Drawing.Color.Black;
        gv.HeaderStyle.HorizontalAlign = HorizontalAlign.Center;
        gv.HeaderStyle.Wrap = false;
        gv.HeaderStyle.Font.Bold = true;
        gv.HeaderStyle.Font.Size = 10;
        gv.RowStyle.Font.Size = 10;
    }

    private static void RenderAndExport(GridView gv, string title)
    {
        HttpContext.Current.Response.Clear();
        HttpContext.Current.Response.Buffer = true;
        HttpContext.Current.Response.ClearContent();
        HttpContext.Current.Response.ClearHeaders();
        
        string fileName = $"Export_{DateTime.Now:yyyyMMdd_HHmmss}.xls";
        HttpContext.Current.Response.AddHeader("Content-Disposition", $"attachment;filename={fileName}");
        HttpContext.Current.Response.ContentType = "application/vnd.ms-excel";
        HttpContext.Current.Response.ContentEncoding = System.Text.Encoding.UTF8;
        HttpContext.Current.Response.Charset = "";

        using (var sw = new StringWriter())
        using (var hw = new HtmlTextWriter(sw))
        {
            // 關鍵:在頁面類別中必須重寫 VerifyRenderingInServerForm (見下方)
            gv.RenderControl(hw);
            
            if (!string.IsNullOrEmpty(title))
            {
                HttpContext.Current.Response.Write($"
{title}
"); } HttpContext.Current.Response.Write(sw.ToString()); HttpContext.Current.Response.Flush(); HttpContext.Current.Response.End(); } } }

頁面類別必須加入的覆寫方法


public partial class MyPage : System.Web.UI.Page
{
    // 必須存在,內容可為空,告訴 ASP.NET 不要檢查 GridView 是否在 form 內
    public override void VerifyRenderingInServerForm(Control control) 
    { 
        // 故意留空
    }

    protected void btnExport_Click(object sender, EventArgs e)
    {
        var data = GetData(); // List 或 DataTable
        string[] fields = { "Id", "Name", "Amount", "Date" };
        string[] headers = { "編號", "名稱", "金額", "日期" };
        ExcelExportHelper.ExportToExcel(data, fields, headers, "銷售報表");
    }
}

進階:真正的 Excel 二進位格式 (OpenXML / EPPlus) - 推薦

HTML 格式 (.xls) 會被 Excel 警告「檔案格式與副檔名不符」,且不支援樣式、公式、凍結窗格。現代專案請使用 **EPPlus** (商業授權) 或 **ClosedXML** (MIT) 產生真正的 `.xlsx`:


// 使用 ClosedXML (NuGet: ClosedXML)
using ClosedXML.Excel;

public static byte[] ExportToXlsx(IEnumerable data, string sheetName = "Sheet1")
{
    using var wb = new XLWorkbook();
    var ws = wb.Worksheets.Add(sheetName);
    ws.Cell(1, 1).InsertTable(data.AsEnumerable()); // 需引用 System.Linq
    ws.Columns().AdjustToContents();
    
    using var ms = new MemoryStream();
    wb.SaveAs(ms);
    return ms.ToArray();
}

// Controller / Page 回傳
public IActionResult Export()
{
    var bytes = ExportToXlsx(GetData(), "報表");
    return File(bytes, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", $"Report_{DateTime.Now:yyyyMMdd}.xlsx");
}

大資料量匯出策略

資料量策略技術
< 5,000 列記憶體直接產生ClosedXML / EPPlus
5,000 ~ 100,000分批串流寫入OpenXML SDK `OpenXmlWriter` / `SXSSF` (NPOI)
> 100,000背景作業 + 下載連結Hangfire / Quartz 生成檔案存 Blob,前端輪詢/通知下載

常見坑點彙整

  • VerifyRenderingInServerForm:忘記覆寫 → 執行時例外。
  • Response.End() 拋 ThreadAbortException:使用 `CompleteRequest()` + `return` 替代 (ASP.NET 4.5+)。
  • 中文檔名亂碼:`HttpUtility.UrlEncode(fileName, Encoding.UTF8)` 並設定 `Response.HeaderEncoding = Encoding.UTF8`。
  • 數值格式:Excel 會自動將長數字轉科學記號,需在匯出前轉字串或設定儲存格格式 `@` (文字)。
  • HTML 格式無法支援多工作表:需改用 OpenXML/EPPlus。

掌握 `VerifyRenderingInServerForm` 覆寫技巧可快速修正舊專案匯出功能;新專案請直接投入 **ClosedXML/OpenXML** 擁抱真正的 `.xlsx` 格式,獲得專業級報表品質。

copyright © 萬盛學電腦網 all rights reserved