C# MVC导出GridView至Excel时单元格内\n\r换行符丢失怎么办

问题描述 #

在C# MVC环境下，通过现有逻辑将GridView数据导出为xls格式文件时，单元格内的所有换行符（\n）、回车符（\r）都会被自动清除，丢失原有的分段排版效果。

• 实际异常效果：导出文本“testing1\r\n\r\ntesting 2\r\n\r\ntesting 3”时，所有换行被移除，内容连成无分段的连续文本
• 期望效果：单元格内保留对应的换行分段，实现多段落的排版展示
• 已排除的方向：曾考虑改用CSV格式导出，但不符合业务对输出格式的要求，未采用

现有问题代码 #

var gridView = new GridView { DataSource = content };
Response.ClearContent();
gridView.DataBind();
Response.Buffer = true;
Response.AddHeader("content-disposition", $"attachment; filename={fileName}.xls");
Response.ContentType = "application/ms-excel";
Response.Charset = "";            
StringWriter objStringWriter = new StringWriter();
HtmlTextWriter objHtmlTextWriter = new HtmlTextWriter(objStringWriter);
gridView.RenderControl(objHtmlTextWriter);
Response.Output.Write(objStringWriter.ToString());
Response.Flush();
Response.End();

问题根因 #

你现在这套导出方式本质是将GridView渲染生成的HTML字符串，伪装成xls格式文件交给Excel打开。

• HTML默认规则会把所有连续空白（包括换行符）折叠为单个空格，原始文本里的换行自然会被直接清除
• 即使手动保留了HTML里的换行占位，Excel打开这类伪Excel文件时，默认不会给单元格开启“自动换行”属性，即便存在换行标记，也无法正确展示分段效果

解决步骤 #

• 预处理单元格内容，将所有换行符替换为HTML可识别的换行标记
  不要直接给GridView绑定原始数据源就结束，需要订阅GridView的RowDataBound事件，逐单元格替换换行符为<br>标签，避免HTML规则自动折叠换行：

  protected void gridView_RowDataBound(object sender, GridViewRowEventArgs e)
  {
      if (e.Row.RowType == DataControlRowType.DataRow)
      {
          foreach (TableCell cell in e.Row.Cells)
          {
              cell.Text = cell.Text
                  .Replace("\r\n", "<br>")
                  .Replace("\r", "<br>")
                  .Replace("\n", "<br>");
          }
      }
  }
  

• 追加Excel兼容的内联样式，强制开启单元格自动换行
  Excel打开HTML格式文件时，可识别网页内的Office专属扩展样式。在拿到GridView渲染完成的HTML字符串后，不要直接输出，先拼接一段样式规则，给所有表格单元格指定文本格式和换行保留规则，
  标记就会被Excel识别为单元格内换行而非普通文本：

  // 获取GridView渲染完成的HTML内容
  string gridContent = objStringWriter.ToString();
  // 定义Excel兼容的表格样式
  string excelStyle = @"
  <style>
      td {
          mso-number-format:"\@";
          white-space: pre-wrap;
      }
  </style>";
  // 拼接样式后再输出到响应流
  Response.Output.Write(excelStyle + gridContent);
  

• 修正细节配置避免其他异常
  • 将原代码中为空的Response.Charset设置为"utf-8"，避免导出文件出现中文乱码
  • 不要给单元格内容额外嵌套多余的HTML标签，避免样式冲突导致换行失效

内容的提问来源于stack exchange，提问作者TechnoKid