Threadlocal Principle Detailed

What is threadlocal?

As early as the version of JDK 1.2, Java.lang.threadlocal,threadlocal provides a new way to solve the concurrency problem of multi-threaded threads. Using this tool class, you can write beautiful multithreaded programs very concisely.

When you use threadlocal to maintain variables, Threadlocal provides a separate copy of the variable for each thread that uses the variable, so each thread can independently change its own copy without affecting the copy of the other thread.

From the thread's point of view, the target variable is like a thread's local variable, which is the meaning of the "local" in the class name.

Therefore, the code to write thread-local variables in Java is relatively clumsy, resulting in thread-local variables not being well-popularized in Java developers.

interface method for Threadlocal

Threadlocal class interface is very simple, there are only 4 methods, let us first look at:

• void set (Object value) sets the value of the thread local variable for the current thread.

• Public Object Get () This method returns the thread local variable that corresponds to the current thread.

• The public void Remove () Removes the value of the current thread local variable to reduce memory usage, which is a new method of JDK 5.0. It is important to note that when the thread ends, the local variables of the thread that should be used are automatically garbage collected, so it is not necessary to explicitly call the method to clear the thread's local variables, but it can speed up the memory reclamation.

• Protected Object InitialValue () returns the initial value of the thread's local variable, which is a protected method, apparently designed to allow subclasses to overwrite. This method is a deferred call method that executes only when the thread calls get () or set (Object) for the 1th time, and executes only 1 times. The default implementation in Threadlocal returns a null directly.

It is worth mentioning that, in JDK5.0, Threadlocal already supports generics, and the class name of the class has become threadlocal<t>. The API methods are also adjusted accordingly, and the new version of the API method is void set (t value), t get (), and T InitialValue ().

How does threadlocal maintain a copy of a variable for each thread? The idea is simple: there is a map in the Threadlocal class that stores a copy of the variable for each thread, the key for the element in the map is the thread object, and the value corresponds to the variable copy of the thread. We can provide a simple implementation version by ourselves:

    Package com.test; public class Testnum {//① the InitialValue () method that overrides ThreadLocal by an anonymous inner class, specifying the initial value private static Threadlocal<int eger> seqNum = new threadlocal<integer> () {public Integer InitialValue () {return              0;                }          };              ② gets the next sequence value public int getnextnum () {Seqnum.set (Seqnum.get () + 1);          return Seqnum.get ();              } public static void Main (string[] args) {testnum sn = new Testnum ();              ③ 3 threads share sn, each generating serial number testclient T1 = new TestClient (SN);              TestClient t2 = new TestClient (SN);              testclient t3 = new TestClient (SN);              T1.start ();              T2.start ();          T3.start ();                    } private static Class TestClient extends Thread {private Testnum sn; Public testclient (Testnum sn) {this.sn = sn; public void Run () {for (int i = 0; i < 3; i++) {//④ per thread                               3 Sequence Values System.out.println ("thread[" + thread.currentthread (). GetName () + "]--sn["                  + sn.getnextnum () + "]");   }              }          }      }

In general, we define the subclass of threadlocal by means of an anonymous inner class, providing the initial variable value, as shown in the example ①. TestClient threads produce a set of serial numbers, and at ③ we generate 3 testclient that share the same testnum instance. Run the above code and output the following results on the console:

THREAD[THREAD-0]--sn[1]thread[thread-1]--sn[1]thread[thread-2]--sn[1]thread[thread-1]--sn[2] THREAD[THREAD-0]--sn[2]thread[thread-1]--sn[3]thread[thread-2]--sn[2]thread[thread-0]--sn[3] Thread[thread-2]-sn[3]

Examining the results of the output, we find that each thread produces an ordinal number that shares the same Testnum instance, but they do not interfere with each other, but instead produce separate serial numbers, because we provide a separate copy of each thread through threadlocal.

Comparison of thread synchronization mechanisms

What are the advantages of threadlocal compared to the thread synchronization mechanism? Both the threadlocal and thread synchronization mechanisms are designed to address the access violation of the same variable in multiple threads.

In the synchronization mechanism, the lock mechanism of the object guarantees that only one thread accesses the variable at the same time. At this time the variable is shared by multiple threads, using the synchronization mechanism requires the program to carefully analyze when to read and write variables, when to lock an object, when to release object locks and other complex problems, programming and writing is relatively difficult.

Threadlocal, however, solves multiple threads of concurrent access from another angle. Threadlocal provides a separate copy of the variable for each thread, isolating the access violation of multiple threads to the data. Because each thread has its own copy of the variable, there is no need to synchronize the variable. Threadlocal provides thread-safe shared objects that can encapsulate unsafe variables into threadlocal when writing multithreaded code.

Because the threadlocal can hold any type of object, the Get () provided by the lower version of the JDK returns an object, which requires a type cast. But JDK 5.0 solves this problem with generics, and simplifies the use of threadlocal to some extent, and listing 9 2 uses the new threadlocal<t> version of JDK 5.0.

To sum up, for the problem of multi-thread resource sharing, the synchronization mechanism adopts the way of "time-changing Space", and threadlocal adopts the way of "changing time by Space". The former provides only one copy of the variable, allowing different threads to queue access, and the latter provides a variable for each thread, so it can be accessed at the same time without affecting each other.

Spring uses threadlocal to solve thread-safety problems we know that in general, only stateless beans can be shared in a multithreaded environment, and in spring, most beans can be declared as singleton scopes. is because spring is for some beans (such as Requestcontextholder, Transactionsynchronizationmanager, Localecontextholder, etc.) the non-thread-safe state is handled by threadlocal, making them also a thread-safe state, because stateful beans can be shared across multiple threads.

The general Web application divides into the presentation layer, the service layer and the persistence layer three levels, writes the corresponding logic in the different layers, the lower layer through the interface to the upper layer open function calls. In general, all program calls from receiving requests to returning responses belong to one thread, as shown in 9?2:

The same thread runs through three layers so that you can store some non-thread-safe variables in threadlocal as needed, and in the same invocation thread of the same request response, all the associated objects are referenced to the same variable.

The following example can reflect spring's transformation of the stateful bean:

Code Listing 3 Testdao: non-thread safe

    Package com.test;            Import java.sql.Connection;      Import java.sql.SQLException;      Import java.sql.Statement;            public class Testdao {          private Connection Conn;//① a non-thread-safe variable public                void Addtopic () throws SQLException {              St Atement stat = conn.createstatement ();//② reference non-thread safe variable              //...          }      }  

Because the conn at ① is a member variable, because the Addtopic () method is non-thread-safe, a new Topicdao instance (not singleton) must be created when it is used. The following uses Threadlocal to transform Conn, a non-thread-safe "state":

Code Listing 4 Testdao: Thread safety

 package com.test;      Import java.sql.Connection;      Import java.sql.SQLException;            Import java.sql.Statement; public class Testdaonew {//① uses ThreadLocal to save the Connection variable private static threadlocal<connection> C                onnthreadlocal = new threadlocal<connection> ();              public static Connection getconnection () {//② If connthreadlocal does not have the corresponding Connection of this thread to create a new Connection,              and save it in a thread-local variable.                  if (connthreadlocal.get () = = null) {Connection conn = getconnection ();                  Connthreadlocal.set (conn);              Return conn;  } else {return connthreadlocal.get ();//③ directly returns thread local variable}} public void Addtopic () throws SQLException {//④ get thread corresponding threadlocal connection stat = Statement from GetConnect          Ion (). Createstatement (); }      }  

When using Topicdao, different threads first determine if Connthreadlocal.get () is null, or NULL, indicating that the current thread does not have a corresponding connection object. At this point, a connection object is created and added to the local thread variable, and if it is not NULL, the current thread already has the connection object, which can be used directly. This ensures that different threads use thread-related connection and do not use the connection of other threads. Therefore, this topicdao can be done singleton share.

Of course, this example itself is very rough, put connection threadlocal directly in DAO can only do this DAO's multiple methods share connection without thread safety problem, but can not be shared with other DAO the same connection, To do the same transaction multiple DAO shares the same connection, you must use Threadlocal to save the connection in a common external class.

    Package com.test;      Import java.sql.Connection;      Import Java.sql.DriverManager;            Import java.sql.SQLException; public class ConnectionManager {private static threadlocal<connection> Connectionholder = new Thread Local<connection> () {@Override protected Connection InitialValue () {Con                  Nection conn = null; try {conn = drivermanager.getconnection ("jdbc:mysql://localhost:3306/t                  EST "," username "," password ");                  } catch (SQLException e) {e.printstacktrace ();              } return conn;                }          };          public static Connection getconnection () {return connectionholder.get ();          } public static void SetConnection (Connection conn) {Connectionholder.set (conn); }      }   

The concrete realization of java.lang.threadlocal<t>

So how does the Threadlocal class implement this "provide a different copy of the variable for each thread"? Let's take a look at how the source code of the Threadlocal set () method is implemented:

    /**         * Sets the current thread's copy of this thread-local variable * to the         specified value.  Most subclasses'll has a no need         to * override this method, and relying solely on the {@link #initialValue}         * method To set the values of Thread-locals.         *         * @param value The value of the stored in the current thread's copy of * this        thread-local.         *         /public void Set (T value) {             Thread T = Thread.CurrentThread ();             Threadlocalmap map = getmap (t);             if (map! = null)                 Map.set (this, value);             else                 createmap (t, value);         }  

Inside this method we see that we first get a threadlocalmap related to the current thread through the Getmap (thread T) method, and then set the value of the variable to the Threadlocalmap object, Of course, if the obtained Threadlocalmap object is empty, it is created by the Createmap method.


The secret of thread isolation lies in the Threadlocalmap class. Threadlocalmap is a static inner class of the Threadlocal class that implements the setting and acquisition of key-value pairs (as compared to the map object), each of which has a separate threadlocalmap copy that stores values that can only be read and modified by the current thread. The Threadlocal class implements the isolation of variable access in different threads by manipulating a threadlocalmap copy of each line thread. Because the variables are unique to each thread, there is no concurrency error at all. Another thing is that the key in the Threadlocalmap stored key-value pair is the Threadlocal object that the this object points to, and the value is the object you set.


To deepen our understanding, let's look at the implementation of the Getmap and Createmap methods that appear in the code above:

    /**      * Get The map associated with a ThreadLocal. Overridden in      * inheritablethreadlocal.      *      * @param  t The current thread      * @return the map      *      /Threadlocalmap getmap (thread t) {          return t.t hreadlocals;      }            /**      * Create The map associated with a ThreadLocal. Overridden in      * inheritablethreadlocal.      *      * @param t the current thread      * @param firstvalue value for the initial entry of the map      * @param map the Map to store.      */      void Createmap (Thread T, T firstvalue) {          t.threadlocals = new Threadlocalmap (this, firstvalue);      }  

Then take a look at the Get () method in the Threadlocal class:

    /** * Returns The value in the current thread's copy of this      * thread-local variable.  If the variable have no value      for the ' current thread ', it is first initialized to the value returned * by an      INVOC Ation of the {@link #initialValue} method.      *      * @return The current thread's value of this thread-local      */public      T get () {          thread t = thread.current Thread ();          Threadlocalmap map = getmap (t);          if (map! = null) {              Threadlocalmap.entry e = Map.getentry (this);              if (E! = null)                  return (T) e.value;          }          return Setinitialvalue ();      }  

Look again at the Setinitialvalue () method:

    /**         * Variant of Set () to establish initialvalue. Used instead         * of Set () in case user has overridden the set () method.         *         * @return The initial value         *         /private T Setinitialvalue () {             T value = InitialValue ();             Thread t = thread.currentthread ();             Threadlocalmap map = getmap (t);             if (map! = null)                 Map.set (this, value);             else                 createmap (t, value);             return value;         }  

When you get the value that is bound to the current thread, the Threadlocalmap object is looked up with the Threadlocal object that this is pointing to, which is, of course, echoing the code of the previous set () method.


Further, we can create different threadlocal instances to implement multiple variable access isolation between different threads, why can we do this? Because different threadlocal objects are different keys, you can certainly set different values in the Threadlocalmap object of the thread. By Threadlocal objects, you can share a value and multiple values in multiple threads, just as you would store a key-value pair and multiple key-value pairs in a HashMap object.

Summary

Threadlocal is a good idea to solve thread safety problems by providing a separate copy of the variable for each thread to solve the conflicting problem of variable concurrency access. In many cases, threadlocal is easier and more convenient than using the synchronized synchronization mechanism to solve thread safety problems, and results programs have higher concurrency.

Package com.test;    Import java.sql.Connection;  Import Java.sql.DriverManager;  Import java.sql.SQLException;    public class ConnectionManager {        private static threadlocal<connection> Connectionholder = new ThreadLocal <Connection> () {          @Override          protected Connection initialvalue () {              Connection conn = null;              try {                  conn = drivermanager.getconnection (                          "jdbc:mysql://localhost:3306/test", "username",                          "password" );              } catch (SQLException e) {                  e.printstacktrace ();              }              return conn;          }      ;        public static Connection getconnection () {          return connectionholder.get ();      }        public static void SetConnection (Connection conn) {          connectionholder.set (conn);      }  }  

Copyright NOTICE: This article for Bo Master original article, without Bo Master permission not reproduced.

Threadlocal Principle Detailed