Spring MVC基础-服务端推送技术
【博文目录>>>】
【项目源码>>>】
【服务端推送技术】
服务端推送技术在我们日常开发中较为常用,可能早期很多人的解决方案是使用Ajax 向服务器轮询消息,使浏览器尽可能第一时间获得服务端的消息,因为这种方式的轮询频率不好控制,所以大大增加了服务端的压力。
本案例所有的服务器端推送的方案都是基于:当客户端向服务端发送请求,服务端会抓住这个请求不放,等有数据更新的时候才返回给客户端,当客户端接收到消息后,再向服务端发送请求,周而复始。这种方式的好处是减少了服务器的请求数量,大大减少了服务器的压力。
除了服务器端推送技术以外,还有一个另外的双向通信的技术——WebSocket,本示例将提供基于SSE (Server Send Event 服务端发送事件)的服务器端推送和基于Servlet 3.0+的异步方法特性,其中第一种方式需要新式浏览器的支持,第二种方式是跨浏览器的。
【代码实现】
package com.example.spring.framework.serverpush.controller;
import com.example.spring.framework.serverpush.service.PushService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.context.request.async.DeferredResult;
/**
* 异步任务的实现是通过控制器从另外一个线程返回一个DeferredResult,这里的
* DeferredResult 是从pushService 中获得的。
* Author: 王俊超
* Date: 2017-07-14 07:44
* All Rights Reserved !!!
*/
@Controller
public class AsyncController {
@Autowired
PushService pushService; // ①定时任务,定时更新DeferredResulto
@RequestMapping("/defer")
@ResponseBody
public DeferredResult<String> deferredCall() {
return pushService.getAsyncUpdate(); // ②返回给客户端DeferredResulto
}
}
package com.example.spring.framework.serverpush.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.Random;
/**
* Author: 王俊超
* Date: 2017-07-14 07:34
* All Rights Reserved !!!
*/
@Controller
public class SeeController {
/**
* ①注意,这里使用输出的媒体类型为text/event-stream ,这是服务器端SSE 的支持,
* 本例演示每5 秒钟向浏览器推送随机消息。
*/
@RequestMapping(value = "/push", produces = "text/event-stream;charset=UTF-8")
public @ResponseBody
String push() {
Random r = new Random();
try {
Thread.sleep(5000);
} catch (InterruptedException e) {
e.printStackTrace();
}
return "data:Testing 1,2,3,...," + r.nextInt() + "\n\n";
}
}
package com.example.spring.framework.serverpush.service;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Service;
import org.springframework.web.context.request.async.DeferredResult;
/**
* Author: 王俊超
* Date: 2017-07-14 07:45
* All Rights Reserved !!!
*/
@Service
public class PushService {
private DeferredResult<String> deferredResult;
public DeferredResult<String> getAsyncUpdate() {
deferredResult = new DeferredResult<>();
return deferredResult;
}
/**
* ①在PushService 里产生DeferredResult ~合控制器使用,通过@Scheduled
* 注解的方法定时更新DeferredResulto
*/
@Scheduled(fixedDelay = 5000)
public void refresh() {
if (deferredResult != null) {
deferredResult.setResult(Long.toString(System.currentTimeMillis()));
}
}
}
package com.example.spring.framework.serverpush.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.view.InternalResourceViewResolver;
import org.springframework.web.servlet.view.JstlView;
/**
* Author: 王俊超
* Date: 2017-07-12 07:22
* All Rights Reserved !!!
*/
@Configuration
@EnableWebMvc
@EnableScheduling
@ComponentScan("com.example.spring.framework.serverpush")
public class MyMvcConfig extends WebMvcConfigurerAdapter{
@Bean
public InternalResourceViewResolver viewResolver() {
InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
viewResolver.setPrefix("/WEB-INF/classes/views/");
viewResolver.setSuffix(".jsp");
viewResolver.setViewClass(JstlView.class);
return viewResolver;
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/assets/**").addResourceLocations("classpath:/assets/");
super.addResourceHandlers(registry);
}
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/see").setViewName("/see");
registry.addViewController("/async").setViewName("/async");
}
}
package com.example.spring.framework.serverpush;
import com.example.spring.framework.serverpush.config.MyMvcConfig;
import org.springframework.web.WebApplicationInitializer;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.servlet.DispatcherServlet;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;
/**
* Author: 王俊超
* Date: 2017-07-11 21:51
* All Rights Reserved !!!
*/
public class WebInitializer implements WebApplicationInitializer {
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
ctx.register(MyMvcConfig.class);
ctx.setServletContext(servletContext);
ServletRegistration.Dynamic servlet = servletContext.addServlet("dispatcher",
new DispatcherServlet(ctx));
servlet.addMapping("/");
servlet.setLoadOnStartup(1);
// 开启异步方法支持
servlet.setAsyncSupported(true);
}
}
async.jsp
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>servlet async support</title>
</head>
<body>
<script type="text/javascript" src="assets/js/jquery.js"></script>
<script type="text/javascript">
deferred();//1
// 递归方法
function deferred() {
$.get('defer', function (data) {
console.log(data); //2
deferred(); //3
});
}
</script>
</body>
</html>
see.jsp
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SSE Demo</title>
</head>
<body>
<div id="msgFrompPush"></div>
<script type="text/javascript" src="<c:url value="assets/js/jquery.js" />"></script>
<script type="text/javascript">
// ①EventSource 对象只有新式的浏览器才有( Chrome 、Firefox )等,EventSource 是SSE的客户端;
if (!!window.EventSource) { //1
var source = new EventSource('push');
s = '';
// ②添加SSE 客户端监呀,在此获得服务器端推送的消息。
source.addEventListener('message', function (e) {
s += e.data + "<br/>";
$("#msgFrompPush").html(s);
});
source.addEventListener('open', function (e) {
console.log("连接打开.");
}, false);
source.addEventListener('error', function (e) {
if (e.readyState == EventSource.CLOSED) {
console.log("连接关闭");
} else {
console.log(e.readyState);
}
}, false);
} else {
console.log("你的浏览器不支持SSE");
}
</script>
</body>
</html>