詳解Spring框架下向異步線程傳遞HttpServletRequest參數(shù)的坑

更新時間：2019年03月21日 09:37:01 作者：geekartt

這篇文章主要介紹了詳解Spring框架下向異步線程傳遞HttpServletRequest參數(shù)的坑，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

在spring的注解 @RequestMapping 之下可以直接獲取 HttpServletRequest 來獲得諸如request header等重要的請求信息：

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
 
  private static final String HEADER = "app-version";
 
  @RequestMapping(value = "/async", method = RequestMethod.GET)
  public void test(HttpServletRequest request) {
        request.getHeader(HEADER);
  }
}

往往，這些重要的信息也會在異步線程中被使用到。于是，一個很自然的想法是，那不如直接把這里獲取到的request當做參數(shù)傳到其它spawn出的子線程里，比如：

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
 
  private static final String HEADER = "app-version";
 
  @RequestMapping(value = "/async", method = RequestMethod.GET)
  public void test(HttpServletRequest request) {
    log.info("Main thread: " + request.getHeader(HEADER));   
    new Thread(() -> {
      log.info("Child thread: " + request.getHeader(HEADER));
    }).start();
  }
}

在header中設置"app-version"為1.0.1后發(fā)送 <base_url>/test/async 請求，可以看到結果：

Main thread: 1.0.1
Child thread: 1.0.1

但是，坑，也就此出現(xiàn)了。

由于 HttpServletRequest 不是線程安全的（后知后覺），當主線程完成自己的工作返回response后，相應的諸如 HttpServletRequest 等對象就會被銷毀。為了看到這個現(xiàn)象，我們可以在子線程中多等待一段時間來保證主線程先于子線程結束。

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {

  private static final String HEADER = "app-version";
  private static final long CHILD_THREAD_WAIT_TIME = 5000;

  @RequestMapping(value = "/async", method = RequestMethod.GET)
  public void test(HttpServletRequest request) {
    log.info("Main thread: " + request.getHeader(HEADER));

    new Thread(() -> {
      try {
        Thread.sleep(CHILD_THREAD_WAIT_TIME);
      } catch (Throwable e) {

      }
      log.info("Child thread: " + request.getHeader(HEADER));
    }).start();
  }
}

在header中設置"app-version"為1.0.1后發(fā)送 <base_url>/test/async 請求，可以看到結果：

Main thread: 1.0.1
Child thread: null

顯然，誰也沒辦法保證自己spawn出來的子線程會先于主線程結束，所以直接傳遞 HttpServletRequest 參數(shù)給子線程是不可行的。

網(wǎng)上有一種方法是通過spring框架自帶的 RequestContextHolder 來獲取request，這對異步線程來講是不可行的。因為只有在負責request處理的線程才能調用到 RequestContextHolder 對象，其它線程中它會直接為空。

那么，一個可以想到的笨辦法是將request的值取出來，注入到自定義的對象中，然后將這個對象作為參數(shù)傳遞給子線程：

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {

  private static final String HEADER = "app-version";
  private static final long MAIN_THREAD_WAIT_TIME = 0;
  private static final long CHILD_THREAD_WAIT_TIME = 5000;

  @RequestMapping(value = "/async", method = RequestMethod.GET)
  public void test(HttpServletRequest request) {
    log.info("Main thread: " + request.getHeader(HEADER));
    TestVo testVo = new TestVo(request.getHeader(HEADER));

    new Thread(() -> {
      try {
        Thread.sleep(CHILD_THREAD_WAIT_TIME);
      } catch (Throwable e) {

      }
      log.info("Child thread: " + request.getHeader(HEADER) + ", testVo = " + testVo.getAppVersion());
    }).start();

    try {
      Thread.sleep(MAIN_THREAD_WAIT_TIME);
    } catch (Throwable e) {

    }
  }

  @Data
  @AllArgsConstructor
  public static class TestVo {
    private String appVersion;
  }
}

再按照"app-version"為1.0.1發(fā)送請求后得到：

Main thread: 1.0.1
Child thread: null, testVo = 1.0.1

嗯，終于成功了。

故事似乎到此就結束了，但如果仔細考察細節(jié)的話，有幾個問題是值得思考的：

如果child thread中的request已經(jīng)被銷毀了，為什么沒有報null exception，而只是獲取到空的"app-version"的值？
如果request被銷毀了，TestVo這個同樣在主線程中創(chuàng)建的object為什么沒有被銷毀？
主線程真的可以銷毀對象嗎？銷毀對象不是GC負責的嗎，為什么總是可以在child thread中得到null的結果？

一個合理的推理是：主線程結束時，調用了一個 destroy() 方法，這個方法主動將 HttpServletRequest 中的資源釋放，例如調用了存放header的map對應的 clear() 方法。如此，在子線程中便無法獲得之前的"app-version"所對應的value了。而TestVo由于是用戶自己創(chuàng)建，必然不可能實現(xiàn)在 destroy() 方法中寫出釋放資源的代碼。它的值也就保存下來了。

另外，無論主線程是否調用了 destroy() 方法，真正回收的時候還是GC的工作，這也就解釋了在子線程中不是報null exception，而只是取不到特定的key所對應的值。

進一步，我們還可以思考的問題是，為什么在主線程的 destoy() 方法中，不直接將request對象賦值為null呢？

這個問題看似有些蹊蹺，而實則根本不成立。因為就算你把主線程的request變量賦值為null時，子線程中的另一個變量已經(jīng)指向了這個request對應的內存，依舊可以拿到相應的值。例如：

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {

  private static final String HEADER = "app-version";
  private static final long MAIN_THREAD_WAIT_TIME = 5000;
  private static final long CHILD_THREAD_WAIT_TIME = 3000;

  @RequestMapping(value = "/async", method = RequestMethod.GET)
  public void test(HttpServletRequest request) {
    log.info("Main thread: " + request.getHeader(HEADER));
    TestVo testVo = new TestVo(request);

    new Thread(() -> {
      try {
        Thread.sleep(CHILD_THREAD_WAIT_TIME);
      } catch (Throwable e) {

      }
      log.info("Child thread: " + testVo.getRequest().getHeader(HEADER));
    }).start();

    request = null;

    try {
      Thread.sleep(MAIN_THREAD_WAIT_TIME);
    } catch (Throwable e) {

    }
  }

  @Data
  @AllArgsConstructor
  public static class TestVo {
    private HttpServletRequest request;
  }
}

按照"app-version"為1.0.1發(fā)送請求后得到：