Android自定义文档打印开发指南

邬颖舒

于 2025-06-04 09:07:02 发布

阅读量368

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00374/article/details/148416654

Android自定义文档打印开发指南

android-training-course-in-chinese Android官方培训课程中文版项目地址: https://gitcode.com/gh_mirrors/an/android-training-course-in-chinese

在Android应用开发中，打印功能是一个经常被需要的特性。对于需要精确控制打印输出的应用（如绘图应用、报表工具等），系统提供的标准打印功能可能无法满足需求。本文将详细介绍如何在Android应用中实现自定义文档打印功能。

打印框架概述

Android打印框架提供了一套完整的API，允许开发者将应用内容输出到打印机。框架支持三种主要打印方式：

图片打印：直接打印位图图像
HTML文档打印：打印网页内容
自定义文档打印：完全控制打印内容和布局

当需要实现复杂排版、多页文档或特殊格式时，自定义文档打印是最佳选择。

打印流程实现

1. 初始化打印任务

打印流程的第一步是获取PrintManager实例并启动打印任务：

private void startPrintJob() {
    // 获取打印管理器
    PrintManager printManager = (PrintManager) getActivity()
            .getSystemService(Context.PRINT_SERVICE);
    
    // 设置打印任务名称（显示在打印队列中）
    String jobName = getActivity().getString(R.string.app_name) + " Document";
    
    // 启动打印任务，传入自定义的PrintDocumentAdapter
    printManager.print(jobName, new CustomPrintDocumentAdapter(getActivity()), null);
}

2. 实现打印适配器

自定义打印的核心是继承PrintDocumentAdapter类并实现关键回调方法：

public class CustomPrintDocumentAdapter extends PrintDocumentAdapter {
    private Context mContext;
    private PrintedPdfDocument mPdfDocument;
    
    public CustomPrintDocumentAdapter(Context context) {
        mContext = context;
    }
    
    @Override
    public void onLayout(PrintAttributes oldAttributes,
                       PrintAttributes newAttributes,
                       CancellationSignal cancellationSignal,
                       LayoutResultCallback callback,
                       Bundle metadata) {
        // 实现文档布局计算
    }
    
    @Override
    public void onWrite(PageRange[] pageRanges,
                       ParcelFileDescriptor destination,
                       CancellationSignal cancellationSignal,
                       WriteResultCallback callback) {
        // 实现文档写入操作
    }
}

3. 计算文档布局

在onLayout()方法中，我们需要完成以下工作：

创建PDF文档对象
响应取消请求
计算总页数
返回文档信息

@Override
public void onLayout(PrintAttributes oldAttributes,
                   PrintAttributes newAttributes,
                   CancellationSignal cancellationSignal,
                   LayoutResultCallback callback,
                   Bundle metadata) {
    // 创建PDF文档
    mPdfDocument = new PrintedPdfDocument(mContext, newAttributes);
    
    // 检查是否取消
    if (cancellationSignal.isCancelled()) {
        callback.onLayoutCancelled();
        return;
    }
    
    // 计算页数（根据打印方向不同）
    int pages = calculatePageCount(newAttributes);
    
    if (pages > 0) {
        // 创建文档信息
        PrintDocumentInfo info = new PrintDocumentInfo
                .Builder("output.pdf")
                .setContentType(PrintDocumentInfo.CONTENT_TYPE_DOCUMENT)
                .setPageCount(pages)
                .build();
        callback.onLayoutFinished(info, true);
    } else {
        callback.onLayoutFailed("计算页数失败");
    }
}

4. 页面内容绘制

在onWrite()方法中，我们需要：

遍历所有页面
检查每页是否在输出范围内
绘制页面内容
完成PDF文件写入

@Override
public void onWrite(PageRange[] pageRanges,
                   ParcelFileDescriptor destination,
                   CancellationSignal cancellationSignal,
                   WriteResultCallback callback) {
    try {
        // 遍历所有页面
        for (int i = 0; i < totalPages; i++) {
            if (isInRange(pageRanges, i)) {
                PdfDocument.Page page = mPdfDocument.startPage(i);
                
                // 检查取消
                if (cancellationSignal.isCancelled()) {
                    callback.onWriteCancelled();
                    mPdfDocument.close();
                    mPdfDocument = null;
                    return;
                }
                
                // 绘制页面内容
                drawPageContent(page);
                
                mPdfDocument.finishPage(page);
            }
        }
        
        // 写入文件
        mPdfDocument.writeTo(new FileOutputStream(
                destination.getFileDescriptor()));
        
        callback.onWriteFinished(new PageRange[]{PageRange.ALL_PAGES});
        
    } catch (IOException e) {
        callback.onWriteFailed(e.toString());
    } finally {
        if (mPdfDocument != null) {
            mPdfDocument.close();
            mPdfDocument = null;
        }
    }
}

5. 页面内容绘制实现

页面内容绘制使用Canvas API，与普通View绘制类似：

private void drawPageContent(PdfDocument.Page page) {
    Canvas canvas = page.getCanvas();
    
    // 单位是点（1/72英寸）
    int titleBaseLine = 72; // 1英寸
    int leftMargin = 54;    // 0.75英寸
    
    Paint paint = new Paint();
    paint.setColor(Color.BLACK);
    
    // 绘制标题
    paint.setTextSize(36);
    canvas.drawText("文档标题", leftMargin, titleBaseLine, paint);
    
    // 绘制正文
    paint.setTextSize(11);
    canvas.drawText("这里是文档正文内容...", leftMargin, titleBaseLine + 25, paint);
    
    // 绘制图形
    paint.setColor(Color.BLUE);
    canvas.drawRect(100, 100, 172, 172, paint);
}