2018-07-03 Spring基础知识之ThreadLocal

我写了个类用于上传文件到指定的FTP服务器，然而上线后，在多个任务并发调用后发现文件上传出错了。研究了问题之后，发现是这个类里的ftpUrl ，port, userName, password 在多线程下串掉了。于是把这四个变量改成ThreadLocal类型。问题才得以解决。
现在就分析下ThreadLocal的作用，以便于知道，为什么要用，干嘛用，怎么用？

为什么要用： 因为多线程下同一对象的变量如果被某个线程改写，那会直接影响到其他线程的使用。

干嘛用： ThreadLocal 把这个对象的指定成ThreadLocal类型的变量，在当前线程上分配一个独立的变量副本，这样当前线程就可以修改这个副本而不会影响其他的线程里的变量。

怎么用：

用ThreadLocal声明变量后，对这个变量的操作就要调用ThreadLocal的set(),get() 方法，而不是直接的等号赋值。对这几个方法的解释：
以下内容出自：http://www.iteye.com/topic/1123824

ThreadLocal类接口很简单，只有4个方法，我们先来了解一下。 
void set(Object value)
   设置当前线程的线程局部变量的值；
public Object get()
   该方法返回当前线程所对应的线程局部变量；
public void remove()
   将当前线程局部变量的值删除，目的是为了减少内存的占用，该方法是JDK 5.0新增的方法。需要指出的是，当线程结束后，对应该线程的局部变量将自动被垃圾回收，所以显式调用该方法清除线程的局部变量并不是必须的操作，但它可以加快内存回收的速度；
protected Object initialValue()
   返回该线程局部变量的初始值，该方法是一个protected的方法，显然是为了让子类覆盖而设计的。这个方法是一个延迟调用方法，在线程第1次调用get()或set(Object)时才执行，并且仅执行1次。ThreadLocal中的默认实现直接返回一个null。 

ThreadLocal是如何做到为每一个线程维护变量的副本的呢？其实实现的思路很简单：在ThreadLocal类中有一个Map，用于存储每一个线程的变量副本，Map中元素的键为线程对象，而值对应线程的变量副本。

package app.ftp.util;

import app.ftp.mongo.ImportMapEntity;
import com.amazonaws.util.CollectionUtils;
import core.framework.api.mongo.MongoCollection;
import core.framework.api.web.exception.BadRequestException;
import core.framework.impl.inject.DeferredInject;
import linc.core.util.Strings;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPSClient;

import java.io.IOException;
import java.util.List;

import static com.mongodb.client.model.Filters.eq;
import static java.text.MessageFormat.format;

/**
 * Created by vickyy on 10/18/2017.
 */
public class FtpUpload extends FtpUtil {
    private static ThreadLocal ftpUrl = new ThreadLocal<>();
    private static ThreadLocal port = new ThreadLocal<>();
    private static ThreadLocal userName = new ThreadLocal<>();
    private static ThreadLocal password = new ThreadLocal<>();

    @DeferredInject
    private MongoCollection importMapCollection;

    public ImportMapEntity initConnection(String tableName) {
        if (Strings.isEmpty(tableName)) {
            throw new BadRequestException("TableName can not be empty!");
        }
        List entities = importMapCollection.find(eq("tableName", tableName));
        if (CollectionUtils.isNullOrEmpty(entities) || entities.get(0).valueMapping == null) {
            throw new BadRequestException("Not available ftp configuration with tableName = itemFtpConfig!");
        }
        ImportMapEntity entity = entities.get(0);
        if (entity.valueMapping.containsKey("ftpUrl")) {
            ftpUrl.set(entity.valueMapping.get("ftpUrl"));
        }
        if (entity.valueMapping.containsKey("port")) {
            port.set(entity.valueMapping.get("port"));
        }
        if (entity.valueMapping.containsKey("userName")) {
            userName.set(entity.valueMapping.get("userName"));
        }
        if (entity.valueMapping.containsKey("password")) {
            password.set(entity.valueMapping.get("password"));
        }
        return entity;
    }

    @Override
    public FTPClient connect() throws IOException {
        FTPSClient ftpClient = new FTPSClient();
        ftpClient.connect(ftpUrl.get(), Integer.parseInt(port.get()));
        ftpClient.setDefaultTimeout(12000);
        ftpClient.login(userName.get(), password.get());
        if (ftpClient.getReplyCode() != 230) {
            throw new BadRequestException(format("FTP LOGIN FAILED: userName:{0}, password:{1}, ftp reply:{2}", userName, password, ftpClient.getReplyString()));
        }
        ftpClient.enterLocalPassiveMode();
        ftpClient.setBufferSize(1024);
        ftpClient.setControlEncoding("utf8");
        ftpClient.setFileType(FTPClient.BINARY_FILE_TYPE);

        return ftpClient;
    }
}