spring boot中支持使用java Web三大组件(servlet、listener和filter),但是坑比较多,主要是spring boot内嵌tomcat和独立tomcat服务器有一些细节上的不同,踩完之后,特有此记。
首先说明下,需要实现的功能,网站中有一些需要进行中英文对照的东西,一开始是写在properties配置文件中,经常修改的话,非常麻烦,还需要重启服务器。
初步考虑觉得采用ServletConetext监听器的触发,从mysql表中加载所以中英文对照数据,存入map,保存在ServletContext中,这种方式简单有效,缺点在于如果一旦改动,就需要重启tomcat。
进一步的想法是采用HttpSessionListener监听器,每个用户开始会话的session创建阶段,获取一次map,保存到ServletContext,所有的request都从全局变量ServletContext取,只存一份,实时更新,即使有变化也无需重启服务器。
一、spring boot内嵌服务器
1.session监听器的实现
@WebListener
public class MyHttpSessionListener implements HttpSessionListener {
@Autowired
private AppMetaService appMetaService; @Override
public void sessionCreated(HttpSessionEvent httpSessionEvent) {
Map<String, String> keyMap = appMetaService.getKeyMap();
ServletContext servletContext = httpSessionEvent.getSession().getServletContext();
servletContext.setAttribute("keyMap",keyMap);
} @Override
public void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
}
}
2.session监听无效
这里有一个问题,发现controller中的请求并不会主动生成session,默认情况下session监听器什么也监听不到。所以需要在每次请求时,手动调用request.getSession触发session的创建。
由于每次请求都需要这些动作,因此我把它加入到了一个过滤器中。
@WebFilter(urlPatterns = "/*")
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
/**
* 在servlet过滤器中触发getSession方法,一次编写,多处使用
*/
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
request.getSession(true);
filterChain.doFilter(request, servletResponse);
} @Override
public void destroy() { }
}
3.内嵌服务器支持
Servlet、Filter、Listener可以直接通过@WebServlet、@WebFilter、@WebListener注解自动注册,无需其他代码。唯一需要的就是在项目的入口类中加一个注解@ServletComponentScan,顾名思义,它会扫描所有的
@WebServlet、@WebFilter、@WebListener完成对象的注入。
@SpringBootApplication
@ServletComponentScan
public class DataboardApplication { public static void main(String[] args) {
SpringApplication.run(DataboardApplication.class, args);
}
}
到此为止,简洁明了,不废话,本地测试成功,直接上tomcat服务器。
二、独立tomcat服务器
最大的坑来了,在本地跑的很正常的程序,在服务器上跑不动,最奇怪的是有些接口能用,有些不能用,经过多方观察,发现用到servlet、listener和filter的都挂了。
搜了很多资料之后,还是在spring boot 2.01的文档中找到这么一句话:
Tip
@ServletComponentScan has no effect in a standalone container, where the container’s builtin
discovery mechanisms are used instead.
翻译一下就是@ServletComponentScan这个注解在独立tomcat服务器不可用。
只好退求其次,采用@Bean注入的方式
1.对应的监听器代码
@Component
public class MyHttpSessionListener implements HttpSessionListener {
@Autowired
private AppMetaService appMetaService; @Override
public void sessionCreated(HttpSessionEvent httpSessionEvent) {
Map<String, String> keyMap = appMetaService.getKeyMap();
ServletContext servletContext = httpSessionEvent.getSession().getServletContext();
servletContext.setAttribute("keyMap",keyMap);
} @Override
public void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
}
}
2.对应过滤器代码
@Component
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
/**
* 在servlet过滤器中触发getSession方法,一次编写,多处使用
*/
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
request.getSession(true);
filterChain.doFilter(request, servletResponse);
} @Override
public void destroy() { }
}
3.启动类代码
@SpringBootApplication
public class DataboardApplication {
@Bean
public ServletListenerRegistrationBean sessionHandler() {
return new ServletListenerRegistrationBean<>(new MyHttpSessionListener());
} @Bean
public FilterRegistrationBean myFilter() {
FilterRegistrationBean myFilter = new FilterRegistrationBean(new MyFilter());
myFilter.addUrlPatterns("/*");
return myFilter;
} public static void main(String[] args) {
SpringApplication.run(DataboardApplication.class, args);
}
}
这里变化最大,去掉了@ServletComponentScan,在类内部增加了两个生成bean的方法。