Вы заметили java.lang.NullPointerException (NPE)? 8 лучших практик, чтобы избежать NPE во время выполнения в Java

Опубликовано: 2020-10-07
Вы заметили java.lang.NullPointerException (NPE)? 8 лучших практик, чтобы избежать NPE во время выполнения в Java

Избегайте исключения Null Pointer Exception в Java и советы и рекомендации по Java, чтобы избежать исключения NullPointerException в Java.

Как разработчик Java, я уверен, что вы, должно быть, столкнулись с исключением Null Pointer Exception (NPE), начиная с 1-го дня. В большинстве случаев исключение NPE показывает четкую трассировку стека, которая указывает на основную причину того же самого, но в случае большого приложения уровня предприятия, в котором у вас есть сотни классов, становится кошмаром выяснить реальную основную причину.

Что такое исключение нулевого указателя (NPE)?

NullPointerException (NPE) — это исключение, возникающее при попытке использовать ссылку, которая не указывает ни на какое место в памяти (пустое), как если бы она ссылалась на объект.

Вызов метода для null ссылки или попытка доступа к полю нулевой ссылки вызовет NPE. Это самая распространенная причина.

Согласно JavaDoc, ниже приведены основные причины NPE:

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

Теперь реальный вопрос: как избежать java.lang.NullPointerException во время выполнения? В этом руководстве мы рассмотрим несколько примеров, которые создают NPE во время выполнения, и шаги, которые нам необходимо выполнить, чтобы решить эту проблему.

Давайте сначала создадим NPE во время выполнения. Взгляните на приведенный ниже пример CrunchifyNullPointerExceptionTips.java

Мы создадим NPE 3 разными способами

  1. NPE будет выброшен, если вы пытаетесь получить доступ к нулевому объекту
  2. NPE будет выброшен, если вы попытаетесь преобразовать нулевую строку
  3. NPE будет выбран, если вы пытаетесь получить доступ к нулевому объекту во время инициализации класса.

Создать класс CrunchifyNullPointerExceptionTips.java

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
package crunchify . com . tutorial ;
 
/**
* @author Crunchify.com
* Have you Noticed java.lang.NullPointerException (NPE)? 8 Best practices to avoid runtime NPE in Java
*/
 
public class CrunchifyNullPointerExceptionTips {
public static void main ( String [ ] args ) {
try {
// Example 1: NPE will be thrown if you are trying to access null Object
CrunchifyNPE1 ( ) ;
} catch ( NullPointerException crunchifyNPE1 ) {
System . out . println ( "Exception in CrunchifyNPE1()" ) ;
crunchifyNPE1 . printStackTrace ( ) ;
}
try {
// Example 2: NPE will be thrown if you are trying to convert null String
CrunchifyNPE2 ( ) ;
} catch ( NullPointerException crunchifyNPE2 ) {
System . out . println ( "\nException in CrunchifyNPE2()" ) ;
// printStackTrace(): Prints this throwable and its backtrace to the standard error stream.
// This method prints a stack trace for this Throwable object on the error output stream that is the value of the field System.err.
// The first line of output contains the result of the toString() method for this object.
// Remaining lines represent data previously recorded by the method fillInStackTrace().
crunchifyNPE2 . printStackTrace ( ) ;
}
try {
// Example 3: NPE will be thrown if you are trying to access null Object during Class Initialization
CrunchifyNPETest npe = new CrunchifyNPETest ( ) ;
npe . getName ( ) ;
// NullPointerException: Thrown when an application attempts to use null in a case where an object is required. These include:
// - Calling the instance method of a null object.
// - Accessing or modifying the field of a null object.
// - Taking the length of null as if it were an array.
// - Accessing or modifying the slots of null as if it were an array.
// - Throwing null as if it were a Throwable value.
} catch ( NullPointerException crunchifyNPE3 ) {
System . out . println ( "\n Exception in CrunchifyNPETest()" ) ;
crunchifyNPE3 . printStackTrace ( ) ;
}
}
private static void CrunchifyNPE1 ( ) {
Object crunchifyObj = null ;
// hasCode(): Returns a hash code value for the object.
// This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
crunchifyObj . hashCode ( ) ;
}
private static void CrunchifyNPE2 ( ) {
String crunchifyString ;
crunchifyString = "https://crunchify.com" ;
// The line 40 declares a variable named "crunchifyString", but, it does not contain a primitive value. Instead it contains a pointer (because the type is String
// which is a reference type). Since you did not say as yet what to point to Java sets it to null, meaning "I am pointing at nothing".
// In line 41, the new keyword is used to instantiate (or create) an object of type String and the pointer variable "crunchifyString" is assigned this
// object. You can now reference the object using the dereferencing operator . (a dot).
System . out . println ( "\nvalue: " + crunchifyString . toString ( ) + ", length: " + crunchifyString . length ( ) ) ;
System . out . println ( "No NPE exception on line 51" ) ;
// Now Let's create NPE
String crunchifyString2 = null ;
System . out . println ( crunchifyString2 . toString ( ) ) ;
}
}
 
class CrunchifyNPETest {
private String crunchifyName ;
public void setName ( String name ) {
this . crunchifyName = name ;
}
public void getName ( ) {
printName ( crunchifyName ) ;
}
private void printName ( String s ) {
System . out . println ( s + " (" + s . length ( ) + ")" ) ;
}
}

Результат:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Exception in CrunchifyNPE1 ( )
java . lang . NullPointerException : Cannot invoke "Object.hashCode()" because "crunchifyObj" is null
at crunchify . com . tutorial . CrunchifyNullPointerExceptionTips . CrunchifyNPE1 ( CrunchifyNullPointerExceptionTips . java : 59 )
at crunchify . com . tutorial . CrunchifyNullPointerExceptionTips . main ( CrunchifyNullPointerExceptionTips . java : 14 )
 
value : https : //crunchify.com, length: 21
No NPE exception on line 51
 
Exception in CrunchifyNPE2 ( )
 
Exception in CrunchifyNPETest ( )
java . lang . NullPointerException : Cannot invoke "String.toString()" because "crunchifyString2" is null
at crunchify . com . tutorial . CrunchifyNullPointerExceptionTips . CrunchifyNPE2 ( CrunchifyNullPointerExceptionTips . java : 75 )
at crunchify . com . tutorial . CrunchifyNullPointerExceptionTips . main ( CrunchifyNullPointerExceptionTips . java : 23 )
java . lang . NullPointerException : Cannot invoke "String.length()" because "s" is null
at crunchify . com . tutorial . CrunchifyNPETest . printName ( CrunchifyNullPointerExceptionTips . java : 92 )
at crunchify . com . tutorial . CrunchifyNPETest . getName ( CrunchifyNullPointerExceptionTips . java : 88 )
at crunchify . com . tutorial . CrunchifyNullPointerExceptionTips . main ( CrunchifyNullPointerExceptionTips . java : 38 )
 
Process finished with exit code 0

Что ж, есть несколько советов и приемов, которые мы могли бы использовать, чтобы избежать исключения NullPointerException во время выполнения. Давайте взглянем.

Подсказка 1:

Eclipse/IntelliJ IDE попытается отобразить NPE в рабочей области. Исправьте свой код только во время разработки.

Подсказка нулевого указателя в Eclipse

Подсказка 2:

Добавьте crunchifyI sNullorEmpty () перед операцией над объектом. Добавьте это в CrunchifyNullPointerExceptionTips.java

Java
1
2
3
4
5
6
7
8
public static boolean crunchifyIsNullOrEmpty ( String crunchifyStr ) {
if ( crunchifyStr == null )
return true ;
else if ( crunchifyStr . trim ( ) . equals ( "" ) )
return true ;
else
return false ;
}

В вышеприведенной Java-программе строки 55 и 56 будут заменены этим.

1
2
3
4
5
6
String crunchifyString2 = null ;
if ( ! crunchifyIsNullOrEmpty ( crunchifyString2 ) ) {
System . out . println ( crunchifyString2 . toString ( ) ) ;
} else {
System . out . println ( "crunchifyString2 is null" ) ;
}

Подсказка 3:

Проверьте, является ли строка null или пустой после операции trim().

1
2
3
public static boolean isNullOrEmptyAfterTrim ( String crunchifyStr ) {
         return ( crunchifyStr == null | | crunchifyStr . trim ( ) . length ( ) == 0 ) ;
}

Подсказка 4:

Всегда используйте Try Catch block , чтобы предотвратить непрерывный процесс выполнения.

1
2
3
4
5
try {
CrunchifyNPE1 ( ) ;
} catch ( NullPointerException npe ) {
System . out . println ( "Exception in CrunchifyNPE1()" + npe ) ;
}

Подсказка 5:

Collections.emptyList() предпочтительнее из-за лучшей обработки дженериков.

Подсказка 6:

Используйте Java Assertions

Утверждение — это утверждение, позволяющее проверить ваши предположения о коде. Например, если вы пишете метод, который возвращает имя в системе, вы можете утверждать, что возвращаемое значение otherName if String равно null.

Основное использование утверждений будет:

1
2
3
4
5
6
7
8
assert < Expression > ; // or another usage is
assert < Expression1 > : < Expression2 > ;
 
// in our program add line below.
private void printName ( String s ) {
assert ( s ! = null ) : "Name must be not null" ;
System . out . println ( s + " (" + s . length ( ) + ")" ) ;
}

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

Подсказка 7:

Попробуйте использовать проверки containsKey() , containsValue() , contains() .

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package com . crunchify . tutorial ;
 
import java . util . * ;
 
/**
* @author Crunchify.com
*
*/
 
public class CrunchifyContainsKeyExample {
public static void main ( String args [ ] ) {
HashMap < Integer , String > crunchifyMap = new HashMap < Integer , String > ( ) ;
 
// populate hash map
crunchifyMap . put ( 1 , "Crunchify" ) ;
crunchifyMap . put ( 2 , "wordpress" ) ;
crunchifyMap . put ( 3 , "java tutorials" ) ;
 
// check existence of key 4
if ( crunchifyMap . containsKey ( 4 ) ) {
System . out . println ( "Check if key 2 exists: " + crunchifyMap . get ( 4 ) ) ;
} else {
System . out . println ( "NPE for value 4 avoided" ) ;
}
}
}

Подсказка 8:

В заключение всегда рекомендуется заботиться о NPE во время разработки, а не отлаживать во время работы. Существует ряд других советов и приемов, доступных с использованием Spring Framework Annotation, Factory Pattern , Null Object Pattern и т. д. Но сейчас я прерву это.

Опубликую новый учебник, вероятно, через неделю по этому. Следите за обновлениями.

Если вы хотите что-то добавить к этому руководству ИЛИ нашли проблему, пожалуйста, напишите нам и оставьте свои комментарии.