Когда и как мне использовать переменную ThreadLocal?

Одно из возможных (и распространенных) вариантов использования - это когда у вас есть объект, который не является потокобезопасным, но вы хотите избежать синхронизация доступа к этому объекту (я смотрю на вас, SimpleDateFormat). Вместо этого дайте каждому потоку собственный экземпляр объекта.

Например:

public class Foo
{
    // SimpleDateFormat is not thread-safe, so give one to each thread
    private static final ThreadLocal<SimpleDateFormat> formatter = new ThreadLocal<SimpleDateFormat>(){
        @Override
        protected SimpleDateFormat initialValue()
        {
            return new SimpleDateFormat("yyyyMMdd HHmm");
        }
    };

    public String formatIt(Date date)
    {
        return formatter.get().format(date);
    }
}

Документация.

Поскольку ThreadLocal - это ссылка на данные в заданном Thread, вы можете столкнуться с утечками загрузки классов при использовании ThreadLocals на серверах приложений, использующих пулы потоков. Вы должны быть очень осторожны при очистке любых ThreadLocals, которые вы get() или set(), используя метод ThreadLocal remove().

Если вы не очистите, когда закончите, любые ссылки, которые он содержит на классы, загруженные как часть развернутого веб-приложения, останутся в постоянная куча и никогда не будет собирать мусор. Повторное развертывание / удаление веб-приложения не приведет к удалению каждой ссылки Thread на классы вашего веб-приложения, поскольку Thread не принадлежит вашему веб-приложению. Каждое последующее развертывание будет создавать новый экземпляр класса, который никогда не будет собираться сборщиком мусора.

Вы получите исключения из-за нехватки памяти из-за java.lang.OutOfMemoryError: PermGen space и после некоторого поиска в Google, вероятно, просто увеличите -XX:MaxPermSize вместо исправления ошибки.

Если вы все же столкнетесь с этими проблемами, вы можете определить, какой поток и класс сохраняют эти ссылки, используя Eclipse Memory Analyzer и / или следуя руководству Фрэнка Киевиета и продолжение.

Обновление: повторно обнаружил запись в блоге Алекса Вассера, которая помогла я отслеживаю некоторые ThreadLocal проблемы, которые у меня были.

Многие фреймворки используют ThreadLocals для поддержки некоторого контекста, связанного с текущим потоком. Например, когда текущая транзакция хранится в ThreadLocal, вам не нужно передавать ее в качестве параметра при каждом вызове метода на случай, если кому-то в стеке потребуется доступ к ней. Веб-приложения могут хранить информацию о текущем запросе и сеансе в ThreadLocal, чтобы приложение имело легкий доступ к ним. С Guice вы можете использовать ThreadLocals при реализации пользовательских областей видимости для внедряемых объектов (по умолчанию Guice области действия сервлетов, скорее всего, тоже их используют).

ThreadLocals - это один из видов глобальных переменных (хотя и немного менее опасный, потому что они ограничены одним потоком), поэтому вы должны быть осторожны при их использовании, чтобы избежать нежелательных побочных эффектов и утечек памяти. Создавайте свои API так, чтобы значения ThreadLocal всегда автоматически сбрасывались, когда они больше не нужны, и что некорректное использование API было бы невозможным (например, вот так). ThreadLocals можно использовать для очистки кода, и в некоторых редких случаях они являются единственным способом заставить что-то работать (в моем текущем проекте было два таких случая; они задокументированы здесь в разделе" Статические поля и глобальные переменные ").

В Java, если у вас есть данные, которые могут варьироваться в зависимости от потока, вы можете выбрать, передать эти данные каждому методу, который в них нуждается (или может нуждаться), или связать данные с потоком. Передача данных повсюду может быть работоспособной, если все ваши методы уже должны передавать общую «контекстную» переменную.

Если это не так, возможно, вы не захотите загромождать сигнатуры ваших методов дополнительным параметром. В мире без потоков вы можете решить проблему с помощью Java-эквивалента глобальной переменной. В многопоточном слове эквивалентом глобальной переменной является локальная переменная потока.

В книге Параллелизм Java на практике есть очень хороший пример. Автор (Джошуа Блох) объясняет, как ограничение потоков является одним из простейших способов обеспечения безопасности потоков и ThreadLocal - это более формальное средство поддержания ограничения потока. В конце он также объясняет, как люди могут злоупотреблять им, используя его в качестве глобальных переменных.

Я скопировал текст из упомянутой книги, но код 3.10 отсутствует, поскольку не так важно понимать, где следует использовать ThreadLocal.

Локальные переменные потока часто используются для предотвращения совместного использования в проектах, основанных на изменяемых синглетонах или глобальных переменных. Например, однопоточное приложение может поддерживать глобальное соединение с базой данных, которое инициализируется при запуске, чтобы избежать необходимости передавать соединение каждому методу. Поскольку соединения JDBC могут быть небезопасными для потоков, многопоточное приложение, использующее глобальное соединение без дополнительной координации, также не является потокобезопасным. Используя ThreadLocal для хранения соединения JDBC, как в ConnectionHolder в листинге 3.10, каждый поток будет иметь собственное соединение.

ThreadLocal широко используется при реализации фреймворков приложений. Например, контейнеры J2EE связывают контекст транзакции с выполняющимся потоком на время вызова EJB. Это легко реализовать с помощью статического Thread-Local, содержащего контекст транзакции: когда код фреймворка должен определить, какая транзакция выполняется в данный момент, он извлекает контекст транзакции из этого ThreadLocal. Это удобно тем, что уменьшает необходимость передавать информацию контекста выполнения в каждый метод, но связывает любой код, использующий этот механизм, с фреймворком.

Можно легко злоупотребить ThreadLocal, рассматривая его свойство ограничения потока как лицензию на использование глобальных переменных или как средство создания «скрытых» аргументов метода. Как и глобальные переменные, локальные переменные потока могут отвлекать от возможности повторного использования и вводить скрытые связи между классами, поэтому их следует использовать с осторожностью.

По сути, когда вам нужно, чтобы значение переменной зависело от текущего потока, и вам неудобно прикреплять значение к потоку каким-либо другим способом (например, , подкласс потока).

Типичный случай, когда какая-то другая структура создала поток, в котором выполняется ваш код, например контейнер сервлета, или там, где имеет смысл использовать ThreadLocal, потому что ваша переменная тогда находится «в своем логическом месте» (а не в переменной, которая находится в подклассе Thread или в какой-либо другой хэш-карте).

На моем веб-сайте есть дополнительные обсуждения и примеры того, когда использовать ThreadLocal, которые могут также быть интересным.

Некоторые люди рекомендуют использовать ThreadLocal как способ прикрепления «идентификатора потока» к каждому потоку в определенных параллельных алгоритмах, где вам нужен номер потока (см., Например, Herlihy & Shavit). В таких случаях убедитесь, что вы действительно получаете выгоду!

1. ThreadLocal в Java был представлен в JDK 1.2, но позже был обобщен в JDK 1.5 для введения безопасности типов в переменной ThreadLocal.

2. ThreadLocal может быть связан с областью Thread, весь код, который выполняется Thread, имеет доступ к переменным ThreadLocal, но два потока не могут видеть переменную ThreadLocal друг друга.

3. Каждый поток содержит эксклюзивную копию переменной ThreadLocal, которая становится доступной для сборки мусора после завершения или смерти потока, обычно или из-за какого-либо исключения, учитывая, что эта переменная ThreadLocal не имеет других живых ссылок.

4. Переменные ThreadLocal в Java обычно являются частными статическими полями в классах и сохраняют свое состояние внутри потока.

Подробнее: ThreadLocal в Java - Пример программы и руководство

В документации очень хорошо сказано: "каждый поток, который обращается к [локальной переменной потока] (через свой метод get или set), имеет свою собственную, независимо инициализированную копию переменной ».

Вы используете его, когда у каждого потока должна быть своя собственная копия чего-либо. По умолчанию данные распределяются между потоками.

Сервер Webapp может хранить пул потоков, и перед ответом клиенту необходимо удалить ThreadLocal var, таким образом, текущий поток может быть повторно использован при следующем запросе.

Два случая использования, в которых может использоваться переменная threadlocal -
1- Когда у нас есть требование связать состояние с потоком (например, идентификатор пользователя или идентификатор транзакции). Обычно это происходит с веб-приложением, когда каждый запрос, отправляемый сервлету, имеет уникальный идентификатор транзакции, связанный с ним.

// This class will provide a thread local variable which
// will provide a unique ID for each thread
class ThreadId {
    // Atomic integer containing the next thread ID to be assigned
    private static final AtomicInteger nextId = new AtomicInteger(0);

    // Thread local variable containing each thread's ID
    private static final ThreadLocal<Integer> threadId =
        ThreadLocal.<Integer>withInitial(()-> {return nextId.getAndIncrement();});

    // Returns the current thread's unique ID, assigning it if necessary
    public static int get() {
        return threadId.get();
    }
}

Обратите внимание, что здесь метод withInitial реализован с использованием лямбда-выражения.
2- Другой вариант использования - это когда мы хотим иметь поточно-безопасный экземпляр, и мы не хотим использовать синхронизацию, поскольку затраты на производительность с синхронизацией выше. Один из таких случаев - использование SimpleDateFormat. Поскольку SimpleDateFormat не является потокобезопасным, мы должны предоставить механизм, чтобы сделать его потокобезопасным.

public class ThreadLocalDemo1 implements Runnable {
    // threadlocal variable is created
    private static final ThreadLocal<SimpleDateFormat> dateFormat = new ThreadLocal<SimpleDateFormat>(){
        @Override
        protected SimpleDateFormat initialValue(){
            System.out.println("Initializing SimpleDateFormat for - " + Thread.currentThread().getName() );
            return new SimpleDateFormat("dd/MM/yyyy");
        }
    };

    public static void main(String[] args) {
        ThreadLocalDemo1 td = new ThreadLocalDemo1();
        // Two threads are created
        Thread t1 = new Thread(td, "Thread-1");
        Thread t2 = new Thread(td, "Thread-2");
        t1.start();
        t2.start();
    }

    @Override
    public void run() {
        System.out.println("Thread run execution started for " + Thread.currentThread().getName());
        System.out.println("Date formatter pattern is  " + dateFormat.get().toPattern());
        System.out.println("Formatted date is " + dateFormat.get().format(new Date()));
    } 

}

Начиная с выпуска Java 8 появился более декларативный способ инициализации ThreadLocal:

ThreadLocal<Cipher> local = ThreadLocal.withInitial(() -> "init value");

До выпуска Java 8 вам приходилось делать следующее:

ThreadLocal<String> local = new ThreadLocal<String>(){
    @Override
    protected String initialValue() {
        return "init value";
    }
};

Более того, если метод создания экземпляра (конструктор, фабричный метод) класса, который используется для ThreadLocal, не принимает никаких параметров, вы можете просто использовать ссылки на методы (введенные в Java 8):

class NotThreadSafe {
    // no parameters
    public NotThreadSafe(){}
}

ThreadLocal<NotThreadSafe> container = ThreadLocal.withInitial(NotThreadSafe::new);

Примечание. Оценка является ленивой, поскольку вы передаете java.util.function.Supplier лямбда, которая оценивается только тогда, когда вызывается ThreadLocal#get, но значение ранее не оценивалось.

Вы должны быть очень осторожны с шаблоном ThreadLocal. Есть несколько основных недостатков, таких как упомянутый Фил, но одна из них не была упомянута - это убедиться, что код, устанавливающий контекст ThreadLocal, не является «реентерабельным».

Плохие вещи могут случиться, когда код, устанавливающий информацию, запускается второй или третий раз, потому что информация в вашем потоке может начать изменяться, когда вы этого не ожидали. Поэтому убедитесь, что информация ThreadLocal не была установлена, прежде чем устанавливать ее снова.

ThreadLocal гарантирует, что доступ к изменяемому объекту несколькими потоками в несинхронизированном методе будет синхронизирован, то есть сделать изменяемый объект неизменным внутри метода.

Это достигается путем предоставления нового экземпляра изменяемого объекта для каждого потока, пытающегося получить к нему доступ. Таким образом, это локальная копия каждого потока. Это некоторый прием, позволяющий сделать переменную экземпляра в методе доступной как локальную переменную. Как вы знаете, локальная переменная метода доступна только потоку, с одним отличием; Локальные переменные метода не будут доступны для потока после завершения выполнения метода, тогда как изменяемый объект, совместно используемый с threadlocal, будет доступен для нескольких методов, пока мы не очистим его.

По определению:

Класс ThreadLocal в Java позволяет создавать переменные, которые могут быть прочитаны и записаны только одним и тем же потоком. Таким образом, даже если два потока выполняют один и тот же код, и код имеет ссылку на переменную ThreadLocal, тогда два потока не могут видеть переменные ThreadLocal друг друга.

Каждый Thread в java содержит ThreadLocalMap.
Где

Key = One ThreadLocal object shared across threads.
value = Mutable object which has to be used synchronously, this will be instantiated for each thread.

Достижение ThreadLocal:

Теперь создайте класс-оболочку для ThreadLocal, который будет содержать изменяемый объект, как показано ниже (с или без initialValue()).
Теперь методы получения и установки этой оболочки будут работать с экземпляром threadlocal вместо изменяемого объекта.

Если метод getter () для threadlocal не нашел никакого значения с в карте threadlocalmap для Thread; затем он вызовет initialValue (), чтобы получить свою частную копию по отношению к потоку.

class SimpleDateFormatInstancePerThread {

    private static final ThreadLocal<SimpleDateFormat> dateFormatHolder = new ThreadLocal<SimpleDateFormat>() {

        @Override
        protected SimpleDateFormat initialValue() {
            SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd") {
                UUID id = UUID.randomUUID();
                @Override
                public String toString() {
                    return id.toString();
                };
            };
            System.out.println("Creating SimpleDateFormat instance " + dateFormat +" for Thread : " + Thread.currentThread().getName());
            return dateFormat;
        }
    };

    /*
     * Every time there is a call for DateFormat, ThreadLocal will return calling
     * Thread's copy of SimpleDateFormat
     */
    public static DateFormat getDateFormatter() {
        return dateFormatHolder.get();
    }

    public static void cleanup() {
        dateFormatHolder.remove();
    }
}

Теперь wrapper.getDateFormatter() вызовет threadlocal.get() и проверит, что currentThread.threadLocalMap содержит this (threadlocal) экземпляр.
Если да, верните значение (SimpleDateFormat) для соответствующего экземпляра threadlocal
иначе добавьте карту с этим threadlocal например, initialValue ().

Тем самым достигается потокобезопасность этого изменяемого класса; каждый поток работает со своим собственным изменяемым экземпляром, но с тем же экземпляром ThreadLocal. Означает, что весь поток будет использовать один и тот же экземпляр ThreadLocal в качестве ключа, но другой экземпляр SimpleDateFormat в качестве значения.

https://github.com/skanagavelu/yt.tech/blob/master/src/ThreadLocalTest.java

когда?

Когда объект не является потокобезопасным, вместо синхронизации, которая затрудняет масштабируемость, дайте по одному объекту каждому потоку и сохраните его область действия потока, то есть ThreadLocal. Одними из наиболее часто используемых, но не поточно-ориентированных объектов являются подключение к базе данных и JMSConnection.

Как ?

Одним из примеров является среда Spring, которая интенсивно использует ThreadLocal для управления транзакциями «за кулисами», сохраняя эти объекты подключения в переменных ThreadLocal. На высоком уровне, когда транзакция запускается, она получает соединение (и отключает автоматическую фиксацию) и сохраняет его в ThreadLocal. при дальнейших вызовах db он использует то же соединение для связи с db. В конце он берет соединение от ThreadLocal и фиксирует (или откатывает) транзакцию и освобождает соединение.

Я думаю, что log4j также использует ThreadLocal для поддержки MDC.

ThreadLocal полезен, когда вы хотите иметь какое-то состояние, которое не должно совместно использоваться разными потоками, но должно быть доступно из каждого потока в течение всего его жизненного цикла.

В качестве примера представьте себе веб-приложение, в котором каждый запрос обслуживается отдельным потоком. Представьте, что для каждого запроса вам потребуется несколько раз фрагмент данных, что довольно дорого для вычисления. Однако эти данные могли изменяться для каждого входящего запроса, а это означает, что вы не можете использовать простой кеш. Простым и быстрым решением этой проблемы было бы наличие переменной ThreadLocal, содержащей доступ к этим данным, чтобы вам приходилось вычислять ее только один раз для каждого запроса. Конечно, эту проблему можно решить и без использования ThreadLocal, но я придумал ее для иллюстрации.

Тем не менее, имейте в виду, что ThreadLocals по сути являются формой глобального состояния. В результате у него есть много других последствий, и его следует использовать только после рассмотрения всех других возможных решений.

Существует 3 сценария использования помощника класса, такого как SimpleDateFormat, в многопоточном коде, лучший из которых - ThreadLocal.

Сценарии

1- Использование как общего объекта с помощью механизма блокировки или синхронизации, который замедляет работу приложения.

Сценарии пула потоков

2- Использование в качестве локального объекта внутри метода

В этом сценарии в пуле потоков, если у нас есть 4 потока, каждый из которых имеет время 1000 задач, тогда у нас есть
4000 SimpleDateFormat < strong> объект создан и ожидает, пока сборщик мусора сотрет их

3- Использование ThreadLocal

В пуле потоков, если у нас есть 4 потока и мы передали каждому потоку по одному экземпляру SimpleDateFormat
, то есть 4 потока, 4 объекта SimpleDateFormat.