好比咱們須要ASP.NET Core 中須要經過PDF來進行某些簡單的報表開發,隨着這並不難,但仍是會手忙腳亂的去搜索一些資料,那麼恭喜您,這篇帖子會幫助到您,咱們就不會再去浪費一些寶貴的時間。css
在本文中咱們將要使用DinkToPDF來處理咱們在.NET Core Web 程序中進行構建PDF文檔!就如今咱們很少說,直接開始有趣的部分。html
您能夠經過建立PDF文檔在個人倉庫中,獲取源代碼,歡迎給個免費的Star...git
如今咱們建立一個.NET Core 3.0 項目,至因而mvc、Api、這些我並不在乎。建立項目後直接Nuget安裝DinkToPDF。隨後您須要下載個人代碼倉庫中的「NativeLibrary」文件夾,在其中,咱們將找到兩個文件32bit和64bit,所以咱們須要爲操做系統選擇合適的庫。咱們將從64位文件夾中選擇文件。github
最後,咱們須要啓動該庫,而且IOC DinkToPDF。數據庫
public void ConfigureServices(IServiceCollection services) { var context = new CustomAssemblyLoadContext(); context.LoadUnmanagedLibrary(Path.Combine(Directory.GetCurrentDirectory(), "libwkhtmltox.dll")); services.AddSingleton(typeof(IConverter), new SynchronizedConverter(new PdfTools())); services.AddControllers(); }
在真實狀況的項目中,咱們能夠從數據庫中收集數據或從其餘API接收數據。可是爲了簡單起見,咱們將從本地存儲中收集PDF文檔的數據。隨後,咱們將建立一個HTML模板並將其存儲在PDF文檔中。api
public class Employee { public string Name { get; set; } public string LastName { get; set; } public int Age { get; set; } public string Gender { get; set; } }
再隨後,咱們要建立一個新的文件夾Services
和裏面兩類文件 DataServices.cs 和 TemplateGenerator.cs 。完整的結構應以下所示:服務器
public class DataServices { public static List<Employee> GetAllEmployess() => new List<Employee> { new Employee { Name="Hao Zi Zhang", LastName="Turner", Age=35, Gender="Male"}, new Employee { Name="Yu Chen", LastName="Markus", Age=22, Gender="Female"}, new Employee { Name="Jian Zhi Chu", LastName="Martins", Age=40, Gender="Male"}, new Employee { Name="ElderJames", LastName="Packner", Age=30, Gender="Female"}, new Employee { Name="BlaZui", LastName="Doe", Age=45, Gender="Male"} }; }
其中添加服務中返回了某些數據,用於模擬服務。咱們要生成一個HTML模板,所以咱們須要修改 TemplateGenerator.cs 文件:mvc
public class TempleGenertor { public static string GetHTMLString() { var employees = DataServices.GetAllEmployess(); var sb = new StringBuilder(); sb.Append(@" <html> <head> </head> <body> <div class='header'><h1>This is the generated PDF report!!!</h1></div> <table align='center'> <tr> <th>Name</th> <th>LastName</th> <th>Age</th> <th>Gender</th> </tr>"); foreach (var emp in employees) { sb.AppendFormat(@"<tr> <td>{0}</td> <td>{1}</td> <td>{2}</td> <td>{3}</td> </tr>", emp.Name, emp.LastName, emp.Age, emp.Gender); } sb.Append(@" </table> </body> </html>"); return sb.ToString(); } }
若是想要指定css樣式,則能夠建立某些文件夾,隨後在API經過服務器路徑來抉擇配置。app
.header { text-align: center; color: green; padding-bottom: 35px; } table { width: 80%; border-collapse: collapse; } td, th { border: 1px solid gray; padding: 15px; font-size: 22px; text-align: center; } table th { background-color: green; color: white; }
就是這樣,咱們有用於HTML建立的HTML模板。如今,咱們能夠繼續執行Controller邏輯。函數
[Route("api/PdfCreator")] [ApiController] public class PdfCreatorController : ControllerBase { private IConverter _converter; public PdfCreatorController(IConverter converter) { _converter = converter; } [HttpGet] public IActionResult CreatePDF() { var globalSettings = new GlobalSettings { ColorMode = ColorMode.Color, Orientation = Orientation.Portrait, PaperSize = PaperKind.A4, Margins = new MarginSettings { Top = 10 }, DocumentTitle = "PDF Report" }; var objectSettings = new ObjectSettings { PagesCount = true, HtmlContent = TempleGenertor.GetHTMLString(), WebSettings = { DefaultEncoding = "utf-8", UserStyleSheet = Path.Combine(Directory.GetCurrentDirectory(), "assets", "style.css") }, HeaderSettings = { FontName = "Arial", FontSize = 9, Right = "Page [page] of [toPage]", Line = true }, FooterSettings = { FontName = "Arial", FontSize = 9, Line = true, Center = "Report Footer" } }; var pdf = new HtmlToPdfDocument() { GlobalSettings = globalSettings, Objects = { objectSettings } }; var file = _converter.Convert(pdf); return File(file, "application/pdf"); } }
在上面的代碼中,咱們首先經過使用 IConverter 接口將註冊的 Converter 與依賴注入注入到構造函數中。而後,咱們建立兩個對象 globalSettings , objectSettings 並將它們用做 HtmlToPdfDcoument 屬性中的配置。
如今讓咱們來講說 GlobalSettings 和 ObjectSettings 類。
它括了PDF文檔的總體配置屬性。咱們僅使用其中的幾個屬性來設置顏色模式,方向,紙張尺寸,文檔標題等…但它還有還多屬性。
ObjectSettings
由相關的PDF文檔的內容的屬性。所以,咱們能夠配置頁面計數器的可見性,頁眉和頁腳的格式,文檔的正文內容(HtmlContent
屬性)或的Web設置。
HtmlContent
屬性是此類的很是重要的屬性。它包含咱們生成的HTML模板,並顯示PDF文檔的主體。
WebSettings
也很是重要,尤爲是若是咱們有一個外部CSS文件來進行樣式設置時。在此屬性中,咱們能夠配置文檔的編碼並提供CSS文件的路徑。若是咱們檢查此屬性,咱們將發現更多能夠配置的設置,例如PDF文檔的背景,文字大小 等等..
經過路由定位到咱們的API中,重定向PDF打印界面。
一切看起來都是那麼完美,就這樣咱們就能夠輕鬆的在ASP.NET Core中構建PDF文檔而且還能夠完美適配相關邏輯和某些文檔設置!!