如何在ASP.NET Core 中快速构建PDF文档

时间 2019-12-16

标签如何 asp.net asp core 快速构建 pdf 文档栏目 ASP 繁體版

原文原文链接

　　好比咱们须要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 类。

关于GlobalSettings类

它括了PDF文档的总体配置属性。咱们仅使用其中的几个属性来设置颜色模式，方向，纸张尺寸，文档标题等…但它还有还多属性。

关于ObjectSettings类

ObjectSettings由相关的PDF文档的内容的属性。所以，咱们能够配置页面计数器的可见性，页眉和页脚的格式，文档的正文内容（HtmlContent属性）或的Web设置。

HtmlContent属性是此类的很是重要的属性。它包含咱们生成的HTML模板，并显示PDF文档的主体。

WebSettings也很是重要，尤为是若是咱们有一个外部CSS文件来进行样式设置时。在此属性中，咱们能够配置文档的编码并提供CSS文件的路径。若是咱们检查此属性，咱们将发现更多能够配置的设置，例如PDF文档的背景，文字大小等等..

启动项目

经过路由定位到咱们的API中，重定向PDF打印界面。

　一切看起来都是那么完美，就这样咱们就能够轻松的在ASP.NET Core中构建PDF文档而且还能够完美适配相关逻辑和某些文档设置！！