如何計算，一對key/value應該放在哪個哈希桶

大家都知道，hashmap底層是數組+鏈表（不討論紅黑樹的情況），其中，這個數組，我們一般叫做哈希桶，大家如果去看jdk的源碼，會發現裏面有一些變量，叫做bin，這個bin，就是桶的意思，結合語境，就是哈希桶。

這裏舉個例子，假設一個hashmap的數組長度為4（0000 0100），那麼該hashmap就有4個哈希桶，分別為bucket[0]、bucket[1]、bucket[2]、bucket[3]。

現在有兩個node，hashcode分別是1（0000 0001），5（0000 0101）. 我們當然知道，這兩個node，都應該放入第一個桶，畢竟1 mod 4，5 mod 4的結果，都是1。

但是，在代碼里，可不是用取模的方法來計算的，而是使用下面的方式：

int entryNodeIndex = (tableLength - 1) & hash;

應該說，在tableLength的值，為2的n次冪的時候，兩者是等價的，但是因為位運算的效率更高，因此，代碼一般都使用位運算，替代取模運算。

下面我們看看具體怎麼計算：

此處，tableLength即為哈希表的長度，此處為4. 4 – 1為3，3的二進製表示為：

0000 0011

那麼，和我們的1（0000 0001）相與：

0000 0001 -------- 1
0000 0011 -------- 3（tableLength - 1）
    相與（同為1，則為1；否則為0）
0000 0001 -------- 1     

結果為1，所以，應該放在第1個哈希桶，即數組下標為1的node。

接下來，看看5這個hashcode的節點要放在什麼位置，是怎麼計算：

0000 0101 -------- 5
0000 0011 -------- 3（tableLength - 1）
    相與（同為1，則為1；否則為0）后結果：
0000 0001 -------- 1     

擴容時，是怎麼對一個hash桶進行transfer的

此處，具體的整個transfer的細節，我們本講不會涉及太多，不過，大體的邏輯，我們可以來想一想。

以前面為例，哈希表一共4個桶，其中bucket[1]裏面，存放了兩個元素，假設是a、b，其hashcode分別是1，5.

現在，假設我們要擴容，一般來說，擴容的時候，都是新建一個bucket數組，其容量為舊錶的一倍，這裏舊錶為4，那新表就是8.

那，新表建立起來了，舊錶里的元素，就得搬到新表裡面去，等所有元素都搬到新表了，就會把新表和舊錶的指針交換。如下：

java.util.concurrent.ConcurrentHashMap#transfer

    private transient volatile Node<K,V>[] nextTable;

	transient volatile Node<K,V>[] table;

if (finishing) {
    // 1
    nextTable = null;
    // 2
    table = nextTab;
    // 3
    sizeCtl = (tabLength << 1) - (tabLength >>> 1);
    return;
}

• 1處，將field：nextTable（也就是新表）設為null，擴容完了，這個field就會設為null

• 2處，將局部變量nextTab，賦值給table，這個局部變量nextTab里，就是當前已經擴容完畢的新表

• 3處，修改表的sizeCtl為：假設此處tabLength為4，tabLength << 1 左移1位，就是8；tabLength >>> 1，右移一位，就是2，。8 – 2 = 6，正好就等於 8（新表容量） * 0.75。

  所以，這裏的sizeCtl就是，新表容量 * 負載因子，超過這個容量，基本就會觸發擴容。

ok，接着說，我們要怎麼從舊錶往新表搬呢？ 那以前面的bucket[1]舉例，遍歷這個鏈表，計算各個node，應該放到新表的什麼位置，不就完了嗎？是的，理論上這麼寫就完事了。

但是，我們會怎麼寫呢？

用hashcode對新bucket數組的長度取余嗎？

jdk對效率的追求那麼高，肯定不會這麼寫的，我們看看，它怎麼寫的：

java.util.concurrent.ConcurrentHashMap#transfer

// 1
for (Node<K,V> p = entryNode; p != null; p = p.next) {
    // 2
    int ph = p.hash;
    K pk = p.key;
    V pv = p.val;
    
	// 3
    if ((ph & tabLength) == 0){
        lowEntryNode = new Node<K,V>(ph, pk, pv, lowEntryNode);
    }
    else{
        highEntryNode = new Node<K,V>(ph, pk, pv, highEntryNode);
    }
}

• 1處，即遍歷舊的哈希表的某個哈希桶，假設就是遍歷前面的bucket[1]，裏面有a/b兩個元素，hashcode分別為1，5那個。

• 2處，獲取該節點的hashcode，此處分別為1，5

• 3處，如果hashcode 和 舊錶長度相與，結果為0，則，將該節點使用頭插法，插入新表的低位；如果結果不為0，則放入高位。

  ok，什麼是高位，什麼是低位。擴容后，新的bucket數組，長度為8，那麼，前面bucket[1]中的兩個元素，將分別放入bucket[1]和bucket[5].

  ok，這裏的bucket[1]就是低位，bucket[5]為高位。

首先，大家要知道，hashmap中，容量總是2的n次方，請牢牢記住這句話。

為什麼要這麼做？你想想，這樣是不是擴容很方便？

以前，hashcode 為1，5的，都在bucket[1]；而現在，擴容為8后，hashcode為1的，還是在newbucket[1]，hashcode為5的，則在newbucket[5]；這樣的話，是不是有一半的元素，根本不用動？

這就是我覺得的，最大的好處；另外呢，運算也比較方便，都可以使用位運算代替，效率更高。

好的，那我們現在問題來了，下面這句的原理是什麼？

    if ((ph & tabLength) == 0){
        lowEntryNode = new Node<K,V>(ph, pk, pv, lowEntryNode);
    } else{
        highEntryNode = new Node<K,V>(ph, pk, pv, highEntryNode);
    }

為啥，hashcode & 舊哈希表的容量， 結果為0的，擴容后，就會在低位，也就是維持位置不變呢？而結果不為0的，擴容后，位置在高位呢？

背後的位運算原理（大白話）

代碼里用的如下判斷，滿足這個條件，去低位；否則，去高位。

 if ((ph & tabLength) == 0)

還是用前面的例子，假設當前元素為a，hashcode為1，和哈希桶大小4，去進行與運算。

0000 0001  ---- 1
0000 0100  ---- 舊哈希表容量4
&運算（同為1則為1，否則為0）
結果：
0000 0000  ---- 結果為0    

ok，這裏算出來，結果為0；什麼情況下，結果會為0呢？

那我們現在開始倒推，什麼樣的數，和 0000 0100 相與，結果會為0？

???? ????  ---- 
0000 0100  ---- 舊哈希表容量
&運算（同為1則為1，否則為0）
結果：
0000 0000  ---- 結果為0    

因為與運算的規則是，同為1，則為1；否則都為0。那麼，我們這個例子里，舊哈希表容量為 0000 0100，假設表示為2的n次方，此處n為2，我們僅有第三位（第n+1）為1，那如果對方這一位為0，那結果中的這一位，就會為0，那麼，整個數，就為0.

所以，我們的結論是：假設哈希表容量，為2的n次方，表示為二進制后，第n+1位為1；那麼，只要我們節點的hashcode，在第n+1位上為0，則最終結果是0.

反之，如果我們節點的hashcode，在第n+1位為1，則最終結果不會是0.

比如，hashcode為5的時候，會是什麼樣子？

0000 0101  ---- 5
0000 0100  ---- 舊哈希表容量
&運算（同為1則為1，否則為0）
結果：
0000 0100  ---- 結果為4    

此時，5這個hashcode，在第n+1位上為1，所以結果不為0。

至此，我們離答案好像還很遠。ok，不慌，繼續。

假設現在擴容了，新bucket數組，長度為8.

a元素，hashcode依然是1，a元素應該放到新bucket數組的哪個bucket里呢？

我們用前面說的這個算法來計算：

int entryNodeIndex = (tableLength - 1) & hash;

0000 0001  ---- 1
0000 0111  ---- 8 - 1 = 7
&運算（同為1則為1，否則為0）
結果：
0000 0001  ---- 結果為1

結果沒錯，確實應該放到新bucket[1]，但怎麼推論出來呢？

    // 1
	if ((ph & tabLength) == 0){
        // 2
        lowEntryNode = new Node<K,V>(ph, pk, pv, lowEntryNode);
    }

也就是說，假設一個數，滿足1處的條件：(ph & tabLength) == 0，那怎麼推論出2呢，即應該在低位呢？

ok，條件1，前面分析了，可以得出：

這個數，第n+1位為0.

接下來，看看數組長度 – 1這個數。

好了，兩個數都有了，

???????0???????   -- 1 節點的hashcode，第n + 1位為0
000000010000000   -- 2 老數組    
000000100000000   -- 3 新數組的長度，等於老數組長度 * 2
000000011111111   -- 4 新數組的長度 - 1
    
    運算：1和4相與
    

大家注意看紅字部分，還有框出來的那一列，這一列為0，導致，最終結果，肯定是比2那一行的数字小，2這行，不就是老數組的長度嗎，那你比老數組小；你比這一行小，在新數組裡，就只能在低位了。

反之，如果節點的hashcode，這一位為1，那麼，最終結果，至少是大於等於2這一行的数字，所以，會放在高位。

參考資料

https://www.jianshu.com/p/2829fe36a8dd

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】

※廣告預算用在刀口上，台北網頁設計公司幫您達到更多曝光效益

※別再煩惱如何寫文案,掌握八大原則!

※教你寫出一流的銷售文案?

※超省錢租車方案

※廣告預算用在刀口上，台北網頁設計公司幫您達到更多曝光效益

※產品缺大量曝光嗎?你需要的是一流包裝設計!

※回頭車貨運收費標準

1.1 背景知識

1.1.1 紅黑樹

　　二叉查找樹可能因為多次插入新節點導致失去平衡，使得查找效率低，查找的複雜度甚至可能會出現線性的，為了解決因為新節點的插入而導致查找樹不平衡，此時就出現了紅黑樹。

紅黑樹它一種特殊的二叉查找樹。紅黑樹的每個節點上都有存儲位表示節點的顏色，可以是紅(Red)或黑(Black)。它具有以下特點：

（1）每個節點或者是黑色，或者是紅色。

（2）根節點是黑色。

（3）每個恭弘=叶 恭弘子節點(恭弘=叶 恭弘子節點，是指為空(NIL或NULL)的恭弘=叶 恭弘子節點)是黑色。

（4）如果一個節點是紅色的，則它的子節點一定是黑色（即從根節點到恭弘=叶 恭弘子節點的路徑上不能有兩個重複的紅色節點）。

（5）從一個節點到其上每一個恭弘=叶 恭弘節點的所有路徑都具有相同的黑色節點個數。

紅黑樹的基本操作–添加

① 將紅黑樹當作一顆二叉查找樹，將節點插入。

② 將插入的節點着色為”紅色”。（因為條件5，從一個節點到其中每一個節點的的所有路徑都具有相同的黑色節點）。

③通過一系列的旋轉（左旋或右旋操作）或着色等操作，使之重新成為一顆紅黑樹。

1.2 源碼

　　在java 1.7之前是用數組和鏈表一起組合構成HashMap，在java1.8之後就使用當鏈表長度超過8之後，就會將鏈錶轉化為紅黑樹，縮小查找的時間（紅黑樹維護也會花費大量時間，包含左旋、右旋和變色過程）。

1.2.1 HashMap的初始化

hashmap構造函數會初始化三個值：

• 初始容量initialCapacity：默認值是16，當儲存的數據越來越多的時候，就必須進行擴容操作。
• 閾值threshold：hashmap的數組結構中所能存放的最大數量，超過該數量，則會對數組進行擴容。閾值的計算方式為：容量（initialCapacity）*負載因子（loadFactor）。
• 負載因子loadFactor：當負載因子很大時，閾值會很大，table數組擴容的可能性比較小，會使得一個數組中的鏈表（紅黑樹）存放過多的數據，雖然節省了一定的空間，但會導致查詢時間很長。相反負載因子很小時，擴容的可能性會很高，使得數組中的數據變得相對少，查詢時間會縮短，但會花費較長的時間。

　　在初始化一個hashmap對象的時候，指定鍵值對的同時，也可以指定初始map的容量大小，假設此處我們指定大小為11，則會在構造函數中調用tableSizeFor將容量改為2的n冪次，即比當前容量大，而且必須是2的指數次冪的最小數，就會變成16。這是因為2的指數次冪便於計算進行位運算操作，提升運行效率問題（位運算>加法>乘法>除法>取模）。

　　hashmap的的默認值是16，負載因子默認是0.75，代碼如下：

//HashMap<String,String> hashMap = new HashMap<String, String>(11);

/**
 * Returns a power of two size for the given target capacity.
 **/
static final int tableSizeFor(int cap) {
    int n = cap - 1;   //10 防止在cap已經是2的n次冪的情況下
    // >>> 表示不關心符號位，對數據的二進制形式進行右移  |表示或運算
    n |= n >>> 1;	  //15
    n |= n >>> 2;     //15
    n |= n >>> 4;     //15
    n |= n >>> 8;     //15
    n |= n >>> 16;    //15
    return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1; //16
}

1.2.2 HashMap的put操作

　　 這裏可以介紹一下&位運算，當我們將一對KV存儲到hashmap當中時，會通過(n – 1) & hash運算來定位將要插入的鍵值對放入到哈希表的某個桶中。其中n表示哈希表的長度，通常n為2的倍數，通過n-1即可n所表示的二進制數，除最高位外，全部轉化為1，藉助與運算即可快速完成取模操作。

 //hashMap.put("2020", "good luck");

 /**
  * Implements Map.put and related methods.
  *
  * @param hash hash for key
  * @param key the key
  * @param value the value to put
  * @param onlyIfAbsent if true, don't change existing value
  * @param evict if false, the table is in creation mode.
  * @return previous value, or null if none
  */
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    //如果hashtable沒有初始化，則初始化該table數組
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length; 
    //通過位運算找到數組中的下標位置，如果數組中對應下標為空，則可以直接存放下去
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    else {
        //數組元素對應的位置已經有元素，產生碰撞
        Node<K,V> e; K k;
        //如果插入的元素key是已經存在的，則將新的value替換掉原來的舊值
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        //如果此時table數組對應的位置是紅黑樹結構，則將該節點插入紅黑樹中
        else if (p instanceof TreeNode)
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
            //如果此時table數組對應的位置是鏈表結構
            for (int binCount = 0; ; ++binCount) {
				//遍歷到數組尾端，沒有與插入鍵值對相同的key，則將新的鍵值對插入鏈表尾部
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    //鏈表過長，將鏈錶轉化為紅黑樹
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);
                    break;
                }
                //發現鏈表中的某個節點有與插入鍵值對相同的key，則跳出循環，在循環外部重新賦值
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        //該key在hashmap已存在，更新與在鏈表跳出循環節點對應的值
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;
    //超過閾值則更新
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

1.2.3 HashMap的get操作

/**
     * Implements Map.get and related methods.
     *
     * @param hash hash for key
     * @param key the key
     * @return the node, or null if none
     */
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        //table數組不為空，且對應的下標位置也不為空。
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
            //如果第一個位置是對應的key，則返回
            if (first.hash == hash && // always check first node
                ((k = first.key) == key || (key != null && key.equals(k))))
                return first;
            //遍歷其他元素
            if ((e = first.next) != null) {
                //紅黑樹
                if (first instanceof TreeNode)
                    return ((TreeNode<K,V>)first).getTreeNode(hash, key);
                //鏈表
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        return e;
                } while ((e = e.next) != null);
            }
        }
        return null;
    }

1.2.4 HashMap的擴容操作

    /**
     * Initializes or doubles table size.  If null, allocates in
     * accord with initial capacity target held in field threshold.
     * Otherwise, because we are using power-of-two expansion, the
     * elements from each bin must either stay at same index, or move
     * with a power of two offset in the new table.
     *
     * @return the table
     */
    final Node<K,V>[] resize() {
        Node<K,V>[] oldTab = table;
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        int oldThr = threshold;
        int newCap, newThr = 0;
        //table不為空，且容量大於0
        if (oldCap > 0) {
            //如果舊的容量到達閾值，則不再擴容，閾值直接設置為最大值
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            //如果舊的容量沒有到達閾值，直接操作
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
        //閾值大於0，直接使用舊的閾值
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        //如果閾值為零，則使用默認的初始化值
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        if (newThr == 0) {
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
        threshold = newThr;
        //更新數組桶
        @SuppressWarnings({"rawtypes","unchecked"})
        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;
        //將之前舊數組桶的數據重新移到新數組桶中
        if (oldTab != null) {
            //依次遍歷舊table中每個數組桶的元素
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                //如果數組桶中含有元素
                if ((e = oldTab[j]) != null) {
                    //將下標數據清空
                    oldTab[j] = null;
                    //如果元組的某一桶中只有一個元素，則直接將該元素移到新的位置去
                    if (e.next == null)
                        newTab[e.hash & (newCap - 1)] = e;
                    //如果是紅黑樹結構
                    else if (e instanceof TreeNode)
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                     //鏈表 -- 對舊桶里鏈表中的每一個元素重新計算哈希值得到下標
                    else { // preserve order
                        //將原先桶中的鏈表分為兩個鏈表
                        Node<K,V> loHead = null, loTail = null;
                        Node<K,V> hiHead = null, hiTail = null;
                        Node<K,V> next;
                        do {
                            next = e.next;
                            /*
                             * e.hash & oldCap 對hash取模運算，
                             * 雖然數組大小擴大了一倍，
                             * 但是同一個key在新舊table中對應的index卻存在一定聯繫： 
                             * 要麼一致，要麼相差一個 oldCap。
                             */
                            if ((e.hash & oldCap) == 0) {
                                if (loTail == null)
                                    loHead = e;
                                else
                                    loTail.next = e;
                                loTail = e;
                            }
                            else {
                                if (hiTail == null)
                                    hiHead = e;
                                else
                                    hiTail.next = e;
                                hiTail = e;
                            }
                        } while ((e = next) != null);
                        if (loTail != null) {
                            loTail.next = null;
                            newTab[j] = loHead;
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }

　　此處在處理鏈表的時候，如何將鏈表中的節點重新分配到新的哈希表需要做一些解釋。在擴容的時候，將原來的哈希表擴大了一倍，原來屬於同一個桶中的數據會被重新分配，此時取模運算時（a mod b），會注意到，b會擴大兩倍（a mod 2b)，此時如果該桶中的某一個數據的哈希值是c1（0<c<b），則它必定還是會落入原來的位置，而如果桶中的某一個數據的哈希值是c2（b<c2<2b）,則它會被重新分配到一個新的位置（這個位置是原先的哈希桶位置+舊桶的大小）。

HashMap在多線程的情況下出現的死循環現象

　　在某些java版本中擴容機制如果使用鏈表，且再插入時使用尾插法會出現死循環，具體原因可以參考老生常談，HashMap的死循環，在本文中所參考的java版本使用了頭插法的方式將元素添加到鏈表當中，可以避免死循環的出現，但是會出現一部分節點丟失的問題。如圖：

　　假設原始的哈希map的某個桶的數據如下，此時線程開始擴容，將桶中的數據分配到lo和hi桶的鏈表中。

 　　初始時刻線程1和線程2開始運行，線程1在執行完以下代碼后，線程1的時間片運行結束。線程1運行的結果如圖所示

　　線程2與線程1同時運行，線程2的時間片未用完，還在繼續執行，根據代碼的分配策略，線程2直到時間片運行結束，出現如圖所示的結果：

 　　此時CPU的時間片又被分配到了線程1，線程1繼續運行，因為此時A所在的鏈表結構已經發生了變化，只能處理A，B，D三個元素。此時線程1創建的hashmap如圖：

 參考資料

　　教你初步了解紅黑樹

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】

※別再煩惱如何寫文案,掌握八大原則!

※網頁設計一頭霧水該從何著手呢? 台北網頁設計公司幫您輕鬆架站!

※超省錢租車方案

※教你寫出一流的銷售文案?

※網頁設計最專業,超強功能平台可客製化

※產品缺大量曝光嗎?你需要的是一流包裝設計!

※台中搬家遵守搬運三大原則,讓您的家具不再被破壞!

在應用開發過程中經常需要對其他應用或者客戶端提供 RESTful API 接口，尤其是在版本快速迭代的開發過程中，修改接口的同時還需要同步修改對應的接口文檔，這使我們總是做着重複的工作，並且如果忘記修改接口文檔，就可能造成不必要的麻煩。

為了解決這些問題，Swagger 就孕育而生了，那讓我們先簡單了解下。

Swagger 簡介

Swagger 是一個規範和完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。

總體目標是使客戶端和文件系統作為服務器，以同樣的速度來更新。文件的方法、參數和模型緊密集成到服務器端的代碼中，允許 API 始終保持同步。

下面我們在 Spring Boot 中集成 Swagger 來構建強大的接口文檔。

Spring Boot 集成 Swagger

Spring Boot 集成 Swagger 主要分為以下三步：

1. 加入 Swagger 依賴
2. 加入 Swagger 文檔配置
3. 使用 Swagger 註解編寫 API 文檔

加入依賴

首先創建一個項目，在項目中加入 Swagger 依賴，項目依賴如下所示：

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

加入配置

接下來在 config 包下創建一個 Swagger 配置類 Swagger2Configuration，在配置類上加入註解 @EnableSwagger2，表明開啟 Swagger，注入一個 Docket 類來配置一些 API 相關信息，apiInfo() 方法內定義了幾個文檔信息，代碼如下：

@Configuration
@EnableSwagger2
public class Swagger2Configuration {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // swagger 文檔掃描的包
                .apis(RequestHandlerSelectors.basePackage("com.wupx.interfacedoc.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("測試接口列表")
                .description("Swagger2 接口文檔")
                .version("v1.0.0")
                .contact(new Contact("wupx", "https://www.tianheyu.top", "wupx@qq.com"))
                .license("Apache License, Version 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
                .build();
    }
}

列舉其中幾個文檔信息說明下：

• title：接口文檔的標題
• description：接口文檔的詳細描述
• termsOfServiceUrl：一般用於存放公司的地址
• version：API 文檔的版本號
• contact：維護人、維護人 URL 以及 email
• license：許可證
• licenseUrl：許可證 URL

編寫 API 文檔

在 domain 包下創建一個 User 實體類，使用 @ApiModel 註解表明這是一個 Swagger 返回的實體，@ApiModelProperty 註解表明幾個實體的屬性，代碼如下（其中 getter/setter 省略不显示）：

@ApiModel(value = "用戶", description = "用戶實體類")
public class User {

    @ApiModelProperty(value = "用戶 id", hidden = true)
    private Long id;

    @ApiModelProperty(value = "用戶姓名")
    private String name;

    @ApiModelProperty(value = "用戶年齡")
    private String age;

    // getter/setter
}

最後，在 controller 包下創建一個 UserController 類，提供用戶 API 接口（未使用數據庫），代碼如下：

@RestController
@RequestMapping("/users")
@Api(tags = "用戶管理接口")
public class UserController {

    Map<Long, User> users = Collections.synchronizedMap(new HashMap<>());

    @GetMapping("/")
    @ApiOperation(value = "獲取用戶列表", notes = "獲取用戶列表")
    public List<User> getUserList() {
        return new ArrayList<>(users.values());
    }

    @PostMapping("/")
    @ApiOperation(value = "創建用戶")
    public String addUser(@RequestBody User user) {
        users.put(user.getId(), user);
        return "success";
    }

    @GetMapping("/{id}")
    @ApiOperation(value = "獲取指定 id 的用戶")
    @ApiImplicitParam(name = "id", value = "用戶 id", paramType = "query", dataTypeClass = Long.class, defaultValue = "999", required = true)
    public User getUserById(@PathVariable Long id) {
        return users.get(id);
    }

    @PutMapping("/{id}")
    @ApiOperation(value = "根據 id 更新用戶")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用戶 id", defaultValue = "1"),
            @ApiImplicitParam(name = "name", value = "用戶姓名", defaultValue = "wupx"),
            @ApiImplicitParam(name = "age", value = "用戶年齡", defaultValue = "18")
    })
    public User updateUserById(@PathVariable Long id, @RequestParam String name, @RequestParam Integer age) {
        User user = users.get(id);
        user.setName(name);
        user.setAge(age);
        return user;
    }

    @DeleteMapping("/{id}")
    @ApiOperation(value = "刪除用戶", notes = "根據 id 刪除用戶")
    @ApiImplicitParam(name = "id", value = "用戶 id", dataTypeClass = Long.class, required = true)
    public String deleteUserById(@PathVariable Long id) {
        users.remove(id);
        return "success";
    }
}

啟動項目，訪問 http://localhost:8080/swagger-ui.html，可以看到我們定義的文檔已經在 Swagger 頁面上显示了，如下圖所示：

到此為止，我們就完成了 Spring Boot 與 Swagger 的集成。

同時 Swagger 除了接口文檔功能外，還提供了接口調試功能，以創建用戶接口為例，單擊創建用戶接口，可以看到接口定義的參數、返回值、響應碼等，單擊 Try it out 按鈕，然後點擊 Execute 就可以發起調用請求、創建用戶，如下圖所示：

註解介紹

由於 Swagger 2 提供了非常多的註解供開發使用，這裏列舉一些比較常用的註解。

@Api

@Api 用在接口文檔資源類上，用於標記當前類為 Swagger 的文檔資源，其中含有幾個常用屬性：

• value：定義當前接口文檔的名稱。
• description：用於定義當前接口文檔的介紹。
• tag：可以使用多個名稱來定義文檔，但若同時存在 tag 屬性和 value 屬性，則 value 屬性會失效。
• hidden：如果值為 true，就會隱藏文檔。

@ApiOperation

@ApiOperation 用在接口文檔的方法上，主要用來註解接口，其中包含幾個常用屬性：

• value：對API的簡短描述。
• note：API的有關細節描述。
• esponse：接口的返回類型（注意：這裏不是返回實際響應，而是返回對象的實際結果）。
• hidden：如果值為 true，就會在文檔中隱藏。

@ApiResponse、@ApiResponses

@ApiResponses 和 @ApiResponse 二者配合使用返回 HTTP 狀態碼。@ApiResponses 的 value 值是 @ApiResponse 的集合，多個 @ApiResponse 用逗號分隔，其中 @ApiResponse 包含的屬性如下：

• code：HTTP狀態碼。
• message：HTTP狀態信息。
• responseHeaders：HTTP 響應頭。

@ApiParam

@ApiParam 用於方法的參數，其中包含以下幾個常用屬性：

• name：參數的名稱。
• value：參數值。
• required：如果值為 true，就是必傳字段。
• defaultValue：參數的默認值。
• type：參數的類型。
• hidden：如果值為 true，就隱藏這個參數。

@ApiImplicitParam、@ApiImplicitParams

二者配合使用在 API 方法上，@ApiImplicitParams 的子集是 @ApiImplicitParam 註解，其中 @ApiImplicitParam 註解包含以下幾個參數：

• name：參數的名稱。
• value：參數值。
• required：如果值為 true，就是必傳字段。
• defaultValue：參數的默認值。
• dataType：數據的類型。
• hidden：如果值為 true，就隱藏這個參數。
• allowMultiple：是否允許重複。

@ResponseHeader

API 文檔的響應頭，如果需要設置響應頭，就將 @ResponseHeader 設置到 @ApiResponse 的 responseHeaders 參數中。@ResponseHeader 提供了以下幾個參數：

• name：響應頭名稱。
• description：響應頭備註。

@ApiModel

設置 API 響應的實體類，用作 API 返回對象。@ApiModel 提供了以下幾個參數：

• value：實體類名稱。
• description：實體類描述。
• subTypes：子類的類型。

@ApiModelProperty

設置 API 響應實體的屬性，其中包含以下幾個參數：

• name：屬性名稱。
• value：屬性值。
• notes：屬性的註釋。
• dataType：數據的類型。
• required：如果值為 true，就必須傳入這個字段。
• hidden：如果值為 true，就隱藏這個字段。
• readOnly：如果值為 true，字段就是只讀的。
• allowEmptyValue：如果為 true，就允許為空值。

到此為止，我們就介紹完了 Swagger 提供的主要註解。

總結

Swagger 可以輕鬆地整合到 Spring Boot 中構建出強大的 RESTful API 文檔，可以減少我們編寫接口文檔的工作量，同時接口的說明內容也整合入代碼中，可以讓我們在修改代碼邏輯的同時方便的修改接口文檔說明，另外 Swagger 也提供了頁面測試功能來調試每個 RESTful API。

如果項目中還未使用，不防嘗試一下，會發現效率會提升不少。

本文的完整代碼在 https://github.com/wupeixuan/SpringBoot-Learn 的 interface-doc 目錄下。

最好的關係就是互相成就，大家的在看、轉發、留言三連就是我創作的最大動力。

參考

http://swagger.io

https://github.com/wupeixuan/SpringBoot-Learn

《Spring Boot 2 實戰之旅》

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】

※超省錢租車方案

※別再煩惱如何寫文案,掌握八大原則!

※回頭車貨運收費標準

※教你寫出一流的銷售文案?

※產品缺大量曝光嗎?你需要的是一流包裝設計!

※廣告預算用在刀口上，台北網頁設計公司幫您達到更多曝光效益

※網頁設計最專業,超強功能平台可客製化

值類型和引用類型，是c#比較基礎，也必須掌握的知識點，但是也不是那麼輕易就能掌握，今天跟着老胡一起來看看吧。
 

典型類型

首先我們看看這兩種不同的類型有哪些比較典型的代表。
 

典型值類型

int, long, float, double等原始類型中表示数字的類型都是值類型，表示時間的datatime也是值類型，除此之外我們還可以通過關鍵字struct自定義值類型。
 

典型引用類型

原始類型中，array, list, dictionary, queue, stack和string都是引用類型，除此之外我們通過關鍵字class自定義引用類型。
 

基類

c#中所有的類型都最終繼承自Object，這是沒有疑問的，但是這其中還有些微區別。
 

值類型基類

對於值類型來說，除了最終繼承自Object，還繼承自ValueType，繼承鏈如下

但是請不要誤解，這裏僅僅指的是值類型天然是ValueType，但是不代表值類型能夠這麼聲明

struct Struct1 : ValueType
{

}

這樣是會引起編譯錯誤的，值類型不能繼承任何其他類型，值類型只能實現接口，不能繼承自其它類型。只有引用類型既可以實現接口也能繼承自其它類型。順便說一下，還有一點比較重要的是，ValueType重寫了Object基類的Equals方法和GetHashCode方法，所以當使用Equals比較兩個值類型的時候，系統會比較兩個值類型的各個屬性是否相等，再返回結果，這就是所謂的相等性。與此相對，引用類型在使用Equals的時候，會在後台調用object.ReferenceEquals，換言之，引用類型在比較相等性的時候會考慮同一性。
 

引用類型基類

對於引用類型就沒有那麼麻煩，引用類型不會繼承自ValueType。引用類型可以繼承其他類型。
 

在內存中的表現

我們都知道，C#將內存分為了兩部分，一個是Stack，另外一個是Managed Heap。一般來說，用於函數調用進棧，函數返回出棧，用的是Stack，而當創造一個新的實例時，會根據創建的實例屬於值類型還是引用類型決定使用Stack還是Managed Heap。
 

值類型在內存中

當創建一個值類型對象時，c#會在Stack上面創建一塊空間，這塊空間就存放這個值類型對象。
int是一個典型的值類型，如下語句

int age = 10;

會存在於內存中的Stack上面。

如果把值類型的實例賦值給另外一個值類型，那麼效果就是複製一個新的值類型實例。

int myAge = age;

引用類型在內存中

與值類型在內存中的表現不一樣，創建一個引用類型的實例，不但會在Stack上面新建一個引用，還會在Heap上面劃分出內存以容納該引用類型實例。用戶在使用的時候通過Stack上面的變量間接引用該實例。

class Author
{
	public string Name{get;set;}
	public int Age{get;set;}
}

Author author = new Author(){Name="deatharthas", Age= 32};

注意看和值類型在內存中的區別，引用類型通過Stack上的變量訪問位於Heap上面的實例。
在賦值的時候，拷貝的僅僅是Stack上面的變量，新拷貝出來的對象和舊的對象指向的是同一塊內存。

Author myAuthor = author;

這個時候，author和myAuthor指向同一塊內存，稱為同一性，通過調用

object.ReferenceEquals(myAuthor, author);

可以得到驗證。
 
但可能有細心的朋友會有疑問了，不是說int是值類型，值類型是存在於Stack上面的嗎？為什麼在author類裏面，它會在Heap裏面呢？贊一個細心！值類型一般存在於Stack上面，但如果某個值類型包含於引用類型，那麼它也會隨着那個引用類型存放在Heap上面。
 

當參數時的行為區別

c#中的參數傳遞默認都是傳值(by value)，但是根據所傳遞對象是值類型還是引用類型，它們的行為還是有所區別，現在我們來看看。

值類型當參數

值類型當參數的時候，傳遞到函數內部的是一份值類型的拷貝，所以在函數內部修改這個拷貝不會影響原對象。除非我們在傳遞參數的時候使用了ref或者out。
 

引用類型當參數

如果參數是引用類型，傳遞到函數內部的依然是一份拷貝，但是這個拷貝是其在Stack上面的變量的拷貝，就像上面的賦值那個例子。所以這個時候這份拷貝其實和原對象指向同一塊內存（指向同一性），修改這個對象可以反映到原對象上面。
 

謹慎返回引用類型

編程是一項需要謹慎的工作，有時候我們經常會犯一些錯誤，而這些錯誤又是那麼的不明顯以至於不摔坑幾次，我們根本察覺不了，考慮下面一個例子。

    class People
    {
        public string Name { get; set; }
        public int Age { get; set; }
        private People _Father = null;
        public People Father { get { return _Father; } }
        public People(People father)
        {
            _Father = father;
        }
        public void ShowFather()
        {
            Console.WriteLine("father's name is " + Father.Name + " and his age is " + Father.Age);
        }
    }

    class Program
    {        
        static void Main(string[] args)
        {
            People father = new People(null) { Name = "father", Age = 60 };
            People son = new People(father);
            son.ShowFather();
            Console.ReadLine();
        }
    }

看起來沒什麼問題，對吧？Father沒有提供setter，似乎是安全的。但是我們試試下面的代碼。

	static void Main(string[] args)
        {
            People father = new People(null) { Name = "father", Age = 60 };
            People son = new People(father);
            var f = son.Father;
            f.Name="Changed";
            son.ShowFather();
            Console.ReadLine();
        }

看，發現了什麼，外部改變了本來應該被封裝所保護的Father屬性，封裝被破壞了！
稍微一想我們應該能明白這個道理，Father屬性返回的拷貝的變量和原Father變量指向同一塊實例。要想解決這個問題，我們要麼返回一個值類型，要麼返回一個全新的對象。修改Father屬性如下:

public People Father { get { return new People(_Father._Father) { Name = _Father.Name, Age = _Father.Age }; } }

再次測試，

這次封裝就沒問題了。
 

總結

我們大概知道了值類型和引用類型的區別，包括它們的行為，在內存的居住方式，以及使用引用類型時可能會遇到的暗坑，希望大家通過閱讀這篇文章，能夠加深一些對它們的了解，少走一些彎路。
今天也簡單的提到了比較時的同一性，和預防封裝被破壞所採用的返回一個新的實例拷貝的策略（這個時候適合使用DeepCopy），我們之後有機會再詳細聊。

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】

※自行創業缺乏曝光? 網頁設計幫您第一時間規劃公司的形象門面

※如何讓商品強力曝光呢? 網頁設計公司幫您建置最吸引人的網站，提高曝光率!

※綠能、環保無空污,成為電動車最新代名詞，目前市場使用率逐漸普及化

※廣告預算用在刀口上，台北網頁設計公司幫您達到更多曝光效益

※教你寫出一流的銷售文案?

※別再煩惱如何寫文案,掌握八大原則!

一、Spring+CXF整合示例

WebService是一種跨編程語言、跨操作系統平台的遠程調用技術，它是指一個應用程序向外界暴露一個能通過Web調用的API接口，我們把調用這個WebService的應用程序稱作客戶端，把提供這個WebService的應用程序稱作服務端。

環境

win10+Spring5.1+cxf3.3.2

下載

• 官網下載：https://archive.apache.org/dist/cxf/
• 百度網盤：
  鏈接：https://pan.baidu.com/s/1nsUweTFG_6CcZKaVBCQ7uQ
  提取碼：4qp7

服務端

• 新建web項目
• 放入依賴
  將apache-cxf-3.3.2\lib中的jar包全部copy至項目WEB-INF\lib目錄下（偷個懶，這些jar包中包含了Spring所需的jar包）
• 在web.xml中添加webService的配置攔截

<!--webService  -->
<servlet>
    <servlet-name>CXFService</servlet-name>
    <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>CXFService</servlet-name>
    <url-pattern>/webservice/*</url-pattern>
</servlet-mapping>

• webservice服務接口
  在項目src目錄下新建pms.inface.WebServiceInterface類

package pms.inface;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;

@WebService(targetNamespace = "http://spring.webservice.server", name = "WebServiceInterface")
public interface WebServiceInterface {

	@WebMethod
    @WebResult(name = "result", targetNamespace = "http://spring.webservice.server")
	public String sayBye(@WebParam(name = "word", targetNamespace = "http://spring.webservice.server") String word);

}

• 接口實現類
  在項目src目錄下新建pms.impl.WebServiceImpl類

package pms.impl;

import javax.jws.WebService;

import pms.inface.WebServiceInterface;

@WebService
public class WebServiceImpl implements WebServiceInterface{

	@Override
	public String sayBye(String word) {
		return word + "當和這個真實的世界迎面撞上時，你是否找到辦法和自己身上的慾望講和，又該如何理解這個鋪面而來的人生？";
	}

}

• webservice配置文件
  在WEB-INF目錄下新建webservice配置文件cxf-webService.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:jaxws="http://cxf.apache.org/jaxws"
	xmlns:cxf="http://cxf.apache.org/core"
	xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
       http://cxf.apache.org/jaxws
       http://cxf.apache.org/schemas/jaxws.xsd
       http://cxf.apache.org/core
	   http://cxf.apache.org/schemas/core.xsd
	   http://cxf.apache.org/transports/http/configuration
	   http://cxf.apache.org/schemas/configuration/http-conf.xsd
	   ">
	   
	<import resource="classpath:META-INF/cxf/cxf.xml" />

	<!-- 使用jaxws:server標籤發布WebService服務 ,設置address為訪問地址, 和web.xml文件中配置的CXF配合為一個完整的路徑 -->
	<!-- serviceClass為實現類的接口 serviceBean引用配置好的WebService實現類 -->
	<jaxws:server address="/webServiceInterface"
		serviceClass="pms.inface.WebServiceInterface">
		<jaxws:serviceBean>
			<ref bean="WebServiceImpl" />
		</jaxws:serviceBean>
	</jaxws:server>
	
	<!-- 為所有的WS設置超時時間 ,此時為默認值 連接時間30s,等待回復時間為60s-->	
	<http-conf:conduit name="*.http-conduit">
		<http-conf:client ConnectionTimeout="60000" ReceiveTimeout="120000"/>
	</http-conf:conduit>

</beans>

• spring配置文件
  在WEB-INF目錄下新建spring配置文件applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

   <bean id="WebServiceImpl" class="pms.impl.WebServiceImpl"></bean>
	
	<import resource="cxf-webService.xml" />

</beans>

      在web.xml中配置applicationContext.xml

<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>
		    /WEB-INF/applicationContext.xml
		</param-value>
  </context-param>
  <listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>

• 將項目放至tomcat中啟動
  啟動后訪問地址：localhost:PORT/項目名/webservice/webServiceInterface?wsdl，如下圖所示，webservice接口發布成功

二、SoapUI測試

SoapUI是一個開源測試工具,通過soap/http來檢查、調用、實現Web Service的功能/負載/符合性測試。

下載

• 百度網盤
  鏈接：https://pan.baidu.com/s/1N2RTqhvrkuzx7YJvmDeY7Q
  提取碼：e1w3

測試

• 打開SoapUI，新建一個SOAP項目，將剛才的發布地址copy至Initial WSDL欄，點擊OK按鈕
• 發起接口請求

三、客戶端

使用wsdl2java工具生成webservice客戶端代碼

• 該工具在剛才下載的apache-cxf-3.3.2\bin目錄下
• 配置環境變量
  設置CXF_HOME，並添加%CXF_HOME %/bin到path環境變量。
• CMD命令行輸入wsdl2java -help，有正常提示說明環境已經正確配置
• wsdl2java.bat用法：

wsdl2java –p 包名 –d 存放目錄 -all wsdl地址

-p 指定wsdl的命名空間，也就是要生成代碼的包名

-d 指令要生成代碼所在目錄

-client 生成客戶端測試web service的代碼

-server 生成服務器啟動web service代碼

-impl 生成web service的實現代碼，我們在方式一用的就是這個

-ant 生成build.xml文件

-all 生成所有開始端點代碼

• 生成客戶端代碼

wsdl2java -p pms.inface -d ./ -all http://localhost:8080/spring_webservice_server/webservice/webServiceInterface?wsdl

客戶端調用

• 新建web項目
• 放入依賴
  將apache-cxf-3.3.2\lib中的jar包全部copy至項目WEB-INF\lib目錄下
• 將wsdl2java生成的代碼放至src.pms.inface目錄下

調用方法一：

• 新建webServiceClientMain測試

package pms;

import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
import pms.inface.WebServiceInterface;

public class webServiceClientMain {
	public static void main(String[] args) {
		JaxWsProxyFactoryBean svr = new JaxWsProxyFactoryBean();
		svr.setServiceClass(WebServiceInterface.class);
		svr.setAddress("http://localhost:8080/spring_webservice_server/webservice/webServiceInterface?wsdl");
		WebServiceInterface webServiceInterface = (WebServiceInterface) svr.create();

		System.out.println(webServiceInterface.sayBye("honey,"));
	}
}

• 運行webServiceClientMain

調用方法二：

• 在src目錄下新建applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:jaxws="http://cxf.apache.org/jaxws"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
		http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
		http://www.springframework.org/schema/context
		http://www.springframework.org/schema/context/spring-context-3.0.xsd
		http://cxf.apache.org/jaxws
		http://cxf.apache.org/schemas/jaxws.xsd">

	<jaxws:client id="webServiceInterface"
		serviceClass="pms.inface.WebServiceInterface"
		address="http://localhost:8080/spring_webservice_server/webservice/webServiceInterface?wsdl" >
	</jaxws:client>	
</beans>

• 新建webServiceClientTest測試

package pms;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import pms.inface.WebServiceInterface;

public class webServiceClientTest {

	public static void main(String[] args) {
		ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
		WebServiceInterface webServiceInterface = context.getBean(WebServiceInterface.class);
		String result = webServiceInterface.sayBye("honey,");
		System.out.println(result);
	}
	
}

• 運行webServiceClientTest

四、服務端攔截器

• 需求場景：服務提供方安全驗證，也就是webservice自定義請求頭的實現，服務接口在身份認證過程中的密碼字段滿足SM3（哈希函數算法標準）的加密要求
• SM3加密所需jar包：commons-lang3-3.9.jar、bcprov-jdk15on-1.60.jar，這兩個jar包在剛才下載的apache-cxf-3.3.2\lib下就有
• 請求頭格式

<security>
	<username></username>
	<password></password>
</auth>

• 在src.pms.interceptor下新建WebServiceInInterceptor攔截器攔截請求，解析頭部

package pms.interceptor;

import java.util.List;
import javax.servlet.http.HttpServletRequest;
import javax.xml.namespace.QName;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.headers.Header;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.apache.cxf.transport.http.AbstractHTTPDestination;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import pms.support.Sm3Utils;
import pms.support.StringUtils;

/**
 * WebService的輸入攔截器
 * @author coisini
 * @date May 2020, 13
 *
 */
public class WebServiceInInterceptor extends AbstractPhaseInterceptor<SoapMessage> {
	
    private static final String USERNAME = "admin";
    private static final String PASSWORD = "P@ssw0rd";
    
    /**
     * 允許訪問的IP
     */
    private static final String ALLOWIP = "127.0.0.1;XXX.XXX.XXX.XXX";

	public WebServiceInInterceptor() {
		/*
		 * 攔截器鏈有多個階段，每個階段都有多個攔截器，攔截器在攔截器鏈的哪個階段起作用，可以在攔截器的構造函數中聲明
		 * RECEIVE 接收階段，傳輸層處理
		 * (PRE/USER/POST)_STREAM 流處理/轉換階段
		 * READ SOAPHeader讀取 
		 * (PRE/USER/POST)_PROTOCOL 協議處理階段，例如JAX-WS的Handler處理 
		 * UNMARSHAL SOAP請求解碼階段 
		 * (PRE/USER/POST)_LOGICAL SOAP請求解碼處理階段 
		 * PRE_INVOKE 調用業務處理之前進入該階段 
		 * INVOKE 調用業務階段 
		 * POST_INVOKE 提交業務處理結果，並觸發輸入連接器
		 */
		super(Phase.PRE_INVOKE);
	}

	/**
	  * 客戶端傳來的 soap 消息先進入攔截器這裏進行處理，客戶端的賬目與密碼消息放在 soap 的消息頭<security></security>中，
	  * 類似如下：
     * <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     * <soap:Header><security><username>admin</username><password>P@ssw0rd</password></security></soap:Header>
     * <soap:Body></soap:Body></soap:Envelope>
     * 現在只需要解析其中的 <head></head>標籤，如果解析驗證成功，則放行，否則這裏直接拋出異常，
     * 服務端不會再往後運行，客戶端也會跟着拋出異常，得不到正確結果
     *
     * @param message
     * @throws Fault
     */
	@Override
    public void handleMessage(SoapMessage message) throws Fault {
		System.out.println("PRE_INVOKE");
		
		HttpServletRequest request = (HttpServletRequest)message.get(AbstractHTTPDestination.HTTP_REQUEST);
	    String ipAddr=request.getRemoteAddr();
	    System.out.println("客戶端訪問IP----"+ipAddr);
	    
	    if(!ALLOWIP.contains(ipAddr)) {
			throw new Fault(new IllegalArgumentException("非法IP地址"), new QName("0009"));
		}
		
		/**
		 * org.apache.cxf.headers.Header
         * QName ：xml 限定名稱，客戶端設置頭信息時，必須與服務器保持一致，否則這裏返回的 header 為null，則永遠通不過的
         */
		Header authHeader = null;
		//獲取驗證頭
		List<Header> headers = message.getHeaders();
		for(Header h:headers){
			if(h.getName().toString().contains("security")){
				authHeader=h;
				break;
			}
		}
		System.out.println("authHeader");
		System.out.println(authHeader);
		
		if(authHeader !=null) {
			Element auth = (Element) authHeader.getObject();
			NodeList childNodes = auth.getChildNodes();
			String username = null,password = null;
			for(int i = 0, len = childNodes.getLength(); i < len; i++){
					Node item = childNodes.item(i);
					if(item.getNodeName().contains("username")){
						username = item.getTextContent();
						System.out.println(username);
					}
					if(item.getNodeName().contains("password")){
						password = item.getTextContent();
						System.out.println(password);
					}
			}
			
			if(StringUtils.isBlank(username) || StringUtils.isBlank(password)) { 
		    	throw new Fault(new IllegalArgumentException("用戶名或密碼不能為空"), new QName("0001")); 
		    }
			
			if(!Sm3Utils.verify(USERNAME, username) || !Sm3Utils.verify(PASSWORD,password)) { 
		    	throw new Fault(new IllegalArgumentException("用戶名或密碼錯誤"), new QName("0008")); 
		    }
		  
		    if (Sm3Utils.verify(USERNAME, username) && Sm3Utils.verify(PASSWORD,password)) { 
		    	System.out.println("webService 服務端自定義攔截器驗證通過...."); 
		    	return;//放行
		    } 
		}else {
			throw new Fault(new IllegalArgumentException("請求頭security不合法"), new QName("0010"));
		}
	}

	// 出現錯誤輸出錯誤信息和棧信息
	public void handleFault(SoapMessage message) {
		Exception exeption = message.getContent(Exception.class);
		System.out.println(exeption.getMessage());
	}
	
}

• 在src.pms.support下新建Sm3Utils加密類

package pms.support;

import java.io.UnsupportedEncodingException;
import java.security.Security;
import java.util.Arrays;
import org.bouncycastle.crypto.digests.SM3Digest;
import org.bouncycastle.crypto.macs.HMac;
import org.bouncycastle.crypto.params.KeyParameter;
import org.bouncycastle.jce.provider.BouncyCastleProvider;
import org.bouncycastle.pqc.math.linearalgebra.ByteUtils;

/**
 * SM3加密
 * @author coisini
 * @date May 2020, 13
 */
public class Sm3Utils {
	 private static final String ENCODING = "UTF-8";
     static {
         Security.addProvider(new BouncyCastleProvider());
     }
	    
    /**
     * sm3算法加密
     * @explain
     * @param paramStr
     * 待加密字符串
     * @return 返回加密后，固定長度=32的16進制字符串
     */
    public static String encrypt(String paramStr){
        // 將返回的hash值轉換成16進制字符串
        String resultHexString = "";
        try {
            // 將字符串轉換成byte數組
            byte[] srcData = paramStr.getBytes(ENCODING);
            // 調用hash()
            byte[] resultHash = hash(srcData);
            // 將返回的hash值轉換成16進制字符串
            resultHexString = ByteUtils.toHexString(resultHash);
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }
        return resultHexString;
    }
    
    /**
     * 返回長度=32的byte數組
     * @explain 生成對應的hash值
     * @param srcData
     * @return
     */
    public static byte[] hash(byte[] srcData) {
        SM3Digest digest = new SM3Digest();
        digest.update(srcData, 0, srcData.length);
        byte[] hash = new byte[digest.getDigestSize()];
        digest.doFinal(hash, 0);
        return hash;
    }
    
    /**
     * 通過密鑰進行加密
     * @explain 指定密鑰進行加密
     * @param key
     *            密鑰
     * @param srcData
     *            被加密的byte數組
     * @return
     */
    public static byte[] hmac(byte[] key, byte[] srcData) {
        KeyParameter keyParameter = new KeyParameter(key);
        SM3Digest digest = new SM3Digest();
        HMac mac = new HMac(digest);
        mac.init(keyParameter);
        mac.update(srcData, 0, srcData.length);
        byte[] result = new byte[mac.getMacSize()];
        mac.doFinal(result, 0);
        return result;
    }
    
    /**
     * 判斷源數據與加密數據是否一致
     * @explain 通過驗證原數組和生成的hash數組是否為同一數組，驗證2者是否為同一數據
     * @param srcStr
     *            原字符串
     * @param sm3HexString
     *            16進制字符串
     * @return 校驗結果
     */
    public static boolean verify(String srcStr, String sm3HexString) {
        boolean flag = false;
        try {
            byte[] srcData = srcStr.getBytes(ENCODING);
            byte[] sm3Hash = ByteUtils.fromHexString(sm3HexString);
            byte[] newHash = hash(srcData);
            if (Arrays.equals(newHash, sm3Hash))
                flag = true;
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }
        return flag;
    }
    
    public static void main(String[] args) {
        // 測試二：account
        String account = "admin";
        String passoword = "P@ssw0rd";
        String hex = Sm3Utils.encrypt(account);
        System.out.println(hex);//dc1fd00e3eeeb940ff46f457bf97d66ba7fcc36e0b20802383de142860e76ae6
        System.out.println(Sm3Utils.encrypt(passoword));//c2de40449a2019db9936381fa9810c22c8548a8635ed2b7fb3c7ec362e37429d
        //驗證加密后的16進制字符串與加密前的字符串是否相同
        boolean flag =  Sm3Utils.verify(account, hex);
        System.out.println(flag);// true
    }
}

• StringUtils工具類

package pms.support;

/**
 * 字符串工具類
 * @author coisini
 * @date Nov 27, 2019
 */
public class StringUtils {

	/**
	 * 判空操作
	 * @param value
	 * @return
	 */
	public static boolean isBlank(String value) {
		return value == null || "".equals(value) || "null".equals(value) || "undefined".equals(value);
	}

}

• 在cxf-webService.xml添加攔截器配置

<!-- 在此處引用攔截器 -->
<bean id="InInterceptor"
	class="pms.interceptor.WebServiceInInterceptor" >
</bean>

<cxf:bus>
	<cxf:inInterceptors>
		<ref bean="InInterceptor" />
	</cxf:inInterceptors>
</cxf:bus> 

• SoapUI調用
• java調用

  服務端攔截器到此結束，由上圖可以看出攔截器配置生效

五、客戶端攔截器

• 在src.pms.support下新建AddHeaderInterceptor攔截器攔截請求，添加自定義認證頭部

package pms.support;

import java.util.List;
import javax.xml.namespace.QName;
import org.apache.cxf.binding.soap.SoapHeader;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.headers.Header;
import org.apache.cxf.helpers.DOMUtils;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

public class AddHeaderInterceptor extends AbstractPhaseInterceptor<SoapMessage>{ 
    
    private String userName; 
    private String password; 
       
    public AddHeaderInterceptor(String userName, String password) { 
        super(Phase.PREPARE_SEND); 
        this.userName = userName; 
        this.password = password;  
    } 
   
    @Override 
    public void handleMessage(SoapMessage msg) throws Fault { 
    	   System.out.println("攔截...");
        
           /**
            * 生成的XML文檔
            * <authHeader>
            *      <userName>admin</userName>
            *      <password>P@ssw0rd</password>
            * </authHeader>
            */ 
        
        	// SoapHeader部分待添加的節點
     		QName qName = new QName("security");
     		Document doc = DOMUtils.createDocument();

     		Element pwdEl = doc.createElement("password");
     		pwdEl.setTextContent(password);
     		Element userEl = doc.createElement("username");
     		userEl.setTextContent(userName);
     		Element root = doc.createElement("security");
     		root.appendChild(userEl);
     		root.appendChild(pwdEl);
     		// 創建SoapHeader內容
     		SoapHeader header = new SoapHeader(qName, root);
     		// 添加SoapHeader內容
     		List<Header> headers = msg.getHeaders();
     		headers.add(header); 
    } 
}

• java調用，修改webServiceClientMain調用代碼如下

public class webServiceClientMain {
	public static void main(String[] args) {
		JaxWsProxyFactoryBean svr = new JaxWsProxyFactoryBean();
		svr.setServiceClass(WebServiceInterface.class);
		svr.setAddress("http://localhost:8081/spring_webservice_server/webservice/webServiceInterface?wsdl");
		WebServiceInterface webServiceInterface = (WebServiceInterface) svr.create();
		
		// jaxws API 轉到 cxf API 添加日誌攔截器
		org.apache.cxf.endpoint.Client client = org.apache.cxf.frontend.ClientProxy
				.getClient(webServiceInterface);
		org.apache.cxf.endpoint.Endpoint cxfEndpoint = client.getEndpoint();
		//添加自定義的攔截器
		cxfEndpoint.getOutInterceptors().add(new AddHeaderInterceptor("dc1fd00e3eeeb940ff46f457bf97d66ba7fcc36e0b20802383de142860e76ae6", "c2de40449a2019db9936381fa9810c22c8548a8635ed2b7fb3c7ec362e37429d"));
		
		System.out.println(webServiceInterface.sayBye("honey,"));
	}
}

• SoapUI調用

六、代碼示例

服務端：https://github.com/Maggieq8324/spring_webservice_server.git
客戶端：https://github.com/Maggieq8324/spring_webservice_client.git

.end

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】

※台北網頁設計公司這麼多該如何選擇?

※智慧手機時代的來臨，RWD網頁設計為架站首選

※評比南投搬家公司費用收費行情懶人包大公開

※回頭車貨運收費標準

※網頁設計最專業,超強功能平台可客製化

※別再煩惱如何寫文案,掌握八大原則!