介紹

通過AbilityAccessCtrl動態向用戶申請“允許不同設備間的數據交換”的權限，使用設備管理實例獲取周邊不可信設備列表。

說明： 查詢周邊不可信設備之前，請確保本設備與周邊設備未進行配對。如果已配對，則恢復出廠設置之后重新查詢。

相關概念

• [訪問控制權限申請]：應用的APL（Ability Privilege Level）等級分為normal、system_basic和system_core三個等級，默認情況下，應用的APL等級都為normal等級。權限類型分為system_grant和user_grant兩種類型。應用可申請的權限項參見應用權限列表。
• [權限類型說明]：根據授權方式的不同，權限類型可分為system_grant（系統授權）和user_grant（用戶授權）。
• [應用ALP等級說明]：元能力權限等級APL（Ability Privilege Level）指的是應用的權限申請優先級的定義，不同APL等級的應用能夠申請的權限等級不同。
• [應用權限列表]：在申請目標權限前，建議開發者先閱讀訪問控制開發概述-權限的工作流程。對權限的工作流程有基本的了解后，再結合以下權限的具體說明，判斷應用能否申請目標權限，提高開發效率。
• [設備管理實例]：用于獲取可信設備和本地設備的相關信息。在調用DeviceManager的方法前，需要先通過createDeviceManager構建一個DeviceManager實例dmInstance。

約束與限制

通過DevEco Studio自動下載的SDK均為public版本，public-SDK不支持開發者使用系統API。本篇Codelab使用的DeviceManager（設備管理實例）依賴于系統API，需下載full-SDK并替換工具自動下載的public-SDK。

相關權限

本篇Codelab需要在配置文件module.json5里添加允許不同設備間的數據交換權限：ohos.permission.DISTRIBUTED_DATASYNC。

環境搭建

軟件要求

• [DevEco Studio]版本：DevEco Studio 3.1 Release。
• OpenHarmony SDK版本：API version 9。

硬件要求

• 開發板類型：[潤和RK3568開發板]。
• OpenHarmony系統：3.2 Release。

環境搭建

完成本篇Codelab我們首先要完成開發環境的搭建，本示例以RK3568開發板為例，參照以下步驟進行：

1. [獲取OpenHarmony系統版本]：標準系統解決方案（二進制）。以3.2 Release版本為例：
   
2. 搭建燒錄環境。
   1. [完成DevEco Device Tool的安裝]
   2. [完成RK3568開發板的燒錄]
3. 搭建開發環境。
   1. 開始前請參考[工具準備]，完成DevEco Studio的安裝和開發環境配置。
   2. 開發環境配置完成后，請參考[使用工程向導]創建工程（模板選擇“Empty Ability”）。
   3. 工程創建完成后，選擇使用[真機進行調測]。
   4. 鴻蒙開發指導文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

代碼結構解讀

本篇Codelab只對核心代碼進行講解，對于完整代碼，我們會在gitee中提供。

├──entry/src/main/ets                      // 代碼區
│  ├──common
│  │  ├──constants
│  │  │  └──CommonConstants.ets            // 公共常量類
│  │  └──util
│  │     ├──DeviceListUtil.ets             // 設備查詢工具類
│  │     ├──Logger.ets                     // 日志管理工具類
│  │     └──PermissionUtil.ets             // 權限申請工具類
│  ├──entryability
│  │  └──EntryAbility.ts                   // 程序入口類
│  ├──pages
│  │  └──HomePage.ets                      // 主頁面
│  └──view
│     ├──DeviceBean.ets                    // 設備信息類
│     ├──DeviceItem.ets                    // 設備信息對象
│     ├──DeviceListDialog.ets              // 設備列表展示彈框
│     └──NoPermissionDialog.ets            // 無權限彈框
└──entry/src/main/resource                 // 應用靜態資源目錄

頁面設計

頁面分為授權圖片、授權說明、查詢內網設備按鈕三部分，效果如圖所示：

// HomePage.ets
struct HomePage {
  @State authorizedImage: Resource = $r('app.media.ic_unauthorized');
  @State permissionDescribe: Resource = $r('app.string.no_permission');
  noPermissionDialog: CustomDialogController = new CustomDialogController({
    builder: NoPermissionDialog(),
    autoCancel: false,
    alignment: DialogAlignment.Bottom,
    offset: {
      dx: CommonConstants.DIALOG_OFFSET_X,
      dy: CommonConstants.DIALOG_OFFSET_Y
    }
  });
  deviceListDialog: CustomDialogController = new CustomDialogController({
    builder: DeviceListDialog(),
    autoCancel: false,
    alignment: DialogAlignment.Bottom,
    offset: {
      dx: CommonConstants.DIALOG_OFFSET_X,
      dy: CommonConstants.DIALOG_OFFSET_Y
    }
  })
  ...
  build() {
    Column() {
      Image(this.authorizedImage)
        ...
      Text(this.permissionDescribe)
        ...
      Column() {
        Button($r('app.string.button_text'), { type: ButtonType.Capsule, stateEffect: true })
          ...
      }
      ...
    }
    ...
  }
}

授權狀態為未授權時，點擊查詢內網設備按鈕打開未申請權限提示的彈框，效果如圖所示：

// NoPermissionDialog.ets
@CustomDialog
export struct NoPermissionDialog {
  controller: CustomDialogController;
 
  build() {
    Column() {
      Text($r('app.string.no_permission_title'))
        ...
      Text($r('app.string.clear_permission'))
        ...
      Text($r('app.string.dialog_confirm'))
        ...
        .onClick(() = > {
          this.controller.close();
        })
    }
    ...
  }
}

授權狀態為已授權時，點擊查詢內網設備按鈕打開設備查詢列表彈框，效果如圖所示：

// DeviceListDialog.ets
@CustomDialog
export struct DeviceListDialog {
  private deviceListUtil: DeviceListUtil = new DeviceListUtil();
  @State deviceList: Array< DeviceBean > = [];
  controller: CustomDialogController;
  ...
  build() {
    Column() {
      Text($r('app.string.device_list'))
        ...
      Column() {
        if (this.deviceList.length === 0) {
          Text($r('app.string.no_device'))
            ...
        } else {
          Column() {
            List() {
              ForEach(this.deviceList, (item: DeviceBean, index: number) = > {
                ListItem() {
                  DeviceItem({item: item, index: index});
                }
              }, (item: DeviceBean) = > JSON.stringify(item))
            }
          }
          ...
        }
      }
      ...
      Text($r('app.string.dialog_confirm'))
        ...
        .onClick(() = > {
          this.deviceListUtil.stopDeviceDiscovery();
          this.controller.close();
        })
    }
    ...
  }
}

權限申請

首次進入主頁面彈出授權彈框，點擊禁止按鈕不會授權，點擊允許按鈕進行授權，再次進入首頁不會出現授權彈框。

// HomePage.ets
struct HomePage {
  ...
  async aboutToAppear() {
    let result = await PermissionUtil.applyPermission();
    if (result === 0) {
      this.permissionDescribe = $r('app.string.has_permission');
      this.authorizedImage = $r('app.media.ic_authorized');
    } else {
      this.permissionDescribe = $r('app.string.no_permission');
    }
  }
  ...
}

// PermissionUtil.ets
async applyPermission() {
  let atManager = abilityAccessCtrl.createAtManager();
  let data = await atManager.requestPermissionsFromUser(getContext(this), [CommonConstants.PERMISSION]);
  let grantStatus: Array< number > = data.authResults;
  let length: number = grantStatus.length;
  if (length === 0) {
    return 1;
  }
  return grantStatus[0];
}

主頁面點擊查詢內網設備按鈕時，先查詢是否授權，根據授權狀態打開對應的彈框（未授權：打開未授權彈框；已授權：打開設備查詢列表彈框）。

// HomePage.ets
struct HomePage {
  ...
  build() {
    Column() {
      ...
      Column() {
        Button($r('app.string.button_text'), { type: ButtonType.Capsule, stateEffect: true })
          ...
          .onClick(async () = > {
            let result = await PermissionUtil.checkPermission();
            if(result === abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED) {
              this.deviceListDialog.open();
            } else {
              this.noPermissionDialog.open();
            }
          })
      }
      ...
    }
    ...
  }
}

// PermissionUtil.ets
async checkPermission() {
  let atManager = abilityAccessCtrl.createAtManager();
  let grantStatus: abilityAccessCtrl.GrantStatus =  abilityAccessCtrl.GrantStatus.PERMISSION_DENIED;
  let tokenId: number = 0;
  try {
    let bundleInfo: bundleManager.BundleInfo =
      await bundleManager.getBundleInfoForSelf(bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION);
    let appInfo: bundleManager.ApplicationInfo = bundleInfo.appInfo;
    tokenId = appInfo.accessTokenId;
  } catch (err) {
    Logger.error(TAG, 'getBundleInfoForSelf failed, code is ${err.code}, message is ${err.message}');
  }
  try {
    grantStatus = await atManager.checkAccessToken(tokenId, CommonConstants.PERMISSION);
  } catch (err) {
    Logger.error(TAG, 'checkAccessToken failed, code is ${err.code}, message is ${err.message}');
  }
  return grantStatus;
}

設備查詢

先創建dmInstance實例，再注冊發現設備（deviceFoundOn）的回調方法，最后調用startDeviceDiscovery方法查詢周邊設備；當查詢到設備之后調用deviceFoundOn方法處理設備信息。

//DeviceListDialog.ets
export struct DeviceListDialog {
  ...
  aboutToAppear() {
    this.deviceListUtil.initDmInstance((data: DeviceInfoInterface) = > {
      ...
    });
  }
  ...
}

// DeviceListUtil.ets
// 創建dmInstance實例
initDmInstance(dealDeviceInfo: Function) {
  this.dealDeviceInfo = dealDeviceInfo;
  try {
    deviceManager.createDeviceManager(getContext(this).applicationInfo.name, (err, data) = > {
      if (err) {
        Logger.error(TAG, 'createDeviceManager errCode:' + err.code + ',errMessage:' + err.message);
        return;
      }
      this.dmInstance = data;
      this.deviceFoundOn();
      this.startDeviceDiscovery();
    });
  } catch (err) {
    Logger.error(TAG, 'createDeviceManager err=' + JSON.stringify(err));
  }
}

// DeviceListUtil.ets
// 注冊發現設備回調方法
deviceFoundOn() {
  try {
    if (this.dmInstance !== undefined) {
      this.dmInstance.on('deviceFound', (data) = > {
        if (this.dealDeviceInfo !== undefined) {
          this.dealDeviceInfo(data);
        }
      });
    }
  } catch (err) {
    Logger.error(TAG, 'deviceFoundOn err:' + JSON.stringify(err));
  }
}

// DeviceListUtil.ets
// 發現周邊設備方法
startDeviceDiscovery() {
  this.subscribeId = Math.floor(Math.random() * CommonConstants.RANDOM_ONE + CommonConstants.RANDOM_TWO);
  let subscribeInfo: SubscribeInfoInterface = {
    subscribeId: this.subscribeId,
    mode: CommonConstants.MODE,
    medium: 0,
    freq: CommonConstants.FREQ,
    isSameAccount: false,
    isWakeRemote: true,
    capability: 1
  };
  try {
    if (this.dmInstance !== undefined) {
      this.dmInstance.startDeviceDiscovery(subscribeInfo);
    }
  } catch (err) {
    Logger.error(TAG, 'startDeviceDiscovery err:' + JSON.stringify(err));
  }
}

審核編輯 黃宇