• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 跨设备文件拷贝
2<!--Kit: Core File Kit-->
3<!--Subsystem: FileManagement-->
4<!--Owner: @wang_zhangjun; @zhuangzhuang-->
5<!--Designer: @wang_zhangjun; @zhuangzhuang; @renguang1116-->
6<!--Tester: @liuhonggang123; @yue-ye2; @juxiaopang-->
7<!--Adviser: @foryourself-->
8
9分布式文件系统为应用提供了跨设备文件拷贝的能力，开发者可以通过[基础文件接口](../reference/apis-core-file-kit/js-apis-file-fs.md)进行跨设备拷贝文件。例如：多设备数据流转的场景，设备组网互联之后，设备A上的应用可将沙箱文件拷贝到设备A的分布式目录下。设备B在粘贴时，从B设备的分布式目录下将文件拷贝到对应的沙箱文件中。
10
11## 开发步骤
12
131. 完成分布式组网。
14   将需要跨设备访问的两个设备登录同一账号，保证设备蓝牙和Wi-Fi功能开启，蓝牙无需互连，Wi-Fi无需接入同一个局域网。
15
162. 授权分布式数据同步权限。
17   分布式数据同步权限的授权方式为user_grant，因此需要调用requestPermissionsFromUser接口，以动态弹窗的方式向用户申请授权。示例中的context的获取方式请参见[获取UIAbility的上下文信息](../application-models/uiability-usage.md#获取uiability的上下文信息)。
18
19   ```ts
20   import { common, abilityAccessCtrl } from '@kit.AbilityKit';
21   import { BusinessError } from '@kit.BasicServicesKit';
22   // 请在组件内获取context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
23   let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
24   let atManager = abilityAccessCtrl.createAtManager();
25   try {
26     //以动态弹窗的方式向用户申请授权
27     atManager.requestPermissionsFromUser(context, ['ohos.permission.DISTRIBUTED_DATASYNC']).then((result) => {
28       console.info(`Request permission result: ${JSON.stringify(result)}`);
29     }).catch((err: BusinessError) => {
30       console.error(`Failed to request permissions from user. Code: ${err.code}, message: ${err.message}`);
31     })
32   } catch (error) {
33     let err: BusinessError = error as BusinessError;
34     console.error(`Catch err. Failed to request permissions from user. Code: ${err.code}, message: ${err.message}`);
35   }
36   ```
37
383. 执行跨设备文件拷贝操作。
39   同一应用在不同设备之间实现跨设备文件拷贝，只需要将对应的文件放在应用沙箱的分布式目录即可。
40
41   将A设备的待拷贝沙箱文件拷贝到A设备的分布式目录下。
42
43   ```ts
44   import { fileIo as fs } from '@kit.CoreFileKit';
45   import { common } from '@kit.AbilityKit';
46   import { BusinessError } from '@kit.BasicServicesKit';
47   import { fileUri } from '@kit.CoreFileKit';
48
49   // 请在组件内获取context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
50   let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
51   let pathDir: string = context.filesDir;
52   let distributedPathDir: string = context.distributedFilesDir;
53   // 待拷贝文件沙箱路径
54   let filePath: string = pathDir + '/src.txt';
55   try {
56    // 准备待拷贝沙箱文件
57    let file = fs.openSync(filePath, fs.OpenMode.CREATE | fs.OpenMode.READ_WRITE);
58    fs.writeSync(file.fd, 'Create file success');
59    fs.closeSync(file);
60   } catch (error) {
61    console.error(`Failed to createFile. Code: ${error.code}, message: ${error.message}`);
62   }
63
64   // 获取待拷贝源文件uri
65   let srcUri = fileUri.getUriFromPath(filePath);
66   // 获取目标路径(分布式目录)的uri
67   let destUri: string = fileUri.getUriFromPath(distributedPathDir + '/src.txt');
68   try {
69     // 将沙箱路径下的源文件拷贝到目标分布式目录下
70     fs.copy(srcUri, destUri).then(()=>{
71       console.info(`Succeeded in copying---. `);
72       console.info(`src: ${srcUri} dest: ${destUri}`);
73     }).catch((error: BusinessError)=>{
74       let err: BusinessError = error as BusinessError;
75       console.error(`Failed to copy. Code: ${err.code}, message: ${err.message}`);
76     })
77   } catch (error) {
78     console.error(`Catch err. Failed to copy. Code: ${error.code}, message: ${error.message}`);
79   }
80   ```
81
82   B设备在获取A设备沙箱文件时，从B设备的分布式目录下将对应的文件拷贝走，以此完成跨设备拷贝。
83
84   ```ts
85   import { fileIo as fs } from '@kit.CoreFileKit';
86   import { common } from '@kit.AbilityKit';
87   import { BusinessError } from '@kit.BasicServicesKit';
88   import { fileUri } from '@kit.CoreFileKit';
89   import { distributedDeviceManager } from '@kit.DistributedServiceKit';
90
91   // context是EntryAbility传过来的context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
92   let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
93   let pathDir: string = context.filesDir;
94   let distributedPathDir: string = context.distributedFilesDir;
95   // 待拷贝文件的目标路径(沙箱路径)
96   let destPath: string = pathDir + '/dest.txt';
97   // 获取目标路径uri
98   let destUri = fileUri.getUriFromPath(destPath);
99
100   // 拷贝源文件路径(分布式目录)
101   let srcPath = distributedPathDir + '/src.txt';
102   // 获取源路径uri
103   let srcUri: string = fileUri.getUriFromPath(srcPath);
104
105   // 定义拷贝回调
106   let progressListener: fs.ProgressListener = (progress: fs.Progress) => {
107     console.info(`progressSize: ${progress.processedSize}, totalSize: ${progress.totalSize}`);
108   };
109   let options: fs.CopyOptions = {
110     "progressListener" : progressListener
111   };
112   // 通过分布式设备管理的接口获取设备A的networkId信息
113   let dmInstance = distributedDeviceManager.createDeviceManager("com.example.hap");
114   let deviceInfoList: Array<distributedDeviceManager.DeviceBasicInfo> = dmInstance.getAvailableDeviceListSync();
115   if (deviceInfoList && deviceInfoList.length > 0) {
116    console.info(`success to get available device list`);
117    let networkId = deviceInfoList[0].networkId; // 这里只是两个设备连接，列表中首个即为A设备的networkId
118    // 定义访问分布式目录的回调
119    let listeners : fs.DfsListeners = {
120      onStatus: (networkId: string, status: number): void => {
121        console.error(`Failed to access public directory，${status}`);
122      }
123    };
124    // 开始跨设备文件拷贝
125    fs.connectDfs(networkId, listeners).then(()=>{
126      try {
127        // 将分布式目录下的文件拷贝到其他沙箱路径下
128        fs.copy(srcUri, destUri, options).then(()=>{
129          console.info(`Succeeded in copying from distribted path`);
130          console.info(`src: ${srcUri} dest: ${destUri}`);
131          fs.unlinkSync(srcPath); // 拷贝完成后清理分布式目录下的临时文件
132        }).catch((error: BusinessError)=>{
133          let err: BusinessError = error as BusinessError;
134          console.error(`Failed to copy. Code: ${err.code}, message: ${err.message}`);
135        })
136      } catch (error) {
137        console.error(`Catch err. Failed to copy. Code: ${error.code}, message: ${error.message}`);
138      }
139    }).catch((error: BusinessError) => {
140     let err: BusinessError = error as BusinessError;
141     console.error(`Failed to connect dfs. Code: ${err.code}, message: ${err.message}`);
142    });
143   }
144   ```
145
1464. 跨设备文件拷贝完成，断开链路。
147
148   ```ts
149   import { BusinessError } from '@kit.BasicServicesKit';
150   import { distributedDeviceManager } from '@kit.DistributedServiceKit'
151   import { fileIo as fs } from '@kit.CoreFileKit';
152
153   // 获取设备A的networkId
154   let dmInstance = distributedDeviceManager.createDeviceManager("com.example.hap");
155   let deviceInfoList: Array<distributedDeviceManager.DeviceBasicInfo> = dmInstance.getAvailableDeviceListSync();
156   if (deviceInfoList && deviceInfoList.length > 0) {
157    console.info(`Success to get available device list`);
158    let networkId = deviceInfoList[0].networkId; // 这里只是两个设备连接，列表中首个即为A设备的networkId
159    // 关闭跨设备文件拷贝
160    fs.disconnectDfs(networkId).then(() => {
161      console.info(`Success to disconnect dfs`);
162    }).catch((error: BusinessError) => {
163      let err: BusinessError = error as BusinessError;
164      console.error(`Failed to disconnect dfs. Code: ${err.code}, message: ${err.message}`);
165    })
166   }
167   ```