Python線程池及其原理和使用（超級詳細）

系統啟動一個新線程的成本是比較高的，因為它涉及與操作系統的交互。在這種情形下，使用線程池可以很好地提升性能，尤其是當程序中需要創建大量生存期很短暫的線程時，更應該考慮使用線程池。

線程池在系統啟動時即創建大量空閑的線程，程序只要將一個函數提交給線程池，線程池就會啟動一個空閑的線程來執行它。當該函數執行結束后，該線程並不會死亡，而是再次返回到線程池中變成空閑狀態，等待執行下一個函數。

此外，使用線程池可以有效地控制系統中並發線程的數量。當系統中包含有大量的並發線程時，會導致系統性能急劇下降，甚至導致 Python 解釋器崩潰，而線程池的最大線程數參數可以控制系統中並發線程的數量不超過此數。

線程池的使用

線程池的基類是 concurrent.futures 模塊中的 Executor，Executor 提供了兩個子類，即 ThreadPoolExecutor 和 ProcessPoolExecutor，其中 ThreadPoolExecutor 用於創建線程池，而 ProcessPoolExecutor 用於創建進程池。

如果使用線程池/進程池來管理並發編程，那么只要將相應的 task 函數提交給線程池/進程池，剩下的事情就由線程池/進程池來搞定。

Exectuor 提供了如下常用方法：

• submit(fn, *args, **kwargs)：將 fn 函數提交給線程池。*args 代表傳給 fn 函數的參數，*kwargs 代表以關鍵字參數的形式為 fn 函數傳入參數。
• map(func, *iterables, timeout=None, chunksize=1)：該函數類似於全局函數 map(func, *iterables)，只是該函數將會啟動多個線程，以異步方式立即對 iterables 執行 map 處理。
• shutdown(wait=True)：關閉線程池。

程序將 task 函數提交（submit）給線程池后，submit 方法會返回一個 Future 對象，Future 類主要用於獲取線程任務函數的返回值。由於線程任務會在新線程中以異步方式執行，因此，線程執行的函數相當於一個“將來完成”的任務，所以 Python 使用 Future 來代表。

Future 提供了如下方法：

• cancel()：取消該 Future 代表的線程任務。如果該任務正在執行，不可取消，則該方法返回 False；否則，程序會取消該任務，並返回 True。
• cancelled()：返回 Future 代表的線程任務是否被成功取消。
• running()：如果該 Future 代表的線程任務正在執行、不可被取消，該方法返回 True。
• done()：如果該 Funture 代表的線程任務被成功取消或執行完成，則該方法返回 True。
• result(timeout=None)：獲取該 Future 代表的線程任務最后返回的結果。如果 Future 代表的線程任務還未完成，該方法將會阻塞當前線程，其中 timeout 參數指定最多阻塞多少秒。
• exception(timeout=None)：獲取該 Future 代表的線程任務所引發的異常。如果該任務成功完成，沒有異常，則該方法返回 None。
• add_done_callback(fn)：為該 Future 代表的線程任務注冊一個“回調函數”，當該任務成功完成時，程序會自動觸發該 fn 函數。

在用完一個線程池后，應該調用該線程池的 shutdown() 方法，該方法將啟動線程池的關閉序列。調用 shutdown() 方法后的線程池不再接收新任務，但會將以前所有的已提交任務執行完成。當線程池中的所有任務都執行完成后，該線程池中的所有線程都會死亡。

使用線程池來執行線程任務的步驟如下：

1. 調用 ThreadPoolExecutor 類的構造器創建一個線程池。
2. 定義一個普通函數作為線程任務。
3. 調用 ThreadPoolExecutor 對象的 submit() 方法來提交線程任務。
4. 當不想提交任何任務時，調用 ThreadPoolExecutor 對象的 shutdown() 方法來關閉線程池。

下面程序示范了如何使用線程池來執行線程任務：

def test(value1, value2=None):
    print("%s threading is printed %s, %s"%(threading.current_thread().name, value1, value2))
    time.sleep(2)
    return 'finished'

def test_result(future):
    print(future.result())

if __name__ == "__main__":
    import numpy as np
    from concurrent.futures import ThreadPoolExecutor
    threadPool = ThreadPoolExecutor(max_workers=4, thread_name_prefix="test_")
    for i in range(0,10):
        future = threadPool.submit(test, i,i+1)
        
    threadPool.shutdown(wait=True)

結果：

test__0 threading is printed 0, 1
test__1 threading is printed 1, 2
test__2 threading is printed 2, 3
test__3 threading is printed 3, 4
test__1 threading is printed 4, 5
test__0 threading is printed 5, 6
test__3 threading is printed 6, 7

 

獲取執行結果

前面程序調用了 Future 的 result() 方法來獲取線程任務的運回值，但該方法會阻塞當前主線程，只有等到錢程任務完成后，result() 方法的阻塞才會被解除。

如果程序不希望直接調用 result() 方法阻塞線程，則可通過 Future 的 add_done_callback() 方法來添加回調函數，該回調函數形如 fn(future)。當線程任務完成后，程序會自動觸發該回調函數，並將對應的 Future 對象作為參數傳給該回調函數。
直接調用result函數結果

def test(value1, value2=None):
    print("%s threading is printed %s, %s"%(threading.current_thread().name, value1, value2))
    time.sleep(2)
    return 'finished'

def test_result(future):
    print(future.result())

if __name__ == "__main__":
    import numpy as np
    from concurrent.futures import ThreadPoolExecutor
    threadPool = ThreadPoolExecutor(max_workers=4, thread_name_prefix="test_")
    for i in range(0,10):
        future = threadPool.submit(test, i,i+1)
#         future.add_done_callback(test_result)
        print(future.result())
        
    threadPool.shutdown(wait=True)
    print('main finished')

結果：

test__0 threading is printed 0, 1
finished
test__0 threading is printed 1, 2
finished
test__1 threading is printed 2, 3
finished

去掉上面注釋部分，調用future.add_done_callback函數，注釋掉第16行

test__0 threading is printed 0, 1
test__1 threading is printed 1, 2
test__2 threading is printed 2, 3
test__3 threading is printed 3, 4
finished
finished
finished
test__1 threading is printed 4, 5
test__0 threading is printed 5, 6
finished

 

另外，由於線程池實現了上下文管理協議（Context Manage Protocol），因此，程序可以使用 with 語句來管理線程池，這樣即可避免手動關閉線程池，如上面的程序所示。

此外，Exectuor 還提供了一個 map(func, *iterables, timeout=None, chunksize=1) 方法，該方法的功能類似於全局函數 map()，區別在於線程池的 map() 方法會為 iterables 的每個元素啟動一個線程，以並發方式來執行 func 函數。這種方式相當於啟動 len(iterables) 個線程，井收集每個線程的執行結果。

例如，如下程序使用 Executor 的 map() 方法來啟動線程，並收集線程任務的返回值：

示例換成多參數的：

def test(value1, value2=None):
    print("%s threading is printed %s, %s"%(threading.current_thread().name, value1, value2))
#     time.sleep(2)


if __name__ == "__main__":
    import numpy as np
    from concurrent.futures import ThreadPoolExecutor
    threadPool = ThreadPoolExecutor(max_workers=4, thread_name_prefix="test_")
    for i in range(0,10):
#         test(str(i), str(i+1))
        threadPool.map(test, [i],[i+1]) # 這是運行一次test的參數，眾所周知map可以讓test執行多次，即一個[]代表一個參數，一個參數賦予不同的值即增加[]的長度如從[1]到[1,2,3]
    threadPool.shutdown(wait=True)

 

上面程序使用 map() 方法來啟動 4個線程（該程序的線程池包含 4 個線程，如果繼續使用只包含兩個線程的線程池，此時將有一個任務處於等待狀態，必須等其中一個任務完成，線程空閑出來才會獲得執行的機會），map() 方法的返回值將會收集每個線程任務的返回結果。
通過上面程序可以看出，使用 map() 方法來啟動線程，並收集線程的執行結果，不僅具有代碼簡單的優點，而且雖然程序會以並發方式來執行 test() 函數，但最后收集的 test() 函數的執行結果，依然與傳入參數的結果保持一致。

 

編寫這個文檔主要是因為示例文檔[1]沒有多參數的。網上很多資料都是基於threadpool方法傳參見[2]

Reference:

[1] http://c.biancheng.net/view/2627.html

[2] https://www.cnblogs.com/gongxijun/p/6862333.html