Flutter插件open_document的使用指南

open_document插件用于在用户的移动设备和桌面创建文件夹，并支持打开pdf、xlsx、docs、ppt和zip等文件类型。本文将详细介绍如何配置和使用该插件，包括完整的示例代码。

功能概述

• Android：文件保存在应用内部文档目录下。
• iOS：文件保存在应用名称下的文件中。
• Windows：文件保存在Documents目录下。

开始使用

Android配置

1. 在res目录下创建一个名为xml的文件夹。
2. 在xml文件夹内创建一个provider_paths.xml文件，内容如下：

<?xml version="1.0" encoding="utf-8"?>
<paths>
    <external-path
        name="external_files"
        path="." />
</paths>

1. 在AndroidManifest.xml中添加权限和Provider：

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

<provider
    android:name="androidx.core.content.FileProvider"
    android:authorities="com.example.open_document_example.fileprovider"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/provider_paths" />
</provider>

iOS配置

在info.plist中添加以下键值对以支持文件打开功能：

<key>LSSupportsOpeningDocumentsInPlace</key>
<true/>

使用方法

示例代码

以下是使用open_document插件的一个完整示例，展示了如何下载并打开一个PDF文件：

import 'package:dio/dio.dart';
import 'package:flutter/material.dart';
import 'package:open_document/open_document.dart';

void main() {
  runApp(MaterialApp(home: MyApp()));
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';

  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  Future<void> initPlatformState() async {
    final url = "https://fase.org.br/wp-content/uploads/2014/05/exemplo-de-pdf.pdf";
    final fileName = await OpenDocument.getNameFile(url: url);
    final filePath = await OpenDocument.getPathDocument() + '/' + fileName;

    final isExists = await OpenDocument.checkDocument(filePath: filePath);

    try {
      if (!isExists) {
        filePath = await downloadFile(filePath: filePath, url: url);
      }
      await OpenDocument.openDocument(filePath: filePath);
    } on OpenDocumentException catch (e) {
      print("ERROR: ${e.errorMessage}");
    }
  }

  Future<String> downloadFile({required String filePath, required String url}) async {
    Dio dio = Dio();
    await dio.download(
      url,
      filePath,
      onReceiveProgress: (received, total) {
        print('Download $received/$total');
      },
    );
    return filePath;
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('Plugin example app')),
        body: Center(child: Text('Running on: $_platformVersion\n')),
      ),
    );
  }
}

此示例展示了如何从网络下载文件并在本地打开它。请注意根据实际情况调整权限设置和文件路径。