Spring5入门与实践web编程之Servlet3.0简介

Spring提供了一套完整的MVC的解决方案，在新版本中已经基本上用java的Annotation来替换了xml，所以以后的内容都只会基于Annotation来进行设置，spring的MVC的利用了一些Servlet3.0的特性，所以为了很好的理解SpringMVC，我们首先要介绍一下Servlet3.0的一些应用

Servlet3.0已经利用Annotation来进行配置，此时已经不再需要曾经的web.xml了，应用的第一步是创建一个web项目并且，引入相应的依赖和添加jetty的插件

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.konghao.mvc</groupId>
  <artifactId>hello-mvc</artifactId>
  <packaging>war</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>hello-mvc Maven Webapp</name>
  <url>http://maven.apache.org</url>
  <dependencies>
    <!--省略其他依赖-->
      <!-- servlet3.1.0的依赖 -->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.0.1</version>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-maven-plugin</artifactId>
        <version>9.4.8.v20171121</version>
        <configuration>
          <scanIntervalSeconds>10</scanIntervalSeconds>
          <webApp>
            <contextPath>/test</contextPath>
          </webApp>
          <httpConnector>
            <port>8888</port>
          </httpConnector>
        </configuration>
      </plugin>
      <!--省略其他插件-->
    </plugins>
  </build>
</project>

创建一个Servlet，通过@WebServlet来进行一些设置

@WebServlet("/hello")
public class HelloServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
        resp.setContentType("text/html;charset=utf-8");
        System.out.println("hello world!");
        resp.getWriter().println("hello world!");
    }
}

下面一个例子将会基于@WebServlet来做原来web.xml中可以做的配置

@WebServlet(value = "/base",name = "baseServlet",
    initParams = {@WebInitParam(name = "test",value = "testValue")},
    loadOnStartup = 2)
public class BaseServlet extends HttpServlet {
    @Override
    public void init(ServletConfig config) throws ServletException {
        System.out.println(config.getInitParameter("test"));
        System.out.println("already run baseServlet");
    }

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.getWriter().println("base servlet already run!");
    }
}

同样的一种方法可以直接用在Filter和Listener中，下面是Filter和Listener两个实例

@WebFilter("/*")
public class CharFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
                         FilterChain chain) throws ServletException,IOException{
        System.out.println(".............");
        request.setCharacterEncoding("UTF-8");
        chain.doFilter(request,response);
    }

    @Override
    public void destroy() {

    }
}

对于Filter而言只要@WebFilter即可，同样也有InitParameter这些设置。

对于Listener而言也是同样设置

@WebListener
public class BaseListener implements ServletContextListener{

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("listener-------------------------");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {

    }
}

完全基于Annotation最大的有点就是可以支持以组件的形式插入，开发人员可以将一些servlet或者Listener打成一个jar包，直接在项目中引用即可，这样就比web.xml的方式要方便一些。

动态注册

在servlet3.0中提供动态注册的方式，动态注册都是在项目启动的时候注册，第一种简单的动态注册可以在一个Listener中进行，在Servlet3.0之后ServletContext提供了addServlet方法来动态添加，先演示一个基于Listener的动态注册Servlet，操作非常简单

//该servlet并没有添加@WebServlet
public class DynamicServlet extends HttpServlet{
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setContentType("text/html;charset=utf-8");
        resp.getWriter().println("dynamic register web");
    }
}

//创建一个Listener来注册以上Servlet
@WebListener
public class ServletInitListener implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        //动态注册一个Servlet
        ServletRegistration.Dynamic sd = sce.getServletContext()
                .addServlet("dynamicServlet",DynamicServlet.class);
        //添加一个url
        sd.addMapping("/dynamic");
        //设置初始化参数
        sd.setInitParameter("test","value");
        //设置启动项
        sd.setLoadOnStartup(2);
    }

}

在以上方法中演示了Servlet的注册，其中初始化参数和loadOnStartup都不是必须的，这里仅仅只是演示了这种用法而已。

这里需要特别强调另外一种用法就是基于javax.servlet.ServletContainerInitializer的用法，Servlet3.0之后提供了这个接口在项目启动之前来做一些注册操作。

@HandlesTypes({HttpServlet.class, Filter.class})
public class ServletInit implements ServletContainerInitializer {

    @Override
    public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {
        for(Class clz:c) {
            System.out.println(clz.getName());
        }
    }
}

最主要代码是@HandlesTypes，这里写了在onStartup中第一个参数Set中所检测到类，上例会检查项目中所有的Servlet和Filter，这些类都会存储在第一个参数c中，我们可以根据需求使用ServletContext的addServlet和addFilter方法将其添加到启动加载项中。写完这个类之后，需要在资源文件夹/resources/META-INF/services中添加一个javax.servlet.ServletContainerInitializer,在该文件中指定ServletInit

org.konghao.web.ServletInit

这一部分简单介绍了servlet3.0的基本应用，这对于下一部分讲解的spring 的web编程有一定的帮助。