51、Android 打印框架：HTML 与网页内容打印全解析

Android打印框架：HTML与网页打印解析

奶茶鉴定专家212

于 2025-08-10 11:32:43 发布

阅读量52

点赞数

CC 4.0 BY-SA版权

分类专栏：探索Android开发：从初学到精通文章标签： Android打印框架 HTML打印网页打印

本文链接：https://blog.youkuaiyun.com/gpt4scribbler/article/details/150457000

探索Android开发：从初学到精通专栏收录该内容

58 篇文章 ¥499.90

订阅专栏¥69.90

会员秒杀 ¥9.9 重磅福利

超级会员免费看

Android 打印框架：HTML 与网页内容打印全解析

1. Android 打印框架基础

Android 打印框架为开发者提供了在应用中实现打印功能的能力，打印输出可以导向合适配置的打印机、本地 PDF 文件，或者通过 Google Drive 上传至云端。下面我们来详细了解不同类型内容的打印方式。

1.1 打印动态 HTML 内容

打印动态 HTML 内容的核心在于确保 HTML 内容完全加载后再启动打印任务，避免因内容未加载完成而导致打印不完整。以下是具体步骤和代码示例：

// 在 printWebView 方法中创建 WebView 并加载 HTML 内容
private void printWebView() {
    WebView webView = new WebView(this);
    webView.setWebViewClient(new WebViewClient() { 
        public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
            return false;
        }

        @Override
        public void onPageFinished(WebView view, String url) {
            createWebPrintJob(view);
            myWebView = null;
        }
    }); 
    String htmlDocument = "<html><body><h1>Android Print Test</h1><p>This is some sample content.</p></body></html>";
    webView.loadDataWithBaseURL(null, htmlDocument, "text/HTML", "UTF-8", null);
    myWebView = webView;
}

// 创建打印任务的方法
private void createWebPrintJob(WebView webView) {
    PrintManager printManager = (PrintManager) this.getSystemService(Context.PRINT_SERVICE); 
    PrintDocumentAdapter printAdapter = webView.createPrintDocumentAdapter("MyDocument");
    String jobName = getString(R.string.app_name) + " Print Test";
    printManager.print(jobName, printAdapter, new PrintAttributes.Builder().build());
}

上述代码中， printWebView 方法创建了一个 WebView 实例，并为其设置了 WebViewClient 。 shouldOverrideUrlLoading 方法返回 false 表示 HTML 内容的加载由 WebView 处理。 onPageFinished 方法在 HTML 内容加载完成后被调用，触发 createWebPrintJob 方法启动打印任务。

createWebPrintJob 方法通过 PrintManager 获取打印服务，创建打印适配器，并设置打印任务的名称，最后调用 print 方法启动打印任务。

1.2 打印网页

打印网页的步骤与打印动态 HTML 内容类似，区别在于需要将网页的 URL 传递给 WebView 。以下是示例代码：

myWebView.loadUrl("https://developer.android.com/google/index.html");

如果希望网页加载完成后自动打印，需要配置 WebViewClient ；如果由用户在页面加载后通过菜单选项触发打印，则只需调用 createWebPrintJob 方法。

2. 自定义文档打印

对于更复杂的打印需求，Android 打印框架提供了自定义文档打印支持。自定义文档打印是一个多阶段的复杂过程，主要步骤如下：
1. 连接到 Android 打印管理器。
2. 创建一个继承自 PrintDocumentAdapter 类的自定义打印适配器。
3. 创建一个 PdfDocument 实例来表示文档页面。
4. 获取 PdfDocument 实例的页面引用，每个页面都关联一个 Canvas 实例。
5. 在页面画布上绘制内容。
6. 通知打印框架文档已准备好打印。

自定义打印适配器必须实现几个方法，其中最重要的是 onLayout 方法和 onWrite 方法。 onLayout 方法负责根据用户更改的设置（如纸张大小或页面方向）重新排列文档布局； onWrite 方法负责渲染要打印的页面。

3. 示例应用创建

为了更清晰地展示打印动态 HTML 内容和网页的方法，我们将创建两个示例应用。

3.1 创建 HTML 打印示例应用

创建 HTML 打印示例应用的步骤如下：
1. 从欢迎屏幕选择“New Project”选项。
2. 在新项目对话框中，选择“Empty Views Activity”模板，然后点击“Next”按钮。
3. 在“Name”字段输入“HTMLPrint”，并指定“com.ebookfrenzy.htmlprint”作为包名。
4. 在点击“Finish”按钮之前，将“Minimum API level”设置为“API 26: Android 8.0 (Oreo)”，并将“Language”菜单选择为“Java”。

3.2 创建网页打印示例应用

创建网页打印示例应用的步骤如下：
1. 从欢迎屏幕选择“New Project”选项。
2. 在新项目对话框中，选择“Basic Views Activity”模板，然后点击“Next”按钮。
3. 在“Name”字段输入“WebPrint”，并指定“com.ebookfrenzy.webprint”作为包名。
4. 在点击“Finish”按钮之前，将“Minimum API level”设置为“API 26: Android 8.0 (Oreo)”，并将“Language”菜单选择为“Java”。

4. 网页打印示例应用的详细操作

在网页打印示例应用中，我们还需要进行一些额外的操作，如移除不必要的组件、设计用户界面布局、加载网页和添加打印菜单选项。

4.1 移除浮动操作按钮

加载 activity_main.xml 布局文件到布局编辑器。
选择浮动操作按钮，然后按下键盘的“Delete”键将其从布局中移除。
编辑 MainActivity.java 文件，从 onCreate 方法中移除浮动操作按钮的代码。

4.2 移除导航功能

在项目工具窗口中，导航到 app -> res -> navigation -> nav_graph.xml 文件并双击加载到导航编辑器。
在编辑器中，选择 SecondFragment 条目并按下键盘的“Delete”键将其从图中移除。
定位并删除 SecondFragment.java 和 fragment_second.xml 文件。
定位 FirstFragment.java 文件，双击加载到编辑器，移除 onViewCreated 方法中的代码。
编辑 MainActivity.java 文件，移除导航代码。

4.3 设计用户界面布局

加载 content_main.xml 布局资源文件到布局编辑器。
在设计模式下，选择并删除 nav_host_fragment_content_main 对象。
从调色板的“Widgets”部分拖放一个 WebView 对象到设备屏幕布局的中心。
点击“推断约束”工具栏按钮，使用“属性”工具窗口将 WebView 的 layout_width 和 layout_height 属性设置为“match constraint”，使其填充整个布局画布。
选择新添加的 WebView 实例，将视图的 ID 更改为 myWebView 。
为项目添加 INTERNET 权限，编辑 AndroidManifest.xml 文件，添加以下代码：

<uses-permission android:name="android.permission.INTERNET" />

4.4 加载网页到 WebView

编辑 MainActivity.java 文件，在 onStart 方法中调用 configureWebView 方法加载网页：

@Override
protected void onStart() {
    super.onStart();
    configureWebView();
}

private void configureWebView() {
    myWebView = findViewById(R.id.myWebView);
    myWebView.setWebViewClient(new WebViewClient(){
        @Override
        public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
            return super.shouldOverrideUrlLoading(view, request);
        }
    });
    myWebView.loadUrl("https://www.answertopia.com"); 
}

4.5 添加打印菜单选项

编辑 strings.xml 文件，添加一个新的字符串资源：

<string name="print_string">Print</string>

加载 menu_main.xml 文件到菜单编辑器，切换到代码模式，将“Settings”菜单选项替换为打印选项：

<menu xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    tools:context="com.ebookfrenzy.webprint.MainActivity" >
    <item
         android:id="@+id/action_settings"
        android:title="@string/action_settings"
        android:orderInCategory="100"
        app:showAsAction="never" />

    <item
        android:id="@+id/action_print"
        android:orderInCategory="100"
        app:showAsAction="never"         
        android:title="@string/print_string"/>
</menu>

编辑 MainActivity.java 文件，修改 onOptionsItemSelected 方法：

@Override
public boolean onOptionsItemSelected(MenuItem item) {
    int id = item.getItemId();
    if (id == R.id.action_print) {
        createWebPrintJob(myWebView);
        return true;
    }
    return super.onOptionsItemSelected(item);
}

5. 总结

Android 打印框架为开发者提供了丰富的打印功能，包括打印动态 HTML 内容、网页和自定义文档。通过合理运用这些功能，开发者可以满足不同用户的打印需求。在实际开发中，需要根据具体需求选择合适的打印方式，并注意处理可能出现的问题，如内存管理和权限设置。

通过以上步骤和代码示例，你可以在 Android 应用中实现打印动态 HTML 内容和网页的功能。希望这篇文章对你有所帮助，祝你在 Android 开发中取得成功！

下面是打印动态 HTML 内容和网页的步骤对比表格：
| 打印类型 | 创建项目模板 | 加载内容方式 | 打印触发方式 |
| ---- | ---- | ---- | ---- |
| 动态 HTML 内容 | Empty Views Activity | 使用 loadDataWithBaseURL 方法加载 HTML 字符串 | HTML 内容加载完成后自动触发 |
| 网页 | Basic Views Activity | 使用 loadUrl 方法加载网页 URL | 用户选择菜单选项触发 |

以下是打印动态 HTML 内容的流程图：

graph TD;
    A[创建 WebView] --> B[设置 WebViewClient];
    B --> C[加载 HTML 内容];
    C --> D{HTML 内容是否加载完成};
    D -- 是 --> E[调用 createWebPrintJob 方法];
    D -- 否 --> C;
    E --> F[启动打印任务];

Android 打印框架：HTML 与网页内容打印全解析

6. 代码实现细节分析

在前面的示例中，我们已经看到了打印动态 HTML 内容和网页的具体代码实现。下面我们对这些代码进行更深入的分析。

6.1 打印动态 HTML 内容代码分析

private void printWebView() {
    WebView webView = new WebView(this);
    webView.setWebViewClient(new WebViewClient() { 
        public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
            return false;
        }

        @Override
        public void onPageFinished(WebView view, String url) {
            createWebPrintJob(view);
            myWebView = null;
        }
    }); 
    String htmlDocument = "<html><body><h1>Android Print Test</h1><p>This is some sample content.</p></body></html>";
    webView.loadDataWithBaseURL(null, htmlDocument, "text/HTML", "UTF-8", null);
    myWebView = webView;
}

private void createWebPrintJob(WebView webView) {
    PrintManager printManager = (PrintManager) this.getSystemService(Context.PRINT_SERVICE); 
    PrintDocumentAdapter printAdapter = webView.createPrintDocumentAdapter("MyDocument");
    String jobName = getString(R.string.app_name) + " Print Test";
    printManager.print(jobName, printAdapter, new PrintAttributes.Builder().build());
}

WebViewClient 的作用 ： shouldOverrideUrlLoading 方法返回 false ，表示 HTML 内容的加载由 WebView 本身处理。 onPageFinished 方法在 HTML 内容加载完成后被调用，确保打印任务在内容准备好后才启动。
内存管理 ：将 WebView 实例的引用存储在 myWebView 变量中，防止 Java 运行时系统进行垃圾回收，避免打印任务提前终止。
打印任务创建 ： createWebPrintJob 方法中，通过 PrintManager 获取打印服务，创建打印适配器，并设置打印任务的名称，最后调用 print 方法启动打印任务。

6.2 网页打印代码分析

@Override
protected void onStart() {
    super.onStart();
    configureWebView();
}

private void configureWebView() {
    myWebView = findViewById(R.id.myWebView);
    myWebView.setWebViewClient(new WebViewClient(){
        @Override
        public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
            return super.shouldOverrideUrlLoading(view, request);
        }
    });
    myWebView.loadUrl("https://www.answertopia.com"); 
}

@Override
public boolean onOptionsItemSelected(MenuItem item) {
    int id = item.getItemId();
    if (id == R.id.action_print) {
        createWebPrintJob(myWebView);
        return true;
    }
    return super.onOptionsItemSelected(item);
}

网页加载 ：在 configureWebView 方法中，通过 loadUrl 方法将网页 URL 加载到 WebView 中。
打印触发 ：用户选择菜单选项时，调用 createWebPrintJob 方法启动打印任务。

7. 常见问题及解决方案

在使用 Android 打印框架时，可能会遇到一些常见问题，下面我们来介绍一些解决方案。

7.1 内存管理问题

如果没有正确管理 WebView 实例的引用，Java 运行时系统可能会进行垃圾回收，导致打印任务提前终止。解决方案是将 WebView 实例的引用存储在一个变量中，确保在打印任务完成之前不会被回收。

7.2 权限问题

如果应用需要访问网络来加载网页，需要在 AndroidManifest.xml 文件中添加 INTERNET 权限：

<uses-permission android:name="android.permission.INTERNET" />

7.3 构建错误

在构建项目时，可能会遇到错误，如“Duplicate class kotlin.collections.jdk8.CollectionsJDK8Kt found in modules kotlin - stdlib”。可以通过修改 build.gradle.kts (Module: app) 文件来解决。

8. 扩展应用场景

除了打印动态 HTML 内容和网页，Android 打印框架还可以应用于其他场景。

8.1 打印图片

可以将图片加载到 WebView 中，然后使用打印框架进行打印。以下是示例代码：

private void printImage() {
    WebView webView = new WebView(this);
    String imageHtml = "<html><body><img src='file:///sdcard/Pictures/image.jpg' /></body></html>";
    webView.loadDataWithBaseURL(null, imageHtml, "text/HTML", "UTF-8", null);
    webView.setWebViewClient(new WebViewClient() {
        @Override
        public void onPageFinished(WebView view, String url) {
            createWebPrintJob(view);
        }
    });
}

8.2 打印报表

可以生成包含数据表格和图表的 HTML 报表，然后使用打印框架进行打印。这在企业应用中非常有用，例如打印销售报表、库存报表等。

9. 总结与展望

通过本文的介绍，我们了解了 Android 打印框架的基本功能，包括打印动态 HTML 内容、网页、自定义文档、图片和报表等。在实际开发中，需要根据具体需求选择合适的打印方式，并注意处理可能出现的问题。

未来，随着 Android 系统的不断发展，打印框架可能会提供更多的功能和更好的性能。例如，支持更多的打印格式、优化打印质量和速度等。开发者可以持续关注 Android 官方文档，以获取最新的打印框架信息。

以下是网页打印的流程图：

graph TD;
    A[创建 WebView] --> B[设置 WebViewClient];
    B --> C[加载网页 URL];
    C --> D{网页是否加载完成};
    D -- 是 --> E{用户是否选择打印菜单选项};
    D -- 否 --> C;
    E -- 是 --> F[调用 createWebPrintJob 方法];
    E -- 否 --> D;
    F --> G[启动打印任务];

下面是不同打印场景的对比表格：
| 打印场景 | 特点 | 适用情况 |
| ---- | ---- | ---- |
| 动态 HTML 内容打印 | 内容动态生成，加载完成后自动打印 | 展示临时生成的信息 |
| 网页打印 | 通过 URL 加载网页，用户手动触发打印 | 打印网页上的信息 |
| 自定义文档打印 | 可绘制文本和图形，流程复杂 | 有复杂打印需求 |
| 图片打印 | 将图片加载到 WebView 中打印 | 打印本地图片 |
| 报表打印 | 生成 HTML 报表后打印 | 企业数据报表打印 |

希望本文能够帮助你更好地理解和使用 Android 打印框架，在实际开发中实现各种打印需求。如果你在使用过程中遇到问题，欢迎在评论区留言讨论。