Rotativa AspNetCore 使用教程

Rotativa AspNetCore 使用教程

Rotativa.AspNetCoreRotativa for Asp.Net Core 项目地址:https://gitcode.com/gh_mirrors/ro/Rotativa.AspNetCore

项目介绍

Rotativa AspNetCore 是一个用于在 ASP.NET Core 应用程序中生成 PDF 文件的开源项目。它基于 wkhtmltopdf 工具，可以将 HTML 页面转换为 PDF 文件。Rotativa AspNetCore 提供了简单易用的 API，使得在 ASP.NET Core 项目中生成 PDF 变得非常方便。

项目快速启动

安装 Rotativa AspNetCore

首先，你需要通过 NuGet 安装 Rotativa AspNetCore 包。你可以在 Visual Studio 的 Package Manager Console 中运行以下命令：

Install-Package Rotativa.AspNetCore -Version 1.3.2

配置 Rotativa AspNetCore

在你的 ASP.NET Core 项目中，打开 Program.cs 文件，并添加以下配置代码：

using Rotativa.AspNetCore;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.UseRotativa();

app.Run();

确保你有一个包含 wkhtmltopdf.exe 文件的文件夹，并且该文件夹对运行 Web 应用的进程是可访问的。默认情况下，Rotativa 会在项目的根目录下搜索名为 "Rotativa" 的文件夹。

生成 PDF

在你的控制器中，你可以使用 ViewAsPdf 方法来生成 PDF 文件：

using Rotativa.AspNetCore;
using Microsoft.AspNetCore.Mvc;

public class HomeController : Controller
{
    public IActionResult PrintViewToPdf()
    {
        return new ViewAsPdf("Index")
        {
            FileName = "TestView.pdf"
        };
    }
}

应用案例和最佳实践

应用案例

Rotativa AspNetCore 可以用于各种需要生成 PDF 文件的场景，例如：

• 生成发票和收据
• 生成报告和报表
• 生成合同和协议

最佳实践

• 确保 wkhtmltopdf 文件路径正确：在配置 Rotativa 时，确保 wkhtmltopdf.exe 文件的路径是正确的，并且对 Web 应用进程是可访问的。
• 优化 HTML 和 CSS：为了生成高质量的 PDF 文件，确保你的 HTML 和 CSS 代码是优化的，并且兼容 wkhtmltopdf 工具。
• 处理大文件生成：如果需要生成大文件，考虑使用异步处理和缓存机制，以避免阻塞 Web 应用的性能。

典型生态项目

Rotativa AspNetCore 可以与其他 ASP.NET Core 项目和工具集成，例如：

• ASP.NET Core MVC：Rotativa AspNetCore 可以与 ASP.NET Core MVC 项目无缝集成，用于生成视图的 PDF 文件。
• Entity Framework Core：可以使用 Entity Framework Core 从数据库中获取数据，并在视图中显示，然后使用 Rotativa 生成 PDF 文件。
• Razor Pages：Rotativa AspNetCore 也支持 Razor Pages，可以用于生成 Razor 页面的 PDF 文件。

通过这些集成，你可以构建功能强大的 Web 应用，满足各种生成 PDF 文件的需求。

Rotativa.AspNetCoreRotativa for Asp.Net Core 项目地址:https://gitcode.com/gh_mirrors/ro/Rotativa.AspNetCore