文档模板：v0.4.2

react-native-document-picker

本项目基于 react-native-document-picker 开发。

该第三方库的仓库已迁移至 Gitcode，且支持直接从 npm 下载，新的包名为：@react-native-ohos/react-native-document-picker 版本所属关系如下：

三方库名称	三方库版本（npm地址）	发布信息	支持RN版本	Autolink	编译API版本	社区基线版本	源码地址
@react-native-ohos/react-native-document-picker	~ 9.4.0	Gitcode Releases	0.82./0.84./0.86	是	API12+	9.3.1	master
@react-native-ohos/react-native-document-picker	~ 9.3.2	Gitcode Releases	0.77.*	否	API12+	9.3.1	br_rnoh0.77
@react-native-ohos/react-native-document-picker	~ 9.2.2	Gitcode Releases	0.72.*	是	API12+	9.2.0	br_rnoh0.72
@react-native-oh-tpl/react-native-document-picker	<= 9.2.0-0.0.2@deprecated	Github Releases(deprecated)	0.72.*	否	API12+	9.2.0	sig

简介

Document Picker 组件用于 React Native。
提供系统文件选择器功能，支持选择单个或多个文件、选择目录，并允许按文件类型进行筛选。

下载安装

进入工程目录并输入以下命令：

npm

npm install @react-native-ohos/react-native-document-picker

yarn

yarn add @react-native-ohos/react-native-document-picker

下面的代码展示了这个库的基本使用场景：

import React, { useState } from "react";
import { Text, TouchableOpacity, View, StyleSheet, Switch, ScrollView } from 'react-native';
import { pick, types, pickDirectory, pickSingle, DocumentPickerOptions } from 'react-native-document-picker';

const typeList = Object.keys(types);

interface MultiSelectProps {
  onSelectValue?: (val: string[]) => void
}

interface UiSelItem {
  label: keyof typeof types,
  selected: boolean,
  index: number
}

type DirType = 'documentDirectory' | 'cachesDirectory'

interface DirOpt {
  label: DirType,
  selected: boolean
}

const MultiSelect: React.FC<MultiSelectProps> = ({ onSelectValue }) => {

  const [typeUi, setTypeUi] = useState<UiSelItem[]>(typeList.map((val, index) => ({
    label: val as keyof typeof types,
    selected: false,
    index
  })))

  const onClickSelLabel = (val: typeof typeUi[0]) => {
    // 选择allfile不行选择其它的
    if (typeUi.find(t => t.label === 'allFiles')?.selected && val.label !== 'allFiles') {
      return;
    }
    let newList = [];
    if (val.label === 'allFiles') {
      newList = typeUi.map(s => {
        return s.label === 'allFiles' ? { ...s, selected: !s.selected } : { ...s, selected: false }
      })
    } else {
      newList = typeUi.map(s => {
        return val.index === s.index ? { ...s, selected: !s.selected } : { ...s }
      })
    }
    const extList = newList.filter(t => t.selected).map(t => types[t.label]).reduce((res, typeStr) => {
      res.push(...typeStr.split(' '))
      return res;
    }, [] as string[]);
    if (onSelectValue) {
      onSelectValue(extList)
    }
    setTypeUi(newList);
  }

  return <>
    <View style={{ display: 'flex', flexWrap: 'wrap', flexDirection: 'row', rowGap: 14 }}>
      <View style={{ width: '100%' }}>
        <Text style={{ fontSize: 20, fontWeight: '600', margin: 6 }}>picker 的文件类型</Text>
      </View>
      {
        typeUi.map((s:any) =>
          <TouchableOpacity key={s.label} onPress={() => {
            onClickSelLabel(s);
          }} >
            <View style={s.selected ? styles.selectBtnActive : styles.selectBtn} >
              <Text>
                {s.label}
              </Text>
            </View>
          </TouchableOpacity>
        )
      }
    </View>
  </>
}

export default function DocumentPickerDemo(): JSX.Element {

  const [pickResult, setPickResult] = useState('');
  // 是否允许多选
  const [allowMultiSelection, setAllowMultiSelection] = useState(true);
  // 选择文件类型
  const [fileTypes, setFileTypes] = useState<string[]>([]);
  // copyTo 文件夹
  const [dirUi, setDirui] = useState<Array<DirOpt>>([
    { label: 'documentDirectory', selected: false },
    { label: 'cachesDirectory', selected: false },
  ]);

  const copyTo = dirUi.find(d => d.selected)?.label;

  const pickOpt: DocumentPickerOptions<'harmony'> = {
    allowMultiSelection,
  };
  if (copyTo) {
    pickOpt.copyTo = copyTo;
  }
  if (fileTypes.length) {
    pickOpt.type = fileTypes;
  }

  const onDirSelect = (val: DirOpt) => {
    const newUiList = dirUi.map(d => {
      if (val.label === d.label) {
        return { ...d, selected: !d.selected }
      } else {
        return { ...d, selected: false }
      }
    });
    setDirui(newUiList);
  }

  const pickFile = async () => {
    try {
      const res = await pick(pickOpt);
      setPickResult(JSON.stringify(res));
    } catch (err) {
      console.log(err);
    }
  }

  const pickS = async () => {
    try {
      const res = await pickSingle(pickOpt);
      setPickResult(JSON.stringify(res));
    } catch (err) {
      console.log(err);
    }
  }

  const pickDir = async () => {
    const res = await pickDirectory();
    console.log(res);
  }

  return <ScrollView>
    <Text>
      {JSON.stringify(pickOpt)}
    </Text>

    <MultiSelect onSelectValue={setFileTypes}></MultiSelect>

    <View style={{ width: '100%' }}>
      <Text style={{ fontSize: 20, fontWeight: '600', margin: 6 }}>是否多选</Text>
    </View>

    <Switch value={allowMultiSelection} onValueChange={setAllowMultiSelection}></Switch>

    <View style={{ width: '100%' }}>
      <Text style={{ fontSize: 20, fontWeight: '600', margin: 6 }}>copyTo文件夹</Text>
    </View>

    <View style={{ display: 'flex', flexWrap: 'wrap', flexDirection: 'row', rowGap: 14 }}>
      {
        dirUi.map(s =>
          <TouchableOpacity key={s.label} onPress={() => {
            onDirSelect(s);
          }} >
            <View style={s.selected ? styles.selectBtnActive : styles.selectBtn} >
              <Text>
                {s.label}
              </Text>
            </View>
          </TouchableOpacity>
        )
      }
    </View>

    <TouchableOpacity onPress={pickFile} style={styles.btn}>
      <Text
        style={styles.btnText}>
        pick file
        </Text>
    </TouchableOpacity>
    <TouchableOpacity onPress={pickS} style={styles.btn}>
      <Text
        style={styles.btnText}>
        pick file single
        </Text>
    </TouchableOpacity>
    <TouchableOpacity onPress={pickDir} style={styles.btn}>
      <Text
        style={styles.btnText}>
        pick Dir
        </Text>
    </TouchableOpacity>
    <View style={{ width: '100%' }}>
      <Text style={{ fontSize: 20, fontWeight: '600', margin: 6 }}>选择结果</Text>
    </View>
    <Text>
      {pickResult}
    </Text>
  </ScrollView>
}

const styles = StyleSheet.create({
  TextInput: { height: 40, borderColor: '#ccc', borderWidth: 1, borderRadius: 4, width: '90%' },
  btn: { borderRadius: 10, display: 'flex', justifyContent: 'center', alignItems: 'center', padding: 10, margin: 10, backgroundColor: 'blue' },
  btnText: { fontWeight: 'bold', color: '#fff', fontSize: 20 },
  selectBtn: { padding: 8, margin: 3, fontSize: 18, borderWidth: 1, borderRadius: 8, borderColor: '#753c13' },
  selectBtnActive: { padding: 8, margin: 3, backgroundColor: '#e2803b', fontSize: 18, borderRadius: 8, borderWidth: 1 }
});

链接

	是否支持 Autolink	RN 框架版本
~9.4.0	是	0.82/0.84/0.86

使用 Autolink 的工程需要根据该文档进行配置，Autolink 框架指导文档：https://gitcode.com/CPF-RN/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md

如您使用的版本支持 Autolink，并且工程已接入 Autolink，可跳过 ManualLink 配置。

ManualLink：此步骤为手动配置原生依赖项的指导

首先需要使用 DevEco Studio 打开项目中的 HarmonyOS 工程 harmony。

覆盖 RN SDK 版本

为了让工程依赖同一版本的 RN SDK，需要在工程根目录的 harmony/oh-package.json5 中添加 overrides 字段，指向工程需要使用的 RN SDK 版本。替换的版本可以是一个具体的版本号，也可以是一个模糊版本，还可以是本地存在的 HAR 包或源码目录。

关于该字段的作用请阅读官方说明

{
  "overrides": {
    "@rnoh/react-native-openharmony": "^0.82.18" // ohpm 在线版本
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony.har" // 指向本地 har 包的路径
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony" // 指向源码路径
  }
}

引入原生端代码

目前有两种方法：

1. 通过 har 包引入；
2. 直接链接源码。

方法一：通过 har 包引入

打开 entry/oh-package.json5，添加以下依赖

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@react-native-ohos/react-native-document-picker": "file:../../node_modules/@react-native-ohos/react-native-document-picker/harmony/document_picker.har"
  }

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

配置 CMakeLists 和引入 DocumentPickerPackage

打开 entry/src/main/cpp/CMakeLists.txt，添加：

+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")

# RNOH_BEGIN: manual_package_linking_1
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/react-native-document-picker/src/main/cpp" ./document_picker)
# RNOH_END: manual_package_linking_1

# RNOH_BEGIN: manual_package_linking_2
+ target_link_libraries(rnoh_app PUBLIC rnoh_document_picker)
# RNOH_END: manual_package_linking_2

打开 entry/src/main/cpp/PackageProvider.cpp，添加：

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
+ #include "DocumentPickerPackage.h"

using namespace rnoh;

std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
    return {
      std::make_shared<RNOHGeneratedPackage>(ctx),
+     std::make_shared<DocumentPickerPackage>(ctx)
    };
}

打开 entry/src/main/ets/RNPackagesFactory.ts，添加：

  ...
+ import { DocumentPickerPackage } from '@react-native-ohos/react-native-document-picker/ts';

export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
  return [
    new SamplePackage(ctx),
+   new DocumentPickerPackage(ctx)
  ];
}

运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

使用此库时，请确保 React-Native 和 RNOH 的版本匹配，同时需搭配对应的 DevEco Studio 和手机 ROM。

以下版本已验证通过：

1. RNOH: 0.82.1; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM:6.0.0.120;
2. RNOH: 0.84.1; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM:6.0.0.120;
3. RNOH: 0.86.1; SDK: HarmonyOS 26.0.0 Release SDK; IDE: DevEco Studio 26.0.0 Release; ROM:7.0.0.100 SP9;

编译运行API要求

1. 本库通过引入 createStreamSync API，实现了基于文件路径同步创建文件流的功能。该 API 需在 API20+ 工程中编译，并在 API20+ ROM 上运行方可生效。

属性

option pick方法的传参选项

名称	参数类型	默认值	必填	平台	HarmonyOS平台支持	描述
allowMultiSelection	boolean	false	no	IOS/Android	yes	是否允许选择多个文件。对于 pick 方法，默认为 false。对于 pickSingle 方法，allowMultiSelection 固定为 false，不可覆盖。
type	string or Array	[types.allFiles]	no	IOS/Android	yes	允许选择的文件类型。可以是字符串数组或单个字符串。默认值为 [types.allFiles]。
copyTo	"cachesDirectory" | "documentDirectory"	/	no	IOS/Android	yes	将选中的文件复制到指定目录。
presentationStyle	'fullScreen' | 'pageSheet' | 'formSheet' | 'overFullScreen'	pageSheet	no	IOS	no	控制选择器的展示方式，例如在 iPad 上可能需要全屏展示。
transitionStyle	'coverVertical' | 'flipHorizontal' | 'crossDissolve' | 'partialCurl'	coverVertical	no	IOS	no	配置选择器的过渡动画样式。
mode	"import" | "open"	import	no	IOS	no	默认为 import。设置为 import 时，文档选择器会将文件从外部导入至应用沙盒；设置为 open 时，文档选择器将原地打开文件。

API

名称	类型	参数类型	返回值	必填	平台	OpenHarmony平台支持	描述
pick	function	DocumentPickerOptions	Promise<DocumentPickerResponse[]>	No	IOS/Android	yes	选择文件。
pickSingle	function	DocumentPickerOptions	Promise	No	IOS/Android	yes	选择单个文件。
pickDirectory	function	Pick<DocumentPickerOptions, 'presentationStyle' | 'transitionStyle'>	Promise<DirectoryPickerResponse | null>	No	IOS/Android	no	打开目录选择器。参数仅支持 presentationStyle 和 transitionStyle；在 iOS 上若用户取消可能返回 null。
isCancel	function	err: unknown	boolean	No	IOS/Android	yes	如果用户取消了文档选择器而未选择文件（在 Android 上按系统返回键，或在 iOS 上点击取消按钮），Promise 将被拒绝并返回一个取消错误。你可以使用 DocumentPicker.isCancel(err) 来检查此错误。鸿蒙端通过 err.message 判断取消错误（而非上游的 err.code）。
isInProgress	function	err: unknown	boolean	No	IOS/Android	yes	如果用户以某种方式打开了多个文件选择器（例如应用无响应时），则只有最后一个打开的选择器的结果会被采纳，之前打开的选择器的 Promise 将被拒绝并返回一个错误，你可以使用 DocumentPicker.isInProgress() 来检查此错误。鸿蒙端通过 err.message 判断进行中错误（而非上游的 err.code）。
releaseSecureAccess	function	string[]	Promise	No	IOS	no	如果 mode 设置为 open，iOS 会授予你访问沙盒外部文件的安全访问权限。在这种情况下，Apple 要求你在使用完资源后尽快释放该访问权限。
types	object	/	/	No	IOS/Android	yes	文件类型对象，例如 types.images、types.pdf。
perPlatformTypes	object	/	/	No	IOS/Android	yes	不同平台的文件类型对象映射。其中 perPlatformTypes.harmony 为鸿蒙平台的映射，使用文件扩展名（extensions）格式。

DocumentPickerResponse

名称	类型	描述
uri	string	选中文件的 URI。
name	string | null	文件名。
copyError	string（可选）	拷贝失败时的错误信息。
fileCopyUri	string | null	拷贝后文件的 URI。
type	string | null	文件的 MIME 类型。
size	number | null	文件大小（字节）。

DirectoryPickerResponse

名称	类型	描述
uri	string	选中目录的 URI。

遗留问题

• HarmonyOS 端file picker selectMode设置选文件夹无效: issue#1
• releaseSecureAccess选择沙箱路径外文件无法实现， HarmonyOS 暂无此能力接口: issue#2

其他

• 因权限问题无法读写图库资源，文件管理中从图库选择文件暂不支持。

目录结构

/rntpc_react-native-document-picker  # 项目根目录
├── harmony              # 鸿蒙适配代码
│    └─ document_picker.har          # har包
│    └─ document_picker                  # 鸿蒙适配核心代码
│          └─ Index.ets    # 鸿蒙适配代码入口    
│          └─ src/main/ets  
│              └─ DocumentPicker  # DocumentPicker组件   
├── src                  # RN代码
│    └─ index.tsx  # 入口文件 
│    └─ index.harmony.ts  # 鸿蒙入口文件
│    └─ NativeDocumentPicker.ts # 类型文件          
│    └─ fileTypes.ts # 文件类型          
├── README.md           # 中文安装使用方法    
├── README_en.md   # 英文安装使用方法                    

贡献代码

在使用过程中发现任何问题，均可提交 Issue，同时也非常欢迎提交 PR。

开源协议

本项目基于 The MIT License (MIT)，欢迎自由使用并积极参与开源共建。