关于Java ThreadLocal

标签：des   style   blog   http   color   java   os   io   

转自：http://www.appneta.com/blog/introduction-to-javas-threadlocal-storage/

What is ThreadLocal? A simple example

As its name suggests, a single instance of ThreadLocal can store different values for each thread independently. Therefore, the value stored in a ThreadLocal instance is specific (local) to the current running Thread, any other code logic running on the same thread will see the same value, but not the values set on the same instance by other threads. (There are exceptions, like InhertiableThreadLocal, which inherits parent thread’s values by default.)

Let’s consider this example:

We have a TransactionManager class that provide static methods to:

• Start a transaction with a generated ID

• Store that ID as a static field and provide a transaction ID getter method to other code logic that needs to know the current transaction ID.

In a single threaded environment, TransactionManager can simply store the ID as a static field and return as is. However, this will certainly not work in a multiple-threaded environment. Imagine multiple threads are using TransactionManager – transaction IDs generated by each thread can overwrite each other as there is only one static instance of transaction ID. One may synchronize and block other transactions to avoid overwrites, but this would totally defeat the purpose of having multiple threads.

In order to solve this problem, ThreadLocal provides a very neat solution:

public class TransactionManager {
    private static final ThreadLocal<String> context = new ThreadLocal<String>();

    public static void startTransaction() {
        //logic to start a transaction
        //...
        context.set(generatedId);
    }

    public static String getTransactionId() {
        return context.get();
    }

    public static void endTransaction() {
        //logic to end a transaction
        //…
        context.remove();
    }
}

Different thread that starts transactions via TransactionManager will get its own transaction ID stored in the context. Any logic within the same thread can call getTransactionId() later on to retrieve the value belongs/local to that Thread. So problem’s solved!

The Internals of ThreadLocal and How it Works

Let’s drill down a little bit into the ThreadLocal’s internals. ThreadLocal is implemented by having a Map (a ThreadLocalMap) as field (with WeakReference entry) within each Thread instance. (There are actually 2 maps; the second one is used for InheritabeleThreadLocal, but let’s not complicate the picture). The keys of those maps are the corresponding ThreadLocals themselves. Therefore, when a set/get is called on a ThreadLocal, it looks at the current thread, find the map, and look up the value with “this” ThreadLocal instance.

Still confused? I certainly am. Let’s look at a real example.

• Code running in Thread 1 calls set() on ThreadLocal instance “A” with value “123″

• Code running in Thread 2 calls set() on ThreadLocal instance “A” with value “234″

• Code running in Thread 1 calls set() on ThreadLocal instance “B” with value “345″

And this is the end result:

Thread 1 (the instance)’s field ThreadLocalMap (m1) has 2 entries:

Now if some code logic in Thread 1 calls get() on ThreadLocal instance “A”, the ThreadLocal logic will lookup the current Thread, which is instance Thread 1, then access the field ThreadLocalMap of that Thread instance, which is m1, it can then lookup the value by using m1.get(this), with “this” as ThreadLocal and the result is “123″

Now what to watch out for!

Did I hear weak reference for ThreadLocal entries? Does that mean I don’t have to clean up? Well, it’s not quite that simple.

First of all, the value object put into the ThreadLocal would not purge itself (garbage collected) if there are no more Strong references to it. Instead, the Weak reference is done on the thread instance, which means Java garbage collection would clean up the ThreadLocal map if the thread itself is not strongly referenced elsewhere.

So now the question is: when would the Thread object get garbage collected?

The answer is: it depends, but always assume the thread is long running. 2 common examples:

• Servlets. The threads that handle servlet requests usually stay alive in the container for the lifetime of the server instance. Code logic that uses ThreadLocal might be referenced indirectly by servlets.

• Thread pooling java.util.concurrent.Executors. Java encourages recycling threads!

A typical usage of Executor introduced in Java 1.5, if ThreadLocal maps are not cleaned up properly after a transaction is done, next TransactionProcessingTask might inherit values from another previous unrelated task!

ExecutorService service = Executors.newFixedThreadPool(10);
service.submit(new TransactionProcessingTask());

Be careful with initialization of ThreadLocal, below is an implementation of a counter by Thread. Can you tell what is wrong in the below initialization?

public class Counter {
    private static ThreadLocal<Integer> counter =
        new ThreadLocal<Integer>();
    static {
        counter.set(0);
    }

    public int getCountInThread() {
        return counter.get();
    }

    //…
}

The counter would not get initialized correctly! Though the counter is declared as static, it CANNOT be initialized by having a static initializer, as the initializer only runs once when the first thread references the Counter class. When the second thread comes in, it does not run counter.set(0) on that thread, therefore counter.get() returns null instead of 0! One solution is to sublcass ThreadLocal and override the initialValue() method to assign non-null initial value.

With these in mind, you can probably picture the consequences of not cleaning up after ourselves! An operation that runs on a recycled thread might inherit the values from previous operation on the same thread! Besides, it can also cause memory leaks as the instance stored in ThreadLocal will never get garbage collected if the thread is alive.

As a rule of thumb, always clean up/reset your threadlocal after you have finished your “unit of operation”! Even though the current code might be simple enough to bypass the cleanups, it might be adapted and integrated into servlets/thread pooling later on! After all, cleaning up responsibly is always appreciated both in the realms of programming and real life.

关于Java ThreadLocal,布布扣,bubuko.com

关于Java ThreadLocal

标签：des   style   blog   http   color   java   os   io   

原文地址：http://my.oschina.net/u/552375/blog/302467