如何在ASP.NET Core 中快速構建PDF文檔

来源:https://www.cnblogs.com/ZaraNet/archive/2019/12/13/12037634.html
-Advertisement-
Play Games

比如我們需要ASP.NET Core 中需要通過PDF來進行某些簡單的報表開發,隨著這並不難,但還是會手忙腳亂的去搜索一些資料,那麼恭喜您,這篇帖子會幫助到您,我們就不會再去浪費一些寶貴的時間。 在本文中我們將要使用DinkToPDF來處理我們在.NET Core Web 程式中進行構建PDF文檔! ...


  比如我們需要ASP.NET Core 中需要通過PDF來進行某些簡單的報表開發,隨著這並不難,但還是會手忙腳亂的去搜索一些資料,那麼恭喜您,這篇帖子會幫助到您,我們就不會再去浪費一些寶貴的時間。

  在本文中我們將要使用DinkToPDF來處理我們在.NET Core Web 程式中進行構建PDF文檔!就現在我們不多說,直接開始有趣的部分。

前言

  您可以通過創建PDF文檔在我的倉庫中,獲取源代碼,歡迎給個免費的Star...

  現在我們創建一個.NET Core 3.0 項目,至於是mvc、Api、這些我並不在意。創建項目後直接Nuget安裝DinkToPDF。隨後您需要下載我的代碼倉庫中的“NativeLibrary”文件夾,在其中,我們將找到兩個文件32bit和64bit,因此我們需要為操作系統選擇合適的庫。我們將從64位文件夾中選擇文件。

  最後,我們需要啟動該庫,並且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文檔中。

 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 文件:

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通過伺服器路徑來抉擇配置。

.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 類。

關於GlobalSettings類

它括了PDF文檔的整體配置屬性。我們僅使用其中的幾個屬性來設置顏色模式,方向,紙張尺寸,文檔標題等…但它還有還多屬性。

關於ObjectSettings類

ObjectSettings由相關的PDF文檔的內容的屬性。因此,我們可以配置頁面計數器的可見性,頁眉和頁腳的格式,文檔的正文內容(HtmlContent屬性)或的Web設置。

HtmlContent屬性是此類的非常重要的屬性。它包含我們生成的HTML模板,並顯示PDF文檔的主體。

WebSettings也非常重要,尤其是如果我們有一個外部CSS文件來進行樣式設置時。在此屬性中,我們可以配置文檔的編碼並提供CSS文件的路徑。如果我們檢查此屬性,我們將發現更多可以配置的設置,例如PDF文檔的背景,文字大小 等等..

啟動項目

通過路由定位到我們的API中,重定向PDF列印界面。

  一切看起來都是那麼完美,就這樣我們就可以輕鬆的在ASP.NET Core中構建PDF文檔並且還可以完美適配相關邏輯和某些文檔設置!!


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 之前我們使用VSCode搭建C 項目,今天寫一篇關於django項目的搭建;django官網:https://www.djangoproject.com/ 安裝django django安裝命令: ,參考:https://docs.djangoproject.com/en/3.0/topics/in ...
  • spring 第一章 Spring模塊規劃圖 核心架包 AOP+Aspects(面向切麵編程模塊) 數據訪問/:Spring資料庫訪問模塊 Web:Spring開發web應用的模塊; ecplise插件的安裝 1.ecplise查看版本號: Help About Eclipse 點擊自己eclips ...
  • 二、Celery基本使用 1.創建一個celery application 用來定義你的任務列表,創建一個任務文件就叫tasks.py吧。 from celery import Celery # 配置好celery的backend和broker app = Celery('task1', backe ...
  • 一、下載(原文鏈接:http://www.studyshare.cn/software/details/1183/0 ) 1、官網下載:下載地址 2、百度網盤下載:下載地址 提取碼:0g5a java開發工具下載地址及安裝教程大全,點這裡。 更多深度技術文章,在這裡。 二、安裝及啟動 1、前提條件: ...
  • 本文將介紹在Java程式中如何將Excel工作簿轉為PDF文檔的,包括: 將整個工作簿轉為PDF 將指定工作表轉為PDF 使用工具:Free Spire.XLS for Java (免費版) Jar文件下載及導入: 方法1:通過官網下載。下載後,解壓文件,將lib文件夾下的Spire.Xls.jar ...
  • 場景 JPA入門簡介與搭建HelloWorld(附代碼下載): https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/103473937 JPA中實現單向多對一的關聯關係: https://blog.csdn.net/BADAO_LIUM ...
  • 一、Task類簡介: Task類是在.NET Framework 4.0中提供的新功能,主要用於非同步操作的控制。它比Thread和ThreadPool提供了更為強大的功能,並且更方便使用。 Task和Task<TResult>類:前者接收的是Action委托類型;後者接收的是Func<TResult ...
  • 問題 在開發一款應用的過程中,我們開發者很難考慮到所有問題,往往會忘記處理一些可能發生的異常。隨之而來的結果就是用戶使用過程中接連不斷的崩潰。所以,我們有必要處理所有未被我們處理的異常。 思路 我們需要做的是,在錯誤發生時保存用戶數據,然後將錯誤直接展示在用戶界面上。 解決 首先,我們打開項目中的 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...