File: ThreadLocalUsage.md

package info (click to toggle)
error-prone-java 2.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 23,204 kB
  • sloc: java: 222,992; xml: 1,319; sh: 25; makefile: 7
file content (28 lines) | stat: -rw-r--r-- 765 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
`ThreadLocal`s should be stored in `static` variables to avoid memory leaks. If
a `ThreadLocal` is stored in an instance (non-static) variable, there will be
<code>M \* N</code> instances of the `ThreadLocal` value where `M` is the number
of threads, and `N` is the number of instances of the containing class. Each
instance may remain live as long the thread that stored it stays live.

Example:

```java
class C {
   private final ThreadLocal<D> local = new ThreadLocal<D>();

   public f() {
       D d = local.get();
       if (d == null) {
          d = new D(this);
          local.set(d);
       }
       d.doSomething();
   }
}
```

The fix is often to make the field `static`:

```java
private static final ThreadLocal<D> local = new ThreadLocal<D>();
```