Spring中使用自定義ThreadLocal存儲導致的坑及解決

Posted on by

Spring自定義ThreadLocal存儲導致的坑

Spring 中有時候我們需要存儲一些和 Request 相關聯的變量，例如用戶的登陸有關信息等，它的生命周期和 Request 相同。

一個容易想到的實現辦法是使用ThreadLocal

public class SecurityContextHolder {
    private static final ThreadLocal<SecurityContext> securityContext = new ThreadLocal<SecurityContext>();
    public static void set(SecurityContext context) {
        securityContext.set(context);
    }
    public static SecurityContext get() {
        return securityContext.get();
    }
    public static void clear() {
        securityContext.remove();
    }
}

使用一個自定義的HandlerInterceptor將有關信息註入進去

@Slf4j
@Component
public class RequestInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws
            Exception {
        try {
            SecurityContextHolder.set(retrieveRequestContext(request));
        } catch (Exception ex) {
            log.warn("讀取請求信息失敗", ex);
        }
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable
            ModelAndView modelAndView) throws Exception {
        SecurityContextHolder.clear();
}

通過這樣，我們就可以在 Controller 中直接使用這個 context，很方便的獲取到有關用戶的信息

@Slf4j
@RestController
class Controller {
  public Result get() {
     long userId = SecurityContextHolder.get().getUserId();
     // ...
  }
}

這個方法也是很多博客中使用的。然而這個方法卻存在著一個很隱蔽的坑： HandlerInterceptor 的 postHandle 並不總是會調用。

當Controller中出現Exception

@Slf4j
@RestController
class Controller {
  public Result get() {
     long userId = SecurityContextHolder.get().getUserId();
     // ...
     throw new RuntimeException();
  }
}

或者在HandlerInterceptor的preHandle中出現Exception

@Slf4j
@Component
public class RequestInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws
            Exception {
        try {
            SecurityContextHolder.set(retrieveRequestContext(request));
        } catch (Exception ex) {
            log.warn("讀取請求信息失敗", ex);
        }
        // ...
        throw new RuntimeException();
        //...
        return true;
    }
}

這些情況下， postHandle 並不會調用。這就導致瞭 ThreadLocal 變量不能被清理。

在平常的 Java 環境中，ThreadLocal 變量隨著 Thread 本身的銷毀，是可以被銷毀掉的。但 Spring 由於采用瞭線程池的設計，響應請求的線程可能會一直常駐，這就導致瞭變量一直不能被 GC 回收。更糟糕的是，這個沒有被正確回收的變量，由於線程池對線程的復用，可能會串到別的 Request 當中，進而直接導致代碼邏輯的錯誤。

為瞭解決這個問題，我們可以使用 Spring 自帶的 RequestContextHolder ，它背後的原理也是 ThreadLocal，不過它總會被更底層的 Servlet 的 Filter 清理掉，因此不存在泄露的問題。

下面是一個使用RequestContextHolder重寫的例子

public class SecurityContextHolder {
    private static final String SECURITY_CONTEXT_ATTRIBUTES = "SECURITY_CONTEXT";
    public static void setContext(SecurityContext context) {
        RequestContextHolder.currentRequestAttributes().setAttribute(
                SECURITY_CONTEXT_ATTRIBUTES,
                context,
                RequestAttributes.SCOPE_REQUEST);
    }
    public static SecurityContext get() {
        return (SecurityContext)RequestContextHolder.currentRequestAttributes()
                .getAttribute(SECURITY_CONTEXT_ATTRIBUTES, RequestAttributes.SCOPE_REQUEST);
    }
}

除瞭使用 RequestContextHolder 還可以使用 Request Scope 的 Bean，或者使用 ThreadLocalTargetSource ，原理上是類似的。

需要時刻註意 ThreadLocal 相當於線程內部的 static 變量，是一個非常容易產生泄露的點，因此使用 ThreadLocal 應該額外小心。

Threadlocal可能會產生內存泄露的問題及原理

剛遇到一個關於threadlocal的內存泄漏問題，剛好總結一下

比較常用的這裡先不提，直接提比較重要的部分

為什麼會產生內存泄露？

    public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }

set方法裡面，先調用到當前線程thread，每個線程裡都會有一個threadlocals成員變量，指向對應的ThreadLocalMap ，然後以new出來的引用作為key，和給定的value一塊保存起來。

當外部引用解除以後，對應的ThreadLocal對象由於被內部ThreadLocalMap 引用，不會GC，可能會導致內存泄露。

JVM解決的辦法

        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;
            Entry(ThreadLocal<?> k, Object v) {
                super(k);
                value = v;
            }
        }

繼承瞭一個軟引用，在系統進行gc的時候就可以回收

但是回收以後，key變成null，value也無法被訪問到，還是可能存在內存泄露。 因此一旦不用瞭，必須對裡面的keyvalue對remove掉，否則就會有內存泄露；而且在threadlocal源碼裡面，在每次get或者set的時候會清楚裡面key為value的記錄

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：