Smart Location Library：简化定位程序使用

Smart Location Library：简化定位程序使用

Smart Location Library

Android library project that intends to simplify the usage of location providers and activity recognition with a nice fluid API.

Supported Android versions: Android 4.0+

Adding to your project

You should add this to your dependencies:

implement 'io.nlopez.smartlocation:library:3.3.3'

Google Play Services compatible version: 11.4.2

If you want the rxjava wrappers, these are now in a separate dependency. Just add this new dependency as well:

implement 'io.nlopez.smartlocation:rx:3.3.3'

If you got any problem compiling, please check the Common Issues section at the bottom of this document.

Location

Starting

For starting the location service:

SmartLocation.with(context).location() .start(new OnLocationUpdatedListener() { ... });

If you just want to get a single location (not periodic) you can just use the oneFix modifier. Example:

SmartLocation.with(context).location() .oneFix() .start(new OnLocationUpdatedListener() { ... });

Stopping

For stopping the location just use the stop method.

SmartLocation.with(context).location().stop();

Status

You can get some information about the current status of location providers to know if you will be able to use the location providers.

// Check if the location services are enabledSmartLocation.with(context).location().state().locationServicesEnabled();// Check if any provider (network or gps) is enabledSmartLocation.with(context).location().state().isAnyProviderAvailable();// Check if GPS is availableSmartLocation.with(context).location().state().isGpsAvailable();// Check if Network is availableSmartLocation.with(context).location().state().isNetworkAvailable();// Check if the passive provider is availableSmartLocation.with(context).location().state().isPassiveAvailable();// Check if the location is mockedSmartLocation.with(context).location().state().isMockSettingEnabled();

Location strategy

There are three presets for location parameters:

LocationParams.BEST_EFFORT (default)LocationParams.NAVIGATIONLocationParams.LAZY

You can change it (if you want one other than the default one) by using the config(locationParams) modifier.

If you want to add some custom parameters for the distances or times involved in the location strategy, you can create your own LocationParams class.

Changing providers

There are some providers shipped with the library.

LocationGooglePlayServicesWithFallbackProvider (default). This one will use the Fused Location Provider if it's present, or the LocationManager as fallback if it's not.LocationGooglePlayServicesProvider This will use the Fused Location Provider.LocationManagerProvider This is the legacy implementation that uses LocationManager.LocationBasedOnActivityProvider This allows you to use the activity recognition system to modify the location strategy depending on the activity changes (if the user is walking, running, on a car, a bike...).MultiFallbackLocationProvider This lets you create your own "fallback provider" if the underlying location service is not available. See "Multiple Fallback Provider" below for details.

You can implement your own if you want. That's ideal if you wanted to use a mock one for testing or something like that, or add support to another possible provider.

Example:

SmartLocation.with(context).location(new LocationBasedOnActivityProvider(callback)) .start(new OnLocationUpdatedListener() { ... });

Multiple Fallback Provider

The MultiFallbackProvider lets you create your own provider that utilizes multiple underlying location services. The provider will use the location services in the order in which they are added to its Builder, which has convenience methods for setting up the Google Play Services provider and the default LocationManager provider. Providers must implement the ServiceLocationProvider interface to enable the fallback behavior. Example:

LocationProvider myProvider = new MyLocationProvider();LocationProvider fallbackProvider = new MultiFallbackProvider.Builder() .withGooglePlayServicesProvider().withProvider(myProvider).build();

Activity

Starting

For starting the activity recognition service, you should run:

SmartLocation.with(context).activityRecognition() .start(new OnActivityUpdatedListener() { ... });

Stopping

For stopping the activity recognition you could use the stop method.

SmartLocation.with(context).activityRecognition().stop();

Geofencing

We can add geofences and receive the information when we enter, exit or dwell in a Geofence. The geofences are defined by a GeofenceModel, and you should use the requestId as a identifier.

We can add and remove geofences with a similar syntax as all the others.

GeofenceModel mestalla = new GeofenceModel.Builder("id_mestalla") .setTransition(Geofence.GEOFENCE_TRANSITION_ENTER) .setLatitude(39.47453120000001) .setLongitude(-0.358065799999963) .setRadius(500) .build();GeofenceModel cuenca = new GeofenceModel.Builder("id_cuenca") .setTransition(Geofence.GEOFENCE_TRANSITION_EXIT) .setLatitude(40.0703925) .setLongitude(-2.1374161999999615) .setRadius(2000) .build();SmartLocation.with(context).geofencing() .add(mestalla) .add(cuenca) .remove("already_existing_geofence_id") .start(new OnGeofencingTransitionListener() { ... });

If you want to capture the Geofence transitions without the app running, you can hook up a BroadcastReceiver to the intent action stored in the GeofencingGooglePlayServicesProvider.BROADCAST_INTENT_ACTION constant. The intent will come with the geofence, the location and the type of transition within the bundle.

Geocoding

The library has support for direct geocoding (aka getting a Location object based on a String) and reverse geocoding (getting the Street name based on a Location object).

There are pretty basic calls in the API for both operations separatedly.

Direct geocoding

SmartLocation.with(context).geocoding() .direct("Estadi de Mestalla", new OnGeocodingListener() { @Override public void onLocationResolved(String name, List results) { // name is the same you introduced in the parameters of the call // results could come empty if there is no match, so please add some checks around that // LocationAddress is a wrapper class for Address that has a Location based on its data if (results.size() > 0) { Location mestallaLocation = results.get(0).getLocation(); // [...] Do your thing! :D } } });

Reverse geocoding

SmartLocation.with(context).geocoding() .reverse(location, new OnReverseGeocodingListener() { @Override public onAddressResolved(Location original, List