在 Android 上使用机器学习套件实现文档扫描器

使用机器学习套件文档扫描器 API 可轻松向您的应用添加文档扫描器功能。

功能 详细信息
SDK 名称 play-services-mlkit-document-scanner
实现 模型、扫描逻辑和界面流程由 Google Play 服务动态下载。
对应用大小的影响 下载大小增加约 300 KB。
初始化时间 用户可能需要等待模型、逻辑和界面流程下载完毕，然后才能首次使用。

试试看

请试用示例应用，了解此 API 的使用示例。

准备工作

  1. 请务必在项目级 build.gradle 文件中的 buildscript 和 allprojects 部分添加 Google 的 Maven 代码库。

  2. 将机器学习套件文档扫描器库的依赖项添加到模块的应用级 Gradle 文件（通常为 app/build.gradle）：

dependencies {
   // …
   implementation 'com.google.android.gms:play-services-mlkit-document-scanner:16.0.0-beta1'
}

文档扫描器配置

SDK 提供文档扫描器用户体验流程（包括专用取景器屏幕和预览屏幕）。取景器和预览屏幕支持以下可自定义控件：

  • 从图库导入
  • 设置扫描的页面数量限制
  • 扫描器模式（用于控制流程中的功能集）

您可以检索扫描的文件的 PDF 和 JPEG 文件。

实例化 GmsDocumentScannerOptions 以配置扫描器选项：

Kotlin

val options = GmsDocumentScannerOptions.Builder()
    .setGalleryImportAllowed(false)
    .setPageLimit(2)
    .setResultFormats(RESULT_FORMAT_JPEG, RESULT_FORMAT_PDF)
    .setScannerMode(SCANNER_MODE_FULL)
    .build()

Java

GmsDocumentScannerOptions options = new GmsDocumentScannerOptions.Builder()
    .setGalleryImportAllowed(false)
    .setPageLimit(2)
    .setResultFormats(RESULT_FORMAT_JPEG, RESULT_FORMAT_PDF)
    .setScannerMode(SCANNER_MODE_FULL)
    .build();

扫描文档

创建 GmsDocumentScannerOptions 后，获取 GmsDocumentScanner 的实例。然后，您可以按照 AndroidX 中引入的 Activity Result API 启动扫描器 activity。

文档扫描完成后，GmsDocumentScanningResult 对象将根据通过 setResultFormats 定义的内容，提供对扫描的页面数量、JPEG 格式图片的 URI 和 PDF 的访问权限：

Kotlin

val scanner = GmsDocumentScanning.getClient(options)
val scannerLauncher = registerForActivityResult(StartIntentSenderForResult()) {
  result -> {
    if (result.resultCode == RESULT_OK) {
      val result =
        GmsDocumentScanningResult.fromActivityResultIntent(result.data)
      result.getPages()?.let { pages ->
        for (page in pages) {
          val imageUri = pages.get(0).getImageUri()
        }
      }
      result.getPdf()?.let { pdf ->
        val pdfUri = pdf.getUri()
        val pageCount = pdf.getPageCount()
      }
    }
  }
}

scanner.getStartScanIntent(activity)
  .addOnSuccessListener { intentSender ->
     scannerLauncher.launch(IntentSenderRequest.Builder(intentSender).build())
   }
  .addOnFailureListener {
    ...
  }

Java

GmsDocumentScanner scanner = GmsDocumentScanning.getClient(options);
ActivityResultLauncher<IntentSenderRequest> scannerLauncher =
  registerForActivityResult(
    new StartIntentSenderForResult(),
      result -> {
        if (result.getResultCode() == RESULT_OK) {
          GmsDocumentScanningResult result = GmsDocumentScanningResult.fromActivityResultIntent(result.getData());
          for (Page page : result.getPages()) {
            Uri imageUri = pages.get(0).getImageUri();
          }

          Pdf pdf = result.getPdf();
          Uri pdfUri = pdf.getUri();
          int pageCount = pdf.getPageCount();
        }
      });

scanner.getStartScanIntent(activity)
  .addOnSuccessListener(intentSender ->
    scannerLauncher.launch(new IntentSenderRequest.Builder(intentSender).build()))
  .addOnFailureListener(...);

提升效果的提示

请注意，生成文档文件需要时间和处理能力，因此请仅请求您实际需要的输出格式（JPEG 或 PDF，或两者兼有）。