A data model validation framework that uses java annotation processing.
A data model validation framework that uses java annotation processing.
RAVE is a shield that prevents invalid data from crashing or causing hard to spot bugs in your Android apps. RAVE uses java annotation processing to leverage the annotations (Nullness, Value Constraint, Typedef) already present in your model classes to increase safety at runtime. Specifically, it ensures models adhere to the set of expectations that are described by their annotations.
Android apps consume data from a variety of sources (network, disk, etc.) that you as an app developer don’t have control over. When external APIs behave badly and return null for something that’s supposed to be @NonNull, your app can crash. Even when APIs behave well, sometimes their corner cases aren’t well-documented, are unknown or may change overtime. RAVE ensures the data you receive from these sources adheres to the set of expectations described by the annotations present on your models.
To integrate RAVE into your project add the following to your 'build.gradle' file:
buildscript {
repositories {
maven { url 'https://maven.google.com' }
}
}
dependencies {
annotationProcessor 'com.uber:rave-compiler:2.2.0'
implementation 'com.uber:rave:2.2.0'
}To ensure validators are not removed by Proguard, add the following to your proguard configuration:
-keep class * implements com.uber.rave.ValidatorFactoryIf you're using a version of the Android gradle plugin below 2.2 you need to use the apt plugin.
There can only be one ValidatorFactory in any given module/library. Example:
public final class SampleFactory implements ValidatorFactory {
@NonNull
@Override
public BaseValidator generateValidator() {
return new SampleFactory_Generated_Validator();
}
}
In the example above SampleFactory_Generated_Validator is generated once a model references the SampleFactory class using the @Validated annotation. See Step 2.
Example:
…public void validateMyModel(SimpleModel myModel) {
try {
Rave.getInstance().validate(myModel);
} catch (UnsupportedObjectException e) {
// handle unsupported error case.
} catch (RaveException e) {
// handle rave validation error.
}
}
Here's a simple recipe to use Rave with Retrofit 2. This is documented and included in the RAVE sample app.
…There may be some cases in which you want to exclude/ignore certain models from validation. To do this apply @Excluded to the method that should be exempted from validation. RAVE will not generate validation code for this method.
A list of supported annotations can be found here.
Rave currently does not validate fields in a model. Rave only validates model methods. If you want a field in a model validated there must be a getter method for that field.
We'd love for you to contribute to our open source projects. Before we can accept your contributions, we kindly ask you to sign our Uber Contributor License Agreement.
RAVE is released under the Apache License, Version 2.0. See the LICENSE file for more information.
No open issues yet, or sync has not completed.