一、简介
使用spring MVC 框架后将很少使用 Servlet、Filter、Listener,但在某些特殊场合可能需要使用 Servlet、Filter、Listener,spring boot 对整合 Servlet、Filter、Listener 也提供了很好的支持。
二、流程
新建spring boot Web 项目
1.TestServlet.java
package com.vincent;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet("/testServlet")
public class TestServlet extends HttpServlet{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("TestServlet doGet");
}
}
2.TestFilter.java
package com.vincent;
import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
@WebFilter("/*")
public class TestFilter implements Filter{
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
System.out.println("TestFilter doFilter");
chain.doFilter(request, response);
}
}
3.TestContextListener.java
package com.vincent;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
@WebListener
public class TestContextListener implements ServletContextListener{
@Override
public void contextInitialized(ServletContextEvent sce) {
System.out.println("TestRequestListener contextInitialized");
}
}
4.启动类使用@ServletComponentScan修饰
package com.vincent;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
@SpringBootApplication
@ServletComponentScan
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
}
}
三、测试
启动项目并在浏览器访问:http://localhost:8080/testServlet
四.总结
使用ServletComponentScan注解扫描使用Servlet 3.0+ 规范标注的@WebServlet、@WebFilter、@Listener 注解的Servlet、Filter、Listener时将丧失Spring IOC 容器依赖注入能力,推荐使用Spring Web 提供的ServletRegistrationBean、FilterRegistrationBean、ServletListenerRegistrationBean 对Servlet、Filter、Listener的配置注入。
实例如下:
package com.vincent;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.servlet.*;
import java.io.IOException;
@SpringBootApplication
public class App {
public static void main(String[] args ) throws Exception {
SpringApplication.run(App.class,args);
}
@Configuration
static class CorsFilter{
@Bean
FilterRegistrationBean corsFilterRegistrationBean(){
FilterRegistrationBean filterBean = new FilterRegistrationBean();
filterBean.setFilter(new Filter() {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println(CorsFilter.class + "---------> doFilter");
filterChain.doFilter(servletRequest,servletResponse);
}
});
filterBean.addUrlPatterns("/*");
filterBean.setOrder(0);
return filterBean;
}
}
}
访问一个@RequestMapping handler后控制台效果如下: