How do I set up NullAway in a Gradle project for Android?

NullAway can be integrated with Android using the Gradle Error Prone plugin, but recent versions may not support Android; refer to the sample app configuration in the README for specific tweaks, and use AndroidX annotations instead of JSpecify.

Is NullAway better than the Checker Framework for Java null checking?

NullAway is faster and more practical with less build overhead, but the Checker Framework offers more comprehensive checks; choose based on whether you prioritize speed and integration or thoroughness in null-safety.

Can NullAway handle Lombok-generated code?

Yes, but it requires specific configuration like adding 'lombok.addLombokGeneratedAnnotation = true' to Lombok config, and compatibility is best-effort with limitations, as noted in the README's Lombok section.

What @Nullable annotations does NullAway support?

NullAway supports various annotations including JSpecify, AndroidX, JetBrains, or any custom @Nullable, making it flexible for different project setups without forcing a specific library.

How to exclude test code from NullAway checks?

In Gradle, you can disable NullAway for test tasks by checking if the task name contains 'test' and setting options.errorprone.disable('NullAway'), as shown in the installation examples.

Does NullAway work with Java 8 or 11?

No, NullAway requires JDK 17 or higher, as specified in the installation overview, so it's not compatible with older Java versions, which may be a barrier for legacy systems.

Open-Awesome

NullAway

MITJavav0.13.6

A fast annotation-based null checker for Java that eliminates NullPointerExceptions with low build-time overhead.

GitHub

4.1k stars338 forks0 contributors

What is NullAway?

NullAway is a static analysis tool for Java that helps developers eliminate NullPointerExceptions (NPEs) by performing compile-time checks based on @Nullable annotations. It identifies potential null dereferences and ensures proper null handling, similar to null-safety features in Kotlin and Swift. The tool integrates with Error Prone and runs during builds with minimal performance impact.

Target Audience

Java developers and teams building large-scale applications who want to improve code reliability by preventing runtime null pointer errors. It's particularly valuable for projects adopting gradual null-safety or migrating from unannotated codebases.

Value Proposition

Developers choose NullAway for its exceptional balance of effectiveness and performance—it catches most production NPEs while adding less than 10% build overhead. Unlike more comprehensive but heavier solutions, it provides practical null-safety with minimal annotation burden and seamless integration into existing Java toolchains.

Overview

A tool to help eliminate NullPointerExceptions (NPEs) in your Java code with low build-time overhead

Use Cases

Best For

Gradually adding null-safety to large existing Java codebases
Preventing NullPointerExceptions in production Java applications
Teams wanting Kotlin-like null safety without switching languages
Java projects using Error Prone for static analysis
Android development with Java (using AndroidX annotations)
Projects needing fast null checking without significant build slowdowns

Not Ideal For

Codebases heavily reliant on Lombok for code generation, due to known incompatibilities and required specific configuration
Projects requiring exhaustive null-safety guarantees, as NullAway is designed for practical, not comprehensive, NPE prevention
Teams using older JDK versions (below 17) or build systems not supported by Error Prone, given its dependencies

Pros & Cons

Pros

Fast Build Integration

Adds typically less than 10% overhead to builds by running as an Error Prone plugin, enabling frequent checks without significant slowdown, as stated in the README.

Flexible Annotation Support

Works with multiple @Nullable annotation libraries like JSpecify, AndroidX, or JetBrains, allowing teams to use their preferred tools without vendor lock-in.

Gradual Adoption Friendly

Supports configurable package scoping to check specific packages, making it easy to incrementally add null-safety to large existing codebases, as highlighted in the features.

Practical NPE Detection

Catches most common NullPointerExceptions observed in production, offering high value with reasonable annotation effort, aligning with its philosophy of practicality.

Cons

Incomplete Null Safety

Does not prevent all possible NPEs, as it focuses on common cases and may miss edge scenarios, unlike more exhaustive tools like the Checker Framework.

Complex Setup for Generated Code

Requires manual configuration to handle code from annotation processors like Dagger, and has issues with Lombok, adding setup complexity and potential build errors.

JDK and Build System Constraints

Mandates JDK 17 or higher and integration with Error Prone, which may not be feasible for legacy projects or those using incompatible build tools.

Frequently Asked Questions

Related Projects

guava

Google core libraries for Java

Stars51,481

Forks11,138

Last commit2 days ago

Hystrix

Hystrix is a latency and fault tolerance library designed to isolate points of access to remote systems, services and 3rd party libraries, stop cascading failure and enable resilience in complex distributed systems where failure is inevitable.

Stars24,455

Forks4,697

Last commit5 months ago

hhvm

A virtual machine for executing programs written in Hack.

FoundationDB - the open source, distributed, transactional key-value store

Stars16,381

Forks1,512