福昕开发者文档中心

示例 ​

示例工程简介 ​

福昕转换 SDK 对所有支持的开发语言库都提供了示例。示例存放在开发包的 examples 目录下。以下是示例目录结构:

examples/
├── simple_demo/              # 简单示例工程
│   ├── input_files/          # 示例使用的测试文件
│   ├── office2pdf/           # Office 转 PDF 示例代码 (仅Windows)
│   └── pdf2office/           # PDF 转 Office 示例代码
└── └── output_files/         # 转换后的文件输出目录

目录说明 ​

  • office2pdf: 包含将 Office 文件（docx、xlsx、pptx）转换为 PDF 文件的示例代码，目前仅支持 windows 平台。
  • pdf2office: 包含将 PDF 文件转换为 Office 文件（docx、xlsx、pptx）的示例代码。
  • input_files : 存放用于示例测试的原始 Office 和 PDF 文件。
  • output_files：示例运行后，转换生成的文件将保存在此目录子文件夹下，并以示例名称命名子文件夹。

运行准备 ​

开发环境配置 ​

为了确保您能够顺利编译和运行 SDK 示例工程，请根据您使用的开发语言配置相应的开发环境：

  • 福昕 Linux C/C++ SDK: camke ≥ 3.1, x86/x64 gcc ≥ 4.94, arm gcc ≥ 8.3
  • 福昕 Java SDK: JDK 版本 ≥ 1.8。
  • 福昕 .NETCore x64 SDK: .NETCore 运行时版本 ≥ 2.1。
  • 福昕 .NET Framework SDK:.NET Framework ≥ 4.0 。
  • 福昕 Python SDK: Python 2.7 或 Python 3.6-3.10
  • 福昕 Node.js SDK: Node.js 版本 8-20

系统支持 ​

关于操作系统版本、编译器要求等，请查看 环境配置指南 获取详细的信息。

运行示例 ​

不同平台的 SDK 开发语言库，其示例运行方式略有差异。

  • Windows C/C++ 和 .NET 库: 由于 SDK 未直接提供命令行运行程序，可使用 IDE（如 Visual Studio）打开并运行示例工程。
  • SDK 其他开发语言库: 可选择使用 SDK 提供的命令行运行程序、特定示例脚本或 IDE 运行示例。
  • Linux C++ 库: 还可选择 使用 CMake 和 Make 编译和运行示例。

以下介绍如何通过不同方式运行相关示例。

使用命令行运行示例 ​

\examples\simple_demo 目录下的示例，除 Python 和 NodeJS 示例工程外，其他有包含命令行运行程序的示例工程，都可以直接运行 .bat 或者 .sh 文件。

运行所有示例 ​

  • Windows 平台运行 RunDemo.bat all 或 RunDemo.bat all x86。
  • Linux 平台运行 RunDemo.sh all。

运行某个特定的示例 ​

  • Windows 平台运行 RunDemo.bat demo_name 或 RunDemo.bat demo_name x86。 比如，RunDemo.bat office2pdf x86 只运行 office2pdf 示例。
  • Linux 平台运行RunDemo.sh demo_name。

NOTE

  • 在 SDK 2.1 版本之前，Java 示例工程的命令行运行程序位于特定的示例目录下。因此，要运行某个示例，您需要先导航至该示例的目录。比如运行 pdf2office 的命令行程序，需要导航到 \examples\simple_demo\pdf2office 目录下执行。

运行 NodeJS 示例 ​

  1. 安装福昕转换 SDK NodeJS 模块：

    • 导航到项目根目录，执行下面命令
    js
    npm i @foxitsoftware/foxit-pdf-conversion-sdk-node

  2. 运行示例：

    • 导航到示例目录， 比如 \examples\simple_demo\office2pdf 或 \examples\simple_demo\pdf2office
    • 运行 node office2pdf.js 或 node pdf2office.js

运行 Python 示例 ​

以下内容将涵盖：

  • 安装 SDK Python 库
  • 配置 SDK Python 库
  • 运行 SDK Python 示例

安装 SDK Python 库 ​

python
pip install FoxitPDFConversionSDKPython3

配置 SDK Python 库 ​

为确保福昕 SDK Python 2.7 库在 Windows 或 Linux 平台正确运行，请根据您的 Python 版本（32 位或 64 位）执行相应的库文件拷贝操作。

Windows 用户：

  • 若使用 32 位 Python 2.7，请将 FoxitPDFConversionSDKPython2/x86_vc15/_fpdfconversionsdk.pyd 手动复制到 FoxitPDFConversionSDKPython2/目录下。
  • 若使用 64 位 Python 2.7，请将 FoxitPDFConversionSDKPython2/x64_vc15/_fpdfconversionsdk.pyd 手动复制到 FoxitPDFConversionSDKPython2/ 目录下。

Linux 用户：

  • 针对 32 位 Python 2.7，请将 FoxitPDFConversionSDKPython2/x86_vc15/_fpdfconversionsdk.so 手动复制到 FoxitPDFConversionSDKPython2/目录下。
  • 针对 64 位 Python 2.7，请将 FoxitPDFConversionSDKPython2/x64_vc15/_fpdfconversionsdk.so 手动复制到 FoxitPDFConversionSDKPython2/ 目录下。

或者，您可以通过运行 examples/simple_demo/rundemo_python.py 脚本实现库文件的自动拷贝。

运行 SDK Python 示例 ​


使用 Python 脚本运行示例 ​

rundemo_python.py 脚本封装了示例运行的配置和依赖处理，简化了示例的运行流程。

运行所有示例

python
cd examples/simple_demo/
python rundemo_python.py

运行某个特定示例

例如，运行 pdf2office 示例：

python
cd examples/simple_demo/
python rundemo_python.py pdf2office
直接运行示例脚本 ​

如果您已正确配置 Python 环境和依赖，可以直接运行示例脚本。以下命令演示如何运行 office2pdf 示例：

sh
cd examples/simple_demo/office2pdf/
python -u office2pdf.py

NOTE

  • Python 2.7 用户，参阅 配置 Python 库,确保库文件与 Python 版本对应。
  • Python 3 用户，如已安装 FoxitPDFSDKPython3 模块，可以直接运行示例脚本。

使用 Visual Studio 运行示例 ​

Windows 下，SDK 库通过 Visual Studio 编译后，会在 \examples\simple_demo\ 下生成 bin 文件夹，并在该文件夹下生成 .exe 可执行文件。可执行文件的名称取决于工程编译配置。

  1. 打开解决方案：

    • 在 \examples\simple_demo 文件夹下，根据您的 Visual Studio 版本，选择相应的解决方案文件（.sln）打开。
    • 若只想编译单个示例，直接双击示例工程文件夹下的 .vcxproj 文件，打开并生成该工程。

  2. 生成解决方案：

    • 在 Visual Studio 中，选择 生成 > 生成解决方案 菜单，编译示例工程。

  3. 运行示例： 编译成功后，可使用以下方法运行相应的示例。

    • 方法一：直接运行 .exe 文件
      • 导航到 bin 文件夹，双击生成的 .exe 可执行文件即可运行相应的示例。
    • 方法二：在 Visual Studio 中运行
      • 在 解决方案资源管理器 中，右键单击您想要运行的示例项目，并选择 设为启动项目。
      • 按 F5 键或点击 调试 -> 开始调试 运行示例。

  4. 查看输出：

    • 示例运行结果将在 Visual Studio 的 “输出” 窗口或控制台窗口中显示。

    NOTE

    若需查看详细的示例执行过程，请通过命令行运行。

    • 打开 cmd.exe，使用 cd 命令导航至 \examples\simple_demo\bin 目录，然后执行特定的 .exe 文件。

使用 Eclipse IDE 运行示例 ​

以下以 Java 示例为例，介绍如何在 Eclipse 中创建和运行 Java 工程示例。

  1. 创建 Java 工程并集成 SDK 库：
    • 在 Eclipse 中创建一个新的 Java 工程。
    • 将福昕转换 SDK 的 Java 库集成到该工程中。
  2. 拷贝示例 Java 文件：
    • 将需要运行的示例 Java 文件拷贝到工程的 src 目录下。
    • 例如，若运行 pdf2office 示例，则将 \examples\simple_demo\pdf2office 目录下的 pdf2office.java 文件拷贝至工程 src 目录。
  3. 配置输入输出路径：
    • 打开拷贝至 src 目录的 Java 文件，根据实际需求修改 output_path 和 input_path 变量。
    • 若使用示例代码中默认的测试文件，需指定绝对路径，指向 examples\simple_demo 目录下的 output_files 和 input_files 文件夹。
  4. 运行示例：
    • 在 Eclipse 中，右键单击工程，选择 Run As -> Java Application 运行示例。