Jump to: navigation, search

Difference between revisions of "JDT Core/Null Analysis"

(Future)
m (Actual Strategy in the JDT)
(10 intermediate revisions by 2 users not shown)
Line 11: Line 11:
 
}
 
}
 
</css>
 
</css>
This page discusses current work on improving the static null analysis of the JDT compiler.
+
This page describes ongoing work on improving the static null analysis of the JDT compiler.
  
The initial master bug for this work was  {{FixedBug|186342}}.
+
The initial master bug for this work was  {{FixedBug|186342}}, this part has been released for Eclipse Juno (JDT 3.8).
  
  
Line 39: Line 39:
 
* analysis might be more precise than some existing tools provide, because the actual flow analysis in the JDT compiler is already pretty strong (unproven claim).
 
* analysis might be more precise than some existing tools provide, because the actual flow analysis in the JDT compiler is already pretty strong (unproven claim).
  
A preparatory discussion of the design space can be found here: [[/Brainstorming]].
 
  
 
[[Image:Video.png]] See also the recording of this [http://eclipsecon.org/europe2011/ ECE 2011] [http://eclipsecon.org/europe2011/sessions/bye-bye-npe session]: '''[http://www.fosslc.org/drupal/content/bye-bye-npe Bye, bye, NPE]'''
 
[[Image:Video.png]] See also the recording of this [http://eclipsecon.org/europe2011/ ECE 2011] [http://eclipsecon.org/europe2011/sessions/bye-bye-npe session]: '''[http://www.fosslc.org/drupal/content/bye-bye-npe Bye, bye, NPE]'''
Line 45: Line 44:
 
==Actual Strategy in the JDT==
 
==Actual Strategy in the JDT==
  
{{note|Work in progress|With [http://download.eclipse.org/eclipse/downloads/drops/S-3.8M4-201112091447/index.php Eclipse 3.8 M4] we released a first version of this feature. We are working on making this easier to consume in Java project setups, and we will also add quick fixes. The implemented features are complete and tested, but e.g. support for annotating fields or APIs from third-party libraries is currently missing.}}
+
{{note|Work in progress|For Eclipse Juno (JDT 3.8) we released a first version of this feature. The implemented features are complete and tested, but further improvements are still in the pipe line (see [[#Status]]).}}
  
By default the JDT does not support inter-procedural null analysis, however, starting with 3.8 M4 the JDT can be configured to use annotations for extended null checking.
+
By default the JDT does not support inter-procedural null analysis, however, starting with 3.8 the JDT can be configured to use annotations for extended null checking.
 +
 
 +
Up-to-date documentation for the annotation-based null analysis and its new configuration options can be found in the Eclipse help (Eclipse 3.8 and greater):
 +
* '''Java development user guide'''
 +
** '''Reference > Preferences > Java > Compiler > Errors/Warnings'''
 +
**: scroll down to '''Null analysis''' -- [http://help.eclipse.org/topic/org.eclipse.jdt.doc.user/reference/preferences/java/compiler/ref-preferences-errors-warnings.htm read online]
 +
** '''Tasks > Improving Java code quality > Using null annotations'''
 +
**: [http://help.eclipse.org/topic/org.eclipse.jdt.doc.user/tasks/task-using_null_annotations.htm?cp=1_3_9_0 read online]
  
 
===Specifying nullness===
 
===Specifying nullness===
Line 53: Line 59:
 
Null annotations in method signatures can be interpreted as [[/Null Contracts|null contracts]], however, a more general approach considers null annotations as an extension of the type system. Eventually - that is once JSR 308 can be used - all type references should either include or exclude null, which allows for complete checking of any possible dereferencing of null. In other words, a fully annotated program which passes the type checker will never raise an NPE at runtime.
 
Null annotations in method signatures can be interpreted as [[/Null Contracts|null contracts]], however, a more general approach considers null annotations as an extension of the type system. Eventually - that is once JSR 308 can be used - all type references should either include or exclude null, which allows for complete checking of any possible dereferencing of null. In other words, a fully annotated program which passes the type checker will never raise an NPE at runtime.
  
To achieve this guarantee two annotations are used. The specific annotations types can be selected as a preference, but the following defaults are provided (see [[#Compiler configuration explained]]):
+
To achieve this guarantee two annotations are used. The specific annotations types can be selected as a preference, but the following defaults are provided:
 
* [http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/tree/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/NonNull.java org.eclipse.jdt.annotation.NonNull]
 
* [http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/tree/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/NonNull.java org.eclipse.jdt.annotation.NonNull]
 
* [http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/tree/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/Nullable.java org.eclipse.jdt.annotation.Nullable]
 
* [http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/tree/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/Nullable.java org.eclipse.jdt.annotation.Nullable]
Line 66: Line 72:
  
 
The above rules imply that the value from a @NonNull variable can be bound to a variable annotated with @Nullable, but the opposite direction is generally illegal.
 
The above rules imply that the value from a @NonNull variable can be bound to a variable annotated with @Nullable, but the opposite direction is generally illegal.
Only after an explicit null check can a @Nullable variable be treated as being @NonNull for the sake of binding to another @NonNull variable or for dereferencing.
+
Only after an explicit null check can a @Nullable variable be treated as being @NonNull for the sake of binding to another @NonNull variable or for dereferencing. For fields the situation is actually more complex &mdash; please read [http://help.eclipse.org/kepler/topic/org.eclipse.jdt.doc.user/tasks/task-using_null_annotations.htm?cp=1_3_9_0_4#fields "The case of fields"].
  
 
For interaction with inheritance see [[/Null Contracts#Null Contract Inheritance|Null Contract Inheritance]].
 
For interaction with inheritance see [[/Null Contracts#Null Contract Inheritance|Null Contract Inheritance]].
Line 73: Line 79:
 
In order to try the new analysis against any existing Java project the following steps should help:
 
In order to try the new analysis against any existing Java project the following steps should help:
  
* Include the example annotation types in your project:
 
** '''Import > Plug-in Development > Plug-ins and Fragments >
 
*: '''Import from: (o) The active target platform >'''
 
*: '''Select org.eclipse.jdt.annotation > Add'''
 
** and
 
*** for plug-in or OSGi projects
 
**** In your '''build.properties''' add: <code>additional.bundles = org.eclipse.jdt.annotation</code>
 
*** for plain Java projects
 
**** Add the project <code>org.eclipse.jdt.annotation</code> to your build path.
 
 
* Open the compiler preferences for your project:
 
* Open the compiler preferences for your project:
:[[Image:annotation-based-null-analysis.png]]
 
 
:* Ensure compliance is 1.5 or higher
 
:* Ensure compliance is 1.5 or higher
:* Select '''Enable annotation-based null analysis'''
+
:* Find the section '''Null analysis''' and select '''Enable annotation-based null analysis'''
:* Enable any null-related warnings you are interested in
+
::[[Image:annotation-based-null-analysis.png]]
* Define <code>@NonNull</code> as the default at the granularity of your choice (project/package/type):
+
:* You will be prompted to update the severity of some null-related problems, this is recommended.
** '''project''': select '''Use non-null as the project-wide default''' in the preferences
+
* Apply any of the annotations <code>@NonNull</code>, <code>@Nullable</code> or <code>@NonNullByDefault</code> in your code.
 +
** The annotation will be unresolvable at first, but a quick fix is offered to update the project setup:
 +
*: (see also: [http://help.eclipse.org/topic/org.eclipse.jdt.doc.user/tasks/task-using_null_annotations.htm&cp=1_3_9_0_2&anchor=buildpath_setup Help: Setup of the build path])
 +
*:* '''Copy library with default annotations to build path''' (plain Java projects), ''or'':
 +
*:* '''Add library with default annotations to build path''' (Plug-in projects).
 +
* Define <code>@NonNull</code> as the default at the granularity of your choice (package/type):
 
** '''package''': add a file <code>package-info.java</code> with contents like this:
 
** '''package''': add a file <code>package-info.java</code> with contents like this:
**: <code>@org.eclipse.jdt.annotation.NonNullByDefault package org.my.pack.age;</code>
+
**: <code>@NonNullByDefault package org.my.pack.age;</code>
** '''type''': add <code>@org.eclipse.jdt.annotation.NonNullByDefault</code> to the type declaration.
+
** '''type''': add <code>@NonNullByDefault</code> to the type declaration.
 
* At this point you should see plenty of new errors and warnings
 
* At this point you should see plenty of new errors and warnings
  
{{tip|Hints:|Setting the default to <code>@NonNull</code> is the recommended option for new projects, but for existing projects this could require a major clean-up in terms of inserting explicit <code>@Nullable</code> annotations in many locations. Experience shows, that this is a non-trivial task since in existing code the original intention, which parameter/return value should be allowed to be null, is usually blurred. Here starting with no default but adding individual annotations where the intention is clear will cause less disruption. This incremental approach should be seen as a long-term yet low effort task, not only for getting rid of NPEs but also for sorting the responsibilities in the code, which may have eroded over time.}}
+
{{tip|Hints:|Setting the default to <code>@NonNull</code> is the recommended option for new projects, but for existing projects this could require a major clean-up in terms of inserting explicit <code>@Nullable</code> annotations in many locations. Experience shows, that this is a non-trivial task since in existing code the original intention, which parameter/return value should be allowed to be null, is usually blurred. Here starting with no default but adding individual annotations where the intention is clear will cause less disruption. This incremental approach should be seen as a long-term yet low effort task, not only for getting rid of NPEs but also for sorting the responsibilities in the code, which may have eroded over time.<br>For more hints on adpoting these annotations see [[JDT Core/Null Analysis/Adopting Null Annotations|Adoption Null Annotations]].}}
  
 
====Cleaning up====
 
====Cleaning up====
{{warning|Temporarily out of service|The following quick fixes were available in the prototype. They are not supported in Eclipse 3.8M4, but the JDT/UI team is currently adopting the implementation so these quick fixes (and more) should be available soon.}}
+
When applying the new analysis to a big existing project, the sheer number of new problems may look intimidating but that's where quick fixes will come to the rescue.
 
+
When applying the new analysis to a big existing project, the sheer number of new problems may look intimidating but that's where quickfixes will come to the rescue.
+
 
Currently the following problems offer a quickfix:
 
Currently the following problems offer a quickfix:
  
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Type mismatch: required '@NonNull Foo' but the provided value is null</div></div>
+
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Null type mismatch: required '@NonNull Foo' but the provided value is null</div></div>
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Type mismatch: required '@NonNull Foo' but the provided value can be null</div></div>
+
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Null type mismatch: required '@NonNull Foo' but the provided value is specified as @Nullable</div></div> ''not in JDT 3.8.0 - see {{bug|337977#c19}}
* <div class="b"><div class="hover">[[Image:Quickfix_warning_obj.gif]] Potential type mismatch: required '@NonNull Foo' but nullness of the provided value is unknown</div></div>
+
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Null type mismatch: required '@NonNull Foo' but the provided value is inferred as @Nullable</div></div>
 +
* <div class="b"><div class="hover">[[Image:Quickfix_warning_obj.gif]] Null type safety: The expression of type Foo needs unchecked conversion to conform to '@NonNull Foo'</div></div>
 
*: '''Fixable for these locations: return statements''':
 
*: '''Fixable for these locations: return statements''':
 
*: Note that the mentioned @NonNull declaration may be implicit via an applicable default
 
*: Note that the mentioned @NonNull declaration may be implicit via an applicable default
*: In cases 2) and 3) use only with care: the compiler has no clear indication if @Nullable was actually intended or not
+
*: In cases 3) and 4) use only with care: the compiler has no clear indication if @Nullable was actually intended or not
 
*: The fix is:
 
*: The fix is:
 
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Declare method return as @Nullable</div></div>
 
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Declare method return as @Nullable</div></div>
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Redundant null check: The variable foo cannot be null at this location</div></div>
+
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Null comparison always yields false: The variable x is specified as @NonNull</div></div>
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Null comparison always yields false: The variable bar cannot be null at this location</div></div>
+
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Redundant null check: The variable x is specified as @NonNull</div></div>
*: '''Fixable for these locations: read access to a method parameter'''
+
*: '''Fixable for these locations: null check for a method parameter'''
 
*: The fix is:
 
*: The fix is:
 
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Declare method parameter as @Nullable</div></div>
 
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Declare method parameter as @Nullable</div></div>
Line 120: Line 120:
 
*: Note again that the mentioned @NonNull declaration may be due to a default.
 
*: Note again that the mentioned @NonNull declaration may be due to a default.
 
*: Possible fixes are:
 
*: Possible fixes are:
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Declare method return as @NonNull</div></div>
+
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Change return type of foo(..) to '@NonNull'</div></div>
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Adjust overridden method from SuperFoo, mark as returning @Nullable</div></div>
+
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Change return type of overridden foo(..) to '@Nullable'</div></div>
 
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Illegal redefinition of parameter a, inherited method from SuperFoo declares this parameter as @Nullable</div></div>
 
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Illegal redefinition of parameter a, inherited method from SuperFoo declares this parameter as @Nullable</div></div>
 
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Illegal redefinition of parameter a, inherited method from SuperFoo does not constrain this parameter.</div></div>
 
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Illegal redefinition of parameter a, inherited method from SuperFoo does not constrain this parameter.</div></div>
Line 127: Line 127:
 
*: The second form occurs when no null default applies at the scope of the super method.
 
*: The second form occurs when no null default applies at the scope of the super method.
 
*: Possible fixes are:
 
*: Possible fixes are:
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Declare method parameter as @Nullable</div></div>
+
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Change parameter type to '@Nullable'</div></div>
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Adjust overridden method from SuperFoo, mark parameter as @NonNull</div></div>
+
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Change parameter type in overridden 'foo(..)' to '@NonNull'</div></div>
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Missing null annotation: inherited method from Testing declares this parameter as @NonNull</div></div>
+
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Missing non-null annotation: inherited method from SuperClass declares this parameter as @NonNull</div></div>
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Missing null annotation: inherited method from Testing declares this parameter as @Nullable</div></div>
+
* <div class="b"><div class="hover">[[Image:Quickfix_error_obj.gif]] Missing nullable annotation: inherited method from SuperClass declares this parameter as @Nullable</div></div>
 
*: '''Location: Parameter declaration of an overriding method'''
 
*: '''Location: Parameter declaration of an overriding method'''
*: Quickfix is either of:
+
*: Quick fix is either of:
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Declare method parameter as @NonNull</div></div>
+
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Change parameter type to @NonNull</div></div>
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Declare method parameter as @Nullable</div></div>
+
*: <div class="b"><div class="fix">[[Image:Correction_change.gif]] Change parameter type to @Nullable</div></div>
  
These quickfixes can be applied...
+
These quick fixes can be applied...
 
* individually (Ctrl-1)
 
* individually (Ctrl-1)
 
* all occurrences per file (via the hover)
 
* all occurrences per file (via the hover)
 
* all occurrences (via context menu in the Problems view)
 
* all occurrences (via context menu in the Problems view)
Note, that some quickfixes require to modify another compilation unit (file) than the one
+
Note, that some quick fixes require to modify another compilation unit (file) than the one
 
where the problem was observed. For these quickfixes the current implementation doesn't
 
where the problem was observed. For these quickfixes the current implementation doesn't
 
support fixing several equal issues in bulk (for the technical background see
 
support fixing several equal issues in bulk (for the technical background see
 
{{bug|337977}}).
 
{{bug|337977}}).
 
===Compiler configuration explained===
 
By default the JDT does not recognize any null annotations but it can be configured to do so.
 
 
Up-to-date documentation for the new configuration options can be found in the online help (Eclipse 3.8 M4 and greater):
 
* '''Java development user guide > Reference > Preferences > Java > Compiler > Errors/Warnings'''
 
*: scroll down to '''Null analysis'''
 
 
See also '''[[/Options|Options]]''' (''work in progress'').
 
  
 
===Defaults at different levels===
 
===Defaults at different levels===
Line 160: Line 151:
 
* dereference without check.
 
* dereference without check.
  
The  preference "Use non-null as workspace-wide default" allows to globally change this so that any declaration (currently: method parameters and method return) to which no null annotation applies will be considered as nonnull.
+
To generally avoid these weak semantics you may want to declare that by default all types should be considered as nonnull.
  
For more fine-grained control an additional annotation can be used. The qualified type
+
This is done using the annotation 'NonNullByDefault'. The qualified type
 
name of this annotation can be configured using the preference "'NonNullByDefault' annotation".
 
name of this annotation can be configured using the preference "'NonNullByDefault' annotation".
 
 
The built-in value for these preference is <code>org.eclipse.jdt.annotation.NonNullByDefault</code>.
 
The built-in value for these preference is <code>org.eclipse.jdt.annotation.NonNullByDefault</code>.
 +
 
* This annotation takes an optional boolean parameter; when set to false this causes the annotation to ''cancel'' a default that may possible apply at the current location. This is useful when, e.g., sub-classing a legacy class without null annotation, where the sub-class sits in a place that would otherwise apply non-null as the default, which would make all overrides incompatible with inherited methods.
 
* This annotation takes an optional boolean parameter; when set to false this causes the annotation to ''cancel'' a default that may possible apply at the current location. This is useful when, e.g., sub-classing a legacy class without null annotation, where the sub-class sits in a place that would otherwise apply non-null as the default, which would make all overrides incompatible with inherited methods.
  
Line 171: Line 162:
 
method returns and parameters with undefined null status within their scope. (More locations will be supported in the future, but local variables are intentially unaffected by any default).
 
method returns and parameters with undefined null status within their scope. (More locations will be supported in the future, but local variables are intentially unaffected by any default).
  
 +
==Status==
  
 
===Done===
 
===Done===
At the current point the following bugs are resolved:
+
At the current point the following bugs are resolved - functionality is released with Eclipse Juno:
 
* {{FixedBug|186342}}.- [[Image:Ok_green.gif]] [compiler][null] Using annotations for null checking
 
* {{FixedBug|186342}}.- [[Image:Ok_green.gif]] [compiler][null] Using annotations for null checking
 
* {{FixedBug|334455}} - [[Image:Ok_green.gif]] UI for new preferences regarding null annotations (plus a dup: {{FixedBug|364815}}).
 
* {{FixedBug|334455}} - [[Image:Ok_green.gif]] UI for new preferences regarding null annotations (plus a dup: {{FixedBug|364815}}).
Line 179: Line 171:
 
* {{FixedBug|331647}} - [[Image:Ok_green.gif]] [compiler][null] support flexible default mechanism for null-annotations
 
* {{FixedBug|331647}} - [[Image:Ok_green.gif]] [compiler][null] support flexible default mechanism for null-annotations
 
* {{FixedBug|365208}} - [[Image:Ok_green.gif]] [compiler][batch] command line options for annotation based null analysis
 
* {{FixedBug|365208}} - [[Image:Ok_green.gif]] [compiler][batch] command line options for annotation based null analysis
 +
* {{FixedBug|331649}} - [[Image:Ok_green.gif]] [compiler][null] consider null annotations for fields
 +
* {{FixedBug|337977}} - [[Image:Ok_green.gif]] [quick fix] Add quickfixes for null annotations
 +
* {{FixedBug|388281}} - [[Image:Ok_green.gif]] [compiler][null] inheritance of null annotations as an option
 +
 +
===Work in Progress===
 +
* {{bug|392099}} - [[Image:Progress.gif]] [1.8][compiler][null] Apply null annotation on types for null analysis - requires Java 8
  
 
===Future===
 
===Future===
 
The following bugzillas address future improvements of the above strategy:
 
The following bugzillas address future improvements of the above strategy:
* {{bug|337977}} - [[Image:Progress.gif]] [quick fix] Add quickfixes for null annotations - planned for 3.8 M6
 
* {{bug|331649}} - [[Image:Progress.gif]] [compiler][null] consider null annotations for fields
 
 
* {{bug|331651}} - [[Image:Glass.gif]] [compiler][null] Support nullity profiles for libraries
 
* {{bug|331651}} - [[Image:Glass.gif]] [compiler][null] Support nullity profiles for libraries
 
+
* {{bug|414237}} - [[Image:Glass.gif]] [compiler][null] Support a @LazyNonNull annotation for fields
 
[[Category:JDT]]
 
[[Category:JDT]]

Revision as of 10:23, 8 October 2013

This page describes ongoing work on improving the static null analysis of the JDT compiler.

The initial master bug for this work was bug 186342, this part has been released for Eclipse Juno (JDT 3.8).


Introduction

The static analysis of the JDT compiler detects many potential programming problems related to the null-ness of variables: dereferencing a null value (-> NPE), redundant null checks etc.

However, the analysis in JDT ≤ 3.7 is restricted to flow analysis within one method. No assumptions can be made about

  • arguments flowing into a method
  • return values from method calls and
  • field reads.

In order to include these elements in the analysis one could either

  • use whole program analysis (very expensive - not feasible for a (incremental) compiler)
  • explicit contracts via an extended type system or annotations

The second option is well explored in research and some existing tools (like the Checker Framework, JML, FindBugs) already introduce specific annotations to this end.

One could argue that advanced analysis should be left to specialized tools but having something like this in the JDT compiler should show two benefits:

  • feedback is more immediate and it is available for all JDT users without installing more software
  • analysis might be more precise than some existing tools provide, because the actual flow analysis in the JDT compiler is already pretty strong (unproven claim).


Video.png See also the recording of this ECE 2011 session: Bye, bye, NPE

Actual Strategy in the JDT

Note.png
Work in progress
For Eclipse Juno (JDT 3.8) we released a first version of this feature. The implemented features are complete and tested, but further improvements are still in the pipe line (see #Status).


By default the JDT does not support inter-procedural null analysis, however, starting with 3.8 the JDT can be configured to use annotations for extended null checking.

Up-to-date documentation for the annotation-based null analysis and its new configuration options can be found in the Eclipse help (Eclipse 3.8 and greater):

  • Java development user guide
    • Reference > Preferences > Java > Compiler > Errors/Warnings
      scroll down to Null analysis -- read online
    • Tasks > Improving Java code quality > Using null annotations
      read online

Specifying nullness

Null annotations in method signatures can be interpreted as null contracts, however, a more general approach considers null annotations as an extension of the type system. Eventually - that is once JSR 308 can be used - all type references should either include or exclude null, which allows for complete checking of any possible dereferencing of null. In other words, a fully annotated program which passes the type checker will never raise an NPE at runtime.

To achieve this guarantee two annotations are used. The specific annotations types can be selected as a preference, but the following defaults are provided:

For any variable who's type is annotated with @NonNull (or the configured equivalent) the following rules apply:

  • It is illegal to bind null or a value that can be null to the variable. (For fields and local variables this applies to initialization and assignments, for method argument binding a value means to pass an actual argument in a method call).
  • It is legal and safe to dereference such a variable for accessing a field or a method of the bound object.

For any variable who's type is annotated with @Nullable (or the configured equivalent) the following rules apply:

  • It is legal to bind null or a value that can be null to the variable (see details above).
  • It is illegal to dereference such a variable for either field or method access.

The above rules imply that the value from a @NonNull variable can be bound to a variable annotated with @Nullable, but the opposite direction is generally illegal. Only after an explicit null check can a @Nullable variable be treated as being @NonNull for the sake of binding to another @NonNull variable or for dereferencing. For fields the situation is actually more complex — please read "The case of fields".

For interaction with inheritance see Null Contract Inheritance.

Usage

In order to try the new analysis against any existing Java project the following steps should help:

  • Open the compiler preferences for your project:
  • Ensure compliance is 1.5 or higher
  • Find the section Null analysis and select Enable annotation-based null analysis
Annotation-based-null-analysis.png
  • You will be prompted to update the severity of some null-related problems, this is recommended.
  • Apply any of the annotations @NonNull, @Nullable or @NonNullByDefault in your code.
    • The annotation will be unresolvable at first, but a quick fix is offered to update the project setup:
    (see also: Help: Setup of the build path)
    • Copy library with default annotations to build path (plain Java projects), or:
    • Add library with default annotations to build path (Plug-in projects).
  • Define @NonNull as the default at the granularity of your choice (package/type):
    • package: add a file package-info.java with contents like this:
      @NonNullByDefault package org.my.pack.age;
    • type: add @NonNullByDefault to the type declaration.
  • At this point you should see plenty of new errors and warnings
Idea.png
Hints:
Setting the default to @NonNull is the recommended option for new projects, but for existing projects this could require a major clean-up in terms of inserting explicit @Nullable annotations in many locations. Experience shows, that this is a non-trivial task since in existing code the original intention, which parameter/return value should be allowed to be null, is usually blurred. Here starting with no default but adding individual annotations where the intention is clear will cause less disruption. This incremental approach should be seen as a long-term yet low effort task, not only for getting rid of NPEs but also for sorting the responsibilities in the code, which may have eroded over time.
For more hints on adpoting these annotations see Adoption Null Annotations.


Cleaning up

When applying the new analysis to a big existing project, the sheer number of new problems may look intimidating but that's where quick fixes will come to the rescue. Currently the following problems offer a quickfix:

  • Quickfix error obj.gif Null type mismatch: required '@NonNull Foo' but the provided value is null
  • Quickfix error obj.gif Null type mismatch: required '@NonNull Foo' but the provided value is specified as @Nullable
    not in JDT 3.8.0 - see bug 337977#c19
  • Quickfix error obj.gif Null type mismatch: required '@NonNull Foo' but the provided value is inferred as @Nullable
  • Quickfix warning obj.gif Null type safety: The expression of type Foo needs unchecked conversion to conform to '@NonNull Foo'
    Fixable for these locations: return statements:
    Note that the mentioned @NonNull declaration may be implicit via an applicable default
    In cases 3) and 4) use only with care: the compiler has no clear indication if @Nullable was actually intended or not
    The fix is:
    Correction change.gif Declare method return as @Nullable
  • Quickfix error obj.gif Null comparison always yields false: The variable x is specified as @NonNull
  • Quickfix error obj.gif Redundant null check: The variable x is specified as @NonNull
    Fixable for these locations: null check for a method parameter
    The fix is:
    Correction change.gif Declare method parameter as @Nullable
    Otherwise a null check may indeed be unnecessary and should be deleted.
  • Quickfix error obj.gif The return type is incompatible with the @NonNull return from SuperFoo.foo()
    Location: declaration of an overriding method
    Note again that the mentioned @NonNull declaration may be due to a default.
    Possible fixes are:
    Correction change.gif Change return type of foo(..) to '@NonNull'
    Correction change.gif Change return type of overridden foo(..) to '@Nullable'
  • Quickfix error obj.gif Illegal redefinition of parameter a, inherited method from SuperFoo declares this parameter as @Nullable
  • Quickfix error obj.gif Illegal redefinition of parameter a, inherited method from SuperFoo does not constrain this parameter.
    Location: Parameter declaration of an overriding method
    The second form occurs when no null default applies at the scope of the super method.
    Possible fixes are:
    Correction change.gif Change parameter type to '@Nullable'
    Correction change.gif Change parameter type in overridden 'foo(..)' to '@NonNull'
  • Quickfix error obj.gif Missing non-null annotation: inherited method from SuperClass declares this parameter as @NonNull
  • Quickfix error obj.gif Missing nullable annotation: inherited method from SuperClass declares this parameter as @Nullable
    Location: Parameter declaration of an overriding method
    Quick fix is either of:
    Correction change.gif Change parameter type to @NonNull
    Correction change.gif Change parameter type to @Nullable

These quick fixes can be applied...

  • individually (Ctrl-1)
  • all occurrences per file (via the hover)
  • all occurrences (via context menu in the Problems view)

Note, that some quick fixes require to modify another compilation unit (file) than the one where the problem was observed. For these quickfixes the current implementation doesn't support fixing several equal issues in bulk (for the technical background see bug 337977).

Defaults at different levels

If no null annotations are used, the compiler uses the original Java semantics, where the following is legal for all variables of reference types:

  • assign null, and
  • dereference without check.

To generally avoid these weak semantics you may want to declare that by default all types should be considered as nonnull.

This is done using the annotation 'NonNullByDefault'. The qualified type name of this annotation can be configured using the preference "'NonNullByDefault' annotation". The built-in value for these preference is org.eclipse.jdt.annotation.NonNullByDefault.

  • This annotation takes an optional boolean parameter; when set to false this causes the annotation to cancel a default that may possible apply at the current location. This is useful when, e.g., sub-classing a legacy class without null annotation, where the sub-class sits in a place that would otherwise apply non-null as the default, which would make all overrides incompatible with inherited methods.

This annotation can be applied to any package, Java type or method and affects all method returns and parameters with undefined null status within their scope. (More locations will be supported in the future, but local variables are intentially unaffected by any default).

Status

Done

At the current point the following bugs are resolved - functionality is released with Eclipse Juno:

  • bug 186342.- Ok green.gif [compiler][null] Using annotations for null checking
  • bug 334455 - Ok green.gif UI for new preferences regarding null annotations (plus a dup: bug 364815).
  • bug 334457 - Ok green.gif [compiler][null] check compatibility of inherited null contracts
  • bug 331647 - Ok green.gif [compiler][null] support flexible default mechanism for null-annotations
  • bug 365208 - Ok green.gif [compiler][batch] command line options for annotation based null analysis
  • bug 331649 - Ok green.gif [compiler][null] consider null annotations for fields
  • bug 337977 - Ok green.gif [quick fix] Add quickfixes for null annotations
  • bug 388281 - Ok green.gif [compiler][null] inheritance of null annotations as an option

Work in Progress

  • bug 392099 - Progress.gif [1.8][compiler][null] Apply null annotation on types for null analysis - requires Java 8

Future

The following bugzillas address future improvements of the above strategy:

  • bug 331651 - Glass.gif [compiler][null] Support nullity profiles for libraries
  • bug 414237 - Glass.gif [compiler][null] Support a @LazyNonNull annotation for fields