Java中的ThreadLocal简介及应用

Java中的ThreadLocal简介及应用

简介

该类提供了线程局部 (thread-local) 变量。这些变量不同于它们的普通对应物，因为访问某个变量（通过其 get 或 set 方法）的每个线程都有自己的局部变量，它独立于变量的初始化副本。ThreadLocal 实例通常是类中的 private static 字段，它们希望将状态与某一个线程（例如，用户 ID 或事务 ID）相关联。

例如，以下类生成对每个线程唯一的局部标识符。 线程 ID 是在第一次调用 UniqueThreadIdGenerator.getCurrentThreadId() 时分配的，在后续调用中不会更改。

import java.util.concurrent.atomic.AtomicInteger;

public class UniqueThreadIdGenerator {

 private static final AtomicInteger uniqueId = new AtomicInteger(0);

 private static final ThreadLocal < Integer > uniqueNum = 
     new ThreadLocal < Integer > () {
         @Override protected Integer initialValue() {
             return uniqueId.getAndIncrement();
     }
 };

 public static int getCurrentThreadId() {
     return uniqueId.get();
 }

} // UniqueThreadIdGenerator

每个线程都保持对其线程局部变量副本的隐式引用，只要线程是活动的并且 ThreadLocal 实例是可访问的；在线程消失之后，其线程局部实例的所有副本都会被垃圾回收（除非存在对这些副本的其他引用）。

ThreadLocal不是解决数据共享的问题，而是解决多线程对局部变量都有一个独立的副本，相互之间互不影响，而且变量通常是类中的 private static 字段，也就是静态变量。

实际应用

在Spring源码的XmlBeanDefinitionReader的loadBeanDefinitions中使用了ThreadLocal。

	//当前正在加载的XML bean definition资源
private final ThreadLocal<Set<EncodedResource>> resourcesCurrentlyBeingLoaded =
			new NamedThreadLocal<Set<EncodedResource>>("XML bean definition resources currently being loaded");

	public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
		Assert.notNull(encodedResource, "EncodedResource must not be null");
		if (logger.isInfoEnabled()) {
			logger.info("Loading XML bean definitions from " + encodedResource.getResource());
		}
		//这里为什么这样设计，使用ThreadLocal，目的是什么？？
		//主要是为了检测是否是循环加载
		Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
		if (currentResources == null) {
			currentResources = new HashSet<EncodedResource>(4);
			this.resourcesCurrentlyBeingLoaded.set(currentResources);
		}
		//检查是否循环加载 也就是xml配置文件是否import自己
		//当第一次解析时，初始化了encodedResource，然后解析了import标签，还会调用此方法
		//第二次的时候，发现currentResources中已经有了资源文件，那么就是循环加载，抛出异常
		if (!currentResources.add(encodedResource)) {
			throw new BeanDefinitionStoreException(
					"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
		}
		try {
			InputStream inputStream = encodedResource.getResource().getInputStream();
			try {
				InputSource inputSource = new InputSource(inputStream);
				if (encodedResource.getEncoding() != null) {
					inputSource.setEncoding(encodedResource.getEncoding());
				}
				//加载BeanDefinitions
				return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
			}
			finally {
				inputStream.close();
			}
		}
		catch (IOException ex) {
			throw new BeanDefinitionStoreException(
					"IOException parsing XML document from " + encodedResource.getResource(), ex);
		}
		finally {
			currentResources.remove(encodedResource);
			if (currentResources.isEmpty()) {
				this.resourcesCurrentlyBeingLoaded.remove();
			}
		}
	}

正如注释的那样，这样做是为了检测xml文件中import标签是否导入了自己本身，也就是因此产生的循环加载问题。

当第一次进入此方法，currentResources为null，然后设置值，这个时候currentResources值与当前线程绑定，当后续解析xml中的import标签，还会调用此方法，第二次，通过判断!currentResources.add(encodedResource)，当然是true，也就完成了循环加载的检测。

更多内容请看个人博客：请点击此处。