【Java代码规范系列集合】注意Map集合存储null值的情况

Java代码规范之注意Map集合存储null值的情况

目录

• 该条规范是什么
• 为什么这么规定
• 多种主要用法及其代码示例
• 其他类似规范
• 详细区别
• 官方链接

该条规范是什么

该规范指出在Java编程中，需要高度注意Map类集合键值对中的Key和Value是否允许存储null值的情况，并列举了不同集合类对null值的处理情况。

为什么这么规定

以下是该规范的原因：

1. 数据一致性：根据不同的业务需求，有些情况下可能需要禁止将null值存储到Map集合中，以保持数据的一致性和准确性。
2. 避免NullPointerException：一些集合类在处理null值时会抛出NullPointerException异常，因此需要特别注意null值的存储情况。

多种主要用法及其代码示例

Hashtable - 不允许存储null值

Hashtable不允许存储null作为Key或Value。

import java.util.Hashtable;

public class HashtableExample {
    public static void main(String[] args) {
        Hashtable<String, Integer> hashtable = new Hashtable<>();
        
        // 存储null值会抛出NullPointerException异常
        // hashtable.put("key", null); // 抛出异常
        
        hashtable.put("key", 1);
        System.out.println(hashtable.get("key")); // 输出: 1
    }
}

ConcurrentHashMap - 不允许存储null值

ConcurrentHashMap不允许存储null作为Key或Value。

import java.util.concurrent.ConcurrentHashMap;

public class ConcurrentHashMapExample {
    public static void main(String[] args) {
        ConcurrentHashMap<String, Integer> concurrentHashMap = new ConcurrentHashMap<>();
        
        // 存储null值会抛出NullPointerException异常
        // concurrentHashMap.put("key", null); // 抛出异常
        
        concurrentHashMap.put("key", 1);
        System.out.println(concurrentHashMap.get("key")); // 输出: 1
    }
}

TreeMap - 允许存储null值作为Value

TreeMap允许存储null值作为Value，但不允许null作为Key。

import java.util.TreeMap;

public class TreeMapExample {
    public static void main(String[] args) {
        TreeMap<String, Integer> treeMap = new TreeMap<>();
        
        // 存储null值作为Value是允许的
        treeMap.put("key", null);
        
        // 不允许存储null作为Key
        // treeMap.put(null, 1); // 抛出异常
        
        System.out.println(treeMap.get("key")); // 输出: null
    }
}

HashMap - 允许存储null值

HashMap允许存储null作为Key和Value。

import java.util.HashMap;

public class HashMapExample {
    public static void main(String[] args) {
        HashMap<String, Integer> hashMap = new HashMap<>();
        
        // 允许存储null值作为Key和Value
        hashMap.put(null, null);
        
        System.out.println(hashMap.get(null)); // 输出: null
    }
}

其他类似规范

• 对于其他集合类，如ArrayList、HashSet等，也应注意它们对null值的处理情况，并根据需求选择合适的集合类型。

详细区别

不同集合类对null值的处理情况的详细区别如下：

• Hashtable和ConcurrentHashMap：不允许存储null作为Key或Value，存储null值会抛出NullPointerException异常。
• TreeMap：不允许null作为Key，但允许存储null值作为Value。
• HashMap：允许存储null作为Key和Value。

官方链接

• Java HashMap文档