• 主页
  • 文章
  • 一般的
  • 你注意到 java.lang.NullPointerException (NPE) 了吗？ 在 Java 中避免运行时 NPE 的 8 个最佳实践

你注意到 java.lang.NullPointerException (NPE) 了吗？ 在 Java 中避免运行时 NPE 的 8 个最佳实践

已发表: 2020-10-07
你注意到 java.lang.NullPointerException (NPE) 了吗？在 Java 中避免运行时 NPE 的 8 个最佳实践

避免 Java 中的 Null 指针异常和 Java 提示和最佳实践以避免 Java 中的 NullPointerException。

作为一名 Java 开发人员，我相信您从第一天开始一定遇到过空指针异常 (NPE)。 在大多数情况下，NPE 异常会显示清晰的堆栈跟踪，它指出了相同的根本原因，但在大型企业级应用程序的情况下，您有数百个类，找出真正的根本原因就变成了噩梦。

什么是空指针异常 (NPE)？

NullPointerException (NPE)是当您尝试使用指向内存中任何位置 (null) 的引用时发生的异常，就好像它正在引用一个对象一样。

在null引用上调用方法或尝试访问空引用的字段将触发 NPE。 这是最常见的原因。

根据 JavaDoc，以下是 NPE 的主要原因：

  • 把null当作一个Throwable值来抛出。
  • 调用null对象的实例方法。
  • 访问或修改null对象的字段。
  • 将null的长度视为一个数组。
  • 访问或修改null的槽，就像它是一个数组一样。

现在真正的问题是如何在运行时避免 java.lang.NullPointerException？ 在本教程中，我们将看一些在运行时创建 NPE 的示例以及我们需要执行的步骤来解决这个问题。

让我们在运行时创建 NPE 1。 看看下面的例子CrunchifyNullPointerExceptionTips.java

我们将以 3 种不同的方式创建 NPE

  1. 如果您尝试访问 null 对象，将抛出 NPE
  2. 如果您尝试转换空字符串，将抛出 NPE
  3. 如果您在类初始化期间尝试访问 null 对象，将抛出 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：

在 trim() 操作后检查 String 是否为null 。

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

断言是一个语句，使您能够测试您对代码的假设。 例如，如果您编写一个在系统中返回名称的方法，您可以断言如果 String 为空，则返回的 otherName。

断言的基本用法是：

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 等还有许多其他提示和技巧可用。但我现在将缩短这一点。

可能会在一周内发布关于这个的新教程。 敬请关注。

您想在本教程中添加任何内容或发现问题，请加入并提供您的意见。