О бедном ThreadLocal замолвите слово

Цитата от Антона Архипова:

Q: что такое ThreadLocal?
A: это Thread, который Local. Ну то есть локальный Thread... лёгковесный... JVM может его круто запускать и использовать меньше памяти...


На собеседованиях есть тенденция спрашивать про ThreadLocal. Как оказалось, далеко не все Java программисты знакомы с данным понятием. В заметке я попробую максимально коротко рассказать про ThreadLocal и поделиться примером его использования.

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

Первое решение, заведомо неправильное, может выглядеть следующим образом:

1. package name.samolisov.threadlocal;


2.  


3.  


4.  


5. public class SomeBuilderDemo {


6.  


7.     public static class SomeBuilder {


8.        


9.         private int counter;


10.        


11.         public void build() {


12.             System.out.println("Thread " + Thread.currentThread().getName() + " Build some structure...");


13.                        


14.             counter++;


15.            


16.             try {


17.                 Thread.sleep(100);


18.             }


19.             catch (InterruptedException e) {


20.                 e.printStackTrace();


21.             }


22.         }


23.        


24.         public int getCount() {


25.             return counter;


26.         }


27.     }


28.    


29.     public static class SomeBuilderThread extends Thread {


30.        


31.         private SomeBuilder builder;


32.        


33.         public SomeBuilderThread(SomeBuilder builder) {    


34.             this.builder = builder;


35.         }


36.        


37.         @Override


38.         public void run() {


39.             for (int i = 0; i < Math.random() * 10; i++) {


40.                 builder.build();               


41.             }


42.             System.out.println("My name is " + getName() + " and I built " + builder.getCount() + " things");


43.         }


44.     }


45.    


46.     public static void main(String[] args) {


47.         SomeBuilder builder = new SomeBuilder();


48.        


49.         Thread thread1 = new SomeBuilderThread(builder);


50.         Thread thread2 = new SomeBuilderThread(builder);


51.         try {


52.             thread1.start();


53.             thread2.start();


54.            


55.             thread1.join();


56.             thread2.join();


57.         }


58.         catch (InterruptedException e) {


59.             e.printStackTrace();


60.         }


61.     }


62. }


63.  

Результат работы:

Thread Thread-1 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-0 Build some structure...
My name is Thread-1 and I built 2 things
Thread Thread-0 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-0 Build some structure...
My name is Thread-0 and I built 8 things

Здесь мы имеем два потока, код которых реализован в классе SomeBuilderThread и между которыми распростределяется переменная builder типа SomeBuilder. Именно класс SomeBuilder реализует логику построения интересующей нас структуры в методе build (для простоты вся логика представлена одной строчкой - выводом сообщения в консоль). В данном же методе и происходит инкрементация счетчика counter. Счетчик является полем класса SomeBuilder и, т.к. объект данного класса распределен между потоками, то и данное поле распределено между потоками, т.е. является общим для всех потоков.

Понятно, что результат работы данной программы неверен: поток Thread-1 построил одну запись, а поток Thread-0 - 7 записей, в то время, как программа вывела 2 и 8 соответственно.

Для решения проблемы взаимного влияния потоков на переменную counter необходимо изолировать доступ к ней из разных потоков, т.е. сделать так, чтобы поток Thread-0 взаимодействовал со своей переменной counter, а поток Thread-1 - с независимой от нее своей. Для изоляции переменных можно использовать таблицу, индексируемую, например, названием потока:

1. package name.samolisov.threadlocal;


2.  


3. import java.util.Hashtable;


4.  


5.  


6. public class SomeBuilderDemo {


7.  


8.     public static class SomeBuilder {


9.        


10.         private Hashtable<String, Integer> counters = new Hashtable<String, Integer>();


11.        


12.         public void build() {


13.             System.out.println("Thread " + Thread.currentThread().getName() + " Build some structure...");


14.            


15.             if (!counters.containsKey(Thread.currentThread().getName()))


16.                 counters.put(Thread.currentThread().getName(), 0);


17.            


18.             counters.put(Thread.currentThread().getName(), counters.get(Thread.currentThread().getName()) + 1);


19.            


20.             try {


21.                 Thread.sleep(100);


22.             }


23.             catch (InterruptedException e) {


24.                 e.printStackTrace();


25.             }


26.         }


27.        


28.         public int getCount() {


29.             return counters.get(Thread.currentThread().getName());


30.         }


31.     }


32.    


33.     public static class SomeBuilderThread extends Thread {


34.        


35.         private SomeBuilder builder;


36.        


37.         public SomeBuilderThread(SomeBuilder builder) {    


38.             this.builder = builder;


39.         }


40.        


41.         @Override


42.         public void run() {


43.             for (int i = 0; i < Math.random() * 10; i++) {


44.                 builder.build();               


45.             }


46.             System.out.println("My name is " + getName() + " and I built " + builder.getCount() + " things");


47.         }


48.     }


49.    


50.     public static void main(String[] args) {


51.         SomeBuilder builder = new SomeBuilder();


52.        


53.         Thread thread1 = new SomeBuilderThread(builder);


54.         Thread thread2 = new SomeBuilderThread(builder);


55.         try {


56.             thread1.start();


57.             thread2.start();


58.            


59.             thread1.join();


60.             thread2.join();


61.         }


62.         catch (InterruptedException e) {


63.             e.printStackTrace();


64.         }


65.     }


66. }


67.  

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

Результат работы программы не отличается от ожидаемого:

Thread Thread-1 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-1 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-1 Build some structure...
Thread Thread-0 Build some structure...
My name is Thread-1 and I built 3 things
My name is Thread-0 and I built 4 things

поток Thread-1 построил 3 записи, в то время, как поток Thread-0 - 4.

Однако, в стандартную поставку JDK входит класс, который избавляет нас от разработки подобного велосипеда. Данный класс, как вы догадались, называется ThreadLocal.

Как работает ThreadLocal? У каждого потока - т.е. экземпляра класса Thread - есть ассоциированная с ним таблица ThreadLocal-переменных. Ключами таблицы являются cсылки на объекты класса ThreadLocal, а значениями - ссылки на объекты, "захваченные" ThreadLocal-переменными.

Например, если мы объявим ThreadLocal-переменную:

1. ThreadLocal<Object> locals = new ThreadLocal<Object>();

А затем, в потоке, сделаем

1. locals.set(myObject)

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

Следует обратить внимание, что ThreadLocal изолирует именно ссылки на объекты, а не сами объекты. Если изолированные внутри потоков ссылки ведут на один и тот же объект, то возможны коллизии.

Теперь рассмотрим пример:

1. package name.samolisov.threadlocal;


2.  


3.  


4.  


5. public class SomeBuilderDemo {


6.  


7.     public static class SomeBuilder {


8.        


9.         private ThreadLocal<Integer> counter = new ThreadLocal<Integer>();


10.        


11.         public void build() {


12.             System.out.println("Thread " + Thread.currentThread().getName() + " Build some structure...");


13.            


14.             if (counter.get() == null)


15.                 counter.set(0);


16.            


17.             counter.set(counter.get() + 1);


18.            


19.             try {


20.                 Thread.sleep(100);


21.             }


22.             catch (InterruptedException e) {


23.                 e.printStackTrace();


24.             }


25.         }


26.        


27.         public int getCount() {


28.             return counter.get();


29.         }


30.     }


31.    


32.     public static class SomeBuilderThread extends Thread {


33.        


34.         private SomeBuilder builder;


35.        


36.         public SomeBuilderThread(SomeBuilder builder) {    


37.             this.builder = builder;


38.         }


39.        


40.         @Override


41.         public void run() {


42.             for (int i = 0; i < Math.random() * 10; i++) {


43.                 builder.build();               


44.             }


45.             System.out.println("My name is " + getName() + " and I built " + builder.getCount() + " things");


46.         }


47.     }


48.    


49.     public static void main(String[] args) {


50.         SomeBuilder builder = new SomeBuilder();


51.        


52.         Thread thread1 = new SomeBuilderThread(builder);


53.         Thread thread2 = new SomeBuilderThread(builder);


54.         try {


55.             thread1.start();


56.             thread2.start();


57.            


58.             thread1.join();


59.             thread2.join();


60.         }


61.         catch (InterruptedException e) {


62.             e.printStackTrace();


63.         }


64.     }


65. }


66.  

Результат работы:

Thread Thread-1 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-1 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-1 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-1 Build some structure...
Thread Thread-1 Build some structure...
My name is Thread-0 and I built 4 things
Thread Thread-1 Build some structure...
Thread Thread-1 Build some structure...
My name is Thread-1 and I built 7 things

Как видим поток Thread-1 построил 7 записей, в то время как Thread-0 - 4.

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

1. if (counter.get() == null)


2.     counter.set(0);

производится ее инициализация. Важно! т.к. ThreadLocal-переменные изолированы в потоках, то инициализация такой переменной должна происходить в том же потоке, в котором она будет использоваться. Ошибкой является инициализация такой переменной - вызов метода set() - в главном потоке приложения, т.к. в данном случае значение, переданное в методе set(), будет "захвачено" для главного потока, и при вызове метода get() в целевом потоке будет возвращен null.

Для облегчения процесса инициализации ThreadLocal-переменной служит protected-метод initialValue(). Данный метод вызывается внутри метода get() в случае, если внутри ThreadLocal-переменной не "захвачено" никакое значение. При перекрытии данного метода следует учитывать такую особенность - он явно предназначен для работы в многопоточной среде, т.е. при первом вызове метода get() из потока A будет вызван initialValue и при первом вызове метода get() из потока B будет вызван тот же самый initialValue. Эти вызовы могут совпасть по времени, соответственно, если у вас в методе initialValue выполняется сложная логика, связанная с изменением каких-либо объектов, то данный метод нужно синхронизировать.

В следующем примере:

1. package name.samolisov.threadlocal;


2.  


3.  


4.  


5. public class SomeBuilderDemo {


6.  


7.     public static class SomeBuilder {


8.        


9.         private ThreadLocal<Integer> counter = new ThreadLocal<Integer>() {


10.             @Override


11.             protected Integer initialValue() {


12.                 return 0;


13.             }          


14.         };


15.        


16.         public void build() {


17.             System.out.println("Thread " + Thread.currentThread().getName() + " Build some structure...");


18.            


19.             counter.set(counter.get() + 1);


20.            


21.             try {


22.                 Thread.sleep(100);


23.             }


24.             catch (InterruptedException e) {


25.                 e.printStackTrace();


26.             }


27.         }


28.        


29.         public int getCount() {


30.             return counter.get();


31.         }


32.     }


33.    


34.     public static class SomeBuilderThread extends Thread {


35.        


36.         private SomeBuilder builder;


37.        


38.         public SomeBuilderThread(SomeBuilder builder) {    


39.             this.builder = builder;


40.         }


41.        


42.         @Override


43.         public void run() {


44.             for (int i = 0; i < Math.random() * 10; i++) {


45.                 builder.build();               


46.             }


47.             System.out.println("My name is " + getName() + " and I built " + builder.getCount() + " things");


48.         }


49.     }


50.    


51.     public static void main(String[] args) {


52.         SomeBuilder builder = new SomeBuilder();


53.        


54.         Thread thread1 = new SomeBuilderThread(builder);


55.         Thread thread2 = new SomeBuilderThread(builder);


56.         try {


57.             thread1.start();


58.             thread2.start();


59.            


60.             thread1.join();


61.             thread2.join();


62.         }


63.         catch (InterruptedException e) {


64.             e.printStackTrace();


65.         }


66.     }


67. }


68.  

инициализация ThreadLocal переменной вынесена в метод initialValue(). Т.к. логика данного метода тривиальна - он просто возвращает константу, то нет необходимости в его синхронизации.

Корректность результата работы программы не изменилась:

Thread Thread-0 Build some structure...
Thread Thread-1 Build some structure...
Thread Thread-1 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-0 Build some structure...
Thread Thread-1 Build some structure...
My name is Thread-0 and I built 3 things
Thread Thread-1 Build some structure...
Thread Thread-1 Build some structure...
My name is Thread-1 and I built 5 things

поток Thread-1 построил 5 записей, в то время, как Thread-0 - 3.

В заключение приведу пример практически значимого использования ThreadLocal. Пример взят с сайта Санкт-Петербургской группы тестирования JVM. Это - JDBC. ThreadLocal удобно использовать для предоставления каждому потоку своего экземпляра соединения с БД. Т.к. в спецификации явно не сказано, что классы, реализующие интерфейс Connection, должны быть потокобезопасными, то разумно изолировать в каждом потоке свой экземпляр соединения.

Реализация данного решения может выглядеть следующим образом:

1. public class ConnectionAccess {


2.     private static ThreadLocal<Connection> connectionHolder = new ThreadLocal<Connection>() {


3.         public Connection initialValue() {


4.             return DriverManager.getConnection(DB_URL);


5.         }


6.     };


7.        


8.     public static Connection getConnection() {


9.         return connectionHolder.get();


10.     }


11. }

Понравилось сообщение - подпишитесь на блог