[Java] Evitare! = Istruzioni nulle


Answers

Se si utilizza (o si prevede di utilizzare) un IDE Java come IDEA IntelliJ JetBrains , Eclipse o Netbeans o uno strumento come findbug, è possibile utilizzare le annotazioni per risolvere questo problema.

Fondamentalmente, hai @Nullable e @NotNull .

Puoi usare in metodo e parametri, come questo:

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

o

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

Il secondo esempio non verrà compilato (in IntelliJ IDEA).

Quando si utilizza la prima funzione helloWorld() in un'altra parte di codice:

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

Ora il compilatore IDEA IntelliJ ti dirà che il controllo è inutile, dal momento che la funzione helloWorld() non restituirà null , mai.

Utilizzando il parametro

void someMethod(@NotNull someParameter) { }

se scrivi qualcosa come:

someMethod(null);

Questo non verrà compilato.

Ultimo esempio con @Nullable

@Nullable iWantToDestroyEverything() { return null; }

Facendo questo

iWantToDestroyEverything().something();

E puoi star certo che questo non accadrà. :)

È un buon modo per consentire al compilatore di controllare qualcosa di più di quello che fa di solito e per rafforzare i tuoi contratti. Sfortunatamente, non è supportato da tutti i compilatori.

In IntelliJ IDEA 10.5 e su, hanno aggiunto il supporto per qualsiasi altra implementazione @Nullable @NotNull .

Vedi post sul blog Altre annotazioni flessibili e configurabili @ Nullable / @ NotNull .

Question

Io uso object != null molto per evitare NullPointerException .

C'è una buona alternativa a questo?

Per esempio:

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

Questo evita una NullPointerException , quando è sconosciuto se l'oggetto è null o meno.

Si noti che la risposta accettata potrebbe non essere aggiornata, consultare https://.com/a/2386013/12943 per un approccio più recente.




Wow, odio quasi aggiungere un'altra risposta quando abbiamo 57 modi diversi per raccomandare il NullObject pattern , ma penso che alcune persone interessate a questa domanda possano piacere sapere che c'è una proposta sulla tabella per Java 7 da aggiungere "null -gestione sicura " -una sintassi semplificata per la logica if-not-equal-null.

L'esempio dato da Alex Miller assomiglia a questo:

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

Il ?. significa solo de-referenziare l'identificatore sinistro se non è nullo, altrimenti valuta il resto dell'espressione come null . Alcune persone, come Dick Wall, membro di Java Posse, e gli elettori di Devoxx amano davvero questa proposta, ma c'è anche un'opposizione, sulla base del fatto che in realtà incoraggerà maggiormente l'uso del null come valore sentinella.

Aggiornamento: una proposed per un operatore null-safe in Java 7 è stata presentata sotto Project Coin. La sintassi è leggermente diversa dall'esempio sopra, ma è la stessa nozione.

Aggiornamento: la proposta dell'operatore null-safe non è stata convertita in Project Coin. Quindi, non vedrai questa sintassi in Java 7.




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.




Sono un fan del codice "fail fast". Chiediti: stai facendo qualcosa di utile nel caso in cui il parametro sia nullo? Se non si dispone di una risposta chiara per ciò che il codice dovrebbe fare in quel caso ... Cioè non dovrebbe mai essere nullo in primo luogo, quindi ignorarlo e consentire che venga lanciata una NullPointerException. Il codice chiamante avrà lo stesso senso di un NPE come sarebbe un IllegalArgumentException, ma sarà più facile per lo sviluppatore eseguire il debug e capire cosa è andato storto se viene lanciato un NPE piuttosto che il codice che tenta di eseguire qualche altro imprevisto logica - che alla fine si traduce nell'errore dell'applicazione in ogni caso.




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? .




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.




Solo per questa situazione - Evitare il controllo di null prima di confrontare una stringa:

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

genererà NullPointerException se foo non esiste.

Puoi evitarlo se confronti le tue String questo modo:

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.




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.




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.



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!




Il framework delle raccolte Google offre un modo valido ed elegante per ottenere il controllo nulla.

C'è un metodo in una classe di libreria come questa:

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

E l'utilizzo è (con l' import static ):

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

O nel tuo esempio:

checkNotNull(someobject).doCalc();



Java 7 ha una nuova classe di utilità java.util.Objects su cui esiste un metodo requireNonNull() . Tutto ciò che viene fatto è lanciare una NullPointerException se il suo argomento è nullo, ma ripulisce un po 'il codice. Esempio:

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

Il metodo è molto utile per checking poco prima di un compito in un costruttore, in cui ogni suo utilizzo può salvare tre righe di codice:

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

diventa

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



A seconda del tipo di oggetti che stai controllando, potresti essere in grado di utilizzare alcune delle classi dei comuni apache come: apache commons lang e apache commons collections

Esempio:

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

oppure (a seconda di cosa è necessario controllare):

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

La classe StringUtils è solo una delle tante; ci sono alcune buone classi nei beni comuni che fanno manipolazioni nulle.

Segue un esempio di come è possibile utilizzare null vallidation in JAVA quando si include la libreria apache (commons-lang-2.4.jar)

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

E se usi Spring, Spring ha anche la stessa funzionalità nel suo pacchetto, vedi library (spring-2.4.6.jar)

Esempio su come usare questo statf classf da spring (org.springframework.util.Assert)

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



Links