构建一个功能基础的 PDF 阅读器（PDFViewCtrl）

本文介绍如何基于 PDFViewCtrl 构建一个功能基础的 PDF 阅读器（展示、缩放、翻页等基础交互），不包含 UI Extensions 的内置工具栏与功能模块。

前置条件

请先完成集成福昕 Android SDK（含工程创建、SDK 集成与授权初始化）。

步骤 1：使用 `PDFViewCtrl` 打开并显示 PDF

在 MainActivity.java 中实例化 PDFViewCtrl，并调用 PDFViewCtrl.openDoc() 打开文档。

注意请确保已将 Sample.pdf 推送到设备/模拟器的 FoxitSDK 目录中。

java

package com.foxit.pdfreader;

import android.os.Bundle;
import android.os.Environment;

import androidx.appcompat.app.AppCompatActivity;

import com.foxit.sdk.PDFViewCtrl;
import com.foxit.sdk.common.Constants;
import com.foxit.sdk.common.Library;

public class MainActivity extends AppCompatActivity {

    private PDFViewCtrl pdfViewCtrl = null;

    // The value of "sn" can be found in the "rdk_sn.txt".
    // The value of "key" can be found in the "rdk_key.txt".
    private static String sn = " ";
    private static String key = " ";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // initialize the library.
        int errorCode = Library.initialize(sn, key);
        if (errorCode != Constants.e_ErrSuccess)
            return;

        pdfViewCtrl = new PDFViewCtrl(this);

        setContentView(pdfViewCtrl);
        String path = Environment.getExternalStorageDirectory().getPath() + "/FoxitSDK/Sample.pdf";
        pdfViewCtrl.openDoc(path, null);
    }
}

提示上述 package com.foxit.pdfreader; 为示例包名，请替换为您工程实际包名（与 applicationId 保持一致）。

步骤 2：申请运行时存储权限（示例代码）

如果您通过外部存储路径（如 /sdcard/FoxitSDK/...）读取文件，需要按不同 Android 版本申请相应权限。下面给出一份可直接参考的运行时权限处理代码片段（请将其加入 MainActivity.java 中对应位置）。

2.1 添加 import 与常量

java

import android.Manifest;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.net.Uri;
import android.os.Build;
import android.provider.Settings;

import androidx.core.app.ActivityCompat;
import androidx.core.content.ContextCompat;
import androidx.annotation.NonNull;

private static final int REQUEST_EXTERNAL_STORAGE = 1;

private static final int REQUEST_ALL_FILES_ACCESS_PERMISSION = 222;

private static final String[] PERMISSIONS_STORAGE = {
        Manifest.permission.READ_EXTERNAL_STORAGE,
        Manifest.permission.WRITE_EXTERNAL_STORAGE
};

2.2 在 `onCreate()` 中发起权限请求

java

// Require the authorization of runtime permissions.
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
    if (!Environment.isExternalStorageManager()) {
        Intent intent = new Intent(Settings.ACTION_MANAGE_APP_ALL_FILES_ACCESS_PERMISSION);
        intent.setData(Uri.parse("package:" + getApplicationContext().getPackageName()));
        startActivityForResult(intent, REQUEST_ALL_FILES_ACCESS_PERMISSION);
        return;
    }
} else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M){
    int permission = ContextCompat.checkSelfPermission(this.getApplicationContext(), Manifest.permission.WRITE_EXTERNAL_STORAGE);
    if (permission != PackageManager.PERMISSION_GRANTED) {
        ActivityCompat.requestPermissions(this, PERMISSIONS_STORAGE, REQUEST_EXTERNAL_STORAGE);
        return;
    }
}

2.3 处理授权回调并打开文档

java

@Override
public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
    if (requestCode == REQUEST_EXTERNAL_STORAGE && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
        // Open and Render a PDF document.
        String path = Environment.getExternalStorageDirectory().getPath() + "/FoxitSDK/Sample.pdf";
        pdfViewCtrl.openDoc(path, null);
    } else {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults);
    }
}

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    if (requestCode == REQUEST_ALL_FILES_ACCESS_PERMISSION) {
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
            if (Environment.isExternalStorageManager()) {
                String path = Environment.getExternalStorageDirectory().getPath() + "/FoxitSDK/Sample.pdf";
                pdfViewCtrl.openDoc(path, null);
            }
        }
    }
}

参考实现：`MainActivity.java`

下面代码可直接对照的 MainActivity.java 示例（包含 PDFViewCtrl 初始化、运行时权限申请与文档打开）：

[MainActivity.java]

java

package com.foxit.pdfreader;

import android.Manifest;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.net.Uri;
import android.os.Build;
import android.os.Bundle;
import android.os.Environment;
import android.provider.Settings;

import androidx.appcompat.app.AppCompatActivity;
import androidx.core.app.ActivityCompat;
import androidx.core.content.ContextCompat;
import androidx.annotation.NonNull;

import com.foxit.sdk.PDFViewCtrl;
import com.foxit.sdk.common.Constants;
import com.foxit.sdk.common.Library;


public class MainActivity extends AppCompatActivity {

    private PDFViewCtrl pdfViewCtrl = null;
    private static final int REQUEST_EXTERNAL_STORAGE = 1;
    private static final int REQUEST_ALL_FILES_ACCESS_PERMISSION = 222;
    private static final String[] PERMISSIONS_STORAGE = {
            Manifest.permission.READ_EXTERNAL_STORAGE,
            Manifest.permission.WRITE_EXTERNAL_STORAGE
    };

    // The value of "sn" can be found in the "rdk_sn.txt".
    // The value of "key" can be found in the "rdk_key.txt".
    private static String sn = " ";
    private static String key = " ";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Initialize the library.
        int errorCode = Library.initialize(sn, key);
        if (errorCode != Constants.e_ErrSuccess)
            return;

        // Instantiate a PDFViewCtrl object.
        pdfViewCtrl = new PDFViewCtrl(this);
        setContentView(pdfViewCtrl);

        // Require the authorization of runtime permissions.
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
            if (!Environment.isExternalStorageManager()) {
                Intent intent = new Intent(Settings.ACTION_MANAGE_APP_ALL_FILES_ACCESS_PERMISSION);
                intent.setData(Uri.parse("package:" + getApplicationContext().getPackageName()));
                startActivityForResult(intent, REQUEST_ALL_FILES_ACCESS_PERMISSION);
                return;
            }
        } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M){
            int permission = ContextCompat.checkSelfPermission(this.getApplicationContext(), Manifest.permission.WRITE_EXTERNAL_STORAGE);
            if (permission != PackageManager.PERMISSION_GRANTED) {
                ActivityCompat.requestPermissions(this, PERMISSIONS_STORAGE, REQUEST_EXTERNAL_STORAGE);
                return;
            }
        }

        // Open and Render a PDF document.
        String path = Environment.getExternalStorageDirectory().getPath() + "/FoxitSDK/Sample.pdf";
        pdfViewCtrl.openDoc(path, null);
    }

    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
        if (requestCode == REQUEST_EXTERNAL_STORAGE && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
            // Open and Render a PDF document.
            String path = Environment.getExternalStorageDirectory().getPath() + "/FoxitSDK/Sample.pdf";
            pdfViewCtrl.openDoc(path, null);
        } else {
            super.onRequestPermissionsResult(requestCode, permissions, grantResults);
        }
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        if (requestCode == REQUEST_ALL_FILES_ACCESS_PERMISSION) {
            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
                if (Environment.isExternalStorageManager()) {
                    String path = Environment.getExternalStorageDirectory().getPath() + "/FoxitSDK/Sample.pdf";
                    pdfViewCtrl.openDoc(path, null);
                }
            }
        }
    }
}

步骤 3：更新 `AndroidManifest.xml`（Android 10 兼容说明）

当您在 Android 10（API 29） 设备/模拟器上运行工程，并且使用外部存储路径访问文件时，可能需要在 AndroidManifest.xml 中加入 android:requestLegacyExternalStorage="true"，以请求 legacy storage mode。

示例（节选）：

xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="com.foxit.pdfreader">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:requestLegacyExternalStorage="true"
        tools:replace="android:theme"
        android:theme="@style/Theme.PDFReader">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

文档基础

内容处理

文本搜索

书签

注释

构建一个功能基础的 PDF 阅读器（PDFViewCtrl）

前置条件

步骤 1：使用 `PDFViewCtrl` 打开并显示 PDF

步骤 2：申请运行时存储权限（示例代码）

2.1 添加 import 与常量

2.2 在 `onCreate()` 中发起权限请求

2.3 处理授权回调并打开文档

参考实现：`MainActivity.java`

步骤 3：更新 `AndroidManifest.xml`（Android 10 兼容说明）

构建一个功能基础的 PDF 阅读器（PDFViewCtrl） ​

前置条件 ​

步骤 1：使用 PDFViewCtrl 打开并显示 PDF ​

步骤 2：申请运行时存储权限（示例代码） ​

2.1 添加 import 与常量 ​

2.2 在 onCreate() 中发起权限请求 ​

2.3 处理授权回调并打开文档 ​

参考实现：MainActivity.java ​

步骤 3：更新 AndroidManifest.xml（Android 10 兼容说明） ​

构建一个功能基础的 PDF 阅读器（PDFViewCtrl）

前置条件

步骤 1：使用 `PDFViewCtrl` 打开并显示 PDF

步骤 2：申请运行时存储权限（示例代码）

2.1 添加 import 与常量

2.2 在 `onCreate()` 中发起权限请求

2.3 处理授权回调并打开文档

参考实现：`MainActivity.java`

步骤 3：更新 `AndroidManifest.xml`（Android 10 兼容说明）