e3ac08d - platform/external/nullaway

commit	e3ac08d96293d4c3a50df015e31c09d14bc71c21	[log] [tgz]
author	Manu Sridharan <msridhar@gmail.com>	Tue Dec 19 13:48:35 2017 -0800
committer	GitHub <noreply@github.com>	Tue Dec 19 13:48:35 2017 -0800
tree	47ad0e16ce154bca40ef16e4ecff0803e7018739
parent	721d21739ec9d3e2fbd01a79b5f106afb11bc702 [diff]

tree: 47ad0e16ce154bca40ef16e4ecff0803e7018739

README.md

NullAway: Fast Annotation-Based Null Checking for Java

NullAway is a tool to help eliminate NullPointerExceptions (NPEs) in your Java code. To use NullAway, first add @Nullable annotations in your code wherever a field, method parameter, or return value may be null. Given these annotations, NullAway performs a series of type-based, local checks to ensure that any pointer that gets dereferenced in your code cannot be null. NullAway is similar to the type-based nullability checking in the Kotlin and Swift languages, and the Checker Framework and Eradicate null checkers for Java.

NullAway is fast. It is built as a plugin to Error Prone and can run on every single build of your code. In our measurements, the build-time overhead of running NullAway is usually less than 10%. NullAway is also practical: it does not prevent all possible NPEs in your code, but it catches most of the NPEs we have observed in production while imposing a reasonable annotation burden, giving a great “bang for your buck.” At Uber, we combine NullAway with RAVE to obtain thorough protection against NPEs in our Android apps.

Installation

Overview

NullAway requires that you build your code with Error Prone, version 2.1.1 or higher. See the Error Prone documentation for instructions on getting started with Error Prone and integration with your build system. The instructions below assume you are using Gradle; see the docs for discussion of other build systems.

Gradle

Java (non-Android)

To integrate NullAway into your non-Android Java project, add the following to your build.gradle file:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
}

plugins {
  // we assume you are already using the Java plugin
  id "net.ltgt.apt" version "0.13"
  id "net.ltgt.errorprone" version "0.0.13"
}

dependencies {
  apt "com.uber.nullaway:nullaway:0.2.2"

  // Optional, some source of nullability annotations.
  // Not required on Android if you use the support 
  // library nullability annotations.
  compileOnly "com.google.code.findbugs:jsr305:3.0.2"

  errorprone "com.google.errorprone:error_prone_core:2.1.3"
}

tasks.withType(JavaCompile) {
  // remove the if condition if you want to run NullAway on test code
  if (!name.toLowerCase().contains("test")) {
    options.compilerArgs += ["-Xep:NullAway:ERROR", "-XepOpt:NullAway:AnnotatedPackages=com.uber"]
  }
}

Let's walk through this script step by step. The buildscript section of the script adds the Maven repository for Gradle plugins. The plugins section pulls in the Gradle Error Prone plugin for Error Prone integration, and the Gradle APT plugin to ease specification of annotation processor dependencies for a build. We need the latter since Error Prone loads plugin checkers from the annotation processor path. If you are using the older apply plugin syntax instead of a plugins block, the following is equivalent:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "net.ltgt.gradle:gradle-errorprone-plugin:0.0.11"
    classpath "net.ltgt.gradle:gradle-apt-plugin:0.11"
  }
}

apply plugin: 'net.ltgt.errorprone'
apply plugin: 'let.ltgt.apt'

In dependencies, the apt line loads NullAway, and the compileOnly line loads a JSR 305 library which provides a suitable @Nullable annotation (javax.annotation.Nullable). NullAway allows for any @Nullable annotation to be used, so, e.g., @Nullable from the Android Support Library or JetBrains annotations is also fine. The errorprone line ensures that a compatible version of Error Prone is used.

Finally, in the tasks.withType(JavaCompile) section, we pass some configuration options to NullAway as compiler arguments. The first argument -Xep:NullAway:ERROR is a standard Error Prone argument that sets NullAway issues to the error level; by default NullAway emits warnings. The second argument, -XepOpt:NullAway:AnnotatedPackages=com.uber, tells NullAway that source code in packages under the com.uber namespace should be checked for null dereferences and proper usage of @Nullable annotations, and that class files in these packages should be assumed to have correct usage of @Nullable (see the docs for more detail). NullAway requires at least the AnnotatedPackages configuration argument to run, in order to distinguish between annotated and unannotated code. See the configuration docs for other useful configuration options.

We recommend addressing all the issues that Error Prone reports, particularly those reported as errors (rather than warnings). But, if you'd like to try out NullAway without running other Error Prone checks, you can pass "-XepDisableAllChecks" to the compiler, before the NullAway-specific arguments.

Snapshots of the development version are available in Sonatype's snapshots repository.

Android

The configuration for an Android project is very similar to the Java case, with two key differences:

The net.ltgt.apt plugin is not required.
The com.google.code.findbugs:jsr305:3.0.2 dependence can be removed; you can use the android.support.annotation.Nullable annotation from the Android Support library.
Rather than declaring NullAway as an apt dependence, use the annotationProcessor configuration:

dependencies {
  annotationProcessor "com.uber.nullaway:nullaway:0.2.2"
}

See the sample-app build.gradle for a complete example.

Annotation Processors / Generated Code

Some annotation processors like Dagger and AutoValue generate code into the same package namespace as your own code. This can cause problems when setting NullAway to the ERROR level as suggested above, since errors in this generated code will block the build. Currently the best solution to this problem is to completely disable Error Prone on generated code, using the -XepExcludedPaths option added in Error Prone 2.13 (documented here). To use, figure out which directory contains the generated code, and add that directory to the excluded path regex.

Note for Dagger users: Dagger versions older than 2.12 can have bad interactions with NullAway; see here. Please update to Dagger 2.12 to fix the problem.

Code Example

Let's see how NullAway works on a simple code example:

static void log(Object x) {
    System.out.println(x.toString());
}
static void foo() {
    log(null);
}

This code is buggy: when foo() is called, the subsequent call to log() will fail with an NPE. You can see this error in the NullAway sample app by running:

cp sample/src/main/java/com/uber/mylib/MyClass.java.buggy sample/src/main/java/com/uber/mylib/MyClass.java
./gradlew build

By default, NullAway assumes every method parameter, return value, and field is non-null, i.e., it can never be assigned a null value. In the above code, the x parameter of log() is assumed to be non-null. So, NullAway reports the following error:

warning: [NullAway] passing @Nullable parameter 'null' where @NonNull is required
    log(null);
        ^

We can fix this error by allowing null to be passed to log(), with a @Nullable annotation:

static void log(@Nullable Object x) {
    System.out.println(x.toString());
}

With this annotation, NullAway points out the possible null dereference:

warning: [NullAway] dereferenced expression x is @Nullable
    System.out.println(x.toString());
                        ^

We can fix this warning by adding a null check:

static void log(@Nullable Object x) {
    if (x != null) {
        System.out.println(x.toString());
    }
}

With this change, all the NullAway warnings are fixed.

For more details on NullAway's checks, error messages, and limitations, see our detailed guide.

Support

Please feel free to open a GitHub issue if you have any questions on how to use NullAway. Or, you can join the NullAway Discord server and ask us a question there.

Contributors

We'd love for you to contribute to NullAway! Please note that once you create a pull request, you will be asked to sign our Uber Contributor License Agreement.

License

NullAway is licensed under the MIT license. See the LICENSE.txt file for more information.