鴻蒙動態權限申請完整規范流程和操作詳解
作者：軟通夏德旺
文章由鴻蒙社區產出，想要了解更多內容請前往：51CTO和華為官方戰略合作共建的鴻蒙技術社區https://harmonyos.51cto.com
好久沒有寫博客了，正好今天HarmonyOS發布會，看完激動人心的發布會之后，還是覺得需要寫些東西。本來準備分享之前自己做的分布式流轉的視頻播放器的，但是分布式流轉開發內容已經有好多博主發表過了，于是搜了下社區內容，發現動態權限申請這塊的內容沒人發布，并且發現有幾篇博客的動態權限申請的代碼過于簡單存在漏洞。于是想著把這塊內容整理整理發出來。
一、權限概述
已在config.json文件中聲明的非敏感權限，非敏感權限不涉及用戶的敏感數據或危險操作，會在應用安裝時自動授予，該類權限的授權方式為系統授權(system_grant)。
敏感權限需要應用動態申請，通過運行時發送彈窗的方式請求用戶授權，該類權限的授權方式為用戶授權(user_grant)。
非敏感權限代碼編寫比較簡單，這里就不做講解。本文只講解敏感權限如何編寫代碼，即動態權限申請流程。
二、敏感權限列表
敏感權限的申請需要按照動態申請流程向用戶申請授權。
三、采用一個簡單的相冊案例演示動態權限申請開發流程
相冊需要讀取本機存儲的權限，即ohos.permission.READ_USER_STORAGE，它屬于敏感權限。
1、項目效果圖以及操作場景展示
(1)首次安裝app，用戶需要讀取相冊數據時，會彈出對話框提醒用戶授權。
點擊"允許"之后才能正常加載數據。
(2)如果點擊禁止，并且沒有勾選"禁止授權并且禁止后續再彈框提示"，那么下次打開app時依然會進行彈框提示。
(3)如果點擊禁止，并且勾選了"禁止授權并且禁止后續再彈框提示"，那么后續也不會再繼續彈框進行授權了，也就看不到數據。如果需要進行授權的話，需要用戶自行去系統設置中手動更改權限。此時我們應該在頁面上友好地使用toast提醒用戶去系統設置中手動更改權限。
請記住我現在描述的3種操作場景，與后續編寫代碼緊密相關，有些開發者編寫代碼一行代碼就搞定了動態授權操作，那樣的代碼只能滿足我說的第一種使用場景，后面兩種無法滿足，使用起來非常不友好。
2、代碼編寫步驟
(1)配置config.json
首先在config.json的module中添加如下配置：
- "reqPermissions": [
- {
- "name": "ohos.permission.READ_USER_STORAGE",
- "reason": "$string:permreason_storage",
- "usedScene":
- {
- "ability": ["com.xdw.album.MainAbility"],
- "when": "always"
- }
- }
- ]
權限申請格式采用數組格式，可支持同時申請多個權限，權限個數最多不能超過1024個。
reqPermissions權限申請字段說明如下表
(2)編寫權限彈框觸發代碼
此步驟需要結合自己項目實際業務邏輯編寫，本相冊項目是在主頁面打開的時候就觸發了權限的申請，因此修改MainAbilitySlice代碼，在onStart的時候就去進行校驗，具體代碼如下
- if (verifySelfPermission("ohos.permission.READ_USER_STORAGE") != IBundleManager.PERMISSION_GRANTED) {
- // 應用未被授予權限
- if (canRequestPermission("ohos.permission.READ_USER_STORAGE")) {
- // 是否可以申請彈框授權(首次申請或者用戶未選擇禁止且不再提示)
- requestPermissionsFromUser(
- new String[] { "ohos.permission.READ_USER_STORAGE" } , MY_PERMISSIONS_REQUEST_READ_USER_STORAGE);
- } else {
- // 顯示應用需要權限的理由，提示用戶進入設置授權
- new ToastDialog(getContext()).setText("請進入系統設置進行授權").show();
- }
- } else {
- // 權限已被授予
- //加載顯示系統相冊中的照片
- showPhotos();
- }
這斷代碼還使用到了一個自定義的常量MY_PERMISSIONS_REQUEST_READ_USER_STORAGE，需要提前定義它，代碼如下：
- public static final int MY_PERMISSIONS_REQUEST_READ_USER_STORAGE = 0; //自定義的一個權限請求識別碼，用于處理權限回調
第一行首先調用系統方法verifySelfPermission校驗權限是否已被授予，如果未授予則調用系統方法canRequestPermission查詢該權限是否可以申請彈框授權，因為如果用戶之前如果勾選了禁止授權并且禁止后續再彈框提示，那么就不能再進行彈框授權了，此時需要toast提示引導用戶自行去系統設置中手動更改權限。如果可以申請彈框授權，則調用系統方法requestPermissionsFromUser進行彈框授權(應用上的彈框就是來自這個方法)。如果之前應用已經被授權過，則直接調用業務處理方法，這里自定義的業務處理方法是showPhotos，它的代碼請見后面完整MainAbilitySlice代碼。
此時還缺少一個在授權彈框上點擊允許授權按鈕之后的回調業務邏輯處理，該回調業務邏輯需要重寫onRequestPermissionsFromUserResult方法，而該方法是Ability類的方法，而不是AbilitySlice類的方法。因此需要在MainAbility中重寫該方法，然后在該重寫方法中調用MainAbilitySlice對象中的showPhotos方法，這個就涉及到了MainAbility與MainAbilitySlice的通信。
關于MainAbility與MainAbilitySlice的通信的具體講解請看我另外一篇博文，這里不在做詳解。
(3)編寫requestPermissionsFromUser的回調
該回調只能在Ability種進行編寫，因此修改MainAbility的代碼，核心代碼如下：
- @Override
- public void onRequestPermissionsFromUserResult(int requestCode, String[] permissions, int[] grantResults) {
- super.onRequestPermissionsFromUserResult(requestCode, permissions, grantResults);
- switch (requestCode) {
- case MY_PERMISSIONS_REQUEST_READ_USER_STORAGE: {
- // 匹配requestPermissions的requestCode
- if (grantResults.length > 0
- && grantResults[0] == IBundleManager.PERMISSION_GRANTED) {
- // 權限被授予之后做相應業務邏輯的處理
- mainAbilitySlice.showPhotos();
- } else {
- // 權限被拒絕
- new ToastDialog(getContext()).setText("權限被拒絕").show();
- }
- return;
- }
- }
- }
這里對requestCode進行了判斷，它就是我們之前自定義的權限申請碼，用來區分我們在多個地方進行權限申請的操作，能區分每次不同請求的回調。
四、常見操作誤區
(1)只用一行簡單代碼進行動態權限申請，而沒有提前校驗權限和回調的過程
- requestPermissionsFromUser(
- new String[] { "ohos.permission.READ_USER_STORAGE" } , MY_PERMISSIONS_REQUEST_READ_USER_STORAGE);
這種情況就會出現萬一有一次禁止了權限，后面就不會顯示相冊數據并且沒人任何提示，影響用戶體驗。
(2)canRequestPermission代碼邏輯沒有編寫
該邏輯代碼不編寫，就會出現用戶點擊了"禁止授權并且禁止后續再彈框提示",然后進入頁面就不會顯示相冊數據并且沒人任何提示，影響用戶體驗。
因此，為了加強用戶體驗，請不要省略上述動態權限申請的代碼編寫流程。
五、完整代碼
MainAbilitySlice的代碼如下：
- package com.xdw.album.slice;
- import com.xdw.album.MainAbility;
- import com.xdw.album.ResourceTable;
- import ohos.aafwk.ability.AbilitySlice;
- import ohos.aafwk.ability.DataAbilityHelper;
- import ohos.aafwk.ability.DataAbilityRemoteException;
- import ohos.aafwk.content.Intent;
- import ohos.agp.components.Component;
- import ohos.agp.components.Image;
- import ohos.agp.components.TableLayout;
- import ohos.agp.components.Text;
- import ohos.agp.window.dialog.ToastDialog;
- import ohos.bundle.IBundleManager;
- import ohos.data.resultset.ResultSet;
- import ohos.hiviewdfx.HiLog;
- import ohos.hiviewdfx.HiLogLabel;
- import ohos.media.image.ImageSource;
- import ohos.media.image.PixelMap;
- import ohos.media.image.common.Size;
- import ohos.media.photokit.metadata.AVStorage;
- import ohos.utils.net.Uri;
- import java.io.FileDescriptor;
- import java.io.FileNotFoundException;
- import java.util.ArrayList;
- public class MainAbilitySlice extends AbilitySlice {
- private static final String TAG = "MainAbilitySlice";
- private static final HiLogLabel LABEL = new HiLogLabel(HiLog.DEBUG, 0, "TAG");
- public static final int MY_PERMISSIONS_REQUEST_READ_USER_STORAGE = 0; //自定義的一個權限請求識別碼，用于處理權限回調
- private TableLayout tlAlbum; //定義表格布局,用來加載圖片控件
- private Text textLoading, textNum; //定義正在加載文本，照片數量顯示文本
- @Override
- public void onStart(Intent intent) {
- super.onStart(intent);
- super.setUIContent(ResourceTable.Layout_ability_main);
- MainAbility mainAbility = (MainAbility) getAbility();
- mainAbility.setMainAbilitySlice(this);
- initView();
- if (verifySelfPermission("ohos.permission.READ_USER_STORAGE") != IBundleManager.PERMISSION_GRANTED) {
- // 應用未被授予權限
- if (canRequestPermission("ohos.permission.READ_USER_STORAGE")) {
- // 是否可以申請彈框授權(首次申請或者用戶未選擇禁止且不再提示)
- requestPermissionsFromUser(
- new String[] { "ohos.permission.READ_USER_STORAGE" } , MY_PERMISSIONS_REQUEST_READ_USER_STORAGE);
- } else {
- // 顯示應用需要權限的理由，提示用戶進入設置授權
- new ToastDialog(getContext()).setText("請進入系統設置進行授權").show();
- }
- } else {
- // 權限已被授予
- //加載顯示系統相冊中的照片
- showPhotos();
- }
- }
- @Override
- public void onActive() {
- super.onActive();
- }
- @Override
- public void onForeground(Intent intent) {
- super.onForeground(intent);
- }
- private void initView() {
- //初始化相關UI組件
- tlAlbum = (TableLayout) findComponentById(ResourceTable.Id_tl_album);
- tlAlbum.setColumnCount(3); //表格設置成3列
- textLoading = (Text) findComponentById(ResourceTable.Id_text_loading);
- textNum = (Text) findComponentById(ResourceTable.Id_text_num);
- }
- //定義加載顯示圖片的方法
- public void showPhotos() {
- //先移除之前的表格布局中的所有組件
- tlAlbum.removeAllComponents();
- //定義一個數組，用來存放圖片的id，它的size就是照片數量
- ArrayList<Integer> img_ids = new ArrayList<Integer>();
- //初始化DataAbilityHelper，用來獲取系統共享數據
- DataAbilityHelper helper = DataAbilityHelper.creator(getContext());
- try {
- //讀取系統相冊的數據
- ResultSet result = helper.query(AVStorage.Images.Media.EXTERNAL_DATA_ABILITY_URI, null, null);
- //根據獲取的數據覺得“正在加載”提示是否顯示
- if (result == null) {
- textLoading.setVisibility(Component.VISIBLE);
- } else {
- textLoading.setVisibility(Component.HIDE);
- }
- //遍歷獲取的數據，來動態加載表格布局中的圖片組件
- while (result != null && result.goToNextRow()) {
- //從獲取的數據中讀取圖片的id
- int mediaId = result.getInt(result.getColumnIndexForName(AVStorage.Images.Media.ID));
- //生成uri，后面會根據uri獲取文件
- Uri uri = Uri.appendEncodedPathToUri(AVStorage.Images.Media.EXTERNAL_DATA_ABILITY_URI, "" + mediaId);
- //獲取文件信息
- FileDescriptor filedesc = helper.openFile(uri, "r");
- //定義一個圖片編碼參數選項用于設置相關編碼參數
- ImageSource.DecodingOptions decodingOpts = new ImageSource.DecodingOptions();
- decodingOpts.desiredSize = new Size(300, 300);
- //根據文件信息生成pixelMap對象，該對象是設置Image組件的關鍵api
- ImageSource imageSource = ImageSource.create(filedesc, null);
- PixelMap pixelMap = imageSource.createThumbnailPixelmap(decodingOpts, true);
- //構造一個圖片組件并且設置相關屬性
- Image img = new Image(MainAbilitySlice.this);
- img.setId(mediaId);
- img.setHeight(300);
- img.setWidth(300);
- img.setMarginTop(20);
- img.setMarginLeft(20);
- img.setPixelMap(pixelMap);
- img.setScaleMode(Image.ScaleMode.ZOOM_CENTER);
- //在表格布局中加載圖片組件
- tlAlbum.addComponent(img);
- HiLog.info(LABEL, "uri=" + uri);
- img_ids.add(mediaId);
- }
- } catch (DataAbilityRemoteException | FileNotFoundException e) {
- e.printStackTrace();
- }
- //完成照片數量的刷新，如果沒有照片，則在UI中顯示“沒有照片”的文本
- if (img_ids.size() > 0) {
- textLoading.setVisibility(Component.HIDE);
- textNum.setVisibility(Component.VISIBLE);
- textNum.setText("照片數量：" + img_ids.size());
- } else {
- textLoading.setVisibility(Component.VISIBLE);
- textLoading.setText("沒有照片");
- textNum.setVisibility(Component.HIDE);
- }
- }
- }
復制MainAbility的代碼如下：
- package com.xdw.album;
- import com.xdw.album.slice.MainAbilitySlice;
- import ohos.aafwk.ability.Ability;
- import ohos.aafwk.content.Intent;
- import ohos.agp.window.dialog.ToastDialog;
- import ohos.bundle.IBundleManager;
- import static com.xdw.album.slice.MainAbilitySlice.MY_PERMISSIONS_REQUEST_READ_USER_STORAGE;
- public class MainAbility extends Ability {
- private MainAbilitySlice mainAbilitySlice;
- @Override
- public void onStart(Intent intent) {
- super.onStart(intent);
- super.setMainRoute(MainAbilitySlice.class.getName());
- }
- @Override
- public void onRequestPermissionsFromUserResult(int requestCode, String[] permissions, int[] grantResults) {
- super.onRequestPermissionsFromUserResult(requestCode, permissions, grantResults);
- switch (requestCode) {
- case MY_PERMISSIONS_REQUEST_READ_USER_STORAGE: {
- // 匹配requestPermissions的requestCode
- if (grantResults.length > 0
- && grantResults[0] == IBundleManager.PERMISSION_GRANTED) {
- // 權限被授予之后做相應業務邏輯的處理
- mainAbilitySlice.showPhotos();
- } else {
- // 權限被拒絕
- new ToastDialog(getContext()).setText("權限被拒絕").show();
- }
- return;
- }
- }
- }
- public MainAbilitySlice getMainAbilitySlice() {
- return mainAbilitySlice;
- }
- public void setMainAbilitySlice(MainAbilitySlice mainAbilitySlice) {
- this.mainAbilitySlice = mainAbilitySlice;
- }
- }
復制布局文件ability_main.xml代碼如下：
- <?xml version="1.0" encoding="utf-8"?>
- <DirectionalLayout
- xmlns:ohos="http://schemas.huawei.com/res/ohos"
- ohos:height="match_parent"
- ohos:width="match_parent"
- ohos:orientation="vertical">
- <Text
- ohos:id="$+id:text_loading"
- ohos:height="match_parent"
- ohos:width="match_parent"
- ohos:text="正在打開..."
- ohos:text_alignment="center"
- ohos:text_size="45fp"></Text>
- <ScrollView
- ohos:height="600vp"
- ohos:width="match_parent"
- ohos:left_padding="25vp"
- >
- <TableLayout
- ohos:id="$+id:tl_album"
- ohos:height="match_content"
- ohos:width="match_parent"
- >
- </TableLayout>
- </ScrollView>
- <Text
- ohos:id="$+id:text_num"
- ohos:height="match_content"
- ohos:width="match_content"
- ohos:text_alignment="center"
- ohos:text_size="20fp"></Text>
- </DirectionalLayout>
責任編輯：jianghua
來源：
鴻蒙社區
