[Java] Vermeiden! = Null-Anweisungen



Answers

Wenn Sie eine Java-IDE wie JetBrains IntelliJ IDEA , Eclipse oder Netbeans oder ein Tool wie Findbugs verwenden (oder planen), können Sie Anmerkungen verwenden, um dieses Problem zu lösen.

Im Grunde haben Sie @Nullable und @NotNull .

Sie können in Methode und Parameter wie folgt verwenden:

@NotNull public static String helloWorld() {
    return "Hello World";
}

oder

@Nullable public static String helloWorld() {
    return "Hello World";
}

Das zweite Beispiel wird nicht kompiliert (in IntelliJ IDEA).

Wenn Sie die erste helloWorld() Funktion in einem anderen Codeabschnitt verwenden:

public static void main(String[] args)
{
    String result = helloWorld();
    if(result != null) {
        System.out.println(result);
    }
}

Der IntelliJ IDEA-Compiler wird Ihnen nun mitteilen, dass die Überprüfung nutzlos ist, da die Funktion helloWorld() null helloWorld() .

Parameter verwenden

void someMethod(@NotNull someParameter) { }

wenn du etwas schreibst wie:

someMethod(null);

Dies wird nicht kompiliert.

Letztes Beispiel mit @Nullable

@Nullable iWantToDestroyEverything() { return null; }

Dies tun

iWantToDestroyEverything().something();

Und Sie können sicher sein, dass dies nicht passieren wird. :)

Es ist eine gute Möglichkeit, den Compiler etwas mehr überprüfen zu lassen, als es normalerweise der Fall ist, und Ihre Verträge stärker zu machen. Leider wird es nicht von allen Compilern unterstützt.

In IntelliJ IDEA 10.5 und @Nullable @NotNull sie Unterstützung für jede andere @Nullable @NotNull Implementierung hinzu.

Siehe Blog-Post Weitere flexible und konfigurierbare Annullierungen für @ Nullable / @ NotNull .

Question

Ich benutze object != null viel, um NullPointerException zu vermeiden.

Gibt es dafür eine gute Alternative?

Beispielsweise:

if (someobject != null) {
    someobject.doCalc();
}

Dies vermeidet eine NullPointerException , wenn unbekannt ist, ob das Objekt null oder nicht.

Beachten Sie, dass die akzeptierte Antwort veraltet sein kann, siehe https://.com/a/2386013/12943 für einen neueren Ansatz.




Java 7 hat eine neue java.util.Objects Dienstprogrammklasse, für die eine requireNonNull() -Methode existiert. All dies bewirkt, dass eine NullPointerException wenn das Argument null ist, aber es den Code ein wenig aufräumt. Beispiel:

Objects.requireNonNull(someObject);
someObject.doCalc();

Die Methode ist am nützlichsten für das checking kurz vor einer Zuweisung in einem Konstruktor, wo jede Verwendung von es drei Codezeilen speichern kann:

Parent(Child child) {
   if (child == null) {
      throw new NullPointerException("child");
   }
   this.child = child;
}

wird

Parent(Child child) {
   this.child = Objects.requireNonNull(child, "child");
}



Wow, ich hasse fast eine weitere Antwort, wenn wir 57 verschiedene Möglichkeiten haben, das NullObject pattern zu empfehlen, aber ich denke, dass einige Leute, die an dieser Frage interessiert sind, gerne wissen würden, dass es einen Vorschlag für Java 7 gibt, "null" hinzuzufügen -safe handling "-eine rationalisierte Syntax für if-not-equal-null-Logik.

Das Beispiel von Alex Miller sieht so aus:

public String getPostcode(Person person) {  
  return person?.getAddress()?.getPostcode();  
}  

Die ?. bedeutet, dass nur der linke Bezeichner de-referenziert, wenn er nicht null ist, andernfalls den Rest des Ausdrucks als null auswerten. Einige Leute, wie das Mitglied von Java Posse, Dick Wall, und die Wähler von Devoxx lieben diesen Vorschlag wirklich, aber es gibt auch Opposition, mit der Begründung, dass sie tatsächlich die Verwendung von null als Sentinel-Wert fördern wird.

Update: Ein proposed für einen Null-Safe-Operator in Java 7 wurde unter Project Coin eingereicht . Die Syntax ist ein wenig anders als das obige Beispiel, aber es ist die gleiche Idee.

Update: Der Vorschlag des Null-sicheren Betreibers hat es nicht in Project Coin geschafft. Daher wird diese Syntax in Java 7 nicht angezeigt.




Ultimately, the only way to completely solve this problem is by using a different programming language:

  • In Objective-C, you can do the equivalent of invoking a method on nil , and absolutely nothing will happen. This makes most null checks unnecessary, but it can make errors much harder to diagnose.
  • In Nice , a Java-derived language, there are two versions of all types: a potentially-null version and a not-null version. You can only invoke methods on not-null types. Potentially-null types can be converted to not-null types through explicit checking for null. This makes it much easier to know where null checks are necessary and where they aren't.



Just don't ever use null. Don't allow it.

In my classes, most fields and local variables have non-null default values, and I add contract statements (always-on asserts) everywhere in the code to make sure this is being enforced (since it's more succinct, and more expressive than letting it come up as an NPE and then having to resolve the line number, etc.).

Once I adopted this practice, I noticed that the problems seemed to fix themselves. You'd catch things much earlier in the development process just by accident and realize you had a weak spot.. and more importantly.. it helps encapsulate different modules' concerns, different modules can 'trust' each other, and no more littering the code with if = null else constructs!

This is defensive programming and results in much cleaner code in the long run. Always sanitize the data, eg here by enforcing rigid standards, and the problems go away.

class C {
    private final MyType mustBeSet;
    public C(MyType mything) {
       mustBeSet=Contract.notNull(mything);
    }
   private String name = "<unknown>";
   public void setName(String s) {
      name = Contract.notNull(s);
   }
}


class Contract {
    public static <T> T notNull(T t) { if (t == null) { throw new ContractException("argument must be non-null"); return t; }
}

The contracts are like mini-unit tests which are always running, even in production, and when things fail, you know why, rather than a random NPE you have to somehow figure out.




Ich bin ein Fan von "fail fast" -Code. Fragen Sie sich - machen Sie etwas Nützliches in dem Fall, in dem der Parameter null ist? Wenn Sie keine klare Antwort darauf haben, was Ihr Code in diesem Fall tun soll ... Dh, es sollte niemals Null sein, dann ignorieren Sie es und lassen Sie eine NullPointerException auslösen. Der aufrufende Code wird für eine NPE genauso nützlich sein wie für eine IllegalArgumentException. Für den Entwickler ist es jedoch einfacher zu debuggen und zu verstehen, was beim Senden einer NPE fehlgeschlagen ist, anstatt dass der Code versucht, eine andere unerwartete Ausnahme durchzuführen Logik - was letztendlich dazu führt, dass die Anwendung trotzdem versagt.




I've tried the NullObjectPattern but for me is not always the best way to go. There are sometimes when a "no action" is not appropiate.

NullPointerException is a Runtime exception that means it's developers fault and with enough experience it tells you exactly where is the error.

Now to the answer:

Try to make all your attributes and its accessors as private as possible or avoid to expose them to the clients at all. You can have the argument values in the constructor of course, but by reducing the scope you don't let the client class pass an invalid value. If you need to modify the values, you can always create a new object . You check the values in the constructor only once and in the rest of the methods you can be almost sure that the values are not null.

Of course, experience is the better way to understand and apply this suggestion.

Byte!




Nur für diese Situation - Vermeiden der Überprüfung auf Null vor einem Zeichenfolgenvergleich:

if ( foo.equals("bar") ) {
 // ...
}

führt zu einer NullPointerException wenn foo nicht existiert.

Sie können das vermeiden, wenn Sie Ihre String wie folgt vergleichen:

if ( "bar".equals(foo) ) {
 // ...
}



Asking that question points out that you may be interested in error handling strategies. Your team's architect should decide how to work errors. There are several ways to do this:

  1. allow the Exceptions to ripple through - catch them at the 'main loop' or in some other managing routine.

    • check for error conditions and handle them appropriately

Sure do have a look at Aspect Oriented Programming, too - they have neat ways to insert if( o == null ) handleNull() into your bytecode.




public static <T> T ifNull(T toCheck, T ifNull) {
    if (toCheck == null) {
           return ifNull;
    }
    return toCheck;
}



  1. Never initialise variables to null.
  2. If (1) is not possible, initialise all collections and arrays to empty collections/arrays.

Doing this in your own code and you can avoid != null checks.

Most of the time null checks seem to guard loops over collections or arrays, so just initialise them empty, you won't need any null checks.

// Bad
ArrayList<String> lemmings;
String[] names;

void checkLemmings() {
    if (lemmings != null) for(lemming: lemmings) {
        // do something
    }
}



// Good
ArrayList<String> lemmings = new ArrayList<String>();
String[] names = {};

void checkLemmings() {
    for(lemming: lemmings) {
        // do something
    }
}

There is a tiny overhead in this, but it's worth it for cleaner code and less NullPointerExceptions.




Je nachdem, welche Art von Objekten Sie überprüfen, können Sie möglicherweise einige der Klassen in den Apache-Commons verwenden, wie zum Beispiel: apache commons lang und apache commons collections

Beispiel:

String foo;
...
if( StringUtils.isBlank( foo ) ) {
   ///do something
}

oder (abhängig davon, was Sie überprüfen müssen):

String foo;
...
if( StringUtils.isEmpty( foo ) ) {
   ///do something
}

Die StringUtils-Klasse ist nur eine von vielen. Es gibt einige gute Klassen in den Commons, die keine sichere Manipulation durchführen.

Hier folgt ein Beispiel, wie Sie in JAVA null vallidation verwenden können, wenn Sie die Apache-Bibliothek (commons-lang-2.4.jar) einschließen

public DOCUMENT read(String xml, ValidationEventHandler validationEventHandler) {
    Validate.notNull(validationEventHandler,"ValidationHandler not Injected");
    return read(new StringReader(xml), true, validationEventHandler);
}

Und wenn Sie Spring verwenden, hat Spring auch die gleiche Funktionalität in seinem Paket, siehe Bibliothek (spring-2.4.6.jar)

Beispiel zur Verwendung dieses statischen classf von spring (org.springframework.util.Assert)

Assert.notNull(validationEventHandler,"ValidationHandler not Injected");



I highly disregard answers that suggest using the null objects in every situation. This pattern may break the contract and bury problems deeper and deeper instead of solving them, not mentioning that used inappropriately will create another pile of boilerplate code that will require future maintenance.

In reality if something returned from a method can be null and the calling code has to make decision upon that, there should an earlier call that ensures the state.

Also keep in mind, that null object pattern will be memory hungry if used without care. For this - the instance of a NullObject should be shared between owners, and not be an unigue instance for each of these.

Also I would not recommend using this pattern where the type is meant to be a primitive type representation - like mathematical entities, that are not scalars: vectors, matrices, complex numbers and POD(Plain Old Data) objects, which are meant to hold state in form of Java built-in types. In the latter case you would end up calling getter methods with arbitrary results. For example what should a NullPerson.getName() method return?

It's worth considering such cases in order to avoid absurd results.




This is a very common problem for every Java developer. So there is official support in Java 8 to address these issues without cluttered code.

Java 8 has introduced java.util.Optional<T> . It is a container that may or may not hold a non-null value. Java 8 has given a safer way to handle an object whose value may be null in some of the cases. It is inspired from the ideas of Haskell and Scala .

In a nutshell, the Optional class includes methods to explicitly deal with the cases where a value is present or absent. However, the advantage compared to null references is that the Optional<T> class forces you to think about the case when the value is not present. As a consequence, you can prevent unintended null pointer exceptions.

In above example we have a home service factory that returns a handle to multiple appliances available in the home. But these services may or may not be available/functional; it means it may result in a NullPointerException. Instead of adding a null if condition before using any service, let's wrap it in to Optional<Service>.

WRAPPING TO OPTION<T>

Let's consider a method to get a reference of a service from a factory. Instead of returning the service reference, wrap it with Optional. It lets the API user know that the returned service may or may not available/functional, use defensively

public Optional<Service> getRefrigertorControl() {
      Service s = new  RefrigeratorService();
       //...
      return Optional.ofNullable(s);
   }

As you see Optional.ofNullable() provides an easy way to get the reference wrapped. There are another ways to get the reference of Optional, either Optional.empty() & Optional.of() . One for returning an empty object instead of retuning null and the other to wrap a non-nullable object, respectively.

SO HOW EXACTLY IT HELPS TO AVOID A NULL CHECK?

Once you have wrapped a reference object, Optional provides many useful methods to invoke methods on a wrapped reference without NPE.

Optional ref = homeServices.getRefrigertorControl();
ref.ifPresent(HomeServices::switchItOn);

Optional.ifPresent invokes the given Consumer with a reference if it is a non-null value. Otherwise, it does nothing.

@FunctionalInterface
public interface Consumer<T>

Represents an operation that accepts a single input argument and returns no result. Unlike most other functional interfaces, Consumer is expected to operate via side-effects. It is so clean and easy to understand. In the above code example, HomeService.switchOn(Service) gets invoked if the Optional holding reference is non-null.

We use the ternary operator very often for checking null condition and return an alternative value or default value. Optional provides another way to handle the same condition without checking null. Optional.orElse(defaultObj) returns defaultObj if the Optional has a null value. Let's use this in our sample code:

public static Optional<HomeServices> get() {
    service = Optional.of(service.orElse(new HomeServices()));
    return service;
}

Now HomeServices.get() does same thing, but in a better way. It checks whether the service is already initialized of not. If it is then return the same or create a new New service. Optional<T>.orElse(T) helps to return a default value.

Finally, here is our NPE as well as null check-free code:

import java.util.Optional;
public class HomeServices {
    private static final int NOW = 0;
    private static Optional<HomeServices> service;

public static Optional<HomeServices> get() {
    service = Optional.of(service.orElse(new HomeServices()));
    return service;
}

public Optional<Service> getRefrigertorControl() {
    Service s = new  RefrigeratorService();
    //...
    return Optional.ofNullable(s);
}

public static void main(String[] args) {
    /* Get Home Services handle */
    Optional<HomeServices> homeServices = HomeServices.get();
    if(homeServices != null) {
        Optional<Service> refrigertorControl = homeServices.get().getRefrigertorControl();
        refrigertorControl.ifPresent(HomeServices::switchItOn);
    }
}

public static void switchItOn(Service s){
         //...
    }
}

The complete post is NPE as well as Null check-free code … Really? .




Das Google Collections Framework bietet eine gute und elegante Möglichkeit, den Null-Check zu erreichen.

Es gibt eine Methode in einer Bibliotheksklasse wie folgt:

static <T> T checkNotNull(T e) {
   if (e == null) {
      throw new NullPointerException();
   }
   return e;
}

Und die Verwendung ist (mit import static ):

...
void foo(int a, Person p) {
   if (checkNotNull(p).getAge() > a) {
      ...
   }
   else {
      ...
   }
}
...

Oder in Ihrem Beispiel:

checkNotNull(someobject).doCalc();



Links