Java實現一個簡單的長輪詢的示例代碼

分析一下長輪詢的實現方式

現在各大中間件都使用瞭長輪詢的數據交互方式,目前比較流行的例如Nacos的配置中心,RocketMQ Pull(拉模式)消息等,它們都是采用瞭長輪詢方的式實現。就例如Nacos的配置中心,如何做到服務端感知配置變化實時推送給客戶端的呢?

長輪詢與短輪詢

說到長輪詢,肯定存在和它相對立的,我們暫且叫它短輪詢吧,我們簡單介紹一下短輪詢:

短輪詢也是拉模式。是指不管服務端數據有無更新,客戶端每隔定長時間請求拉取一次數據,可能有更新數據返回,也可能什麼都沒有。如果配置中心使用這樣的方式,會存在以下問題:

由於配置數據並不會頻繁變更,若是一直發請求,勢必會對服務端造成很大壓力。還會造成推送數據的延遲,比如:每10s請求一次配置,如果在第11s時配置更新瞭,那麼推送將會延遲9s,等待下一次請求;

無法在推送延遲和服務端壓力兩者之間中和。降低輪詢的間隔,延遲降低,壓力增加;增加輪詢的間隔,壓力降低,延遲增高。

長輪詢為瞭解決短輪詢存在的問題,客戶端發起長輪詢,如果服務端的數據沒有發生變更,會hold住請求,直到服務端的數據發生變化,或者等待一定時間超時才會返回。返回後,客戶端再發起下一次長輪詢請求監聽。

這樣設計的好處:

  • 相對於低延時,客戶端發起長輪詢,服務端感知到數據發生變更後,能立刻返回響應給客戶端。
  • 服務端的壓力減小,客戶端發起長輪詢,如果數據沒有發生變更,服務端會hold住此次客戶端的請求,hold住請求的時間一般會設置到30s或者60s,並且服務端hold住請求不會消耗太多服務端的資源。

下面借用圖片來說明一下流程:

  • 首先客戶端發起長輪詢請求,服務端收到客戶端的請求,這時會掛起客戶端的請求,如果在服務端設計的30s之內都沒有發生變更,服務端會響應回客戶端數據沒有變更,客戶端會繼續發送請求。
  • 如果在30s之內服務數據發生瞭變更,服務端會推送變更的數據到客戶端。

配置中心長輪詢設計

上面我們已經介紹瞭整個思路,下面我們用代碼實現一下:

  • 首先客戶端發送一個HTTP請求到服務端;服務端會開啟一個異步線程,如果一直沒有數據變更會掛起當前請求(一個 Tomcat 也就 200 個線程,長輪詢也不應該阻塞 Tomcat 的業務線程,所以需要配置中心在實現長輪詢時往往采用異步響應的方式來實現,而比較方便實現異步 HTTP 的常見手段便是 Servlet3.0 提供的 AsyncContext 機制。)
  • 在服務端設置的超時時間內仍然沒有數據變更,那就返回客戶端一個沒有變更的標識。例如響應304狀態碼;
  • 在服務端設置的超時時間內有數據變更瞭,就返回客戶端變更的內容;

配置中心長輪詢實現

下面用代碼實現長輪詢:

客戶端實現

 @Slf4j
 public class ConfigClientWorker {
 ​
     private final CloseableHttpClient httpClient;
 ​
     private final ScheduledExecutorService executorService;
 ​
     public ConfigClientWorker(String url, String dataId) {
         this.executorService = Executors.newSingleThreadScheduledExecutor(runnable -> {
             Thread thread = new Thread(runnable);
             thread.setName("client.worker.executor-%d");
             thread.setDaemon(true);
             return thread;
         });
 ​
         // ① httpClient 客戶端超時時間要大於長輪詢約定的超時時間
         RequestConfig requestConfig = RequestConfig.custom().setSocketTimeout(40000).build();
         this.httpClient = HttpClientBuilder.create().setDefaultRequestConfig(requestConfig).build();
 ​
         executorService.execute(new LongPollingRunnable(url, dataId));
     }
 ​
     class LongPollingRunnable implements Runnable {
 ​
         private final String url;
         private final String dataId;
 ​
         public LongPollingRunnable(String url, String dataId) {
             this.url = url;
             this.dataId = dataId;
         }
 ​
         @SneakyThrows
         @Override
         public void run() {
             String endpoint = url + "?dataId=" + dataId;
             log.info("endpoint: {}", endpoint);
             HttpGet request = new HttpGet(endpoint);
             CloseableHttpResponse response = httpClient.execute(request);
             switch (response.getStatusLine().getStatusCode()) {
                 case 200: {
                     BufferedReader rd = new BufferedReader(new InputStreamReader(response.getEntity()
                             .getContent()));
                     StringBuilder result = new StringBuilder();
                     String line;
                     while ((line = rd.readLine()) != null) {
                         result.append(line);
                     }
                     response.close();
                     String configInfo = result.toString();
                     log.info("dataId: [{}] changed, receive configInfo: {}", dataId, configInfo);
                     break;
                 }
                 // ② 304 響應碼標記配置未變更
                 case 304: {
                     log.info("longPolling dataId: [{}] once finished, configInfo is unchanged, longPolling again", dataId);
                     break;
                 }
                 default: {
                     throw new RuntimeException("unExcepted HTTP status code");
                 }
             }
             executorService.execute(this);
         }
     }
 ​
     public static void main(String[] args) throws IOException {
 ​
         new ConfigClientWorker("http://127.0.0.1:8080/listener", "user");
         System.in.read();
     }
 }
  • httpClient 客戶端超時時間要大於長輪詢約定的超時時間,不然還沒等到服務端返回,客戶端自己就超時瞭。
  • 304 響應碼標記配置未變更;
  • http://127.0.0.1:8080/listener 是服務端地址;

服務端實現

 @RestController
 @Slf4j
 @SpringBootApplication
 public class ConfigServer {
 ​
     @Data
     private static class AsyncTask {
         // 長輪詢請求的上下文,包含請求和響應體
         private AsyncContext asyncContext;
         // 超時標記
         private boolean timeout;
 ​
         public AsyncTask(AsyncContext asyncContext, boolean timeout) {
             this.asyncContext = asyncContext;
             this.timeout = timeout;
         }
     }
 ​
     // guava 提供的多值 Map,一個 key 可以對應多個 value
     private Multimap<String, AsyncTask> dataIdContext = Multimaps.synchronizedSetMultimap(HashMultimap.create());
 ​
     private ThreadFactory threadFactory = new ThreadFactoryBuilder().setNameFormat("longPolling-timeout-checker-%d")
             .build();
     private ScheduledExecutorService timeoutChecker = new ScheduledThreadPoolExecutor(1, threadFactory);
 ​
     // 配置監聽接入點
     @RequestMapping("/listener")
     public void addListener(HttpServletRequest request, HttpServletResponse response) {
 ​
         String dataId = request.getParameter("dataId");
 ​
         // 開啟異步!!!
         AsyncContext asyncContext = request.startAsync(request, response);
         AsyncTask asyncTask = new AsyncTask(asyncContext, true);
 ​
         // 維護 dataId 和異步請求上下文的關聯
         dataIdContext.put(dataId, asyncTask);
 ​
         // 啟動定時器,30s 後寫入 304 響應
         timeoutChecker.schedule(() -> {
             if (asyncTask.isTimeout()) {
                 dataIdContext.remove(dataId, asyncTask);
                 response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
               // 標志此次異步線程完成結束!!!
                 asyncContext.complete();
             }
         }, 30000, TimeUnit.MILLISECONDS);
     }
 ​
     // 配置發佈接入點
     @RequestMapping("/publishConfig")
     @SneakyThrows
     public String publishConfig(String dataId, String configInfo) {
         log.info("publish configInfo dataId: [{}], configInfo: {}", dataId, configInfo);
         Collection<AsyncTask> asyncTasks = dataIdContext.removeAll(dataId);
         for (AsyncTask asyncTask : asyncTasks) {
             asyncTask.setTimeout(false);
             HttpServletResponse response = (HttpServletResponse)asyncTask.getAsyncContext().getResponse();
             response.setStatus(HttpServletResponse.SC_OK);
             response.getWriter().println(configInfo);
             asyncTask.getAsyncContext().complete();
         }
         return "success";
     }
 ​
     public static void main(String[] args) {
         SpringApplication.run(ConfigServer.class, args);
     }
 }
  • 客戶端請求過來,首先開啟一個異步線程request.startAsync(request, response);保證不占用Tomcat線程。此時Tomcat線程以及釋放。配合asyncContext.complete()使用。
  • dataIdContext.put(dataId, asyncTask);會將 dataId 和異步請求上下文給關聯起來,方便配置發佈時,拿到對應的上下文
  • Multimap<String, AsyncTask> dataIdContext它是一個多值 Map,一個 key 可以對應多個 value,你也可以理解為 Map<String,List<AsyncTask>>
  • timeoutChecker.schedule() 啟動定時器,30s 後寫入 304 響應
  • @RequestMapping("/publishConfig") ,配置發佈的入口。配置變更後,根據 dataId 一次拿出所有的長輪詢,為之寫入變更的響應。
  • asyncTask.getAsyncContext().complete();表示這次異步請求結束瞭。

啟動配置監聽

先啟動 ConfigServer,再啟動 ConfigClient。30s之後控制臺打印第一次超時之後收到服務端304的狀態碼

 16:41:14.824 [client.worker.executor-%d] INFO cn.haoxiaoyong.poll.ConfigClientWorker - longPolling dataId: [user] once finished, configInfo is unchanged, longPolling again

請求一下配置發佈,請求localhost:8080/publishConfig?dataId=user&configInfo=helloworld

服務端打印日志:

 2022-08-25 16:45:56.663  INFO 90650 --- [nio-8080-exec-2] cn.haoxiaoyong.poll.ConfigServer         : publish configInfo dataId: [user], configInfo: helloworld

到此這篇關於Java實現一個簡單的長輪詢的示例代碼的文章就介紹到這瞭,更多相關Java長輪詢內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: