Что такое исключение NullPointerException и как его исправить?

Oct 20 2008

Что такое исключения нулевого указателя ( java.lang.NullPointerException) и что их вызывает?

Какие методы / инструменты можно использовать для определения причины, чтобы исключение не привело к преждевременному завершению программы?

Ответы

3848 VincentRamdhanie Oct 20 2008 at 20:54

Когда вы объявляете ссылочную переменную (то есть объект), вы действительно создаете указатель на объект. Рассмотрим следующий код, в котором вы объявляете переменную примитивного типа int:

int x;
x = 10;

В этом примере переменная xявляется intи Java будет инициализировать его 0для вас. Когда вы присваиваете ему значение 10во второй строке, ваше значение 10записывается в ячейку памяти, на которую указывает x.

Но когда вы пытаетесь объявить ссылочный тип , происходит нечто иное. Возьмите следующий код:

Integer num;
num = new Integer(10);

Первая строка объявляет переменную с именем num, но на самом деле она еще не содержит примитивного значения. Вместо этого он содержит указатель (потому Integerчто это ссылочный тип). Поскольку вы еще не сказали, на что указывать, Java устанавливает это значение null, что означает « Я ни на что не указываю ».

Во второй строке newключевое слово используется для инстанцирования (или создания) объекта типа Integer, и numэтому Integerобъекту присваивается переменная-указатель .

Это NullPointerExceptionпроисходит, когда вы объявляете переменную, но не создаете объект и не назначаете его переменной перед попыткой использовать содержимое переменной (это называется разыменованием ). Итак, вы указываете на то, чего на самом деле не существует.

Разыменование обычно происходит при использовании .для доступа к методу или полю или при использовании [для индексации массива.

Если вы попытаетесь разыменовать numДО создания объекта, вы получите файл NullPointerException. В самых тривиальных случаях компилятор обнаружит проблему и сообщит вам, что " num may not have been initialized," но иногда вы можете написать код, который не создает объект напрямую.

Например, у вас может быть следующий метод:

public void doSomething(SomeObject obj) {
   //do something to obj, assumes obj is not null
   obj.myMethod();
}

В этом случае вы не создаете объект obj, а скорее предполагаете, что он был создан до вызова doSomething()метода. Обратите внимание, метод можно вызвать так:

doSomething(null);

В этом случае objis null, и инструкция obj.myMethod()выдаст NullPointerException.

Если метод предназначен для того, чтобы что-то сделать с переданным объектом, как это делает вышеупомянутый метод, целесообразно выбросить, NullPointerExceptionпотому что это ошибка программиста, и программисту потребуется эта информация для целей отладки.

В дополнение к NullPointerExceptions, создаваемому в результате логики метода, вы также можете проверить аргументы метода на предмет nullзначений и явно выдавать NPE, добавив что-то вроде следующего в начале метода:

//Throws an NPE with a custom error message if obj is null
Objects.requireNonNull(obj, "obj must not be null");

Обратите внимание, что в сообщении об ошибке полезно четко указать, каким объектом быть не может null. Преимущество такой проверки заключается в том, что 1) вы можете возвращать собственные более четкие сообщения об ошибках и 2) для остальной части метода, который, как вы знаете, если он objне переназначен, он не равен нулю и может быть безопасно разыменован.

В качестве альтернативы могут быть случаи, когда целью метода является не только работа с переданным объектом, и поэтому может быть приемлем нулевой параметр. В этом случае вам нужно будет проверить нулевой параметр и вести себя иначе. Вы также должны объяснить это в документации. Например, doSomething()можно записать так:

/**
  * @param obj An optional foo for ____. May be null, in which case 
  *  the result will be ____.
  */
public void doSomething(SomeObject obj) {
    if(obj == null) {
       //do something
    } else {
       //do something else
    }
}

Наконец, как определить исключение и причину с помощью трассировки стека

Какие методы / инструменты можно использовать для определения причины, чтобы исключение не привело к преждевременному завершению программы?

Сонар с ошибками поиска может обнаруживать NPE. Может ли сонар динамически перехватывать исключения нулевого указателя, вызванные JVM

Теперь Java 14 добавила новую языковую функцию, чтобы показать основную причину NullPointerException. Эта языковая функция является частью коммерческой JVM SAP с 2006 года. Ниже приводится 2 минуты чтения, чтобы понять эту удивительную языковую функцию.

https://jfeatures.com/blog/NullPointerException

В java 14 ниже приведен пример сообщения об исключении NullPointerException:

в потоке «main» java.lang.NullPointerException: невозможно вызвать «java.util.List.size ()», потому что «list» имеет значение null

898 BilltheLizard Oct 20 2008 at 20:20

NullPointerExceptions - это исключения, которые возникают, когда вы пытаетесь использовать ссылку, которая не указывает ни на какое место в памяти (null), как если бы она ссылалась на объект. Вызов метода для нулевой ссылки или попытка доступа к полю нулевой ссылки вызовет запуск файла NullPointerException. Это наиболее распространенные способы, но другие способы перечислены на NullPointerExceptionстранице javadoc.

Вероятно, самый быстрый пример кода, который я мог бы придумать для иллюстрации NullPointerException:

public class Example {

    public static void main(String[] args) {
        Object obj = null;
        obj.hashCode();
    }

}

В первой строке внутри mainя явно устанавливаю Objectссылку, objравную null. Это означает, что у меня есть ссылка, но она не указывает ни на какой объект. После этого я пытаюсь рассматривать ссылку, как если бы она указывает на объект, вызывая для него метод. Это приводит к появлению, NullPointerExceptionпоскольку в том месте, на которое указывает ссылка, нет кода для выполнения.

(Это формальность, но я думаю, что стоит упомянуть: ссылка, указывающая на null, не то же самое, что указатель C, указывающий на недопустимую ячейку памяти. Нулевой указатель буквально никуда не указывает , что немного отличается от указывая на недопустимое местоположение.)

709 fgb Jun 08 2014 at 02:22

Что такое исключение NullPointerException?

Хорошее место для начала - JavaDocs . Они покрыли это:

Вызывается, когда приложение пытается использовать значение null в случае, когда требуется объект. К ним относятся:

  • Вызов метода экземпляра нулевого объекта.
  • Доступ или изменение поля нулевого объекта.
  • Принимая длину нуля, как если бы это был массив.
  • Доступ или изменение пустых слотов, как если бы это был массив.
  • Выбрасывание null, как если бы это было значение Throwable.

Приложения должны генерировать экземпляры этого класса, чтобы указать на другое незаконное использование нулевого объекта.

Также бывает, что если вы попытаетесь использовать пустую ссылку с synchronized, это также вызовет это исключение в соответствии с JLS :

SynchronizedStatement:
    synchronized ( Expression ) Block
  • В противном случае, если значение Expression равно нулю, выдается a NullPointerException.

Как мне это исправить?

Итак, у вас есть файл NullPointerException. Как это исправить? Возьмем простой пример, который генерирует NullPointerException:

public class Printer {
    private String name;

    public void setName(String name) {
        this.name = name;
    }

    public void print() {
        printString(name);
    }

    private void printString(String s) {
        System.out.println(s + " (" + s.length() + ")");
    }

    public static void main(String[] args) {
        Printer printer = new Printer();
        printer.print();
    }
}

Определите нулевые значения

Первый шаг - точно определить, какие значения вызывают исключение . Для этого нам нужно немного отладить. Важно научиться читать трассировку стека . Это покажет вам, где было выброшено исключение:

Exception in thread "main" java.lang.NullPointerException
    at Printer.printString(Printer.java:13)
    at Printer.print(Printer.java:9)
    at Printer.main(Printer.java:19)

Здесь мы видим, что исключение выбрасывается в строке 13 (в printStringметоде). Посмотрите на строку и проверьте, какие значения равны нулю, добавив операторы регистрации или используя отладчик . Мы обнаруживаем, что sэто null, и вызов lengthметода для него вызывает исключение. Мы видим, что программа перестает генерировать исключение при s.length()удалении из метода.

Отследите, откуда берутся эти значения

Затем проверьте, откуда взялось это значение. Следуя за вызывающими объектами метода, мы видим, что sон передается с printString(name)помощью print()метода и this.nameимеет значение NULL.

Проследите, где должны быть установлены эти значения

Где this.nameставится? В setName(String)методе. После дополнительной отладки мы видим, что этот метод вообще не вызывается. Если метод был вызван, обязательно проверьте порядок, в котором эти методы вызываются, и метод set не вызывается после метода печати.

Этого достаточно, чтобы дать нам решение: добавить вызов printer.setName()перед вызовом printer.print().

Прочие исправления

Переменная может иметь значение по умолчаниюsetNameможет предотвратить ее установку в нуль):

private String name = "";

Либо метод printили printStringможет проверять значение null , например:

printString((name == null) ? "" : name);

Или вы можете спроектировать класс так, чтобы он name всегда имел ненулевое значение :

public class Printer {
    private final String name;

    public Printer(String name) {
        this.name = Objects.requireNonNull(name);
    }

    public void print() {
        printString(name);
    }

    private void printString(String s) {
        System.out.println(s + " (" + s.length() + ")");
    }

    public static void main(String[] args) {
        Printer printer = new Printer("123");
        printer.print();
    }
}

Смотрите также:

  • Как избежать операторов «! = Null» в Java?

Я все еще не могу найти проблему

Если вы пытались отладить проблему, но по-прежнему не нашли решения, вы можете задать вопрос, чтобы получить дополнительную помощь, но не забудьте указать то, что вы пробовали до сих пор. Как минимум, включите в вопрос трассировку стека и отметьте важные номера строк в коде. Кроме того, сначала попробуйте упростить код (см. SSCCE ).

516 StephenC Jun 22 2014 at 09:16

Вопрос: что вызывает NullPointerException(NPE)?

Как вы должны знать, типы Java делятся на примитивные типы ( boolean, intи т. Д.) И ссылочные типы . Ссылочные типы в Java позволяют вам использовать специальное значение, nullкоторое в языке Java означает «нет объекта».

A NullPointerExceptionвыдается во время выполнения всякий раз, когда ваша программа пытается использовать a, nullкак если бы это была настоящая ссылка. Например, если вы напишете это:

public class Test {
    public static void main(String[] args) {
        String foo = null;
        int length = foo.length();   // HERE
    }
}

оператор с меткой «ЗДЕСЬ» будет пытаться запустить length()метод по nullссылке, и это вызовет ошибку NullPointerException.

Есть много способов использовать nullзначение, которое приведет к расширению NullPointerException. Фактически, единственное, что вы можете делать с a, nullне вызывая NPE:

  • присвоить его ссылочной переменной или прочитать его из ссылочной переменной,
  • назначить его элементу массива или прочитать его из элемента массива (при условии, что сама ссылка на массив не равна нулю!),
  • передать его как параметр или вернуть как результат, или
  • проверить его с помощью ==или !=операторов, или instanceof.

Вопрос: как прочитать трассировку стека NPE?

Предположим, я компилирую и запускаю указанную выше программу:

$ javac Test.java $ java Test
Exception in thread "main" java.lang.NullPointerException
    at Test.main(Test.java:4)
$

Первое наблюдение: компиляция прошла успешно! Проблема в программе НЕ ошибка компиляции. Это ошибка времени выполнения . (Некоторые IDE могут предупреждать, что ваша программа всегда будет генерировать исключение ... но стандартный javacкомпилятор этого не делает.)

Второе наблюдение: когда я запускаю программу, она выводит две строки «gobbledy-gook». НЕПРАВИЛЬНО!! Это не чепуха. Это трассировка стека ... и она предоставляет важную информацию , которая поможет вам отследить ошибку в вашем коде, если вы потратите время на ее внимательное прочтение.

So let's look at what it says:

Exception in thread "main" java.lang.NullPointerException

The first line of the stack trace tells you a number of things:

  • It tells you the name of the Java thread in which the exception was thrown. For a simple program with one thread (like this one), it will be "main". Let's move on ...
  • It tells you the full name of the exception that was thrown; i.e. java.lang.NullPointerException.
  • If the exception has an associated error message, that will be output after the exception name. NullPointerException is unusual in this respect, because it rarely has an error message.

The second line is the most important one in diagnosing an NPE.

at Test.main(Test.java:4)

This tells us a number of things:

  • "at Test.main" says that we were in the main method of the Test class.
  • "Test.java:4" gives the source filename of the class, AND it tells us that the statement where this occurred is in line 4 of the file.

If you count the lines in the file above, line 4 is the one that I labeled with the "HERE" comment.

Note that in a more complicated example, there will be lots of lines in the NPE stack trace. But you can be sure that the second line (the first "at" line) will tell you where the NPE was thrown1.

In short, the stack trace will tell us unambiguously which statement of the program has thrown the NPE.

1 - Not quite true. There are things called nested exceptions...

Question: How do I track down the cause of the NPE exception in my code?

This is the hard part. The short answer is to apply logical inference to the evidence provided by the stack trace, the source code, and the relevant API documentation.

Let's illustrate with the simple example (above) first. We start by looking at the line that the stack trace has told us is where the NPE happened:

int length = foo.length(); // HERE

How can that throw an NPE?

In fact, there is only one way: it can only happen if foo has the value null. We then try to run the length() method on null and... BANG!

But (I hear you say) what if the NPE was thrown inside the length() method call?

Well, if that happened, the stack trace would look different. The first "at" line would say that the exception was thrown in some line in the java.lang.String class and line 4 of Test.java would be the second "at" line.

So where did that null come from? In this case, it is obvious, and it is obvious what we need to do to fix it. (Assign a non-null value to foo.)

OK, so let's try a slightly more tricky example. This will require some logical deduction.

public class Test {

    private static String[] foo = new String[2];

    private static int test(String[] bar, int pos) {
        return bar[pos].length();
    }

    public static void main(String[] args) {
        int length = test(foo, 1);
    }
}

$ javac Test.java 
$ java Test Exception in thread "main" java.lang.NullPointerException at Test.test(Test.java:6) at Test.main(Test.java:10) $ 

So now we have two "at" lines. The first one is for this line:

return args[pos].length();

and the second one is for this line:

int length = test(foo, 1);

Looking at the first line, how could that throw an NPE? There are two ways:

  • If the value of bar is null then bar[pos] will throw an NPE.
  • If the value of bar[pos] is null then calling length() on it will throw an NPE.

Next, we need to figure out which of those scenarios explains what is actually happening. We will start by exploring the first one:

Where does bar come from? It is a parameter to the test method call, and if we look at how test was called, we can see that it comes from the foo static variable. In addition, we can see clearly that we initialized foo to a non-null value. That is sufficient to tentatively dismiss this explanation. (In theory, something else could change foo to null ... but that is not happening here.)

So what about our second scenario? Well, we can see that pos is 1, so that means that foo[1] must be null. Is this possible?

Indeed it is! And that is the problem. When we initialize like this:

private static String[] foo = new String[2];

we allocate a String[] with two elements that are initialized to null. After that, we have not changed the contents of foo ... so foo[1] will still be null.

432 RakeshBurbure Oct 20 2008 at 20:21

It's like you are trying to access an object which is null. Consider below example:

TypeA objA;

At this time you have just declared this object but not initialized or instantiated. And whenever you try to access any property or method in it, it will throw NullPointerException which makes sense.

See this below example as well:

String a = null;
System.out.println(a.toString()); // NullPointerException will be thrown
365 nathan1138 Apr 17 2013 at 09:57

A null pointer exception is thrown when an application attempts to use null in a case where an object is required. These include:

  1. Calling the instance method of a null object.
  2. Accessing or modifying the field of a null object.
  3. Taking the length of null as if it were an array.
  4. Accessing or modifying the slots of null as if it were an array.
  5. Throwing null as if it were a Throwable value.

Applications should throw instances of this class to indicate other illegal uses of the null object.

Reference: http://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html

341 MrZebra Oct 20 2008 at 20:25

A null pointer is one that points to nowhere. When you dereference a pointer p, you say "give me the data at the location stored in "p". When p is a null pointer, the location stored in p is nowhere, you're saying "give me the data at the location 'nowhere'". Obviously, it can't do this, so it throws a null pointer exception.

In general, it's because something hasn't been initialized properly.

329 L.G. Jun 25 2014 at 18:17

A lot of explanations are already present to explain how it happens and how to fix it, but you should also follow best practices to avoid NullPointerExceptions at all.

See also: A good list of best practices

I would add, very important, make a good use of the final modifier. Using the "final" modifier whenever applicable in Java

Summary:

  1. Use the final modifier to enforce good initialization.
  2. Avoid returning null in methods, for example returning empty collections when applicable.
  3. Use annotations @NotNull and @Nullable
  4. Fail fast and use asserts to avoid propagation of null objects through the whole application when they shouldn't be null.
  5. Use equals with a known object first: if("knownObject".equals(unknownObject)
  6. Prefer valueOf() over toString().
  7. Use null safe StringUtils methods StringUtils.isEmpty(null).
  8. Use Java 8 Optional as return value in methods, Optional class provide a solution for representing optional values instead of null references.
323 ashishbhatt Jan 28 2012 at 13:45

In Java, everything (excluding primitive types) is in the form of a class.

If you want to use any object then you have two phases:

  1. Declare
  2. Initialization

Example:

  • Declaration: Object object;
  • Initialization: object = new Object();

Same for the array concept:

  • Declaration: Item item[] = new Item[5];
  • Initialization: item[0] = new Item();

If you are not giving the initialization section then the NullPointerException arise.

322 javidpiprani Sep 24 2013 at 13:01

A null pointer exception is an indicator that you are using an object without initializing it.

For example, below is a student class which will use it in our code.

public class Student {

    private int id;

    public int getId() {
        return this.id;
    }

    public setId(int newId) {
        this.id = newId;
    }
}

The below code gives you a null pointer exception.

public class School {

    Student student;

    public School() {
        try {
            student.getId();
        }
        catch(Exception e) {
            System.out.println("Null pointer exception");
        }
    }
}

Because you are using student, but you forgot to initialize it like in the correct code shown below:

public class School {

    Student student;

    public School() {
        try {
            student = new Student();
            student.setId(12);
            student.getId();
        }
        catch(Exception e) {
            System.out.println("Null pointer exception");
        }
    }
}
315 OscarRyz Oct 21 2008 at 03:05

In Java all the variables you declare are actually "references" to the objects (or primitives) and not the objects themselves.

When you attempt to execute one object method, the reference asks the living object to execute that method. But if the reference is referencing NULL (nothing, zero, void, nada) then there is no way the method gets executed. Then the runtime let you know this by throwing a NullPointerException.

Your reference is "pointing" to null, thus "Null -> Pointer".

The object lives in the VM memory space and the only way to access it is using this references. Take this example:

public class Some {
    private int id;
    public int getId(){
        return this.id;
    }
    public setId( int newId ) {
        this.id = newId;
    }
}

And on another place in your code:

Some reference = new Some();    // Point to a new object of type Some()
Some otherReference = null;     // Initiallly this points to NULL

reference.setId( 1 );           // Execute setId method, now private var id is 1

System.out.println( reference.getId() ); // Prints 1 to the console

otherReference = reference      // Now they both point to the only object.

reference = null;               // "reference" now point to null.

// But "otherReference" still point to the "real" object so this print 1 too...
System.out.println( otherReference.getId() );

// Guess what will happen
System.out.println( reference.getId() ); // :S Throws NullPointerException because "reference" is pointing to NULL remember...

This an important thing to know - when there are no more references to an object (in the example above when reference and otherReference both point to null) then the object is "unreachable". There is no way we can work with it, so this object is ready to be garbage collected, and at some point, the VM will free the memory used by this object and will allocate another.

287 Makoto May 25 2014 at 13:11

Another occurrence of a NullPointerException occurs when one declares an object array, then immediately tries to dereference elements inside of it.

String[] phrases = new String[10];
String keyPhrase = "Bird";
for(String phrase : phrases) {
    System.out.println(phrase.equals(keyPhrase));
}

This particular NPE can be avoided if the comparison order is reversed; namely, use .equals on a guaranteed non-null object.

All elements inside of an array are initialized to their common initial value; for any type of object array, that means that all elements are null.

You must initialize the elements in the array before accessing or dereferencing them.

String[] phrases = new String[] {"The bird", "A bird", "My bird", "Bird"};
String keyPhrase = "Bird";
for(String phrase : phrases) {
    System.out.println(phrase.equals(keyPhrase));
}