Evitando! = Instruções nulas

Eu uso muito o object != null para evitar o NullPointerException .

Existe uma boa alternativa para isso?

Por exemplo:

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

Isso evita um NullPointerException , quando não se sabe se o object é null ou não.

Observe que a resposta aceita pode estar desatualizada, consulte https://stackoverflow.com/a/2386013/12943 para obter uma abordagem mais recente.

   

Isso para mim soa como um problema razoavelmente comum que desenvolvedores juniores a intermediários tendem a enfrentar em algum momento: eles não sabem ou não confiam nos contratos em que estão participando e sobrescrevem defensivamente para nulos. Além disso, ao escrever seu próprio código, eles tendem a confiar em retornar nulos para indicar algo, exigindo, assim, que o chamador verifique se há nulos.

Para colocar isso de outra maneira, há duas instâncias em que a verificação de nulos aparece:

  1. Onde null é uma resposta válida em termos do contrato; e

  2. Onde não é uma resposta válida.

(2) é fácil. Use instruções assert (afirmações) ou permita falha (por exemplo, NullPointerException ). As asserções são um recurso Java altamente subutilizado que foi adicionado em 1.4. A syntax é:

 assert  

ou

 assert  :  

onde é uma expressão booleana e é um object cuja saída do método toString() será incluída no erro.

Uma instrução assert gera um Error ( AssertionError ) se a condição não for verdadeira. Por padrão, o Java ignora as asserções. Você pode ativar as asserções passando a opção -ea para a JVM. Você pode ativar e desativar asserções para classs e pacotes individuais. Isso significa que você pode validar o código com as asserções durante o desenvolvimento e o teste e desativá-las em um ambiente de produção, embora meus testes tenham mostrado quase nenhum impacto no desempenho das asserções.

Não usar asserções neste caso é OK porque o código simplesmente falhará, que é o que acontecerá se você usar asserções. A única diferença é que, com as afirmações, isso pode acontecer mais cedo, de uma maneira mais significativa e possivelmente com informações extras, o que pode ajudá-lo a descobrir por que isso aconteceu se você não estivesse esperando por isso.

(1) é um pouco mais difícil. Se você não tem controle sobre o código que está chamando, então você está preso. Se null é uma resposta válida, você deve verificar isso.

Se é o código que você controla, no entanto (e esse é frequentemente o caso), então é uma história diferente. Evite usar nulos como resposta. Com methods que retornam collections, é fácil: retornar collections vazias (ou matrizes) em vez de nulos praticamente o tempo todo.

Com não-collections, pode ser mais difícil. Considere isso como um exemplo: se você tiver essas interfaces:

 public interface Action { void doSomething(); } public interface Parser { Action findAction(String userInput); } 

onde o Parser usa a input bruta do usuário e encontra algo para fazer, talvez se você estiver implementando uma interface de linha de comando para algo. Agora você pode fazer o contrato que retorna null se não houver ação apropriada. Isso leva a verificação nula de que você está falando.

Uma solução alternativa é nunca retornar null e, em vez disso, usar o padrão Null Object :

 public class MyParser implements Parser { private static Action DO_NOTHING = new Action() { public void doSomething() { /* do nothing */ } }; public Action findAction(String userInput) { // ... if ( /* we can't find any actions */ ) { return DO_NOTHING; } } } 

Comparar:

 Parser parser = ParserFactory.getParser(); if (parser == null) { // now what? // this would be an example of where null isn't (or shouldn't be) a valid response } Action action = parser.findAction(someInput); if (action == null) { // do nothing } else { action.doSomething(); } 

para

 ParserFactory.getParser().findAction(someInput).doSomething(); 

que é um design muito melhor porque leva a um código mais conciso.

Dito isso, talvez seja inteiramente apropriado que o método findAction () lance uma exceção com uma mensagem de erro significativa – especialmente neste caso em que você está confiando na input do usuário. Seria muito melhor para o método findAction lançar uma Exception do que para o método de chamada explodir com um NullPointerException simples sem explicação.

 try { ParserFactory.getParser().findAction(someInput).doSomething(); } catch(ActionNotFoundException anfe) { userConsole.err(anfe.getMessage()); } 

Ou se você acha que o mecanismo try / catch é muito feio, em vez de Do Nothing, sua ação padrão deve fornecer feedback ao usuário.

 public Action findAction(final String userInput) { /* Code to return requested Action if found */ return new Action() { public void doSomething() { userConsole.err("Action not found: " + userInput); } } } 

Se você usa (ou planeja usar) um IDE Java como JetBrains IntelliJ IDEA , Eclipse ou Netbeans ou uma ferramenta como findbugs, então você pode usar annotations para resolver este problema.

Basicamente, você tem @Nullable e @NotNull .

Você pode usar no método e parâmetros, assim:

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

ou

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

O segundo exemplo não será compilado (no IntelliJ IDEA).

Quando você usa a primeira function helloWorld() em outro trecho de código:

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

Agora o compilador IntelliJ IDEA dirá que a verificação é inútil, já que a function helloWorld() não retornará null , nunca.

Usando o parâmetro

 void someMethod(@NotNull someParameter) { } 

se você escreve algo como:

 someMethod(null); 

Isso não irá compilar.

Último exemplo usando @Nullable

 @Nullable iWantToDestroyEverything() { return null; } 

Fazendo isso

 iWantToDestroyEverything().something(); 

E você pode ter certeza que isso não vai acontecer. 🙂

É uma boa maneira de permitir que o compilador verifique algo mais do que normalmente faz e imponha que seus contratos sejam mais fortes. Infelizmente, não é suportado por todos os compiladores.

No IntelliJ IDEA 10.5 e no, eles adicionaram suporte a qualquer outra implementação @Nullable @NotNull .

Veja a postagem do blog Mais flexível e configurável em annotations @ Nullable / @ NotNull .

Se valores nulos não são permitidos

Se o seu método é chamado externamente, comece com algo como isto:

 public void method(Object object) { if (object == null) { throw new IllegalArgumentException("..."); } 

Então, no restante desse método, você saberá que o object não é nulo.

Se for um método interno (não faz parte de uma API), apenas documente que não pode ser nulo, e é isso.

Exemplo:

 public String getFirst3Chars(String text) { return text.subString(0, 3); } 

No entanto, se o seu método apenas passar o valor, e o próximo método o transmitir, etc., pode ficar problemático. Nesse caso, você pode querer verificar o argumento como acima.

Se nulo for permitido

Isso realmente depende. Se achar que muitas vezes eu faço algo assim:

 if (object == null) { // something } else { // something else } 

Então eu me ramifico e faço duas coisas completamente diferentes. Não há trecho de código feio, porque eu realmente preciso fazer duas coisas diferentes dependendo dos dados. Por exemplo, devo trabalhar na input ou devo calcular um bom valor padrão?


Na verdade, é raro eu usar o idioma ” if (object != null && ... “.

Pode ser mais fácil dar exemplos, se você mostrar exemplos de onde normalmente usa o idioma.

Uau, eu quase odeio adicionar outra resposta quando temos 57 maneiras diferentes de recomendar o NullObject pattern , mas acho que algumas pessoas interessadas nesta questão podem gostar de saber que há uma proposta na tabela para o Java 7 adicionar “null – manipulação segura ” – uma syntax simplificada para a lógica if-not-equal-null.

O exemplo dado por Alex Miller é assim:

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

O ?. significa apenas desreferenciar o identificador esquerdo se ele não for nulo; caso contrário, avalie o restante da expressão como null . Algumas pessoas, como o membro do Java Posse, Dick Wall, e os eleitores da Devoxx realmente adoram essa proposta, mas também há oposição, sob a alegação de que ela realmente encorajaria mais o uso do null como um valor sentinela.


Atualização: Uma proposta oficial para um operador seguro em nulo no Java 7 foi submetida sob o Project Coin. A syntax é um pouco diferente do exemplo acima, mas é a mesma noção.


Atualização: A proposta do operador sem nulo não entrou no Project Coin. Então, você não verá esta syntax no Java 7.

Se valores indefinidos não são permitidos:

Você pode configurar seu IDE para avisá-lo sobre o potencial de desreferência nula. Por exemplo, no Eclipse, consulte Preferências> Java> Compilador> Erros / Avisos / Análise nula .

Se valores indefinidos são permitidos:

Se você quiser definir uma nova API em que os valores indefinidos fazem sentido , use o Padrão de opções (pode ser familiar a partir de idiomas funcionais). Tem as seguintes vantagens:

  • É declarado explicitamente na API se existe uma input ou saída ou não.
  • O compilador força você a lidar com o caso “indefinido”.
  • A opção é uma mônada , portanto, não há necessidade de verificação detalhada de nulos, apenas use map / foreach / getOrElse ou um combinador semelhante para usar com segurança o valor (exemplo) .

O Java 8 possui uma class Optional interna (recomendada); para versões anteriores, há alternativas de biblioteca, por exemplo, a Optional ou FunctionalJava do Guava . Mas, como muitos padrões de estilo funcional, o uso de Option em Java (até mesmo 8) resulta em algum clichê, que você pode reduzir usando uma linguagem de JVM menos detalhada, por exemplo, Scala ou Xtend.

Se você tiver que lidar com uma API que possa retornar valores nulos , não será possível fazer muito em Java. Xtend e Groovy possuem o operador Elvis ?: e o operador de referência do nulo seguro ?. , mas observe que isso retorna null no caso de uma referência nula, portanto, apenas “adia” o tratamento adequado de null.

Apenas para esta situação –

Não verificar se uma variável é nula antes de invocar um método equals (um exemplo de comparação de string abaixo):

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

resultará em um NullPointerException se foo não existir.

Você pode evitar que, se você comparar sua String como esta:

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

Com o Java 8, vem a nova class java.util.Optional que soluciona indiscutivelmente alguns dos problemas. Pode-se pelo menos dizer que melhora a legibilidade do código e, no caso de APIs públicas, torna o contrato da API mais claro para o desenvolvedor do cliente.

Eles funcionam assim:

Um object opcional para um determinado tipo ( Fruit ) é criado como o tipo de retorno de um método. Pode estar vazio ou conter um object Fruit :

 public static Optional find(String name, List fruits) { for (Fruit fruit : fruits) { if (fruit.getName().equals(name)) { return Optional.of(fruit); } } return Optional.empty(); } 

Agora olhe para este código onde procuramos uma lista de Fruit ( fruits ) para uma dada instância de fruta:

 Optional found = find("lemon", fruits); if (found.isPresent()) { Fruit fruit = found.get(); String name = fruit.getName(); } 

Você pode usar o operador map() para executar um cálculo – ou extrair um valor de – um object opcional. orElse() permite fornecer um retorno para valores ausentes.

 String nameOrNull = find("lemon", fruits) .map(f -> f.getName()) .orElse("empty-name"); 

Naturalmente, a verificação do valor nulo / vazio ainda é necessária, mas pelo menos o desenvolvedor está consciente de que o valor pode estar vazio e o risco de esquecer de verificar é limitado.

Em uma API construída a partir do zero usando Optional sempre que um valor de retorno pode estar vazio e retornando um object simples somente quando não pode ser null (convenção), o código do cliente pode abandonar as verificações nulas em valores de retorno de object simples …

É claro que Optional também pode ser usado como um argumento de método, talvez uma maneira melhor de indicar argumentos opcionais do que 5 ou 10 methods de sobrecarga em alguns casos.

Optional oferece outros methods convenientes, como orElse que permitem o uso de um valor padrão e ifPresent que funciona com expressões lambda .

Eu o convido a ler este artigo (minha principal fonte para escrever esta resposta), na qual a solução NullPointerException (e, em geral, ponteiro nulo), bem como a solução (parcial) trazida por Optional são bem explicadas: Objetos Opcionais Java .

Dependendo do tipo de object que você está verificando, você pode usar algumas das classs do apache commons, como: apache commons lang e apache commons collections

Exemplo:

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

ou (dependendo do que você precisa verificar):

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

A class StringUtils é apenas uma das muitas; Existem algumas boas classs nos comuns que fazem manipulação segura nula.

Aqui segue um exemplo de como você pode usar a validação nula em JAVA quando você inclui a biblioteca do 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 você estiver usando o Spring, o Spring também tem a mesma funcionalidade em seu pacote, veja library (spring-2.4.6.jar)

Exemplo sobre como usar este classf estático da primavera (org.springframework.util.Assert)

 Assert.notNull(validationEventHandler,"ValidationHandler not Injected"); 
  • Se você considerar que um object não deve ser nulo (ou é um bug), use uma afirmação.
  • Se o seu método não aceitar parâmetros nulos, diga-o no javadoc e use uma afirmação.

Você tem que verificar o object! = Null somente se você quiser lidar com o caso em que o object pode ser nulo …

Existe uma proposta para adicionar novas annotations no Java7 para ajudar com parâmetros nulos / não nulos: http://tech.puredanger.com/java7/#jsr308

Eu sou fã do código “fail fast”. Pergunte a si mesmo – você está fazendo algo útil no caso em que o parâmetro é nulo? Se você não tem uma resposta clara para o que seu código deve fazer nesse caso … Ou seja, nunca deve ser nulo, em seguida, ignorá-lo e permitir que um NullPointerException seja lançado. O código de chamada fará tanto sentido quanto um NPE quanto seria um IllegalArgumentException, mas será mais fácil para o desenvolvedor depurar e entender o que deu errado se um NPE for lançado em vez de seu código tentar executar alguma outra contingência inesperada. lógica – que finalmente resulta na falha do aplicativo de qualquer maneira.

Às vezes, você tem methods que operam em seus parâmetros que definem uma operação simétrica:

 af(b); < -> bf(a); 

Se você sabe que b nunca pode ser nulo, você pode simplesmente trocá-lo. É mais útil para iguais: em vez de foo.equals("bar"); melhor fazer "bar".equals(foo); .

A estrutura de collections do Google oferece uma maneira boa e elegante de atingir a verificação de nulos.

Existe um método em uma class de biblioteca como esta:

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

E o uso é (com a import static ):

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

Ou no seu exemplo:

 checkNotNull(someobject).doCalc(); 

Em vez de Null Object Pattern – que tem seus usos – você pode considerar situações em que o object nulo é um bug.

Quando a exceção é lançada, examine o rastreamento de pilha e trabalhe com o bug.

O Java 7 tem uma nova class de utilitário java.util.Objects na qual existe um método requireNonNull() . Tudo isso faz é lançar um NullPointerException se seu argumento é nulo, mas ele limpa o código um pouco. Exemplo:

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

O método é mais útil para verificar antes de uma atribuição em um construtor, onde cada uso pode salvar três linhas de código:

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

torna-se

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

Null is not a ‘problem’. It is an integral part of a complete modeling tool set. Software aims to model the complexity of the world and null bears its burden. Null indicates ‘No data’ or ‘Unknown’ in Java and the like. So it is appropriate to use nulls for these purposes. I don’t prefer the ‘Null object’ pattern; I think it rise the ‘ who will guard the guardians ‘ problem.
If you ask me what is the name of my girlfriend I’ll tell you that I have no girlfriend. In the Java language I’ll return null. An alternative would be to throw meaningful exception to indicate some problem that can’t be (or don’t want to be) solved right there and delegate it somewhere higher in the stack to retry or report data access error to the user.

  1. For an ‘unknown question’ give ‘unknown answer’. (Be null-safe where this is correct from business point of view) Checking arguments for null once inside a method before usage relieves multiple callers from checking them before a call.

     public Photo getPhotoOfThePerson(Person person) { if (person == null) return null; // Grabbing some resources or intensive calculation // using person object anyhow. } 

    Previous leads to normal logic flow to get no photo of a non-existent girlfriend from my photo library.

     getPhotoOfThePerson(me.getGirlfriend()) 

    And it fits with new coming Java API (looking forward)

     getPhotoByName(me.getGirlfriend()?.getName()) 

    While it is rather ‘normal business flow’ not to find photo stored into the DB for some person, I used to use pairs like below for some other cases

     public static MyEnum parseMyEnum(String value); // throws IllegalArgumentException public static MyEnum parseMyEnumOrNull(String value); 

    And don’t loathe to type + + (generate javadoc in Eclipse) and write three additional words for you public API. This will be more than enough for all but those who don’t read documentation.

     /** * @return photo or null */ 

    ou

     /** * @return photo, never null */ 
  2. This is rather theoretical case and in most cases you should prefer java null safe API (in case it will be released in another 10 years), but NullPointerException is subclass of an Exception . Thus it is a form of Throwable that indicates conditions that a reasonable application might want to catch ( javadoc )! To use the first most advantage of exceptions and separate error-handling code from ‘regular’ code ( according to creators of Java ) it is appropriate, as for me, to catch NullPointerException .

     public Photo getGirlfriendPhoto() { try { return appContext.getPhotoDataSource().getPhotoByName(me.getGirlfriend().getName()); } catch (NullPointerException e) { return null; } } 

    Questions could arise:

    Q. What if getPhotoDataSource() returns null?
    A. It is up to business logic. If I fail to find a photo album I’ll show you no photos. What if appContext is not initialized? This method’s business logic puts up with this. If the same logic should be more strict then throwing an exception it is part of the business logic and explicit check for null should be used (case 3). The new Java Null-safe API fits better here to specify selectively what implies and what does not imply to be initialized to be fail-fast in case of programmer errors.

    Q. Redundant code could be executed and unnecessary resources could be grabbed.
    A. It could take place if getPhotoByName() would try to open a database connection, create PreparedStatement and use the person name as an SQL parameter at last. The approach for an unknown question gives an unknown answer (case 1) works here. Before grabbing resources the method should check parameters and return ‘unknown’ result if needed.

    Q. This approach has a performance penalty due to the try closure opening.
    A. Software should be easy to understand and modify firstly. Only after this, one could think about performance, and only if needed! and where needed! ( source ), and many others).

    PS. This approach will be as reasonable to use as the separate error-handling code from “regular” code principle is reasonable to use in some place. Consider the next example:

     public SomeValue calculateSomeValueUsingSophisticatedLogic(Predicate predicate) { try { Result1 result1 = performSomeCalculation(predicate); Result2 result2 = performSomeOtherCalculation(result1.getSomeProperty()); Result3 result3 = performThirdCalculation(result2.getSomeProperty()); Result4 result4 = performLastCalculation(result3.getSomeProperty()); return result4.getSomeProperty(); } catch (NullPointerException e) { return null; } } public SomeValue calculateSomeValueUsingSophisticatedLogic(Predicate predicate) { SomeValue result = null; if (predicate != null) { Result1 result1 = performSomeCalculation(predicate); if (result1 != null && result1.getSomeProperty() != null) { Result2 result2 = performSomeOtherCalculation(result1.getSomeProperty()); if (result2 != null && result2.getSomeProperty() != null) { Result3 result3 = performThirdCalculation(result2.getSomeProperty()); if (result3 != null && result3.getSomeProperty() != null) { Result4 result4 = performLastCalculation(result3.getSomeProperty()); if (result4 != null) { result = result4.getSomeProperty(); } } } } } return result; } 

    PPS. For those fast to downvote (and not so fast to read documentation) I would like to say that I’ve never caught a null-pointer exception (NPE) in my life. But this possibility was intentionally designed by the Java creators because NPE is a subclass of Exception . We have a precedent in Java history when ThreadDeath is an Error not because it is actually an application error, but solely because it was not intended to be caught! How much NPE fits to be an Error than ThreadDeath ! But it is not.

  3. Check for ‘No data’ only if business logic implies it.

     public void updatePersonPhoneNumber(Long personId, String phoneNumber) { if (personId == null) return; DataSource dataSource = appContext.getStuffDataSource(); Person person = dataSource.getPersonById(personId); if (person != null) { person.setPhoneNumber(phoneNumber); dataSource.updatePerson(person); } else { Person = new Person(personId); person.setPhoneNumber(phoneNumber); dataSource.insertPerson(person); } } 

    e

     public void updatePersonPhoneNumber(Long personId, String phoneNumber) { if (personId == null) return; DataSource dataSource = appContext.getStuffDataSource(); Person person = dataSource.getPersonById(personId); if (person == null) throw new SomeReasonableUserException("What are you thinking about ???"); person.setPhoneNumber(phoneNumber); dataSource.updatePerson(person); } 

    If appContext or dataSource is not initialized unhandled runtime NullPointerException will kill current thread and will be processed by Thread.defaultUncaughtExceptionHandler (for you to define and use your favorite logger or other notification mechanizm). If not set, ThreadGroup#uncaughtException will print stacktrace to system err. One should monitor application error log and open Jira issue for each unhandled exception which in fact is application error. Programmer should fix bug somewhere in initialization stuff.

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.

Common “problem” in Java indeed.

First, my thoughts on this:

I consider that it is bad to “eat” something when NULL was passed where NULL isn’t a valid value. If you’re not exiting the method with some sort of error then it means nothing went wrong in your method which is not true. Then you probably return null in this case, and in the receiving method you again check for null, and it never ends, and you end up with “if != null”, etc..

So, IMHO, null must be a critical error which prevents further execution (that is, where null is not a valid value).

The way I solve this problem is this:

First, I follow this convention:

  1. All public methods / API always check its arguments for null
  2. All private methods do not check for null since they are controlled methods (just let die with nullpointer exception in case it wasn’t handled above)
  3. The only other methods which do not check for null are utility methods. They are public, but if you call them for some reason, you know what parameters you pass. This is like trying to boil water in the kettle without providing water…

And finally, in the code, the first line of the public method goes like this:

 ValidationUtils.getNullValidator().addParam(plans, "plans").addParam(persons, "persons").validate(); 

Note that addParam() returns self, so that you can add more parameters to check.

Method validate() will throw checked ValidationException if any of the parameters is null (checked or unchecked is more a design/taste issue, but my ValidationException is checked).

 void validate() throws ValidationException; 

The message will contain the following text if, for example, “plans” is null:

Illegal argument value null is encountered for parameter [plans]

As you can see, the second value in the addParam() method (string) is needed for the user message, because you cannot easily detect passed-in variable name, even with reflection (not subject of this post anyway…).

And yes, we know that beyond this line we will no longer encounter a null value so we just safely invoke methods on those objects.

This way, the code is clean, easy maintainable and readable.

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.

In addition to using assert you can use the following:

 if (someobject == null) { // Handle null here then move on. } 

This is slightly better than:

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

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

In my classs, 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 = ""; public void setName(String s) { name = Contract.notNull(s); } } class Contract { public static  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.

Guava, a very useful core library by Google, has a nice and useful API to avoid nulls. I find UsingAndAvoidingNullExplained very helpful.

As explained in the wiki:

Optional is a way of replacing a nullable T reference with a non-null value. An Optional may either contain a non-null T reference (in which case we say the reference is “present”), or it may contain nothing (in which case we say the reference is “absent”). It is never said to “contain null.”

Uso:

 Optional possible = Optional.of(5); possible.isPresent(); // returns true possible.get(); // returns 5 

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

WRAPPING TO OPTION

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

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 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.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 service; public static Optional get() { service = Optional.of(service.orElse(new HomeServices())); return service; } public Optional getRefrigertorControl() { Service s = new RefrigeratorService(); //... return Optional.ofNullable(s); } public static void main(String[] args) { /* Get Home Services handle */ Optional homeServices = HomeServices.get(); if(homeServices != null) { Optional 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 like articles from Nat Pryce. Aqui estão os links:

  • Avoiding Nulls with Polymorphic Dispatch
  • Avoiding Nulls with “Tell, Don’t Ask” Style

In the articles there is also a link to a Git repository for a Java Maybe Type which I find interesting, but I don’t think it alone could decrease the checking code bloat. After doing some research on the Internet, I think != null code bloat could be decreased mainly by careful design.

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!

Probably the best alternative for Java 8 or newer is to use the Optional class.

 Optional stringToUse = Optional.of("optional is there"); stringToUse.ifPresent(System.out::println); 

This is especially handy for long chains of possible null values. Exemplo:

 Optional i = Optional.ofNullable(wsObject.getFoo()) .map(f -> f.getBar()) .map(b -> b.getBaz()) .map(b -> b.getInt()); 

Example on how to throw exception on null:

 Optional optionalCarNull = Optional.ofNullable(someNull); optionalCarNull.orElseThrow(IllegalStateException::new); 

Java 7 introduced the Objects.requireNonNull method which can be handy when something should be checked for non-nullness. Exemplo:

 String lowerVal = Objects.requireNonNull(someVar, "input cannot be null or empty").toLowerCase(); 

May I answer it more generally!

We usually face this issue when the methods get the parameters in the way we not expected (bad method call is programmer’s fault). For example: you expect to get an object, instead you get a null. You expect to get an String with at least one character, instead you get an empty String …

So there is no difference between:

 if(object == null){ //you called my method badly! 

}

ou

 if(str.length() == 0){ //you called my method badly again! } 

They both want to make sure that we received valid parameters, before we do any other functions.

As mentioned in some other answers, to avoid above problems you can follow the Design by contract pattern. Please see http://en.wikipedia.org/wiki/Design_by_contract .

To implement this pattern in java, you can use core java annotations like javax.annotation.NotNull or use more sophisticated libraries like Hibernate Validator .

Just a sample:

 getCustomerAccounts(@NotEmpty String customerId,@Size(min = 1) String accountType) 

Now you can safely develop the core function of your method without needing to check input parameters, they guard your methods from unexpected parameters.

You can go a step further and make sure that only valid pojos could be created in your application. (sample from hibernate validator site)

 public class Car { @NotNull private String manufacturer; @NotNull @Size(min = 2, max = 14) private String licensePlate; @Min(2) private int seatCount; // ... } 

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.

  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 lemmings; String[] names; void checkLemmings() { if (lemmings != null) for(lemming: lemmings) { // do something } } // Good ArrayList lemmings = new ArrayList(); 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.

This is the most common error occurred for most of the developers.

We have number of ways to handle this.

Approach 1:

 org.apache.commons.lang.Validate //using apache framework 

notNull(Object object, String message)

Approach 2:

 if(someObject!=null){ // simply checking against null } 

Approach 3:

 @isNull @Nullable // using annotation based validation 

Approach 4:

 // by writing static method and calling it across whereever we needed to check the validation static  T isNull(someObject e){ if(e == null){ throw new NullPointerException(); } return e; } 
 public static  T ifNull(T toCheck, T ifNull) { if (toCheck == null) { return ifNull; } return toCheck; }