1# 网络共享 2 3## 简介 4 5网络共享管理分享设备已有网络给其他连接设备，支持Wi-Fi热点共享、蓝牙共享和USB共享，同时提供网络共享状态、共享流量查询功能。 6 7> **说明：** 8> 为了保证应用的运行效率，大部分API调用都是异步的，对于异步调用的API均提供了callback和Promise两种方式，以下示例均采用callback函数，更多方式可以查阅[API参考](../reference/apis/js-apis-net-sharing.md)。 9 10## 基本概念 11 12- WIFI共享：通过WIFI热点共享网络。 13- 蓝牙共享：通过蓝牙共享网络。 14- USB共享：通过USB共享网络。 15 16## 约束 17 18- 开发语言：C++ JS 19- 系统：linux内核 20- 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 21 22## 场景介绍 23 24网络共享的典型场景有： 25 26- 开启网络共享 27- 停止网络共享 28- 获取共享网络的数据流量 29 30以下分别介绍具体开发方式。 31 32## 接口说明 33 34完整的JS API说明以及实例代码请参考：[网络共享](../reference/apis/js-apis-net-sharing.md)。 35 36| 类型 | 接口 | 功能说明 | 37| ---- | ---- | ---- | 38| ohos.net.sharing | function isSharingSupported(callback: AsyncCallback\<boolean>): void; | 获取当前系统是否支持网络共享，使用callback方式作为异步方法 | 39| ohos.net.sharing | function isSharing(callback: AsyncCallback\<boolean>): void; | 获取当前共享状态，使用callback方式作为异步方法 | 40| ohos.net.sharing | function startSharing(type: SharingIfaceType, callback: AsyncCallback\<void>): void; | 开启共享，type为共享类型，目前支持Wifi热点、蓝牙、USB，使用callback方式作为异步方法 | 41| ohos.net.sharing | function stopSharing(type: SharingIfaceType, callback: AsyncCallback\<void>): void; | 停止指定类型共享，type为共享类型，包括Wifi热点、蓝牙、USB，使用callback方式作为异步方法 | 42| ohos.net.sharing | function getStatsRxBytes(callback: AsyncCallback\<number>): void; | 获取共享接收数据量，单位KB，使用callback方式作为异步方法 | 43| ohos.net.sharing | function getStatsTxBytes(callback: AsyncCallback\<number>): void; | 获取共享发送数据量，单位KB，使用callback方式作为异步方法 | 44| ohos.net.sharing | function getStatsTotalBytes(callback: AsyncCallback\<number>): void; | 获取共享总数据流量，单位KB，使用callback方式作为异步方法 | 45| ohos.net.sharing | function getSharingIfaces(state: SharingIfaceState, callback: AsyncCallback\<Array\<string>>): void; | 获取指定状态的网卡名称，state为状态，包括正在共享、可共享、共享错误，使用callback方式作为异步方法 | 46| ohos.net.sharing | function getSharingState(type: SharingIfaceType, callback: AsyncCallback\<SharingIfaceState>): void; | 获取指定类型共享状态，type为类型，目前支持Wifi热点、蓝牙、USB，使用callback方式作为异步方法 | 47| ohos.net.sharing | function getSharableRegexes(type: SharingIfaceType, callback: AsyncCallback\<Array\<string>>): void; | 获取与指定类型匹配的网卡正则表达式列表，type为类型，目前支持Wifi热点、蓝牙、USB，使用callback方式作为异步方法 | 48| ohos.net.sharing | function on(type: 'sharingStateChange', callback: Callback\<boolean>): void; | 注册共享状态改变监听，返回网络共享的状态。 | 49| ohos.net.sharing | function off(type: 'sharingStateChange', callback?: Callback\<boolean>): void; | 注销共享状态改变监听，返回网络共享的状态。 | 50| ohos.net.sharing | unction on(type: 'interfaceSharingStateChange', callback: Callback\<{ type: SharingIfaceType, iface: string, state: SharingIfaceState }>): void; | 注册指定网卡共享状态改变监听 | 51| ohos.net.sharing | function off(type: 'interfaceSharingStateChange', callback?: Callback\<{ type: SharingIfaceType, iface: string, state: SharingIfaceState }>): void; | 注销指定网卡共享状态改变监听 | 52| ohos.net.sharing | function on(type: 'sharingUpstreamChange', callback: Callback\<NetHandle>): void; | 注册上行网卡改变监听 | 53| ohos.net.sharing | function off(type: 'sharingUpstreamChange', callback?: Callback\<NetHandle>): void; | 注销上行网卡改变监听 | 54 55## 开启网络共享 56 571. 从@ohos.net.sharing中导入sharing命名空间。 582. 注册监听共享状态的改变。 593. 调用startSharing方法，来开启指定类型共享。 604. 接收到共享状态开启的回调，开启共享成功。 61 62```js 63// 从@ohos.net.sharing中导入sharing命名空间 64import sharing from '@ohos.net.sharing' 65 66// 注册监听共享状态的改变 67sharing.on('sharingStateChange', (error, data) => { 68 console.log(JSON.stringify(error)); 69 console.log(JSON.stringify(data)); 70}); 71 72// 调用startSharing方法，来开启指定类型共享 73sharing.startSharing(sharing.SharingIfaceType.SHARING_WIFI, (error) => { 74 console.log(JSON.stringify(error)); 75}); 76``` 77 78## 停止网络共享 79 80### 开发步骤 81 821. 从@ohos.net.sharing中导入sharing命名空间。 832. 注册监听共享状态的改变。 843. 调用stopSharing方法，来停止指定类型共享。 854. 接收到共享状态关闭的回调，停止共享成功。 86 87```js 88// 从@ohos.net.sharing中导入sharing命名空间 89import sharing from '@ohos.net.sharing' 90 91// 注册监听共享状态的改变 92sharing.on('sharingStateChange', (error, data) => { 93 console.log(JSON.stringify(error)); 94 console.log(JSON.stringify(data)); 95}); 96 97// 调用stopSharing方法，来停止指定类型共享 98sharing.stopSharing(sharing.SharingIfaceType.SHARING_WIFI, (error) => { 99 console.log(JSON.stringify(error)); 100}); 101``` 102 103## 获取共享网络的数据流量 104 105### 开发步骤 106 1071. 从@ohos.net.sharing中导入sharing命名空间。 1082. 调用startSharing方法，来开启指定类型共享。 1093. 调用getStatsTotalBytes方法，来获取共享网络数据量。 1104. 调用stopSharing方法，来停止指定类型共享，共享网络数据量清零。 111 112```js 113// 从@ohos.net.sharing中导入sharing命名空间 114import sharing from '@ohos.net.sharing' 115 116// 调用startSharing方法，来开启指定类型共享 117sharing.startSharing(sharing.SharingIfaceType.SHARING_WIFI, (error) => { 118 console.log(JSON.stringify(error)); 119}); 120 121// 调用getStatsTotalBytes方法，来获取共享网络数据量 122sharing.getStatsTotalBytes((error, data) => { 123 console.log(JSON.stringify(error)); 124 console.log(JSON.stringify(data)); 125}); 126 127// 调用stopSharing方法，来停止指定类型共享，共享网络数据量清零 128sharing.stopSharing(sharing.SharingIfaceType.SHARING_WIFI, (error) => { 129 console.log(JSON.stringify(error)); 130}); 131 132// 再次调用getStatsTotalBytes方法，共享网络数据量已清零 133sharing.getStatsTotalBytes((error, data) => { 134 console.log(JSON.stringify(error)); 135 console.log(JSON.stringify(data)); 136}); 137``` 138