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