定位服务API案例
定位服务API案例
要使用定位服务API,需要确保设备已经下载并安装了HMS Core服务组件,并将Location Kit的SDK集成到项目中。
指定应用权限
- Android提供了两种位置权限: ACCESS_COARSE_LOCATION(粗略的位置权限)和ACCESS_FINE_LOCATION(精确的位置权限)。需要在“AndroidManifest.xml”文件中申请权限:
- <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
- <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
- 在Android Q版本中,如果需要应用程序在后台执行时也具备持续定位能力,需要在“AndroidManifest.xml”文件中申请ACCESS_BACKGROUND_LOCATION权限:
- <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />
- 在“AndroidManifest.xml”中添加后,还要在代码中动态申请一下权限(Android 6.0危险权限要求):
- // Android SDK<=28 所需权限动态申请
- if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.P) {
- Log.i(TAG, "android sdk <= 28 Q");
- if (ActivityCompat.checkSelfPermission(this,
- Manifest.permission.ACCESS_FINE_LOCATION) != PackageManager.PERMISSION_GRANTED
- && ActivityCompat.checkSelfPermission(this,
- Manifest.permission.ACCESS_COARSE_LOCATION) != PackageManager.PERMISSION_GRANTED) {
- String[] strings =
- {Manifest.permission.ACCESS_FINE_LOCATION, Manifest.permission.ACCESS_COARSE_LOCATION};
- 10. ActivityCompat.requestPermissions(this, strings, 1);
- 11. }
12. } else {
- 13. // Android SDK>28 所需权限动态申请,需添加“android.permission.ACCESS_BACKGROUND_LOCATION”权限
- 14. if (ActivityCompat.checkSelfPermission(this,
- 15. Manifest.permission.ACCESS_FINE_LOCATION) != PackageManager.PERMISSION_GRANTED
- 16. && ActivityCompat.checkSelfPermission(this,
- 17. Manifest.permission.ACCESS_COARSE_LOCATION) != PackageManager.PERMISSION_GRANTED
- 18. && ActivityCompat.checkSelfPermission(this,
- 19. "android.permission.ACCESS_BACKGROUND_LOCATION") != PackageManager.PERMISSION_GRANTED) {
- 20. String[] strings = {android.Manifest.permission.ACCESS_FINE_LOCATION,
- 21. android.Manifest.permission.ACCESS_COARSE_LOCATION,
- 22. "android.permission.ACCESS_BACKGROUND_LOCATION"};
- 23. ActivityCompat.requestPermissions(this, strings, 2);
- 24. }
25. }
创建定位服务客户端
在项目中使用到定位服务的Activity中的onCreate()方法中创建一个FusedLocationProviderClient实例,通过该实例调用定位相关接口。
- // 定位交互接入对象
- private FusedLocationProviderClient fusedLocationProviderClient;
- // 定位请求信息对象
- private LocationRequest mLocationRequest;
- protected void onCreate(Bundle savedInstanceState) {
- fusedLocationProviderClient = LocationServices.getFusedLocationProviderClient(this);
- }
说明
当传入参数为非Activity类型时,如果使用FusedLocationProviderClient实例调用定位服务接口发生异常,就不会弹出UI交互界面提示用户处理,只会返回错误码。例如:当HMS Core不符合定位服务的版本要求时,便会返回错误码907135003,此时需要手动升级HMS Core。如果需要拉起升级引导界面,建议传入Activity类型参数替代Context类型,创建FusedLocationProviderClient实例。
检查设备定位设置
设备的相关定位设置会影响定位服务的定位结果,例如位置开关选项处于关闭状态时,将无法获取到位置信息。因此,建议在持续获取位置信息之前,先检查设备设置是否满足定位条件。定位服务提供了检查设备定位相关设置的能力,通过LocationServices的getSettingsClient(Activity activity)获取SettingsClient实例,然后调用checkLocationSettings(LocationSettingsRequest locationSettingsRequest)接口获取定位设置结果,当设置不满足定位条件时,可以调用startResolutionForResult接口用于弹框提示用户打开对应的权限(HMS Core 定位权限必须打开,Android Q版本必须选择“始终允许”)。
- 调用getSettingsClient()接口获取SettingsClient实例。
- SettingsClient settingsClient = LocationServices.getSettingsClient(this);
- 调用checkLocationSettings()检查设备设置。
- LocationSettingsRequest.Builder builder = new LocationSettingsRequest.Builder();
- mLocationRequest = new LocationRequest();
- builder.addLocationRequest(mLocationRequest);
- LocationSettingsRequest locationSettingsRequest = builder.build();
- // 检查设备定位设置
- settingsClient.checkLocationSettings(locationSettingsRequest)
- // 检查设备定位设置接口成功监听回调
- .addOnSuccessListener(new OnSuccessListener<LocationSettingsResponse>() {
- @Override
- 10. public void onSuccess(LocationSettingsResponse locationSettingsResponse) {
- 11. // 设置满足定位条件,再发起位置请求
- 12. fusedLocationProviderClient
- 13. .requestLocationUpdates(mLocationRequest, mLocationCallback,Looper.getMainLooper())
- 14. // 请求位置更新接口成功监听回调
- 15. .addOnSuccessListener(new OnSuccessListener<Void>() {
- 16. @Override
- 17. public void onSuccess(Void aVoid) {
- 18. // ...
- 19. }
- 20. });
- 21. }
- 22. })
- 23. // 检查设备定位设置接口失败监听回调
- 24. .addOnFailureListener(new OnFailureListener() {
- 25. @Override
- 26. public void onFailure(Exception e) {
- 27. // 设置不满足定位条件
- 28. int statusCode = ((ApiException) e).getStatusCode();
- 29. switch (statusCode) {
- 30. case LocationSettingsStatusCodes.RESOLUTION_REQUIRED:
- 31. try {
- 32. ResolvableApiException rae = (ResolvableApiException) e;
- 33. // 调用startResolutionForResult可以弹窗提示用户打开相应权限
- 34. rae.startResolutionForResult(MainActivity.this, 0);
- 35. } catch (IntentSender.SendIntentException sie) {
- 36. // …
- 37. }
- 38. break;
- 39. }
- 40. }
- 41. });
持续获取位置信息
如果希望应用可以持续获取设备位置,可以使用定位服务提供的requestLocationUpdates()接口。该接口根据入参形式的不同,将以两种不同的形式将位置信息返回。一种是通过调用已经定义的LocationCallback类中onLocationResult()回调方法返回一个包含位置信息的LocationResult对象,另一种是将位置信息置于PendingIntent扩展信息中返回。
当应用程序不再需要接收位置更新时,应当停止位置更新,以便于降低功耗。要停止位置更新,可以调用removeLocationUpdates(),传入与requestLocationUpdates()接口相对应的LocationCallback或PendingIntent对象。这里以回调方式作为样例,代码如下。详细的参数说明请参见LocationService接口说明。
- 设置持续定位请求参数。
- LocationRequest mLocationRequest = new LocationRequest();
- // 设置位置更新的间隔(单位为毫秒)
- mLocationRequest.setInterval(10000);
- // 设置定位类型
- mLocationRequest.setPriority(LocationRequest.PRIORITY_HIGH_ACCURACY);
- 定义位置更新回调。
- LocationCallback mLocationCallback;
- mLocationCallback = new LocationCallback() {
- @Override
- public void onLocationResult(LocationResult locationResult) {
- if (locationResult != null) {
- // 处理位置回调结果
- }
- }
- };
- 调用requestLocationUpdates()进行持续定位。
- fusedLocationProviderClient
- .requestLocationUpdates(mLocationRequest, mLocationCallback, Looper.getMainLooper())
- .addOnSuccessListener(new OnSuccessListener<Void>() {
- @Override
- public void onSuccess(Void aVoid) {
- // 接口调用成功的处理
- }
- })
- .addOnFailureListener(new OnFailureListener() {
- 10. @Override
- 11. public void onFailure(Exception e) {
- 12. // 接口调用失败的处理
- 13. }
- 14. });
说明
如果接口调用成功,获取位置信息失败,请参见接口调用成功,获取不到位置信息。
- 调用removeLocationUpdates()停止位置更新。
- // 注意:停止位置更新时,mLocationCallback必须与requestLocationUpdates方法中的LocationCallback参数为同一对象。
- fusedLocationProviderClient.removeLocationUpdates(mLocationCallback)
- // 停止位置更新成功监听回调
- .addOnSuccessListener(new OnSuccessListener<Void>() {
- @Override
- public void onSuccess(Void aVoid) {
- //...
- }
- })
- 10. // 停止位置更新失败监听回调
- 11. .addOnFailureListener(new OnFailureListener() {
- 12. @Override
- 13. public void onFailure(Exception e) {
- 14. // ...
- 15. }
- 16. });
获取最后的已知位置
应用可以调用getLastLocation()方法获取设备最后的已知位置,大多情况下,该位置即为设备的当前位置。代码样例如下:
- // 获取最后的已知位置
- Task<Location> task = fusedLocationProviderClient.getLastLocation()
- // 获取最后的已知位置成功监听回调
- .addOnSuccessListener(new OnSuccessListener<Location>() {
- @Override
- public void onSuccess(Location location) {
- if (location == null) {
- return;
- }
- 10. // 成功时Location对象处理逻辑
- 11. // ...
- 12. }
- 13. })
- 14. // 获取最后的已知位置失败监听回调
- 15. .addOnFailureListener(new OnFailureListener() {
- 16. @Override
- 17. public void onFailure(Exception e) {
- 18. // ...
- 19. }
- 20. });
说明
getLastLocation()方法是从系统缓存中获取位置信息的。如果获取的位置信息为null,则可能是系统缓存已经被清除;此时先调用requestLocationUpdates()方法获取位置信息以刷新缓存,再调用getLastLocation()方法即可以获取到位置信息。
使用模拟位置信息功能
具体操作步骤:打开“设置 > 系统和更新 > 开发人员选项 > 选择模拟位置信息应用 > 选择要模拟位置信息应用”(如果没有发现“开发人员选项”,请执行如下操作:“设置 > 关于手机 > 版本号”,连续点击“版本号”7次,“开发人员选项”会出现在“系统与更新”页面,再重复上述操作),代码开发步骤如下:
- 在AndroidManifest.xml文件中配置模拟定位权限。
- <uses-permission
- android:name="android.permission.ACCESS_MOCK_LOCATION"
- tools:ignore="MockLocation,ProtectedPermissions" />
- 设置mock模式,调用setMockMode(boolean isMockMode)。
- // 设置mock模式,参数传入ture:模拟模式;false:正常状态
- boolean mockFlag = true;
- fusedLocationProviderClient.setMockMode(mockFlag)
- .addOnSuccessListener(new OnSuccessListener<Void>() {
- @Override
- public void onSuccess(Void aVoid) {
- Log.i(TAG, "setMockMode onSuccess");
- }
- })
- 10. .addOnFailureListener(new OnFailureListener() {
- 11. @Override
- 12. public void onFailure(Exception e) {
- 13. Log.i(TAG, "setMockMode onFailure:" + e.getMessage());
- 14. }
- 15. });
- 设置模拟位置信息,调用setMockLocation(Location mockLocation)。
- // 设置模拟位置信息
- final Location mockLocation = new Location(LocationManager.GPS_PROVIDER);
- mockLocation.setLongitude(118.76);
- mockLocation.setLatitude(31.98);
- fusedLocationProviderClient.setMockLocation(mockLocation)
- // 设置模拟位置信息成功监听回调
- .addOnSuccessListener(new OnSuccessListener<Void>() {
- @Override
- public void onSuccess(Void aVoid) {
- 10. Log.i(TAG, "setMockLocation onSuccess");
- 11. }
- 12. })
- 13. // 设置模拟位置信息失败监听回调
- 14. .addOnFailureListener(new OnFailureListener() {
- 15. @Override
- 16. public void onFailure(Exception e) {
- 17. Log.i(TAG, "setMockLocation onFailure:" + e.getMessage());
- 18. }
- 19. });