• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 向用户申请授权
2
3当应用需要访问用户的隐私信息或使用系统能力时,例如获取位置信息、访问日历、使用相机拍摄照片或录制视频等,应该向用户请求授权,这部分权限是user_grant权限。
4
5当应用申请user_grant权限时,需要完成以下步骤:
6
71. 在配置文件中,声明应用需要请求的权限。
8
92. 将应用中需要申请权限的目标对象与对应目标权限进行关联,让用户明确地知道,哪些操作需要用户向应用授予指定的权限。
10   以上两步请参考章节[声明权限](declare-permissions.md)完成。
11
123. 运行应用时,在用户触发访问操作目标对象时应该调用接口,精准触发动态授权弹框。该接口的内部会检查当前用户是否已经授权应用所需的权限,如果当前用户尚未授予应用所需的权限,该接口会拉起动态授权弹框,向用户请求授权。
13
144. 检查用户的授权结果,确认用户已授权才可以进行下一步操作。
15
16本章节会介绍如何完成步骤3和4。
17
18## 约束与限制
19
20- user_grant权限授权要基于用户可知可控的原则,需要应用在运行时主动调用系统动态申请权限的接口,系统弹框由用户授权,用户结合应用运行场景的上下文,识别出应用申请相应敏感权限的合理性,从而做出正确的选择。
21
22- 系统不鼓励频繁弹窗打扰用户,如果用户拒绝授权,将无法再次拉起弹窗,需要应用引导用户在系统应用“设置”的界面中手动授予权限。
23
24- 系统权限弹窗不可被遮挡。
25
26  系统权限弹窗不可被其他组件/控件遮挡,弹窗信息需要完整展示,以便用户识别并完成授权动作。
27  如果系统权限弹窗与其他组件/控件同时同位置展示,系统权限弹窗将默认覆盖其他组件/控件。
28
29- 每次执行需要目标权限的操作时,应用都必须检查自己是否已经具有该权限。
30
31  如需检查用户是否已向您的应用授予特定权限,可以使用[checkAccessToken()](../../reference/apis-ability-kit/js-apis-abilityAccessCtrl.md#checkaccesstoken9)函数,此方法会返回[PERMISSION_GRANTED](../../reference/apis-ability-kit/js-apis-abilityAccessCtrl.md#grantstatus)或[PERMISSION_DENIED](../../reference/apis-ability-kit/js-apis-abilityAccessCtrl.md#grantstatus)。具体示例可参考下文。
32
33- 每次访问受目标权限保护的接口之前,都需要使用[requestPermissionsFromUser()](../../reference/apis-ability-kit/js-apis-abilityAccessCtrl.md#requestpermissionsfromuser9)接口请求相应的权限。
34
35  用户可能在动态授予权限后通过系统设置来取消应用的权限,因此不能将之前授予的授权状态持久化。
36
37- 应用在onWindowStageCreate()回调中申请授权时,需要等待异步接口loadContent()/setUIContent()执行结束后或在loadContent()/setUIContent()回调中调用[requestPermissionsFromUser()](../../reference/apis-ability-kit/js-apis-abilityAccessCtrl.md#requestpermissionsfromuser9),否则在Content加载完成前,requestPermissionsFromUser会调用失败。
38  <!--RP1--><!--RP1End-->
39
40## 开发步骤
41
42以申请使用位置权限为例进行说明。
43
44效果展示:
45
46<!--RP4-->
47![zh-cn_image_location](figures/zh-cn_image_location.png)
48<!--RP4End-->
49
501. 申请ohos.permission.LOCATIONohos.permission.APPROXIMATELY_LOCATION权限,配置方式请参见[声明权限](declare-permissions.md)。
51
522. 校验当前是否已经授权。
53
54   在进行权限申请之前,需要先检查当前应用程序是否已经被授予权限。可以通过调用[checkAccessToken()](../../reference/apis-ability-kit/js-apis-abilityAccessCtrl.md#checkaccesstoken9)方法来校验当前是否已经授权。如果已经授权,则可以直接访问目标操作,否则需要进行下一步操作,即向用户申请授权。
55
56   ```ts
57   import { abilityAccessCtrl, bundleManager, Permissions } from '@kit.AbilityKit';
58   import { BusinessError } from '@kit.BasicServicesKit';
59
60   async function checkPermissionGrant(permission: Permissions): Promise<abilityAccessCtrl.GrantStatus> {
61     let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
62     let grantStatus: abilityAccessCtrl.GrantStatus = abilityAccessCtrl.GrantStatus.PERMISSION_DENIED;
63
64     // 获取应用程序的accessTokenID。
65     let tokenId: number = 0;
66     try {
67       let bundleInfo: bundleManager.BundleInfo = await bundleManager.getBundleInfoForSelf(bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION);
68       let appInfo: bundleManager.ApplicationInfo = bundleInfo.appInfo;
69       tokenId = appInfo.accessTokenId;
70     } catch (error) {
71       const err: BusinessError = error as BusinessError;
72       console.error(`Failed to get bundle info for self. Code is ${err.code}, message is ${err.message}`);
73     }
74
75     // 校验应用是否被授予权限。
76     try {
77       grantStatus = await atManager.checkAccessToken(tokenId, permission);
78     } catch (error) {
79       const err: BusinessError = error as BusinessError;
80       console.error(`Failed to check access token. Code is ${err.code}, message is ${err.message}`);
81     }
82
83     return grantStatus;
84   }
85
86   async function checkPermissions(): Promise<void> {
87     let grantStatus1: boolean = await checkPermissionGrant('ohos.permission.LOCATION') === abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED;// 获取精确定位权限状态。
88     let grantStatus2: boolean = await checkPermissionGrant('ohos.permission.APPROXIMATELY_LOCATION') === abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED;// 获取模糊定位权限状态。
89     // 精确定位权限只能跟模糊定位权限一起申请,或者已经有模糊定位权限才能申请精确定位权限。
90     if (grantStatus2 && !grantStatus1) {
91        // 申请精确定位权限。
92     } else if (!grantStatus1 && !grantStatus2) {
93        // 申请模糊定位权限与精确定位权限或单独申请模糊定位权限。
94     } else {
95        // 已经授权,可以继续访问目标操作。
96     }
97   }
98   ```
99
1003. 动态向用户申请授权。
101
102   动态向用户申请权限是指在应用程序运行时向用户请求授权的过程。可以通过调用[requestPermissionsFromUser()](../../reference/apis-ability-kit/js-apis-abilityAccessCtrl.md#requestpermissionsfromuser9)方法来实现。该方法接收一个权限列表参数,例如位置、日历、相机、麦克风等。用户可以选择授予权限或者拒绝授权。
103
104   可以在UIAbility的onWindowStageCreate()回调中调用[requestPermissionsFromUser()](../../reference/apis-ability-kit/js-apis-abilityAccessCtrl.md#requestpermissionsfromuser9)方法来动态申请权限,也可以根据业务需要在UI中向用户申请授权。
105
106   应用在onWindowStageCreate()回调中申请授权时,需要等待异步接口loadContent()/setUIContent()执行结束后或在loadContent()/setUIContent()回调中调用[requestPermissionsFromUser()](../../reference/apis-ability-kit/js-apis-abilityAccessCtrl.md#requestpermissionsfromuser9),否则在Content加载完成前,requestPermissionsFromUser会调用失败。
107
108   <!--RP1--><!--RP1End-->
109
110   <!--RP2-->
111   - 在UIAbility中向用户申请授权。
112
113      ```ts
114      import { abilityAccessCtrl, common, Permissions, UIAbility } from '@kit.AbilityKit';
115      import { window } from '@kit.ArkUI';
116      import { BusinessError } from '@kit.BasicServicesKit';
117
118      const permissions: Array<Permissions> = ['ohos.permission.LOCATION','ohos.permission.APPROXIMATELY_LOCATION'];
119      function reqPermissionsFromUser(permissions: Array<Permissions>, context: common.UIAbilityContext): void {
120        let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
121        // requestPermissionsFromUser会判断权限的授权状态来决定是否唤起弹窗。
122        atManager.requestPermissionsFromUser(context, permissions).then((data) => {
123          let grantStatus: Array<number> = data.authResults;
124          let length: number = grantStatus.length;
125          for (let i = 0; i < length; i++) {
126            if (grantStatus[i] === 0) {
127              // 用户授权,可以继续访问目标操作。
128            } else {
129              // 用户拒绝授权,提示用户必须授权才能访问当前页面的功能,并引导用户到系统设置中打开相应的权限。
130              return;
131            }
132          }
133          // 授权成功。
134        }).catch((err: BusinessError) => {
135          console.error(`Failed to request permissions from user. Code is ${err.code}, message is ${err.message}`);
136        })
137      }
138      export default class EntryAbility extends UIAbility {
139        onWindowStageCreate(windowStage: window.WindowStage): void {
140          // ...
141          windowStage.loadContent('pages/Index', (err, data) => {
142            reqPermissionsFromUser(permissions, this.context);
143          // ...
144          });
145        }
146
147        // ...
148      }
149      ```
150
151   - 在UI中向用户申请授权。
152
153      ```ts
154      import { abilityAccessCtrl, common, Permissions } from '@kit.AbilityKit';
155      import { BusinessError } from '@kit.BasicServicesKit';
156
157      const permissions: Array<Permissions> = ['ohos.permission.LOCATION','ohos.permission.APPROXIMATELY_LOCATION'];
158      function reqPermissionsFromUser(permissions: Array<Permissions>, context: common.UIAbilityContext): void {
159        let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
160        // requestPermissionsFromUser会判断权限的授权状态来决定是否唤起弹窗。
161        atManager.requestPermissionsFromUser(context, permissions).then((data) => {
162          let grantStatus: Array<number> = data.authResults;
163          let length: number = grantStatus.length;
164          for (let i = 0; i < length; i++) {
165            if (grantStatus[i] === 0) {
166              // 用户授权,可以继续访问目标操作。
167            } else {
168              // 用户拒绝授权,提示用户必须授权才能访问当前页面的功能,并引导用户到系统设置中打开相应的权限。
169              return;
170            }
171          }
172          // 授权成功。
173        }).catch((err: BusinessError) => {
174          console.error(`Failed to request permissions from user. Code is ${err.code}, message is ${err.message}`);
175        })
176      }
177
178      @Entry
179      @Component
180      struct Index {
181        aboutToAppear() {
182          const context: common.UIAbilityContext = getContext(this) as common.UIAbilityContext;
183          reqPermissionsFromUser(permissions, context);
184        }
185
186        build() {
187          // ...
188        }
189      }
190      ```
191   <!--RP2End-->
192
1934. 处理授权结果。
194
195   调用[requestPermissionsFromUser()](../../reference/apis-ability-kit/js-apis-abilityAccessCtrl.md#requestpermissionsfromuser9)方法后,应用程序将等待用户授权的结果。如果用户授权,则可以继续访问目标操作。如果用户拒绝授权,则需要提示用户必须授权才能访问当前页面的功能,并引导用户到系统应用“设置”中打开相应的权限。<!--RP3-->
196
197   路径:设置 \> 隐私 \> 权限管理 \> 应用 \> 目标应用<!--RP3End-->
198