Python threading Local()函數(shù)用法案例詳解

更新時間：2021年09月06日 14:26:05 作者：碼農(nóng)飛哥

這篇文章主要介紹了Python threading Local()函數(shù)用法案例詳解,本篇文章通過簡要的案例,講解了該項技術的了解與使用,以下就是詳細內容,需要的朋友可以參考下

前言

當多線程訪問同一個公共資源時，如果涉及到修改該公共資源的操作就可能會出現(xiàn)由于數(shù)據(jù)不同步導致的線程安全問題。一般情況下我們可以通過給公共資源加互斥鎖的方式來處理該問題。

當然，除非必須將多線程使用的資源設置為公共資源的情況。如果一個資源不需要在多個線程之間共享。我們也可以使用Python threading模塊提供的local()方式來避免線程安全問題。
Python threading模塊的local()函數(shù)跟Java中的ThreadLocal類有諸多類似的地方，感興趣的小伙伴可以看下Java版的ThreadLoalJava ThreadLocal原理解析以及應用場景分析案例詳解

local() 函數(shù)是什么？

threading的local()函數(shù)主要是用來封裝公共資源，使得同一個公共資源在不同線程之間得以隔離。這句話該如何理解呢？舉個例子說明下！假設現(xiàn)在有一個大箱子（相當于公共資源），每個人（相當于各個線程）將自己的手機放入這個大箱子里。如果不做任何控制的話，當人們從大箱子中取出手機時極有可能會出現(xiàn)取錯的情況（找不到自己當初放入的手機）。而使用local()函數(shù)的話，就相當于對這個大箱子進行管理。當每個人放入手機的時候做一個標記（比如在手機上標記所有者的姓名）并隔離放置到箱子中。這樣當人們從大箱子中取出手機就能準確的找到自己當初放入的手機。

調用local()函數(shù)會生成一個ThreadLocal對象，該對象是所有線程都能訪問的，就像上面例子中的大箱子。但是，放入到ThreadLocal對象中的變量則是各個線程所獨有的，隨便變量名相同，但是指向的值則是完全不同的。

local()函數(shù)如何用？

local()函數(shù)使用的基本語法是：

import threading

local=threading.local()

第一步就是引入threading模塊，第二步就是調用local()函數(shù)得到全局的Threadlocal對象。這樣說始終是有點干澀，沒味道。那么就給代碼加點鹽吧。還是從那個大箱子說起。

1. 不做標記，不做隔離

第一個示例代碼就是所有人將自己的手機放入大箱子里，不做標記，不做隔離。先放入，過一段時間后再取出。

import threading
import time


def set_telephone(telephone):
    global global_telephone
    global_telephone = telephone
    print(threading.current_thread().name + " 放入的手機是", global_telephone)
    time.sleep(1)
    get_telephone()


def get_telephone():
    print(threading.current_thread().name + " 取出的手機是", global_telephone)


if __name__ == '__main__':
    for i in range(3):
        thread = threading.Thread(target=set_telephone, name='學生' + str(i), args=('手機' + str(i),))
        thread.start()

運行結果是：

學生0 放入的手機是手機0

學生1 放入的手機是手機1

學生2 放入的手機是手機2

學生0 取出的手機是手機2

學生1 取出的手機是手機2

學生2 取出的手機是手機2

這里有三個線程，分別模擬學生0，學生1，學生2 將各種的手機賦值給一個全局變量global_telephone（大箱子），然后取全局變量global_telephone中的值?？梢钥闯鋈〕龅慕Y果都變成了手機2。這顯然沒有達到我們的預期結果。這就是不加控制的后果。

2.使用local()函數(shù)加以控制

使用local()函數(shù)控制的話，就是將全局變量替換成ThreadLoal對象，由他來管理每個線程中的值。

import threading
import time


def set_telephone(telephone):
    local.telephone = telephone
    print(threading.current_thread().name + " 放入的手機是", local.telephone + "\n")
    time.sleep(1)
    get_telephone()


def get_telephone():
    print(threading.current_thread().name + " 取出的手機是", local.telephone + "\n")


if __name__ == '__main__':
    local = threading.local()
    for i in range(3):
        thread = threading.Thread(target=set_telephone, name='學生' + str(i), args=('手機' + str(i),))
        thread.start()

運行結果是：

學生0 放入的手機是手機0

學生1 放入的手機是手機1

學生2 放入的手機是手機2

學生1 取出的手機是手機1

學生0 取出的手機是手機0

學生2 取出的手機是手機2

可以看出每個學生放入的手機和最終取出的手機是一致的。那么threading的local()函數(shù)是如何實現(xiàn)這一效果的呢？我們在這里不妨做一個推理。應該是將手機和它的主人做了一層映射關系。根據(jù)主人的唯一標識來尋找自己的手機。

3. 模擬實現(xiàn)local()的功能，創(chuàng)建一個箱子

前面我們推測我們需要定義一個全局的字典來存放每個學生各自放入的手機，字典的鍵是線程ID，值是指定的鍵值對。示例代碼如下：

import threading
import time

global_goods_dict = {}

# {
#     "線程ID":{"telephone":"放入的具體手機"},
#     "線程ID":{"telephone":"放入的具體手機"},
#     "線程ID":{"telephone":"放入的具體手機"}
#
# }

def set_telephone(telephone):
    # 獲取線程ID
    thread_id = threading.get_ident()
    global_goods_dict[thread_id] = {}
    global_goods_dict[thread_id]["telephone"] = telephone
    print(threading.current_thread().name + " 放入的手機是", telephone)
    time.sleep(1)
    get_telephone()


def get_telephone():
    thread_id = threading.get_ident()
    print(threading.current_thread().name + " 取出的手機是", global_goods_dict[thread_id]["telephone"])


if __name__ == '__main__':
    for i in range(3):
        thread = threading.Thread(target=set_telephone, name='學生' + str(i), args=('手機' + str(i),))
        thread.start()

運行結果同上，這里定義了一個全局的字典global_goods_dict，字典的鍵盤是線程ID，這就保證了每個線程只能取到自己設置的數(shù)據(jù)。字典的值同樣是一個字典。這是因為一個線程的要存的值可能不止一個。這里的global_goods_dict[thread_id]["telephone"] = telephone 就等價于上例中的local.telephone = telephone。這樣使用雖然能達到效果，但是使用起來還是有點繁瑣。那么能不能想local()函數(shù)那樣使用起來絲滑呢。

4. 簡化代碼操作，進一步模擬實現(xiàn)local()函數(shù)

我們可以將全局的global_goods_dict字典用一個類封裝到一個類中。讓該類在自動的設置值

class MyBox:
    box = {}

    def __setattr__(self, key, value):
        thread_id = threading.get_ident()
        # 單元格已存在
        if thread_id in MyBox.box:
            MyBox.box[thread_id][key] = value
        else:
            MyBox.box[thread_id] = {key: value}

    def __getattr__(self, item):
        thread_id = threading.get_ident()
        return MyBox.box[thread_id][item]


def set_telephone(telephone):
    myBox.telephone = telephone
    print(threading.current_thread().name + " 放入的手機是", myBox.telephone + "\n")
    time.sleep(1)
    get_telephone()


def get_telephone():
    print(threading.current_thread().name + " 取出的手機是", myBox.telephone + "\n")


if __name__ == '__main__':
    myBox = MyBox()
    for i in range(3):
        thread = threading.Thread(target=set_telephone, name='學生' + str(i), args=('手機' + str(i),))
        thread.start()

運行結果同上。這里通過MyBox類封裝了一個名為box的字典。該字典的鍵是當前線程ID，值是賦值的變量名以及值組成的鍵值對。當執(zhí)行set_telephone方法的myBox.telephone = telephone
，實際上會調用MyBox的__setattr__方法，參數(shù)key是telephone，參數(shù)value是"手機xx"。當調用myBox.telephone時實際上會調用__getattr__方法，傳入的參數(shù)item是telephone。取值時首先獲取當前線程ID。

在這里插入圖片描述