1# Location Kit开发指南 2 3## 申请位置权限开发指导 4 5### 场景概述 6 7应用在使用Location Kit系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限。 8 9系统提供的定位权限有： 10 11- ohos.permission.LOCATION：用于获取精准位置，精准度在米级别。 12 13- ohos.permission.APPROXIMATELY_LOCATION：用于获取模糊位置，精确度为5公里。 14 15- ohos.permission.LOCATION_IN_BACKGROUND：用于应用切换到后台仍然需要获取定位信息的场景。 16 17访问设备的位置信息，必须申请权限，并且获得用户授权。 18 19当前位置相关能力仅支持WGS-84坐标系。 20 21**表1** 位置权限申请方式介绍 22 23| target API level | 申请位置权限 | 申请结果 | 位置的精确度 | 24| -------- | -------- | -------- | -------- | 25| 小于9 | ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 | 26| 大于等于9 | ohos.permission.LOCATION | 失败 | 无法获取位置。 | 27| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION | 成功 | 获取到模糊位置，精确度为5公里。 | 28| 大于等于9 | 同时申请ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 | 29 30如果应用在后台运行时也需要访问设备位置，需要申请ohos.permission.LOCATION_IN_BACKGROUND权限或申请LOCATION类型的长时任务，这样应用在切入后台之后，系统可以继续上报位置信息。 31 32应用如需使用ohos.permission.LOCATION_IN_BACKGROUND权限，需要在设置界面由用户手动授予，具体授权方式可参考[ohos.permission.LOCATION_IN_BACKGROUND权限说明](../../security/AccessToken/permissions-for-all.md#ohospermissionlocation_in_background)。 33 34长时任务申请可参考[长时任务](../../task-management/continuous-task.md)。 35 36开发者可以在应用配置文件中声明所需要的权限，具体可参考[申请应用权限](../../security/AccessToken/determine-application-mode.md)。 37 38Location Kit每个接口需要申请哪些权限可以参见如下文档：[Location Kit](../../reference/apis-location-kit/js-apis-geoLocationManager.md)。 39 40### 开发步骤 41 42具体可参考[申请应用权限](../../security/AccessToken/determine-application-mode.md)。 43 44 45## 获取设备的位置信息开发指导 46 47### 场景概述 48 49开发者可以调用OpenHarmony位置相关接口，获取设备实时位置，或者最近的历史位置。 50 51对于位置敏感的应用业务，建议获取设备实时位置信息。如果不需要设备实时位置信息，并且希望尽可能的节省耗电，开发者可以考虑获取最近的历史位置。 52 53### 接口说明 54 55获取设备的位置信息所使用的接口如下，详细说明参见：[Location Kit](../../reference/apis-location-kit/js-apis-geoLocationManager.md)。 56 57**表2** 获取设备的位置信息接口介绍 58 59| 接口名 | 功能描述 | 60| -------- | -------- | 61| on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void | 开启位置变化订阅，并发起定位请求。 | 62| off(type: 'locationChange', callback?: Callback<Location>): void | 关闭位置变化订阅，并删除对应的定位请求。 | 63| getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void | 获取当前位置，使用callback回调异步返回结果。 | 64| getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> | 获取当前位置，使用Promise方式异步返回结果。 | 65| getLastLocation(): Location | 获取最近一次定位结果。 | 66 67### 开发步骤 68 691. 获取设备的位置信息，需要有位置权限，位置权限申请的方法和步骤见[申请位置权限开发指导](#申请位置权限开发指导)。 70 712. 导入geoLocationManager模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。 72 73 ```ts 74 import geoLocationManager from '@ohos.geoLocationManager'; 75 ``` 76 773. 实例化LocationRequest对象，用于告知系统该向应用提供何种类型的定位服务，以及位置结果上报的频率。<br/> 78 **方式一：** 79 80 为了面向开发者提供贴近其使用场景的API使用方式，系统定义了几种常见的位置能力使用场景，并针对使用场景做了适当的优化处理，应用可以直接匹配使用，简化开发复杂度。系统当前支持场景如下表所示。 81 82 ***定位场景类型说明*** 83 84 - 导航场景：NAVIGATION<br/> 85 适用于在户外定位设备实时位置的场景，如车载、步行导航。<br/>在此场景下，为保证系统提供位置结果精度最优，主要使用GNSS定位技术提供定位服务，结合场景特点，在导航启动之初，用户很可能在室内、车库等遮蔽环境，GNSS技术很难提供定位服务。<br/>为解决此问题，我们会在GNSS提供稳定位置结果之前，使用系统网络定位技术，向应用提供定位服务，以在导航初始阶段提升用户体验。<br/>此场景默认以最小1秒间隔上报定位结果，使用此场景的应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 86 87 - 轨迹跟踪场景：TRAJECTORY_TRACKING<br/> 88 适用于记录用户位置轨迹的场景，如运动类应用记录轨迹功能。主要使用GNSS定位技术提供定位服务。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 89 90 - 出行约车场景：CAR_HAILING<br/> 91 适用于用户出行打车时定位当前位置的场景，如网约车类应用。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 92 93 - 生活服务场景：DAILY_LIFE_SERVICE<br/> 94 生活服务场景，适用于不需要定位用户精确位置的使用场景，如新闻资讯、网购、点餐类应用，做推荐、推送时定位用户大致位置即可。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用至少申请ohos.permission.LOCATION权限，同时获得用户授权。 95 96 - 无功耗场景：NO_POWER<br/> 97 无功耗场景，适用于不需要主动启动定位业务。系统在响应其他应用启动定位业务并上报位置结果时，会同时向请求此场景的应用程序上报定位结果，当前的应用程序不产生定位功耗。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用需要申请ohos.permission.LOCATION权限，同时获得用户授权。 98 99 100 ```ts 101 export enum LocationRequestScenario { 102 UNSET = 0x300, 103 NAVIGATION, 104 TRAJECTORY_TRACKING, 105 CAR_HAILING, 106 DAILY_LIFE_SERVICE, 107 NO_POWER, 108 } 109 ``` 110 111 112 以导航场景为例，实例化方式如下： 113 114 ```ts 115 let requestInfo:geoLocationManager.LocationRequest = {'scenario': geoLocationManager.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; 116 ``` 117 118 **方式二：** 119 120 如果定义的现有场景类型不能满足所需的开发场景，系统提供了基本的定位优先级策略类型。 121 122 ***定位优先级策略类型说明*** 123 124 - 定位精度优先策略：ACCURACY<br/> 125 定位精度优先策略主要以GNSS定位技术为主，在开阔场景下可以提供米级的定位精度，具体性能指标依赖用户设备的定位硬件能力，但在室内等强遮蔽定位场景下，无法提供准确的定位服务。 126 127 - 快速定位优先策略：FIRST_FIX<br/> 128 快速定位优先策略会同时使用GNSS定位、基站定位和WLAN、蓝牙定位技术，以便室内和户外场景下，通过此策略都可以获得位置结果，当各种定位技术都有提供位置结果时，系统会选择其中精度较好的结果返回给应用。因为对各种定位技术同时使用，对设备的硬件资源消耗较大，功耗也较大。 129 130 - 低功耗定位优先策略：LOW_POWER<br/> 131 低功耗定位优先策略主要使用基站定位和WLAN、蓝牙定位技术，也可以同时提供室内和户外场景下的定位服务，因为其依赖周边基站、可见WLAN、蓝牙设备的分布情况，定位结果的精度波动范围较大，如果对定位结果精度要求不高，或者使用场景多在有基站、可见WLAN、蓝牙设备高密度分布的情况下，推荐使用，可以有效节省设备功耗。 132 133 ```ts 134 export enum LocationRequestPriority { 135 UNSET = 0x200, 136 ACCURACY, 137 LOW_POWER, 138 FIRST_FIX, 139 } 140 ``` 141 142 以定位精度优先策略为例，实例化方式如下： 143 144 ```ts 145 let requestInfo:geoLocationManager.LocationRequest = {'priority': geoLocationManager.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; 146 ``` 147 1484. 实例化Callback对象，用于向系统提供位置上报的途径。 149 应用需要自行实现系统定义好的回调接口，并将其实例化。系统在定位成功确定设备的实时位置结果时，会通过该接口上报给应用。应用程序可以在接口的实现中完成自己的业务逻辑。 150 151 ```ts 152 let locationChange = (location:geoLocationManager.Location):void => { 153 console.log('locationChanger: data: ' + JSON.stringify(location)); 154 }; 155 ``` 156 1575. 启动定位。 158 159 ```ts 160 geoLocationManager.on('locationChange', requestInfo, locationChange); 161 ``` 162 1636. （可选）结束定位。 164 165 如果不主动结束定位可能导致设备功耗高，耗电快；建议在不需要获取定位信息时及时结束定位。 166 167 ```ts 168 geoLocationManager.off('locationChange', locationChange); 169 ``` 170 171 如果应用使用场景不需要实时的设备位置，可以获取系统缓存的最近一次历史定位结果。 172 173 ```ts 174 import geoLocationManager from '@ohos.geoLocationManager'; 175 import BusinessError from "@ohos.base"; 176 try { 177 let location = geoLocationManager.getLastLocation(); 178 } catch (err) { 179 console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); 180 } 181 ``` 182 183 184## （逆）地理编码转化开发指导 185 186### 场景概述 187 188使用坐标描述一个位置，非常准确，但是并不直观，面向用户表达并不友好。系统向开发者提供了以下两种转化能力。 189 190- 地理编码转化：将地理描述转化为具体坐标。 191 192- 逆地理编码转化能力：将坐标转化为地理描述。 193 194其中地理编码包含多个属性来描述位置，包括国家、行政区划、街道、门牌号、地址描述等等，这样的信息更便于用户理解。 195 196### 接口说明 197 198进行坐标和地理编码信息的相互转化，所使用的接口说明如下，详细信息参见：[Location Kit](../../reference/apis-location-kit/js-apis-geoLocationManager.md)。 199 200**表3** （逆）地理编码转化接口介绍 201 202| 接口名 | 功能描述 | 203| -------- | -------- | 204| isGeocoderAvailable(): boolean; | 判断（逆）地理编码服务状态。 | 205| getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void | 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 | 206| getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>> | 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 | 207| getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void | 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 | 208| getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>> | 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 | 209 210### 开发步骤 211 212> **说明：** 213> GeoConvert需要访问后端服务，请确保设备联网，以进行信息获取。 214 2151. 导入geoLocationManager模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。 216 217 ```ts 218 import geoLocationManager from '@ohos.geoLocationManager'; 219 ``` 220 2212. 查询geoCoder服务是否可用。 222 - 调用isGeoServiceAvailable查询geoCoder服务是否可用，如果服务可用再继续进行步骤3。 223 224 ```ts 225 import geoLocationManager from '@ohos.geoLocationManager'; 226 import BusinessError from "@ohos.base"; 227 try { 228 let isAvailable = geoLocationManager.isGeocoderAvailable(); 229 } catch (err) { 230 console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); 231 } 232 ``` 233 2343. 获取转化结果。 235 - 调用getAddressesFromLocation，坐标转化地理位置信息。 236 237 ```ts 238 let reverseGeocodeRequest:geoLocationManager.ReverseGeoCodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; 239 try { 240 geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { 241 if (err) { 242 console.log('getAddressesFromLocation err: ' + JSON.stringify(err)); 243 } else { 244 console.log('getAddressesFromLocation data: ' + JSON.stringify(data)); 245 } 246 }); 247 } catch (err) { 248 console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); 249 } 250 ``` 251 252 参考接口API说明[Location Kit](../../reference/apis-location-kit/js-apis-geoLocationManager.md)，应用可以获得与此坐标匹配的GeoAddress列表，应用可以根据实际使用需求，读取相应的参数数据。 253 - 调用getAddressesFromLocationName位置描述转化坐标。 254 255 ```ts 256 let geocodeRequest:geoLocationManager.GeoCodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; 257 try { 258 geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { 259 if (err) { 260 console.log('getAddressesFromLocationName err: ' + JSON.stringify(err)); 261 } else { 262 console.log('getAddressesFromLocationName data: ' + JSON.stringify(data)); 263 } 264 }); 265 } catch (err) { 266 console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); 267 } 268 ``` 269 270 参考接口API说明[Location Kit](../../reference/apis-location-kit/js-apis-geoLocationManager.md)，应用可以获得与位置描述相匹配的GeoAddress列表，其中包含对应的坐标数据，请参考API使用。 271 272 如果需要查询的位置描述可能出现多地重名的请求，可以设置GeoCodeRequest，通过设置一个经纬度范围，以高效地获取期望的准确结果。 273 274 275## 地理围栏开发指导 276 277### 场景概述 278 279地理围栏就是虚拟地理边界，当设备进入、离开某个特定地理区域时，可以接收自动通知和警告。 280 281目前仅支持圆形围栏，并且依赖GNSS芯片的地理围栏功能。 282 283应用场景举例：开发者可以使用地理围栏，在企业周围创建一个区域进行广告定位，在不同的地点，在移动设备上进行有针对性的促销优惠。 284 285### 接口说明 286 287地理围栏所使用的接口如下，详细说明参见：[Location Kit](../../reference/apis-location-kit/js-apis-geoLocationManager.md)。 288 289**表4** 地理围栏接口介绍 290 291| 接口名 | 功能描述 | 292| -------- | -------- | 293| on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; | 添加一个围栏，并订阅地理围栏事件。 | 294| off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; | 删除一个围栏，并取消订阅该围栏事件。 | 295 296### 开发步骤 297 2981. 使用地理围栏功能，需要有权限ohos.permission.APPROXIMATELY_LOCATION，位置权限申请的方法和步骤见[申请位置权限开发指导](#申请位置权限开发指导)。 299 3002. 导入geoLocationManager模块、wantAgent模块和BusinessError模块。 301 302 ```ts 303 import geoLocationManager from '@ohos.geoLocationManager'; 304 import wantAgent, {WantAgent as _wantAgent} from '@ohos.app.ability.wantAgent'; 305 import BusinessError from "@ohos.base"; 306 ``` 307 3083. 创建WantAgentInfo信息。 309 310 场景一：创建拉起Ability的WantAgentInfo信息。 311 312 ```ts 313 let wantAgentObj:_wantAgent|null = null; // 用于保存创建成功的wantAgent对象，后续使用其完成触发的动作。 314 315 // 通过WantAgentInfo的operationType设置动作类型 316 let wantAgentInfo:wantAgent.WantAgentInfo = { 317 wants: [ 318 { 319 deviceId: '', 320 bundleName: 'com.example.myapplication', 321 abilityName: 'EntryAbility', 322 action: '', 323 entities: [], 324 uri: '', 325 parameters: {} 326 } 327 ], 328 operationType: wantAgent.OperationType.START_ABILITY, 329 requestCode: 0, 330 wantAgentFlags:[wantAgent.WantAgentFlags.CONSTANT_FLAG] 331 }; 332 ``` 333 334 场景二：创建发布公共事件的WantAgentInfo信息。 335 336 ```ts 337 let wantAgentObj:_wantAgent|null = null; // 用于保存创建成功的WantAgent对象，后续使用其完成触发的动作。 338 339 // 通过WantAgentInfo的operationType设置动作类型 340 let wantAgentInfo:wantAgent.WantAgentInfo = { 341 wants: [ 342 { 343 action: 'event_name', // 设置事件名 344 parameters: {}, 345 } 346 ], 347 operationType: wantAgent.OperationType.SEND_COMMON_EVENT, 348 requestCode: 0, 349 wantAgentFlags: [wantAgent.WantAgentFlags.CONSTANT_FLAG], 350 } 351 ``` 352 3534. 调用getWantAgent()方法进行创建WantAgent。 354 355 并且在获取到WantAgent对象之后调用地理围栏接口添加围栏，当设备进入或者退出该围栏时，系统会自动触发WantAgent的动作。 356 357 ```ts 358 // 创建WantAgent 359 wantAgent.getWantAgent(wantAgentInfo, (err, data) => { 360 if (err) { 361 console.error('getWantAgent err=' + JSON.stringify(err)); 362 return; 363 } 364 console.info('getWantAgent success'); 365 wantAgentObj = data; 366 let requestInfo:geoLocationManager.GeofenceRequest = {'scenario': 0x301, "geofence": {"latitude": 31.12, "longitude": 121.11, "radius": 100, "expiration": 10000}}; 367 try { 368 geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj); 369 } catch (err) { 370 console.error("errCode:" + (err as BusinessError.BusinessError).code + ",errMessage:" + (err as BusinessError.BusinessError).message); 371 } 372 }); 373 ``` 374 375## 相关实例 376 377针对位置开发，有以下相关实例可供参考： 378 379- [位置服务（ArkTS）(API9)](https://gitee.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/DeviceManagement/Location)