如何在ASP.NET Core 中快速构建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文档并且还可以完美适配相关逻辑和某些文档设置!!