Wkhtmltopdf.NetCore 项目教程

Wkhtmltopdf.NetCore 项目教程

Wkhtmltopdf.NetCore-deprecated Rotativa + Net Core 项目地址: https://gitcode.com/gh_mirrors/wk/Wkhtmltopdf.NetCore-deprecated

1. 项目介绍

Wkhtmltopdf.NetCore 是一个在 ASP.NET Core 环境中实现 wkhtmltopdf 库的项目。wkhtmltopdf 是一个用于将 HTML 页面转换为 PDF 文件的开源工具。Wkhtmltopdf.NetCore 项目使得在 Windows、Linux、macOS 以及 Docker 环境中使用 wkhtmltopdf 变得更加方便。

该项目已经被归档，但仍然可以作为参考和学习使用。

2. 项目快速启动

2.1 安装依赖

首先，你需要在你的项目中安装 Wkhtmltopdf.NetCore NuGet 包。你可以使用以下命令：

dotnet add package Wkhtmltopdf.NetCore --version 3.0.2

2.2 配置项目结构

在你的项目中，创建以下文件夹结构：

├── Example
│   ├── Example.csproj
│   └── Rotativa
│       ├── Linux
│       │   └── wkhtmltopdf
│       ├── Mac
│       │   └── wkhtmltopdf
│       └── Windows
│           └── wkhtmltopdf.exe
└── Example.sln

2.3 配置 Startup.cs

在 Startup.cs 文件的 ConfigureServices 方法中添加以下代码：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddWkhtmltopdf();
}

2.4 使用 Docker 容器

如果你使用的是 Microsoft 提供的 .NET Core Docker 容器，你需要在 Dockerfile 中添加以下内容：

FROM mcr.microsoft.com/dotnet/core/aspnet:3.1-buster-slim AS base
WORKDIR /app
RUN apt-get update -qq && apt-get -y install libgdiplus libc6-dev
EXPOSE 80

3. 应用案例和最佳实践

3.1 生成 PDF 文件

以下是一个简单的示例，展示如何使用 Wkhtmltopdf.NetCore 生成 PDF 文件：

public IActionResult GeneratePdf()
{
    var htmlContent = "<h1>Hello, World!</h1>";
    var pdfBytes = Wkhtmltopdf.NetCore.Wkhtmltopdf.Convert(htmlContent);
    return File(pdfBytes, "application/pdf", "output.pdf");
}

3.2 最佳实践

• 跨平台支持：确保在不同操作系统上测试你的应用，以确保 wkhtmltopdf 在所有环境中都能正常工作。
• 性能优化：对于大量 PDF 生成任务，考虑使用异步编程和批处理来提高性能。

4. 典型生态项目

4.1 Rotativa

Rotativa 是一个基于 wkhtmltopdf 的 ASP.NET MVC 项目，提供了更高级的功能和集成。虽然 Wkhtmltopdf.NetCore 主要针对 ASP.NET Core，但 Rotativa 的某些功能可以作为参考。

4.2 Docker 集成

Wkhtmltopdf.NetCore 提供了与 Docker 的集成，使得在容器化环境中部署和运行变得更加容易。你可以参考 Docker 官方文档和 Wkhtmltopdf.NetCore 的 Dockerfile 示例来进一步了解如何集成。

通过以上步骤，你应该能够快速上手并使用 Wkhtmltopdf.NetCore 项目生成 PDF 文件。

Wkhtmltopdf.NetCore-deprecated Rotativa + Net Core 项目地址: https://gitcode.com/gh_mirrors/wk/Wkhtmltopdf.NetCore-deprecated