ThreadLocal，直譯為“線程本地”或“本地線程”，如果你真的這么認為，那就錯了！其實，它就是一個容器，用于存放線程的局部變量，我認為應該叫做 ThreadLocalVariable（線程局部變量）才對，真不理解為什么當初 Sun 公司的工程師這樣命名。
早在 JDK 1.2 的時代，java.lang.ThreadLocal 就誕生了，它是為了解決多線程并發問題而設計的，只不過設計得有些難用，所以至今沒有得到廣泛使用。其實它還是挺有用的，不相信的話，我們一起來看看這個例子吧。
一個序列號生成器的程序，可能同時會有多個線程并發訪問它，要保證每個線程得到的序列號都是自增的，而不能相互干擾。
先定義一個接口：
|
1
2
3
4
|
public interface Sequence { int getNumber();} |
每次調用 getNumber() 方法可獲取一個序列號，下次再調用時，序列號會自增。
再做一個線程類：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
public class ClientThread extends Thread { private Sequence sequence; public ClientThread(Sequence sequence) { this.sequence = sequence; } @Override public void run() { for (int i = 0; i < 3; i++) { System.out.println(Thread.currentThread().getName() + " => " + sequence.getNumber()); } }} |
在線程中連續輸出三次線程名與其對應的序列號。
我們先不用 ThreadLocal，來做一個實現類吧。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
public class SequenceA implements Sequence { private static int number = 0; public int getNumber() { number = number + 1; return number; } public static void main(String[] args) { Sequence sequence = new SequenceA(); ClientThread thread1 = new ClientThread(sequence); ClientThread thread2 = new ClientThread(sequence); ClientThread thread3 = new ClientThread(sequence); thread1.start(); thread2.start(); thread3.start(); }} |
序列號初始值是0，在 main() 方法中模擬了三個線程，運行后結果如下：
|
1
2
3
4
5
6
7
8
9
|
Thread-0 => 1Thread-0 => 2Thread-0 => 3Thread-2 => 4Thread-2 => 5Thread-2 => 6Thread-1 => 7Thread-1 => 8Thread-1 => 9 |
由于線程啟動順序是隨機的，所以并不是0、1、2這樣的順序，這個好理解。為什么當 Thread-0 輸出了1、2、3之后，而 Thread-2 卻輸出了4、5、6呢？線程之間竟然共享了 static 變量！這就是所謂的“非線程安全”問題了。
那么如何來保證“線程安全”呢？對應于這個案例，就是說不同的線程可擁有自己的 static 變量，如何實現呢？下面看看另外一個實現吧。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
public class SequenceB implements Sequence { private static ThreadLocal<Integer> numberContainer = new ThreadLocal<Integer>() { @Override protected Integer initialValue() { return 0; } }; public int getNumber() { numberContainer.set(numberContainer.get() + 1); return numberContainer.get(); } public static void main(String[] args) { Sequence sequence = new SequenceB(); ClientThread thread1 = new ClientThread(sequence); ClientThread thread2 = new ClientThread(sequence); ClientThread thread3 = new ClientThread(sequence); thread1.start(); thread2.start(); thread3.start(); }} |
通過 ThreadLocal 封裝了一個 Integer 類型的 numberContainer 靜態成員變量，并且初始值是0。再看 getNumber() 方法，首先從 numberContainer 中 get 出當前的值，加1，隨后 set 到 numberContainer 中，最后將 numberContainer 中 get 出當前的值并返回。
是不是很惡心？但是很強大！確實稍微饒了一下，我們不妨把 ThreadLocal 看成是一個容器，這樣理解就簡單了。所以，這里故意用 Container 這個單詞作為后綴來命名 ThreadLocal 變量。
運行結果如何呢？看看吧。
|
1
2
3
4
5
6
7
8
9
|
Thread-0 => 1Thread-0 => 2Thread-0 => 3Thread-2 => 1Thread-2 => 2Thread-2 => 3Thread-1 => 1Thread-1 => 2Thread-1 => 3 |
每個線程相互獨立了，同樣是 static 變量，對于不同的線程而言，它沒有被共享，而是每個線程各一份，這樣也就保證了線程安全。 也就是說，TheadLocal 為每一個線程提供了一個獨立的副本！
搞清楚 ThreadLocal 的原理之后，有必要總結一下 ThreadLocal 的 API，其實很簡單。
- public void set(T value)：將值放入線程局部變量中
- public T get()：從線程局部變量中獲取值
- public void remove()：從線程局部變量中移除值（有助于 JVM 垃圾回收）
- protected T initialValue()：返回線程局部變量中的初始值（默認為 null）
為什么 initialValue() 方法是 protected 的呢？就是為了提醒程序員們，這個方法是要你們來實現的，請給這個線程局部變量一個初始值吧。
了解了原理與這些 API，其實想想 ThreadLocal 里面不就是封裝了一個 Map 嗎？自己都可以寫一個 ThreadLocal 了，嘗試一下吧。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
public class MyThreadLocal<T> { private Map<Thread, T> container = Collections.synchronizedMap(new HashMap<Thread, T>()); public void set(T value) { container.put(Thread.currentThread(), value); } public T get() { Thread thread = Thread.currentThread(); T value = container.get(thread); if (value == null && !container.containsKey(thread)) { value = initialValue(); container.put(thread, value); } return value; } public void remove() { container.remove(Thread.currentThread()); } protected T initialValue() { return null; }} |
以上完全山寨了一個 ThreadLocal，其中中定義了一個同步 Map（為什么要這樣？請讀者自行思考），代碼應該非常容易讀懂。
下面用這 MyThreadLocal 再來實現一把看看。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
public class SequenceC implements Sequence { private static MyThreadLocal<Integer> numberContainer = new MyThreadLocal<Integer>() { @Override protected Integer initialValue() { return 0; } }; public int getNumber() { numberContainer.set(numberContainer.get() + 1); return numberContainer.get(); } public static void main(String[] args) { Sequence sequence = new SequenceC(); ClientThread thread1 = new ClientThread(sequence); ClientThread thread2 = new ClientThread(sequence); ClientThread thread3 = new ClientThread(sequence); thread1.start(); thread2.start(); thread3.start(); }} |
以上代碼其實就是將 ThreadLocal 替換成了 MyThreadLocal，僅此而已，運行效果和之前的一樣，也是正確的。
其實 ThreadLocal 可以單獨成為一種設計模式，就看你怎么看了。
ThreadLocal 具體有哪些使用案例呢？
我想首先要說的就是：通過 ThreadLocal 存放 JDBC Connection，以達到事務控制的能力。
還是保持我一貫的 Style，用一個 Demo 來說話吧。用戶提出一個需求：當修改產品價格的時候，需要記錄操作日志，什么時候做了什么事情。
想必這個案例，只要是做過應用系統的小伙伴們，都應該遇到過吧？無外乎數據庫里就兩張表：product 與 log，用兩條 SQL 語句應該可以解決問題：
|
1
2
|
update product set price = ? where id = ?insert into log (created, description) values (?, ?) |
But！要確保這兩條 SQL 語句必須在同一個事務里進行提交，否則有可能 update 提交了，但 insert 卻沒有提交。如果這樣的事情真的發生了，我們肯定會被用戶指著鼻子狂罵：“為什么產品價格改了，卻看不到什么時候改的呢？”。
聰明的我在接到這個需求以后，是這樣做的：
首先，我寫一個 DBUtil 的工具類，封裝了數據庫的常用操作：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
public class DBUtil { // 數據庫配置 private static final String driver = "com.mysql.jdbc.Driver"; private static final String url = "jdbc:mysql://localhost:3306/demo"; private static final String username = "root"; private static final String password = "root"; // 定義一個數據庫連接 private static Connection conn = null; // 獲取連接 public static Connection getConnection() { try { Class.forName(driver); conn = DriverManager.getConnection(url, username, password); } catch (Exception e) { e.printStackTrace(); } return conn; } // 關閉連接 public static void closeConnection() { try { if (conn != null) { conn.close(); } } catch (Exception e) { e.printStackTrace(); } }} |
里面搞了一個 static 的 Connection，這下子數據庫連接就好操作了，牛逼吧！
然后，我定義了一個接口，用于給邏輯層來調用：
|
1
2
3
4
|
public interface ProductService { void updateProductPrice(long productId, int price);} |
根據用戶提出的需求，我想這個接口完全夠用了。根據 productId 去更新對應 Product 的 price，然后再插入一條數據到 log 表中。
其實業務邏輯也不太復雜，于是我快速地完成了 ProductService 接口的實現類：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
public class ProductServiceImpl implements ProductService { private static final String UPDATE_PRODUCT_SQL = "update product set price = ? where id = ?"; private static final String INSERT_LOG_SQL = "insert into log (created, description) values (?, ?)"; public void updateProductPrice(long productId, int price) { try { // 獲取連接 Connection conn = DBUtil.getConnection(); conn.setAutoCommit(false); // 關閉自動提交事務（開啟事務） // 執行操作 updateProduct(conn, UPDATE_PRODUCT_SQL, productId, price); // 更新產品 insertLog(conn, INSERT_LOG_SQL, "Create product."); // 插入日志 // 提交事務 conn.commit(); } catch (Exception e) { e.printStackTrace(); } finally { // 關閉連接 DBUtil.closeConnection(); } } private void updateProduct(Connection conn, String updateProductSQL, long productId, int productPrice) throws Exception { PreparedStatement pstmt = conn.prepareStatement(updateProductSQL); pstmt.setInt(1, productPrice); pstmt.setLong(2, productId); int rows = pstmt.executeUpdate(); if (rows != 0) { System.out.println("Update product success!"); } } private void insertLog(Connection conn, String insertLogSQL, String logDescription) throws Exception { PreparedStatement pstmt = conn.prepareStatement(insertLogSQL); pstmt.setString(1, new SimpleDateFormat("yyyy-MM-dd HH:mm:ss SSS").format(new Date())); pstmt.setString(2, logDescription); int rows = pstmt.executeUpdate(); if (rows != 0) { System.out.println("Insert log success!"); } }} |
代碼的可讀性還算不錯吧？這里我用到了 JDBC 的高級特性 Transaction 了。暗自慶幸了一番之后，我想是不是有必要寫一個客戶端，來測試一下執行結果是不是我想要的呢？ 于是我偷懶，直接在 ProductServiceImpl 中增加了一個 main() 方法：
|
1
2
3
4
|
public static void main(String[] args) { ProductService productService = new ProductServiceImpl(); productService.updateProductPrice(1, 3000);} |
我想讓 productId 為 1 的產品的價格修改為 3000。于是我把程序跑了一遍，控制臺輸出：
|
1
2
|
Update product success!Insert log success! |
應該是對了。作為一名專業的程序員，為了萬無一失，我一定要到數據庫里在看看。沒錯！product 表對應的記錄更新了，log 表也插入了一條記錄。這樣就可以將 ProductService 接口交付給別人來調用了。
幾個小時過去了，QA 妹妹開始罵我：“我靠！我才模擬了 10 個請求，你這個接口怎么就掛了？說是數據庫連接關閉了！”。
聽到這樣的叫聲，讓我渾身打顫，立馬中斷了我的小視頻，趕緊打開 IDE，找到了這個 ProductServiceImpl 這個實現類。好像沒有 Bug 吧？但我現在不敢給她任何回應，我確實有點怕她的。
我突然想起，她是用工具模擬的，也就是模擬多個線程了！那我自己也可以模擬啊，于是我寫了一個線程類：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
public class ClientThread extends Thread { private ProductService productService; public ClientThread(ProductService productService) { this.productService = productService; } @Override public void run() { System.out.println(Thread.currentThread().getName()); productService.updateProductPrice(1, 3000); }} |
我用這線程去調用 ProduceService 的方法，看看是不是有問題。此時，我還要再修改一下 main() 方法：
|
1
2
3
4
5
6
7
8
9
10
11
12
|
// public static void main(String[] args) {// ProductService productService = new ProductServiceImpl();// productService.updateProductPrice(1, 3000);// } public static void main(String[] args) { for (int i = 0; i < 10; i++) { ProductService productService = new ProductServiceImpl(); ClientThread thread = new ClientThread(productService); thread.start(); }} |
我也模擬 10 個線程吧，我就不信那個邪了！
運行結果真的讓我很暈、很暈：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
Thread-1Thread-3Thread-5Thread-7Thread-9Thread-0Thread-2Thread-4Thread-6Thread-8Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException: No operations allowed after connection closed.at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:39)at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:27)at java.lang.reflect.Constructor.newInstance(Constructor.java:513)at com.mysql.jdbc.Util.handleNewInstance(Util.java:411)at com.mysql.jdbc.Util.getInstance(Util.java:386)at com.mysql.jdbc.SQLError.createSQLException(SQLError.java:1015)at com.mysql.jdbc.SQLError.createSQLException(SQLError.java:989)at com.mysql.jdbc.SQLError.createSQLException(SQLError.java:975)at com.mysql.jdbc.SQLError.createSQLException(SQLError.java:920)at com.mysql.jdbc.ConnectionImpl.throwConnectionClosedException(ConnectionImpl.java:1304)at com.mysql.jdbc.ConnectionImpl.checkClosed(ConnectionImpl.java:1296)at com.mysql.jdbc.ConnectionImpl.commit(ConnectionImpl.java:1699)at com.smart.sample.test.transaction.solution1.ProductServiceImpl.updateProductPrice(ProductServiceImpl.java:25)at com.smart.sample.test.transaction.ClientThread.run(ClientThread.java:18) |
我靠！竟然在多線程的環境下報錯了，果然是數據庫連接關閉了。怎么回事呢？我陷入了沉思中。于是我 Copy 了一把那句報錯信息，在百度、Google，還有 OSC 里都找了，解答實在是千奇百怪。
我突然想起，既然是跟 Connection 有關系，那我就將主要精力放在檢查 Connection 相關的代碼上吧。是不是 Connection 不應該是 static 的呢？我當初設計成 static 的主要是為了讓 DBUtil 的 static 方法訪問起來更加方便，用 static 變量來存放 Connection 也提高了性能啊。怎么搞呢？
于是我看到了 OSC 上非?；鸨囊黄恼隆禩hreadLocal 那點事兒》，終于才讓我明白了！原來要使每個線程都擁有自己的連接，而不是共享同一個連接，否則線程1有可能會關閉線程2的連接，所以線程2就報錯了。一定是這樣！
我趕緊將 DBUtil 給重構了：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
public class DBUtil { // 數據庫配置 private static final String driver = "com.mysql.jdbc.Driver"; private static final String url = "jdbc:mysql://localhost:3306/demo"; private static final String username = "root"; private static final String password = "root"; // 定義一個用于放置數據庫連接的局部線程變量（使每個線程都擁有自己的連接） private static ThreadLocal<Connection> connContainer = new ThreadLocal<Connection>(); // 獲取連接 public static Connection getConnection() { Connection conn = connContainer.get(); try { if (conn == null) { Class.forName(driver); conn = DriverManager.getConnection(url, username, password); } } catch (Exception e) { e.printStackTrace(); } finally { connContainer.set(conn); } return conn; } // 關閉連接 public static void closeConnection() { Connection conn = connContainer.get(); try { if (conn != null) { conn.close(); } } catch (Exception e) { e.printStackTrace(); } finally { connContainer.remove(); } }} |
我把 Connection 放到了 ThreadLocal 中，這樣每個線程之間就隔離了，不會相互干擾了。
此外，在 getConnection() 方法中，首先從 ThreadLocal 中（也就是 connContainer 中） 獲取 Connection，如果沒有，就通過 JDBC 來創建連接，最后再把創建好的連接放入這個 ThreadLocal 中?？梢园?ThreadLocal 看做是一個容器，一點不假。
同樣，我也對 closeConnection() 方法做了重構，先從容器中獲取 Connection，拿到了就 close 掉，最后從容器中將其 remove 掉，以保持容器的清潔。
這下應該行了吧？我再次運行 main() 方法：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
Thread-0Thread-2Thread-4Thread-6Thread-8Thread-1Thread-3Thread-5Thread-7Thread-9Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success!Update product success!Insert log success! |
總算是解決了
