如何集成 ComPDFKit 使用 Objective-C 创建 iOS 应用程序 ​

本节将为您提供逐步说明，帮助您快速开始使用 Objective-C 语言集成 ComPDFKit PDF SDK 创建 iOS 应用程序。总共包括以下步骤：

1. 创建一个新的 iOS 项目。

2. 将 ComPDFKit 集成到您的应用程序中。

3. 替换许可证密钥的 XML 文件。

4. 显示 PDF 文档。

用 Objective-C 语言创建一个新的 iOS 项目 ​

在本指南中，我们使用 Xcode 12.4 版本的开发环境创建一个新的 iOS 项目。

打开 Xcode，选择 File -> New -> Project...，然后选择 iOS -> Single View Application。点击 Next。

为您的新项目设置一些必要信息。请确保选择 Objective-C 作为开发语言。然后，点击 Next。

将项目保存到所需位置。然后，点击 Create。

将 ComPDFKit 集成到您的 App 中 ​

要将动态 xcframework “ComPDFKit.xcframework” 添加到 “PDFViewer” 项目中，请按照以下步骤操作：

1. 右键单击 “PDFViewer” 项目，如图所示，选择 Add Files to "PDFViewer"...。

   

   在下载包中找到并选择 “ComPDFKit.xcframework” ，然后点击 Add。

   注： 确保您选中了 Copy items if needed 选项。

   

   然后，“PDFViewer” 项目将如下图所示。

   

2. 将动态xcframework “ComPDFKit.xcframework” 添加到 Xcode 的 Embedded Binaries 中。左键单击项目，在 General 选项卡中找到 Embedded Binaries，并选择 Embed & Sign。

   

   对于较早的 Xcode 版本（如 Xcode 13），Bitcode 选项可能默认为打开状态，但这个选项需要关闭。下面的图片中显示了如何关闭 Bitcode 选项。

   

应用许可证密钥 ​

您可以联系ComPDFKit团队获取试用许可证。在使用任何 ComPDFKit PDF SDK 类之前，必须执行的操作是设置许可证密钥

1. 在 AppDelegate.m 中导入头文件 “ComPDFKit/ComPDFKit.h” 。

2. 按照以下代码，在 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 中调用CPDFKit verifyWithKey:@"LICENSE_KEY"方法。您需要用ComPDFKit销售团队给您的许可证替换 LICENSE_KEY 。

   objective-c

   #import <ComPDFKit/ComPDFKit.h>
   
   - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     // 在这里设置您的许可证密钥。ComPDFKit 是商业软件。
     // 每个 ComPDFKit 许可证都绑定到特定的应用程序包标识符。
     // com.compdfkit.pdfviewer
       
       [CPDFKit verifyWithKey:@"YOUR_LICENSE_KEY_GOES_HERE"];
       
       return YES;
   }

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   

编译并运行项目。如果控制台输出"version information"，则表示许可证设置成功。否则，请查看故障排除部分或在控制台中检查错误日志，快速识别和解决问题。

显示 PDF 文档 ​

到目前为止，我们已经将 “ComPDFKit.xcframework” 添加到 “PDFViewer” 项目中，并完成了 ComPDFKit PDF SDK 的初始化。现在，让我们开始使用几行代码构建一个简单的 PDF 阅读器。

1. 准备一个测试 PDF 文件，将其拖放到新创建的 PDFView 项目中。通过这种方式，您可以使用 NSBundle 加载并预览本地 PDF 文档。下图显示了将名为“Online5”的 PDF 文档导入到项目的示例。

   

2. 在您的 UIViewController.m 子类实现的顶部导入 <ComPDFKit/ComPDFKit.h>：

   objective-c

   #import <ComPDFKit/ComPDFKit.h>

   1
   

3. 通过 NSURL 创建一个 CPDFDocument 对象，并创建一个 CPDFView 来显示它。下面的代码展示了如何使用本地 PDF 文件路径加载PDF数据并通过 CPDFView 显示它。

   objective-c

   NSBundle *bundle  = [NSBundle mainBundle];
   NSString *pdfPath= [bundle pathForResource:@"Online5" ofType:@"pdf"];
   NSURL *url = [NSURL fileURLWithPath:pdfPath];
   CPDFDocument *document = [[CPDFDocument alloc] initWithURL:url];
   
   CGRect rect = self.view.bounds;
   CPDFView *pdfView = [[CPDFView alloc] initWithFrame:rect];
   pdfView.autoresizingMask = UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight;
   pdfView.document = document;

   1
   2
   3
   4
   5
   6
   7
   8
   9
   

4. 将创建的CPDFView添加到当前控制器的视图中。示例代码如下所示。

   objective-c

    [self.view addSubview:pdfView];

   1
   

   这里显示的代码是上面提到的步骤的集合:

   objective-c

   - (void)viewWillAppear:(BOOL)animated {
       [super viewWillAppear:animated];
       
       NSBundle *bundle  = [NSBundle mainBundle];
       NSString *pdfPath= [bundle pathForResource:@"Online5" ofType:@"pdf"];
       NSURL *url = [NSURL fileURLWithPath:pdfPath];
       CPDFDocument *document = [[CPDFDocument alloc] initWithURL:url];
   
       CGRect rect = self.view.bounds;
       CPDFView *pdfView = [[CPDFView alloc] initWithFrame:rect];
       pdfView.autoresizingMask = UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight;
       pdfView.document = document;
       [self.view addSubview:pdfView];
   }

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   

5. 连接您的设备或模拟器，使用快捷方式 Command_R 运行应用程序。PDF 文件将被打开并显示。

   

故障排除 ​

1. Bitcode

   即使所有配置都正确，仍可能出现编译错误。首先，请检查是否禁用了 Bitcode。在较早的 Xcode 版本（例如 Xcode 13）中，默认情况下会启用 Bitcode 选项。它需要设置为 No 才能运行应用程序。

2. 许可证

   如果出现许可证设置错误，请确保 General 中的 Identity（Bundle ID）设置与您在联系我们获取许可证时提供的 Bundle ID 匹配。如果出现过期的许可证消息，请联系ComPDFKit团队获取最新的许可证和密钥。

3. 无法在 i386 架构模拟器上运行

   Xcode 12.5 或更高版本的版本，不支持i386模拟器。苹果在转换为 ARM 处理器后放弃了 i386，并且不再维护i386架构模拟器。请使用 ARM 模拟器或 x86_64 架构模拟器来测试和开发您的程序。

   所以您需要在 TARGETS 的 Build Settings 中搜索 Excluded Architectures，然后双击它。会弹出一个弹出窗口，点击加号（如下图所示）来添加 i386。

   

4. 未显示 PDF

​ 检查我们传递的路径是否需要特殊编码，或者我们传递的本地路径是否存在。

5. 其他问题

​ 如果在集成我们的 ComPDFKit PDF SDK for iOS 时遇到其他问题，请随时联系ComPDFKit团队。