ASP.NET Core 5中如何生成PDF文档

前言

大家用 ASP.NET Core 进行项目开发时，常会有生成 PDF 的需求，那如何生成呢？这篇文章我们就来讨论如何通过 DinkToPdf 来生成 PDF 文档，DinkToPdf 封装了 C++ 的 wkhtmltopdf 工具包，前者通过 P/Invoke 的方式来调用后者，而底层的 wkhtmltopdf 利用 Qt WebKit 渲染引擎将 html 转成 pdf。

安装 DinkToPdf

要想安装 DinkToPdf，可以通过 Nuget 可视化界面或者通过 NuGet Package Manager Console 命令行工具输入以下命令：

Install-Package DinkToPdf

安装完毕之后可以验证下 DinkToPdf.dll 是否已成功引用到项目中。

既然是封装了 C++ 的 wkhtmltopdf，肯定要拿到原生的 wkhtmltopdf 工具包， 官方下载地址：https://wkhtmltopdf.org/downloads.html ，也可以在 DinkToPdf 的官方Github：https://github.com/rdvojmoc/DinkToPdf/tree/master/v0.12.4  上下载，然后根据你的需要选择 32bit 还是 64bit 。

注册 DinkToPdf

要想在 ASP.NET Core 中使用，需要在 ConfigureServices() 方法下将 DinkToPdf 注入到 IOC 容器中，下面的代码展示了如何去实现。

 public void ConfigureServices(IServiceCollection services)
 {
 services.AddSingleton(typeof(IConverter),new SynchronizedConverter(new PdfTools()));

 services.AddControllers();
 }

创建 ReportService

基础配置做好之后，接下来我们来写生成 PDF 的业务逻辑，创建一个 IReportService 和 ReportService 实现类，代码如下：

 public interface IReportService
 {
 public byte[] GeneratePdfReport();
 }

 public class ReportService : IReportService
 {
 private readonly IConverter _converter;
 public ReportService(IConverter converter)
 {
 _converter = converter;
 }
 public byte[] GeneratePdfReport()
 {
 throw new NotImplementedException();
 }
 }

从上面的代码可以看出，IConverter 实例是通过 构造函数 注入的，接下来可以在 GeneratePdfReport() 方法中构建生成 pdf 的具体业务逻辑。

 public byte[] GeneratePdfReport()
 {
 var html = $@"<!DOCTYPE html>
 <html lang=""en"">
 <head>
 This is the header of this document.
 </head>
 <body>
 <h1>This is the heading for demonstration purposes only.</h1>
 <p>This is a line of text for demonstration purposes only.</p>
 </body>
 </html>";
 GlobalSettings globalSettings = new GlobalSettings();
 globalSettings.ColorMode = ColorMode.Color;
 globalSettings.Orientation = Orientation.Portrait;
 globalSettings.PaperSize = PaperKind.A4;
 globalSettings.Margins = new MarginSettings { Top = 25, Bottom = 25 };
 ObjectSettings objectSettings = new ObjectSettings();
 objectSettings.PagesCount = true;
 objectSettings.HtmlContent = html;
 WebSettings webSettings = new WebSettings();
 webSettings.DefaultEncoding = "utf-8";
 HeaderSettings headerSettings = new HeaderSettings();
 headerSettings.FontSize = 15;
 headerSettings.FontName = "Ariel";
 headerSettings.Right = "Page [page ] of [toPage]";
 headerSettings.Line = true;
 FooterSettings footerSettings = new FooterSettings();
 footerSettings.FontSize = 12;
 footerSettings.FontName = "Ariel";
 footerSettings.Center = "This is for demonstration purposes only.";
 footerSettings.Line = true;
 objectSettings.HeaderSettings = headerSettings;
 objectSettings.FooterSettings = footerSettings;
 objectSettings.WebSettings = webSettings;
 HtmlToPdfDocument htmlToPdfDocument = new HtmlToPdfDocument()
 {
 GlobalSettings = globalSettings,
 Objects = { objectSettings },
 };
 return _converter.Convert(htmlToPdfDocument);
 }

然后再将 IReportService 和 ReportService 注入到 IOC 容器中，如下代码所示：

services.AddSingleton<IReportService, ReportService>();

创建 ReportController

GeneratePdfReport() 方法的业务逻辑构建好之后，现在可以将 IReportService 实例注入到 ReportController 中来最终渲染 pdf，下面的代码展示了如何去实现。

 [Route("api/[controller]")]
 [ApiController]
 public class ReportController : ControllerBase
 {
 private readonly IReportService _reportService;
 public ReportController(IReportService reportService)
 {
 _reportService = reportService;
 }
 [HttpGet]
 public IActionResult Get()
 {
 var pdfFile = _reportService.GeneratePdfReport();
 return File(pdfFile,"application/octet-stream", "SimplePdf.pdf");
 }
 }

在 ASP.NET Core 中并没有内置对 pdf 的支持，所以有这方面的需求只能借助于第三方框架，而 DinkToPdf 就是这么一款非常优秀的工具包，DinkToPdf 是一款用 .NET 语言编写的用于包装 C++ 的 wkhtmltopdf 的工具包，它可以非常方便的将 Html 转成 PDF ，关于更多 DinkToPdf 可参考 Github：https://github.com/rdvojmoc/DinkToPdf

译文链接：https://www.infoworld.com/article/3605276/how-to-create-pdf-documents-in-aspnet-core-5.html

总结

到此这篇关于ASP.NET Core 5中如何生成PDF文档的文章就介绍到这了,更多相关ASP.NET Core5生成PDF内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • asp.net 按指定模板导出word,pdf实例代码

    复制代码 代码如下: /// <summary>        /// 导出word文件        /// </summary>        /// <param name="templateFile">模板路径</param>        /// <param name="fileNameWord">导出文件名称</param>        /// <param name=&q

  • 如何使用Rotativa在ASP.NET Core MVC中创建PDF详解

    如何使用Rotativa在ASP.NET Core MVC中创建PDF详解

    前言 在本文中,我们将学习如何使用Rotativa.AspNetCore工具从ASP.NET Core中的视图创建PDF.如果您使用ASP.NET MVC,那么Rot​​ativa工具已经可用,我们可以使用它来生成pdf. 创建一个MVC项目,无论您是core或不core,都可以nuget下包.命令如下: Install-Package Rotativa #或者 Install-Package Rotativa.AspNetCore 这个工具由意大利人Giorgio Bozio创建.他需要在AS

  • ASP.NET Core中快速构建PDF文档的步骤分享第1/2页

    ASP.NET Core中快速构建PDF文档的步骤分享第1/2页

    比如我们需要ASP.NET Core 中需要通过PDF来进行某些简单的报表开发,随着这并不难,但还是会手忙脚乱的去搜索一些资料,那么恭喜您,这篇帖子会帮助到您,我们就不会再去浪费一些宝贵的时间. 在本文中我们将要使用DinkToPDF来处理我们在.NET Core Web 程序中进行构建PDF文档!就现在我们不多说,直接开始有趣的部分. 前言# 您可以通过创建PDF文档在我的仓库中,获取源代码,欢迎给个免费的Star... 现在我们创建一个.NET Core 3.0 项目,至于是mvc.Api.

  • ASP.NET Core 5中如何生成PDF文档

    ASP.NET Core 5中如何生成PDF文档

    前言 大家用 ASP.NET Core 进行项目开发时,常会有生成 PDF 的需求,那如何生成呢?这篇文章我们就来讨论如何通过 DinkToPdf 来生成 PDF 文档,DinkToPdf 封装了 C++ 的 wkhtmltopdf 工具包,前者通过 P/Invoke 的方式来调用后者,而底层的 wkhtmltopdf 利用 Qt WebKit 渲染引擎将 html 转成 pdf. 安装 DinkToPdf 要想安装 DinkToPdf,可以通过 Nuget 可视化界面或者通过 NuGet Pa

  • 详解Java生成PDF文档方法

    详解Java生成PDF文档方法

    最近项目需要实现PDF下载的功能,由于没有这方面的经验,从网上花了很长时间才找到相关的资料.整理之后,发现有如下几个框架可以实现这个功能. 1. 开源框架支持 iText,生成PDF文档,还支持将XML.Html文件转化为PDF文件: Apache PDFBox,生成.合并PDF文档: docx4j,生成docx.pptx.xlsx文档,支持转换为PDF格式. 比较: iText开源协议为AGPL,而其他两个框架协议均为Apache License v2.0. 使用PDFBox生成PDF就像画图

  • Django生成PDF文档显示网页上以及PDF中文显示乱码的解决方法

    项目地址:https://github.com/PythonerKK/django-generate-pdf/tree/master 这个demo实现了通过用户输入自己的个人信息生成一份简历pdf,来阐述如何使用Django的HttpResponse生成PDF的文档. 先上效果图: 安装依赖库 首先安装Django最新版2.2.2和PDF依赖包xhtml2pdf pip install django pip install xhtml2pdf 编写表单验证 为了简单起见,这个demo依赖数据库,

  • 手把手教你使用Java实现在线生成pdf文档

    手把手教你使用Java实现在线生成pdf文档

    目录 一.介绍 二.案例实现 2.1添加iText依赖包 2.2简单实现 2.3复杂实现 2.4变量替换方式 三.总结 一.介绍 在实际的业务开发的时候,研发人员往往会碰到很多这样的一些场景,需要提供相关的电子凭证信息给用户,例如网银/支付宝/微信购物支付的电子发票.订单的库存打印单.各种电子签署合同等等,以方便用户查看.打印或者下载. 例如下图的电子发票! 熟悉这块业务的童鞋,一定特别清楚,目前最常用的解决方案是:把相关的数据信息,通过一些技术手段生成对应的 PDF 文件,然后返回给用户,以便

  • SpringBoot+Thymeleaf实现生成PDF文档

    SpringBoot+Thymeleaf实现生成PDF文档

    目录 前言 一.引入依赖 二.application.yml配置 三.PDF相关配置 四.Controller 五.生成PDF文件响应效果 前言 温馨提示:本博客使用Thymeleaf模板引擎实现PDF打印仅供参考: 在阅读该博客之前,先要了解一下Thymeleaf模板引擎,因为是使用Thymeleaf模板引擎实现的PDF打印的, Thymeleaf是一个现代的服务器端 Java 模板引擎,适用于 Web 和独立环境. Thymeleaf 的主要目标是为您的开发工作流程带来优雅的自然模板——HT

  • C#编程简单实现生成PDF文档的方法示例

    本文实例讲述了C#编程简单实现生成PDF文档的方法.分享给大家供大家参考,具体如下: using System; using System.IO; using System.Text; using System.Collections; namespace PDFGenerator { public class PDFGenerator { static float pageWidth = 594.0f; static float pageDepth = 828.0f; static float

  • eclipse中自动生成javadoc文档的方法

    本文实例讲述了eclipse中自动生成javadoc文档的方法.分享给大家供大家参考.具体方法如下: 使用eclipse生成文档(javadoc)主要有三种方法: 1. 在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步. 在Javadoc Generation对话框中有两个地方要注意的: javadoc command:应该选择jdk的bin/javadoc.exe destination:为生成文档的保存路径,可自由选

  • Java 生成PDF文档的示例代码

    Java 生成PDF文档的示例代码

    最近项目需要实现PDF下载的功能,由于没有这方面的经验,从网上花了很长时间查找了相关的资料.整理之后,发现有几个框架可以实现这个功能. 1. 开源框架支持 iText,生成PDF文档,还支持将XML.Html文件转化为PDF文件: Apache PDFBox,生成.合并PDF文档: docx4j,生成docx文档,支持转换为PDF格式. 2. 实现方案 比较了一番后,采用了FreeMarker+docx4j+Apache PDFBox的方案: maven依赖 <!-- pdfbox --> &

  • PHP中使用TCPDF生成PDF文档实例

    实际工作中,我们要使用PHP动态的创建PDF文档,目前有许多开源的PHP创建PDF的类库,今天我给大家来介绍一款优秀的PDF库,它就是TCPDF,TCPDF是一个用于快速生成PDF文件的PHP5函数包.TCPDF基于FPDF进行扩展和改进,增强了实用功能. 特性 TCPDF具有以下特性: 1.支持页面页脚: 2.支持HTML标签代码: 3.支持jpg/png/gif/svg图形图像: 4.支持表格: 5.支持中文字符:(有些PDF类不支持中文或者处理中文相当麻烦) 6.自动分页,自动页码,等等.

随机推荐