servlet3.0异步+Spring DeferredResult +apollo的长轮询

今天看apollo官网，看到Config Service通知客户端的长轮询实现原理部分，学习了一下。

基础原理：

https://blog.youkuaiyun.com/wangxindong11/article/details/78591396 servlet3异步原理与实践 （写的很清楚的一篇文章，同时还写了spring的DeferredResult）

https://www.cnblogs.com/jiaoyiping/p/5979242.html 关于servlet3.0中的异步servlet

https://www.cnblogs.com/davenkin/p/async-servlet.html Servlet 3.0/3.1 中的异步处理

 

spring的DeferredResult相关

https://www.jianshu.com/p/acd4bbd83314 Spring MVC异步处理-DeferedResult使用 （反面教材文章，说的是容器主线程要阻塞，其实刚好说错，容器主线程不会阻塞）

https://www.cnblogs.com/aheizi/p/5659030.html 理解Callable 和 Spring DeferredResult（翻译）

servlet3.0异步机制实现的长轮询

（以下3篇文章都是和apollo的长轮询实现差不多，想了解apollo怎么具体实现的，官网的Apollo配置中心设计 这一篇有说明）

https://blog.youkuaiyun.com/liuchangqing123/article/details/76599534 基于servlet3实现长轮询

https://blog.youkuaiyun.com/xiejiefeng333/article/details/84105685 Spring使用DeferredResult实现长连接

https://blog.youkuaiyun.com/xiao_jun_0820/article/details/82956593 通过spring提供的DeferredResult实现长轮询服务端推送消息

个人总计：servlet的异步，就是客户端发起一个请求到服务器，然后客户端一直就等待服务器的io返回，服务器这个时候主线程会切换出去干其他事情，直到这个请求结果出来之后再返回给客户端，这样服务器的线程资源就不必一直被这个请求占用。而spring的DeferredResult长轮询也是利用这个机制，DeferredResult有一个超时时间，在超时之前，往DeferredResult set值进去就算是正常返回，客户端就可以立即得到响应并进行处理，处理完成后又进行下一次的调用；如果超时了，就返回一个特殊的状态码如304给客户端；客户端如果看到304说明这段时间内没有需要返回给他的，那么他就继续进行下一次的调用；效果就像是客户端一直长连接在服务器上一样，服务器端有任何需要通知客户端的信息，就能够立即通知到客户端，并且服务器端只有io是一直有一个连接打开，线程是不会被阻塞在那里的，效率也很高；

参考上面3个文章自己写的范例,亲测有效：

package com.feiynn.study.springboot.web;


import com.google.common.collect.HashMultimap;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.async.DeferredResult;

import java.util.Collection;

/**
 *  模拟Config Service通知客户端的长轮询实现原理
 */
@RestController
public class ApolloController {
	private final Logger logger = LoggerFactory.getLogger(this.getClass());

	//guava中的Multimap，多值map,对map的增强，一个key可以保持多个value
	private Multimap<String, DeferredResult<String>> watchRequests = Multimaps.synchronizedSetMultimap(HashMultimap.create());


	/**
	 * 模拟长轮询
	 */
	@RequestMapping(value = "/watch/{namespace}", method = RequestMethod.GET, produces = "text/html")
	public DeferredResult<String> watch(@PathVariable("namespace") String namespace) {
		logger.info("Request received");
		ResponseEntity<String>
				NOT_MODIFIED_RESPONSE = new ResponseEntity<>(HttpStatus.NOT_MODIFIED);
		DeferredResult<String> deferredResult = new DeferredResult<>(5000L,NOT_MODIFIED_RESPONSE);
		//当deferredResult完成时（不论是超时还是异常还是正常完成），移除watchRequests中相应的watch key
		deferredResult.onCompletion(() -> {
			logger.info("remove key:" + namespace);
			watchRequests.remove(namespace, deferredResult);
		});
		deferredResult.onTimeout(()->{
			logger.info("onTimeout()" );
		});
		watchRequests.put(namespace, deferredResult);
		logger.info("Servlet thread released");
		return deferredResult;
	}

	//模拟发布namespace配置
	@RequestMapping(value = "/publish/{namespace}", method = RequestMethod.GET, produces = "text/html")
	public Object publishConfig(@PathVariable("namespace") String namespace) {
		if (watchRequests.containsKey(namespace)) {
			Collection<DeferredResult<String>> deferredResults = watchRequests.get(namespace);
			Long time = System.currentTimeMillis();
			//通知所有watch这个namespace变更的长轮训配置变更结果
			for (DeferredResult<String> deferredResult : deferredResults) {
				//deferredResult一旦执行了setResult()方法，就说明DeferredResult正常完成了，会立即把结果返回给客户端
				deferredResult.setResult(namespace + " changed:" + time);
			}
		}
		return "success";

	}
}