springMvc中DeferredResult的long polling應用示例解析

Posted on by

1.瞭解servlet以及spring mvc中的異步

Spring MVC 3.2開始引入瞭基於Servlet 3的異步請求處理。相比以前，控制器方法已經不一定需要返回一個值，而是可以返回一個java.util.concurrent.Callable的對象，並通過Spring MVC所管理的線程來產生返回值。與此同時，Servlet容器的主線程則可以退出並釋放其資源瞭，同時也允許容器去處理其他的請求。通過一個TaskExecutor，Spring MVC可以在另外的線程中調用Callable。當Callable返回時，請求再攜帶Callable返回的值，再次被分配到Servlet容器中恢復處理流程。以下代碼給出瞭一個這樣的控制器方法作為例子：

@RequestMapping(method=RequestMethod.POST)
public CallableprocessUpload(final MultipartFile file) {
    return new Callable() {
        public String call() throws Exception {
            // ...
            return "someView";
        }
    };
}

另一個選擇，是讓控制器方法返回一個DeferredResult的實例。這種場景下，返回值可以由任何一個線程產生，也包括那些不是由Spring MVC管理的線程。舉個例子，返回值可能是為瞭響應某些外部事件所產生的，比如一條JMS的消息，一個計劃任務，等等。以下代碼給出瞭一個這樣的控制器作為例子：

@RequestMapping("/quotes")
@ResponseBody
public DeferredResultquotes() {
    DeferredResultdeferredResult = new DeferredResult();
    // Save the deferredResult somewhere..
    return deferredResult;
}
    // In some other thread...
    deferredResult.setResult(data);

如果對Servlet 3.0的異步請求處理特性沒有瞭解，理解這個特性可能會有點困難。因此，閱讀一下前者的文檔將會很有幫助。

以下給出瞭這個機制運作背後的一些原理：

一個servlet請求ServletRequest可以通過調用request.startAsync()方法而進入異步模式。這樣做的主要結果就是該servlet以及所有的過濾器都可以結束，但其響應（response）會留待異步處理結束後再返回調用request.startAsync()方法會返回一個AsyncContext對象，可用它對異步處理進行進一步的控制和操作。比如說它也提供瞭一個與轉向（forward）很相似的dispatch方法，隻不過它允許應用恢復Servlet容器的請求處理進程ServletRequest提供瞭獲取當前DispatherType的方式，後者可以用來區別當前處理的是原始請求、異步分發請求、轉向，或是其他類型的請求分發類型。

有瞭上面的知識，下面可以來看一下Callable的異步請求被處理時所依次發生的事件：

  • 控制器先返回一個Callable對象
  • Spring MVC開始進行異步處理，並把該Callable對象提交給另一個獨立線程的執行器TaskExecutor處理
  • DispatcherServlet和所有過濾器都退出Servlet容器線程，但此時方法的響應對象仍未返回
  • Callable對象最終產生一個返回結果，此時Spring MVC會重新把請求分派回Servlet容器，恢復處理
  • DispatcherServlet再次被調用，恢復對Callable異步處理所返回結果的處理
  • 對DeferredResult異步請求的處理順序也非常類似，區別僅在於應用可以通過任何線程來計算返回一個結果：
  • 控制器先返回一個DeferredResult對象，並把它存取在內存（隊列或列表等）中以便存取
  • Spring MVC開始進行異步處理
  • DispatcherServlet和所有過濾器都退出Servlet容器線程，但此時方法的響應對象仍未返回
  • 由處理該請求的線程對 DeferredResult進行設值，然後Spring MVC會重新把請求分派回Servlet容器，恢復處理
  • DispatcherServlet再次被調用，恢復對該異步返回結果的處理

2.簡述polling和long polling的區別

這裡暫拋開某些場景webSocket的解決方案。

舉一個生活中的列子來說明長輪詢比輪詢好在哪裡：電商雲集的時代，大傢肯定都有查詢快遞的經歷，怎麼最快知道快遞的進度呢？polling和long polling的方式分別如下：

  • polling：如果我想在兩分鐘內看到快遞的變化，那麼，輪詢會每隔兩分鐘去像服務器發起一次快遞變更的查詢請求，如果快遞其實是一個小時變更一次，那麼polling的方式在獲取一次真實有效信息時需要發起30次
  • long polling：首先發起查詢請求，服務端沒有更新的話就不回復，直到一個小時變更時才將結果返回給客戶，然後客戶發起下次查詢請求。長輪詢保證瞭每次發起的查詢請求都是有效的，極大的減少瞭與服務端的交互，基於web異步處理技術，大大的提升瞭服務性能

如果在發散的觸類旁通一下，long polling的方式和發佈訂閱的模式有點類似之處，隻是每次拿到瞭發佈的結果之後需要再次發起消息訂閱

3.因為DeferredResult，所以long polling

因為DeferredResult技術，所以使得long polling不會一直占用容器資源，使得長輪詢成為可能。長輪詢的應用有很多，簡述下就是：需要及時知道某些消息的變更的場景都可以用長輪詢來解決，當然，你可能又想起瞭發佈訂閱瞭，哈哈

  • 比如：在線聊天？一個服務端，多個客戶端，服務端管理所有的人的消息，客戶端向服務端發起給自己的消息的請求，服務端處理後給返回，然後客戶端再次發起？
  • 在比如類發佈訂閱的例子：配置中心服務，當配置中心的配置變更好，相關的客戶端程序需要及時更新最新的配置。disconf就是基於zookeeper的發佈訂閱來做的，apollo就是采用的DeferredResult的long polling來做的，客戶端發起長輪詢，配置中心監聽器監聽到配置變更後，將結果響應給客戶端。

apollo的具體做法可見

  • 服務端：com/ctrip/framework/apollo/configservice/controller/NotificationControllerV2.java 
  • 客戶端：com/ctrip/framework/apollo/internals/RemoteConfigLongPollService.java

4.簡單的測試用例

多個請求的結果，使用另一個請求控制他的響應返回。本實例構建在spring boot 1.5.7上。

1.定義異步接口

/**
 * Created by kl on 2017/9/27.
 * Content :
 */
@RestController
@RequestMapping("/async")
public class AsyncController {
    final Map deferredResultMap=new ConcurrentReferenceHashMap<>();
    @GetMapping("/longPolling")
    public DeferredResultlongPolling(){
        DeferredResultdeferredResult=new DeferredResult(0L);
        deferredResultMap.put(deferredResult.hashCode(),deferredResult);
        deferredResult.onCompletion(()->{
            deferredResultMap.remove(deferredResult.hashCode());
            System.err.println("還剩"+deferredResultMap.size()+"個deferredResult未響應");
        });
        return deferredResult;
    }
    @GetMapping("/returnLongPollingValue")
    public void returnLongPollingValue(){
        for (Map.Entry entry:deferredResultMap.entrySet()){
            entry.getValue().setResult("kl");
        }
    }
}

2.定義接口訪問實例，使用fegin

/**
 * Created by kl on 2017/9/27.
 * Content :
 */
@FeignClient(url = "localhost:8976",name = "async")
public interface AsyncFeginService {
    @GetMapping("/async/longPolling")
    String longPolling();
    @GetMapping("/async/returnLongPollingValue")
     void returnLongPollingValue();
}

3.測試用例

@RunWith(SpringRunner.class)
@SpringBootTest
public class LongPollingdemoApplicationTests {
	@Autowired
	AsyncFeginService asyncFeginService;
	/**
	 * 模擬多個瀏覽器客戶端發起長輪詢請求，等待testLongPolling測試用例請求通知服務端返回各瀏覽器的請求結果
	 * @throws Exception
	 */
	@Test
	public void contextLoads() throws Exception{
		ExecutorService executorService=Executors.newFixedThreadPool(4);
		for (int i=0;i<=3;i++){
			executorService.execute(()->{
				String kl=asyncFeginService.longPolling();
				System.err.println("收到響應："+kl);
			});
		}
		System.in.read();
	}
	/**
	 * 通知服務端返回上個測試的長輪詢結果
	 */
	@Test
	public void testLongPolling(){
		asyncFeginService.returnLongPollingValue();
	}
}

測試時，先啟動contextLoads會發起四個異步請求，一直等待請求結果響應，直到testLongPolling通知服務端返回deferredResult的值。

以上就是springMvc中DeferredResult的long polling應用示例解析內容，更多關於springMvc DeferredResult的long polling應用的資料請關註WalkonNet其它相關文章！

推薦閱讀：