Map、TreeMap

package com.sq.map;

import org.junit.Test;

import java.util.*;

/*
一、Map 的实现类的结构：
    |-----Map: 双列数据，存储 key-value 对的数据 ---类似于高中的函数：y = f(x)
        |-----HashMap: 作为 Map 的主要实现类：线程不安全，效率高；存储 null 的 key 和 value
            |-----LinkedHashMap:保证在遍历 map 元素时，可以按照添加的顺序实现遍历。
                                原因：在原有的 HashMap 底层结构基础上，添加了一对指针，指向前一个和后一个元素。
                                对于频繁的遍历操作，此类执行效率高于 HashMap。
        |-----TreeMap: 保证按照添加的 key-value 对进行排序，实现排序遍历。此时考虑 kye 的自然排序或定制排序
                       底层使用红黑树
        |-----Hashtable: 作为古老的实现类：线程安全的，效率低；不能存储 null 的 key 和 value
            |-----Properties：常用来处理配置文件。key 和 value 都是 String 类型

        HashMap的底层: 数组+链表         (jdk7 及之前)
                      数组+链表+红黑树   (jdk 8)

    面试题：
        1.HashMap的底层实现原理？
        2.HashMap 和 Hashtable 的异同？
        3.CurrentHashMap 与 Hashtable 的异同？(暂时不讲)

二、Map 结构的理解：
   Map 中 key: 无序的、不可重复的，使用 Set 存储所有的 key  ---> key 所在的类要重写 equals() 和 hashCode() (以 HashMap 为例)
   Map 中的 value：无序的、可重复的，使用 Collection 存储所有的 value ---> value 所在的类要重写 equals()
   一个键值对：key-value 构成了一个 Entry 对象。
   Map 中的 entry：无序的、不可重复的，使用 Set 存储所有的 entry

三、HashMap 的底层实现原理？以 jdk7 为例说明：
   HashMap map = new HashMap();
   在实例化以后，底层创建了长度是 16 的一维数组 Entry[] table.
   ... 可能已经执行过多次 put ...
   map.put(key1,value1):
   首先，调用 key1 所在类的 hashCode() 计算 key1 哈希值，此哈希值经过某种算法计算以后，得到在 Entry 数组中的存放位置。
   如果此位置上的数据为空，此时的 key1-value1 添加成功。 ---> 情况 1
   如果此位置上的数据不为空，(意味着此位置上存在一个或多个数据(以链表形式存在))，比较 key1 和已经存在的一个或多个数据
   的哈希值：
          如果 key1 的哈希值与已经存在的数据的哈希值都不相同，此时 key1-value1 添加成功。 ---> 情况 2
          如果 key1 的哈希值和已经存在的某一个数据(key2-value2)的哈希值相同，继续比较：调用 key1 所在类的 equals() 方法，比较：
                   如果 equals() 返回 false：此时 key1-value1 添加成功。 ---> 情况 3
                   如果 equals() 返回 true：使用 value1 替换相同 key 的 value 值

   补充：关于 情况2 和 情况3：此时 key1-value1 和原来的数据以链表的方式存储。

   在不断的添加过程中，会涉及到扩容问题，默认的扩容方式：扩容为原来的容量的 2 倍，并将原有的数据复制过来。

   jdk8 相较于 jdk7 在底层实现方面的不同：
        1.new HashMap():底层没有创建一个长度为 16 的数组
        2.jdk8 底层的数组是：Node[]，而非 Entry[]
        3.首次调用 put() 方法时，底层创建长度为 16 的数组
        4.jdk7 底层结构只有：数组+链表。jdk8中底层结构：数组+链表+红黑树。
               当数组的某一个索引位置上的元素以链表形式存在的数据个数 > 8 且当前数组的长度 > 64 时，
               此时此索引位置上的所有数据改为使用红黑树存储。

        DEFAULT_INITIAL_CAPACITY : HashMap 的默认容量，16
        DEFAULT_LOAD_FACTOR: HashMap 的默认加载因子：0.75
        threshold：扩容的临界值，=容量*填充因子：16 * 0.75 => 12
        TREEIFY_THRESHOLO: Bucket 中链表长度大于该默认值，转化为红黑谁：8
        MIN_TREEIFY_CAPACITY: 桶中的 Node 被树化时最小的 hash 表容量：64

四、LinkedHashMap 的底层实现原理(了解)
    源码中：
    static class Entry<K,V> extends HashMap.Node<K,V> {
        Entry<K,V> before, after; // 能够记录添加的元素的先后顺序
        Entry(int hash, K key, V value, Node<K,V> next) {
            super(hash, key, value, next);
        }
    }

五、Map 中定义的方法：
   添加、删除、修改操作：
   Object put(Object key,Object value): 将指定 key-value 添加到(或修改)当前 map 对象中
   void putAll(Map m): 将 m 中的所有 key-value 对存放到当前 map 中
   Object remove(Object key): 移出指定 key 的 key-value 对，并返回 value
   void clear()：清空当前 map 中的所有数据
   元素查询的操作
   Object get(Object key)：获取指定 key 对应的 value
   boolean containsKey(Object key): 是否包含指定的 key
   boolean containsValue(Object value): 是否包含指定的 value
   int size()：返回 map 中 key-value 对的个数
   boolean isEmpty(): 判断当前 map 是否为空
   boolean equals(Object obj): 判断当前 map 和参数对象 obj 是否相等
   元视图操作的方法：
   Set keySet(): 返回所有 key 构成的 Set 集合
   Collection values()：返回所有 vlaue 构成的 Collection 集合
   Set entrySet(): 返回所有 key-value 对构成的 Set 集合

   总结：常用方法：
   添加：put(Object key,Object value)
   删除：remove(Object key)
   修改：put(Object key,Object value)
   查询：get(Object key)
   长度：size()
   遍历：keySet() / values() / entrySet()
 */
public class MapTest {

    @Test
    public void test1(){
        Map map = new HashMap();// 相对于 Hashtable，HashMap 健壮性更好
//        map = new Hashtable();// 空指针异常: NullPointerException 只要 key 或者 value 中有一个为 null 都会报
        map.put(null,123);
    }

    @Test
    public void test2(){
        Map map = new HashMap();
        map = new LinkedHashMap();
        map.put(123,"AA");
        map.put(345,"BB");
        map.put(12,"CC");
        System.out.println(map);
        // Map map = new HashMap();
        // {345=BB, 123=AA, 12=CC}

        // map = new LinkedHashMap();
        // {123=AA, 345=BB, 12=CC}
    }

    /*
        添加、删除、修改操作：
           Object put(Object key,Object value): 将指定 key-value 添加到(或修改)当前 map 对象中
           void putAll(Map m): 将 m 中的所有 key-value 对存放到当前 map 中
           Object remove(Object key): 移出指定 key 的 key-value 对，并返回 value
           void clear()：清空当前 map 中的所有数据
     */
    @Test
    public void test3(){
        Map map = new HashMap();
        // 添加
        map.put("AA",123);
        map.put("45",123);
        map.put("BB",56);
        System.out.println();// {AA=123, BB=56, 45=123}

        // 修改
        map.put("AA",87);
        System.out.println(map);// {AA=87, BB=56, 45=123}

        Map map1 = new HashMap();
        map1.put("CC",123);
        map1.put("DD",123);

        // putAll(Map m)
        map.putAll(map1);
        System.out.println(map);// {AA=87, BB=56, CC=123, DD=123, 45=123}

        // remove(Object key)
        Object value = map.remove("CC");
        System.out.println(value);// 123
        System.out.println(map);// {AA=87, BB=56, DD=123, 45=123}

        // clear()
        map.clear(); // 与 map = null 操作不同
        System.out.println(map.size());// 0
        System.out.println(map);// {}
    }

    /*
        元素查询的操作
           Object get(Object key)：获取指定 key 对应的 value
           boolean containsKey(Object key): 是否包含指定的 key
           boolean containsValue(Object value): 是否包含指定的 value
           int size()：返回 map 中 key-value 对的个数
           boolean isEmpty(): 判断当前 map 是否为空
           boolean equals(Object obj): 判断当前 map 和参数对象 obj 是否相等
     */
    @Test
    public void test4(){
        Map map = new HashMap();
        map.put("AA",123);
        map.put(45,123);
        map.put("BB",56);

        // Object get(Object key)
        System.out.println(map.get(455));// null
        System.out.println(map.get(45));// 123

        // containsKey(Object key)
        boolean isExist = map.containsKey("BB");
        System.out.println(isExist);// true
        // containsValue(Object value)
        isExist = map.containsValue(123);
        System.out.println(isExist);// true

        // isEmpty()
        map.clear();
        System.out.println(map.isEmpty());// true
    }

    @Test
    public void test5(){
        Map map1 = new HashMap();
        map1.put("AA",123);
        map1.put(45,123);
        map1.put("BB",56);

        Map map2 = new HashMap();
        map2.put("AA",123);
        map2.put(45,123);
        map2.put("BB",56);

        Map map3 = new HashMap();
        map3.put("11",123);
        map3.put(45,123);
        map3.put("BB",56);

        // equals(Object obj)
        System.out.println(map1.equals(map2));// true
        System.out.println(map1.equals(map3));// false
    }

    /*
        元视图操作的方法：
           Set keySet(): 返回所有 key 构成的 Set 集合
           Collection values()：返回所有 vlaue 构成的 Collection 集合
           Set entrySet(): 返回所有 key-value 对构成的 Set 集合
     */
    @Test
    public void test6(){
        Map map = new HashMap();
        map.put("AA",123);
        map.put(45,1234);
        map.put("BB",56);

        // 遍历所有的 key 集：keySet()
        Set set = map.keySet();
        Iterator iterator = set.iterator();
        while(iterator.hasNext()){
            System.out.println(iterator.next());
        }
//        AA
//        BB
//        45

        System.out.println();
        // 遍历所有的 value 集：values()
        Collection values = map.values();
        for(Object obj : values){
            System.out.println(obj);
        }
//        123
//        56
//        1234

        System.out.println();
        // 遍历所有的 key-value
        // 方式一：entrySet():
        Set entrySet = map.entrySet();
        Iterator iterator1 = entrySet.iterator();
        while(iterator1.hasNext()){
            Object obj = iterator1.next();
            Map.Entry entry = (Map.Entry) obj;
            System.out.println(entry.getKey() + "--->" + entry.getValue());
//            AA--->123
//            BB--->56
//            45--->1234
            //System.out.println(iterator1.next());
//            AA=123
//            BB=56
//            45=1234
        }
        System.out.println();
        // 方式二：
        Set keySet = map.keySet();
        Iterator iterator2 = keySet.iterator();
        while(iterator2.hasNext()){
            Object key = iterator2.next();
            Object value = map.get(key);
            System.out.println(key + "=====" + value);
        }
//        AA=====123
//        BB=====56
//        45=====1234

    }
}

package com.sq.map;

import java.util.Objects;

public class User implements Comparable {
    private String name;
    private int age;

    public User() {
    }

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

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

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        System.out.println("User equals()");
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        User user = (User) o;
        return age == user.age && Objects.equals(name, user.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, age);
    }

    // 按照姓名从小到大排列,年龄从小到大排列
    @Override
    public int compareTo(Object o) {
        if(o instanceof User){
            User user = (User)o;
            // 从小到大
//            return this.name.compareTo(user.name);
            int compare = this.name.compareTo(user.name);
            if(compare != 0){
                return compare;
            } else {
                return Integer.compare(this.age,user.age);
            }
            // 从大到小
//            return -this.name.compareTo(user.name);
        } else {
            throw new RuntimeException("输入的类型不匹配");
        }
    }
}

package com.sq.map;

import org.junit.Test;

import java.util.*;

public class TreeMapTest {

    // 向 TreeMap 中添加 key-value，要求 key 必须是由同一个类创建的对象
    // 因为要按照 key 进行排序：自然排序、定制排序
    @Test
    public void test1(){
        TreeMap map = new TreeMap();
        User u1 = new User("Tom",23);
        User u2 = new User("Jerry",32);
        User u3 = new User("Jack",20);
        User u4 = new User("Rose",18);

        map.put(u1,98);
        map.put(u2,89);
        map.put(u3,76);
        map.put(u4,100);

        Set entrySet = map.entrySet();
        Iterator iterator = entrySet.iterator();
        while(iterator.hasNext()){
            Object obj = iterator.next();
            Map.Entry entry = (Map.Entry) obj;
            System.out.println(entry.getKey() + "---->" + entry.getValue());
        }
//        User{name='Jack', age=20}---->76
//        User{name='Jerry', age=32}---->89
//        User{name='Rose', age=18}---->100
//        User{name='Tom', age=23}---->98
    }

    // 定制排序
    @Test
    public void test2(){
        TreeMap map = new TreeMap(new Comparator() {
            @Override
            public int compare(Object o1, Object o2) {
                if(o1 instanceof User && o2 instanceof User){
                    User u1 = (User) o1;
                    User u2 = (User) o2;
                    return Integer.compare(u1.getAge(),u2.getAge());
                }
                throw new RuntimeException("输入的类型不匹配");
            }
        });
        User u1 = new User("Tom",23);
        User u2 = new User("Jerry",32);
        User u3 = new User("Jack",20);
        User u4 = new User("Rose",18);

        map.put(u1,98);
        map.put(u2,89);
        map.put(u3,76);
        map.put(u4,100);

        Set entrySet = map.entrySet();
        Iterator iterator = entrySet.iterator();
        while(iterator.hasNext()){
            Object obj = iterator.next();
            Map.Entry entry = (Map.Entry) obj;
            System.out.println(entry.getKey() + "---->" + entry.getValue());
        }
//        User{name='Rose', age=18}---->100
//        User{name='Jack', age=20}---->76
//        User{name='Tom', age=23}---->98
//        User{name='Jerry', age=32}---->89

    }
}