ASP.NET MVC 拓展ActionResult實現Html To Pdf 導出

之前實現了html直接轉換為word文檔的功能，那么是否也同樣可以直接轉換為pdf文檔呢，網上搜了下html to pdf 的開源插件有很多 如：wkhtmltopdf，pdfsharp，itextsharp等

本文使用itextsharp實現如何將html文件轉換為pdf文檔

 

首先使用Nuget安裝itextsharp插件

1. Install-Package itextsharp.xmlworker

創建FileContentResult文件繼承自ActionResult，方法HtmlToPdf中實現了如何將一段html轉換為pdf文檔邏輯，itextsharp.xmlworker能夠支持豐富的css和html標簽，但是有一個很大的缺點就是不支持中文，網上的一些解決中文字體的邏輯，在新版里面已經不支持了，在以下的示例代碼中已經解決此問題，重點是以下兩部代碼：

FontFactory.RegisterDirectories();//注冊當前系統中所支持的字體

worker.ParseXHtml(pdfWriter, document, new MemoryStream(Encoding.UTF8.GetBytes(sbHtml.ToString())), null, Encoding.UTF8, new UnicodeFontFactory()); //指定要使用的字體

 

1. public class PdfContentResult : ActionResult
2. {
3.     public PdfContentResult() : this(null, null) { }
4.  
5.     public PdfContentResult(string viewName) : this(null, viewName) { }
6.  
7.     public PdfContentResult(object model) : this(model, null) { }
8.  
9.     public PdfContentResult(object model, string viewName)
10.     {
11.         this.ViewName = viewName;
12.         ViewData = null != model ? new ViewDataDictionary(model) : null;
13.     }
14.  
15.     public ViewDataDictionary ViewData { get; set; } = new ViewDataDictionary();
16.  
17.     public string ViewName { get; set; }
18.  
19.     public IView View { get; set; }
20.  
21.     public override void ExecuteResult(ControllerContext context)
22.     {
23.         if (String.IsNullOrEmpty(ViewName))
24.         {
25.             ViewName = context.RouteData.GetRequiredString("action");
26.         }
27.         if (ViewData == null)
28.         {
29.             ViewData = context.Controller.ViewData;
30.         }
31.         ViewEngineResult result = ViewEngines.Engines.FindView(context, ViewName, null);
32.         View = result.View;
33.  
34.         StringBuilder sbHtml = new StringBuilder();
35.         TextWriter txtWriter = new StringWriter(sbHtml);
36.         ViewContext viewContext = new ViewContext(context, View, ViewData, context.Controller.TempData, txtWriter);
37.         result.View.Render(viewContext, txtWriter);
38.  
39.         HttpResponseBase httpResponse = context.HttpContext.Response;
40.         httpResponse.ContentType = System.Net.Mime.MediaTypeNames.Application.Pdf;
41.  
42.         //加入此頭部文件會直接下載pdf文件，而不是在瀏覽器中預覽呈現
43.         //context.HttpContext.Response.AppendHeader("Content-Disposition", string.Format("attachment;filename={0}.pdf", ViewName));
44.  
45.         HtmlToPdf(sbHtml, httpResponse);
46.  
47.         result.ViewEngine.ReleaseView(context, View);
48.     }
49.  
50.     private static void HtmlToPdf(StringBuilder sbHtml, HttpResponseBase httpResponse)
51.     {
52.         using (Document document = new Document(PageSize.A4, 4, 4, 4, 4))
53.         {
54.             using (PdfWriter pdfWriter = PdfWriter.GetInstance(document, httpResponse.OutputStream))
55.             {
56.                 document.Open();
57.                 FontFactory.RegisterDirectories();//注冊系統中所支持的字體
58.                 XMLWorkerHelper worker = XMLWorkerHelper.GetInstance();
59.                 //UnicodeFontFactory 自定義實現解決itextsharp.xmlworker 不支持中文的問題
60.                 worker.ParseXHtml(pdfWriter, document, new MemoryStream(Encoding.UTF8.GetBytes(sbHtml.ToString())), null, Encoding.UTF8, new UnicodeFontFactory());
61.                 document.Close();
62.             }
63.         }
64.     }
65. }

 

UnicodeFontFactory完整代碼

 

1. public class UnicodeFontFactory : FontFactoryImp
2. {
3.     static UnicodeFontFactory()
4.     {
5.  
6.     }
7.     public override Font GetFont(string fontname, string encoding, bool embedded, float size, int style, BaseColor color, bool cached)
8.     {
9.         return FontFactory.GetFont("arial unicode ms", BaseFont.IDENTITY_H, BaseFont.EMBEDDED);
10.     }
11. }

 

 

如何確定哪些字體在itextsharp中是支持中文的呢，可以通過下面這個小程序驗證輸出所有的字體名稱，及是否支持中文

通過控制台應用程序執行完成后，打開生成的pdf文件，查看 字體名稱是否有中文 " 我支持中文" ，如果存在則表示支持中文，否則不支持中文

1. Document document = new Document();
2. PdfWriter writer = PdfWriter.GetInstance(document, new FileStream(@"c:\pdf\pdf.pdf", FileMode.Create));
3. document.Open();
4.  
5. FontFactory.RegisterDirectories();
6.  
7. foreach (var item in FontFactory.RegisteredFonts)
8. {
9.     Font font = FontFactory.GetFont(item, BaseFont.IDENTITY_H, BaseFont.EMBEDDED);
10.     document.Add(new Paragraph(item + "<p>我支持中文</p>", font));
11. }
12. document.Close();

 

 

上面說了如何轉換html為pdf及怎么解決中文字體的問題，那么怎么使用定義的PdfContentResult呢，

使用方式一：直接在控制器的Action方法中返回PdfContentResult實例

1. public class PdfController : Controller
2.     {
3.         // GET: Pdf
4.         public ActionResult Index()
5.         {
6.             return new PdfContentResult(null,"index");
7.         }
8.     }

 

使用方式二：添加Controller類的拓展方法，然后在控制器的Action方法中返回對應的拓展方法

1. public static class ControllerExtensions
2.   {
3.       public static PdfContentResult Pdf(this Controller controller, object model)
4.       {
5.           return new PdfContentResult(model);
6.       }
7.  
8.       public static PdfContentResult Pdf(this Controller controller, object model, string fileName)
9.       {
10.           return new PdfContentResult(model, fileName);
11.       }
12.  
13.       public static PdfContentResult Pdf(this Controller controller, string fileName)
14.       {
15.           return new PdfContentResult(fileName);
16.       }
17.   }

 

這種感覺用起來是不是與return view();一樣

1. public class PdfController : Controller
2. {
3.     // GET: Pdf
4.     public ActionResult Index()
5.     {
6.         return this.Pdf(null, "index");
7.     }
8. }

 

可能有人會問pdf文檔的內容在哪里維護，直接打開Action對應的View視圖，像寫mvc頁面一樣布局pdf內容就可以了

 

至於itextsharp更多功能支持，請參考此文檔：http://developers.itextpdf.com/