Map之一個Key存多個Value的MultiValueMap(一個鍵多個值)

 

　　在日常的開發中經常用到鍵值對，也就是Map啦，我們知道Map是一個接口，它的特點是一個Key對應一個Value，也就是一個鍵對應一個值，但是往往我們需要一個Key對應多個Value，這種時候系統的API就無法滿足我們的需要了，因此今天介紹一個我封裝的一個Key對應多個Value，既一個鍵對應多個值的MultiValueMap。 
　　第二個，我們的MultiValueMap要想什么Key-Value都可以放，就要用到泛型，泛型不好的同學也不用擔心，只要你用過Map、HashMap我保准你看得懂。

MultiValueMap接口的定義

　　用過Map的人都知道，Map是一個接口（interface），所以我們這里也把MultiValueMap定義成一個接口。那么需要那些方法呢，我們來列個表：

• 添加一個Key對應一個Value的：void add(K, V);
• 添加一個Key對應多個Value的：void add(K, List);
• 設置一個Key對應一個Value的：void set(K, V);
• 設置一個Key對應多個Value的：void set(K, List);
• 移除一個Key和它對應的Value：List remove(K);
• 清除所有Value的：void clear();
• 拿到所有Key的集合：Set keySet();
• 拿到所有的值：List values();
• 拿到一個Key對應的某個值：V getValue(K, index);
• 拿到一個Key對應的所有Value：List getValues(K);
• 拿到MultiValueMap的大小：int size();
• 判斷是否為空MultiValueMap：boolean isEmpty();
• 判斷是否包含某個Key：boolean containKey(K);

　　下面我們根據分析先把MultiValueMap接口定義出來，其實這個封裝是我的開源項目NoHttp中提出來的，有興趣的看官光顧下NoHttp，廢話不多說，上代碼：

import java.util.List; import java.util.Map; import java.util.Set; /** * <p>Can save multiple the value of the map.</p> * Created in Jan 10, 2016 5:00:07 PM. * * @author Yan Zhenjie; */ public interface MultiValueMap<K, V> { /** * 添加Key-Value。 * * @param key key. * @param value value. */ void add(K key, V value); /** * 添加Key-List<Value>。 * * @param key key. * @param values values. */ void add(K key, List<V> values); /** * 設置一個Key-Value，如果這個Key存在就被替換，不存在則被添加。 * * @param key key. * @param value values. */ void set(K key, V value); /** * 設置Key-List<Value>，如果這個Key存在就被替換，不存在則被添加。 * @param key key. * @param values values. * @see #set(Object, Object) */ void set(K key, List<V> values); /** * 替換所有的Key-List<Value>。 * * @param values values. */ void set(Map<K, List<V>> values); /** * 移除某一個Key，對應的所有值也將被移除。 * * @param key key. * @return value. */ List<V> remove(K key); /** * 移除所有的值。 * Remove all key-value. */ void clear(); /** * 拿到Key的集合。 * @return Set. */ Set<K> keySet(); /** * 拿到所有的值的集合。 * * @return List. */ List<V> values(); /** * 拿到某一個Key下的某一個值。 * * @param key key. * @param index index value. * @return The value. */ V getValue(K key, int index); /** * 拿到某一個Key的所有值。 * * @param key key. * @return values. */ List<V> getValues(K key); /** * 拿到MultiValueMap的大小. * * @return size. */ int size(); /** * 判斷MultiValueMap是否為null. * * @return True: empty, false: not empty. */ boolean isEmpty(); /** * 判斷MultiValueMap是否包含某個Key. * * @param key key. * @return True: contain, false: none. */ boolean containsKey(K key); }

 

　　是不是有些小激動呢，接口終於擼完了。是不是就可以用了呢，答案當然是不能，我們知道Map使用的時候假如是用HashMap是這樣實例化的：Map<K, V> map = new HashMap<>();，那么我們的MultiValueMap是不是也要提供一個像HashMap一個樣實現類呢？

MultiValueMap接口的實現類LinkedMultiValueMap

1. 實現MultiValueMap接口要implements MultiValueMap...

2. 既然是可以容納任何類型的MultiValueMap，實現類LinkedMultiValueMap也要用泛型

   　　分析到里我們先把類的雛形寫出來：

public class LinkedMultiValueMap<K, V> implements MultiValueMap<K, V> { ... }

　　看到這里有經驗的小伙伴就會發現這尼瑪和Map、HashMap一個原理啊，這就對了，當我們看到LinkedMultiValueMap的時候就應該知道我們會用到LinkedHashMap。 
　　這里把存放數據的原理分析一下，一個Key對應多個Value，我第一個想到的樣子是：Map<K, List<Value>>，綜上所述我們的數據源就出來了：

public class LinkedMultiValueMap<K, V> implements MultiValueMap<K, V> { protected Map<K, List<V>> mSource = new LinkedHashMap<K, List<V>>(); ... }

　　接下來我們就該實現MultiValueMap接口所有的方法啦，嗯沒啥好說的了，上代碼，不懂的地方有注釋：

import java.util.ArrayList; import java.util.LinkedHashMap; import java.util.List; import java.util.Map; import java.util.Set; /** * Created in Jan 10, 2016 5:03:17 PM. * * @author Yan Zhenjie; */ public class LinkedMultiValueMap<K, V> implements MultiValueMap<K, V> { protected Map<K, List<V>> mSource = new LinkedHashMap<K, List<V>>(); public LinkedMultiValueMap() { } @Override public void add(K key, V value) { if (key != null) { // 如果有這個Key就繼續添加Value，沒有就創建一個List並添加Value if (!mSource.containsKey(key)) mSource.put(key, new ArrayList<V>(2)); mSource.get(key).add(value); } } @Override public void add(K key, List<V> values) { // 便利添加進來的List的Value，調用上面的add(K, V)方法添加 for (V value : values) { add(key, value); } } @Override public void set(K key, V value) { // 移除這個Key，添加新的Key-Value mSource.remove(key); add(key, value); } @Override public void set(K key, List<V> values) { // 移除Key，添加List<V> mSource.remove(key); add(key, values); } @Override public void set(Map<K, List<V>> map) { // 移除所有值，便利Map里的所有值添加進來 mSource.clear(); mSource.putAll(map); } @Override public List<V> remove(K key) { return mSource.remove(key); } @Override public void clear() { mSource.clear(); } @Override public Set<K> keySet() { return mSource.keySet(); } @Override public List<V> values() { // 創建一個臨時List保存所有的Value List<V> allValues = new ArrayList<V>(); // 便利所有的Key的Value添加到臨時List Set<K> keySet = mSource.keySet(); for (K key : keySet) { allValues.addAll(mSource.get(key)); } return allValues; } @Override public List<V> getValues(K key) { return mSource.get(key); } @Override public V getValue(K key, int index) { List<V> values = mSource.get(key); if (values != null && index < values.size()) return values.get(index); return null; } @Override public int size() { return mSource.size(); } @Override public boolean isEmpty() { return mSource.isEmpty(); } @Override public boolean containsKey(K key) { return mSource.containsKey(key); } }

 

　　到這里，實現類也就完了，高手們已經肯定會用了。

MultiValueMap接口和實現類LinkedMultiValueMap的用法

　　其實本來不想寫用法的，但是我們還是要本着一個負責人的態度是吧。其實這個封裝在開源框架NoHttp中用的很多，很成熟了，下面也再寫點用法：

public static void main(String[] args) { MultiValueMap<String, String> stringMultiValueMap = new LinkedMultiValueMap<>(); // 添加Key為name的 stringMultiValueMap.add("name", "yolanda"); stringMultiValueMap.add("name", "yanzhenjie"); stringMultiValueMap.add("name", "嚴振傑"); stringMultiValueMap.add("name", "尤蘭達"); // 添加Key為domain的 stringMultiValueMap.add("domain", "http://www.yanzhenjie.com"); stringMultiValueMap.add("domain", "http://www.nohttp.net"); // 拿到某個key的某個值 System.out.println("name的第三個值：" + stringMultiValueMap.getValue("name", 3)); // 打印所有值 Set<String> keySet = stringMultiValueMap.keySet(); for (String key : keySet) { List<String> values = stringMultiValueMap.getValues(key); for (String value : values) { System.out.println(key + ": " + value); } } }

　　我們run一下看結果：

name的第三個值：尤蘭達
name: yolanda
name: yanzhenjie
name: 嚴振傑
name: 尤蘭達
domain: http://www.yanzhenjie.com domain: http://www.nohttp.net

　　果然沒有問題呀，我得意的笑呀哈哈哈…… 
　　還是有疑問的同學在下面留言噢，天很晚了，睡覺。

---

歡迎大家關注Android開源網絡框架NoHttp：https://github.com/yanzhenjie/NoHttp 
在線直播視頻和代碼下載：http://pan.baidu.com/s/1miEOtwG