这篇博客主要是总结一下通过spring-boot 整合servlet、filter、listener三个web中用到的重要组件。
在未使用spring-boot之前,当要使用到servlet 时需要一下几个步骤:
- 创建servlet类
- web.xml中加入servlet-name以及servlet-mapping标签
引入了spring-boot之后只需要几个annotation就能够完成以上操作,且能够让代码更容易被理解,维护起来更加简洁。
这一篇主要要介绍到以下几个注解
- @webServlet 用于注解servlet类,常用到的属性有name,urlpatterns
@WebServlet(name="FirstServlet",urlPatterns = "/first")
public class FirstServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println("firstServlet..............");
}
}
- @webFilter 用于注解filter类,常用到的属性有filterName,urlpatterns
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter(filterName = "FirstFilter",urlPatterns = "/first")
public class FirstFilter implements Filter {
private static final Logger logger = LoggerFactory.getLogger(FirstFilter.class);
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
logger.info("firstFilter............进来");
filterChain.doFilter(servletRequest, servletResponse);
logger.info("firstFilter............出去");
}
@Override
public void destroy() {
}
}
- @webListener 用于注解listener
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
@WebListener
public class FirstListener implements ServletContextListener {
@Override
public void contextInitialized(ServletContextEvent servletContextEvent) {
System.out.println("first listener ..............init");
}
@Override
public void contextDestroyed(ServletContextEvent servletContextEvent) {
System.out.println("first listener ..............destroy");
}
}
- @servletcomponentscan 用于注解启动类,加上该注解表示spring-boot会在当前包或者当前包的子包下查找servlet相关组件
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;
@SpringBootApplication
@ServletComponentScan
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
}
}
以上介绍的是spring-boot整合web组件的方式之一。是通过注解整合
还有一种是非注解整合的我也打算在这里稍微总结一下, 以为不时之需。
非注解方式与注解方式的不同点在于:
- servlet、filter、listener类上的注解全部不需要
- 需要在启动类添加方法分别对应返回ServletRegistrationBean/FilterRegistrationBean/ServletListenerRegistrationBean类,并且在方法上添加@Bean注解,即可将以上组件整合至spring-boot中
例如:
import com.zgp.filter.SecondFilter;
import com.zgp.servlet.SecondServlet;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
@SpringBootApplication
public class App2 {
public static void main(String[] args) {
SpringApplication.run(App2.class,args);
}
@Bean
public ServletRegistrationBean getServletRegistrationBean() {
return new ServletRegistrationBean(new SecondServlet(), "/second");
}
@Bean
public FilterRegistrationBean getFilterRegistrationBean() {
FilterRegistrationBean bean = new FilterRegistrationBean(new SecondFilter());
bean.addUrlPatterns("/second");
return bean;
}
}
这两种方式的个人比较倾向于注解, 重点是因为懒! 没错,就是因为懒,不懒谁用spring-boot啊!