SpringBoot-18-注册Web原生组件

注册原生组件

    在Java Web阶段我们学过的Web原生组件有Servlet、Filter、Listener等，但在Spring Boot项目中我们的项目默认是以Jar包方式进行部署的，而不是war方式，所以默认没有web.xml,自然不能通过web.xml来配置使用原生组件，因此Spring Boot给我们提供了两种方式来注册这些原生组件。

• 使用RegistrationBean注册
• 通过注解扫描注册

1.使用RegistrationBean注册

我们可以通过配置类中使用RegistrationBean的实现类来注册原生Web组件，这种方式显得比较繁琐。

RegistrationBean是个抽象类，负责将组件注册到Servlet容器中，Spring 提供了三个它的实现类，分别用来注册 Servlet、Filter 和 Listener。

• ServletRegistrationBean：Servlet 的注册类
• FilterRegistrationBean：Filter 的注册类
• ServletListenerRegistrationBean：Listener 的注册类

实现

1.定义原生Web原生组件

• 创建自定义MyServlet1类

package com.liang.component;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;

public class MyServlet1 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setContentType("text/html;charset=UTF-8");
        //获得向文本输入的流
        PrintWriter writer = resp.getWriter();
        writer.write("SpringBoot Servlet1");
        //关闭写入流
        writer.close();
//        doPost(req, resp);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //设置响应请求的编码方式和文本内容
        System.out.println("hello");
        resp.setContentType("text/html;charset=UTF-8");
        //获得向文本输入的流
        PrintWriter writer = resp.getWriter();
        writer.write("SpringBoot Servlet");
        //关闭写入流
        writer.close();
    }
}

• 创建自定义MyFilter1类

package com.liang.component;

import javax.servlet.*;
import java.io.IOException;

public class MyFilter1 implements Filter {


    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("MyFilter1 初始化");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("MyFilter1 执行过滤中");
        chain.doFilter(request,response);
    }


    //摧毁
    @Override
    public void destroy() {
        System.out.println("MyFilter1 摧毁中");
    }

}

• 创建自定义MyListener2类

package com.liang.component;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

public class MyListener1 implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("MyListener1  内容初始化");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("MyListen1 内容销毁中");
    }
}

2.创建一个配置类MyConfig

    使用 @Bean 注解将 ServletRegistrationBean、FilterRegistrationBean 和 ServletListenerRegistrationBean 添加到 Spring 容器中，并分别使用它们注册我们自定义的 Servlet、Filter 和 Listener。

package com.liang.controller;


import com.liang.component.MyFilter1;
import com.liang.component.MyListener1;
import com.liang.component.MyServlet1;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.Arrays;

@Configuration
//这是一个配置类，用来配置原生web组件
public class MyConfig {

    //注册servlet
    @Bean
    public ServletRegistrationBean servletRegistrationBean()
    {
        System.out.println("进入创建Servlet");
        return new ServletRegistrationBean(new MyServlet1(),"/myServlet1");
    }

    //注册Filter过滤器
    @Bean
    public FilterRegistrationBean filterRegistrationBean()
    {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(new MyFilter1());
        // //注册该过滤器需要过滤的 url,使用Array.asList此方法得到的List的长度是不可改变的
        filterRegistrationBean.setUrlPatterns(Arrays.asList("/myServlet1"));
        return filterRegistrationBean;
    }

    //注册监听器
    @Bean
    public ServletListenerRegistrationBean servletListenerRegistrationBean()
    {
       return new ServletListenerRegistrationBean(new MyListener1());
    }
}

3.启动Spring Boot主启动类

得到测试结果

可以看出我们通过Registrartion注册web原生组件的方式实现了。

2. 通过组件扫描注册

Servlet 3.0 提供了以下3个注解:

• @WebServlet: 用来声明一个Servlet
• @WebFilter：用于声明一个 Filter；
• @WebListener：用于声明一个 Listener。

这些注解可直接标注在对应组件上，它们与在web.xml中的配置意义相同，每个注解都具有与web.xml对应的属性，可直接配置，省去了配置 web.xml 的繁琐。

除此之外，我们还需要使用@ServletComponentScan注解来扫描标记了以上注解的组件类，将它们祖册到容器中。

注意@ServletComponentScan注解只能标记在配置类或者启动类上

实现

1. 注册原生Web组件

• 使用@WebServlet注解声明一个自定义的MyServlet2

代码

package com.liang.component;


import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;

@WebServlet(name="myServlet2",urlPatterns = "/myServlet2")
public class MyServlet2 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doPost(req,resp);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //设置响应的文本和编码
        resp.setContentType("text/html;charset=UTF-8");
        PrintWriter writer = resp.getWriter();
        writer.write("SpringBoot MyServlet2");
        writer.close();
    }
}

• 使用@WebFilter注解声明一个自定义的MyFilter2

代码

package com.liang.component;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter("/myServlet2")
public class MyFilter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("MyFilter2初始化");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("MyFilter2执行过滤中");
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {
        System.out.println("MyFilter2摧毁中");
    }
}

• 使用 @WebListener 注解声明一个自定义的 MyListener2

代码

package com.liang.component;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

@WebListener
public class MyListener2 implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("Listener内容初始化");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("Listener内容摧毁中");
    }
}

2.启动Spring Boot 主启动类

在启动类使用@ServletComponentScan注解，扫描以上声明的Servlet、Filter和Listener,并将它们注册到容器中使用。

代码

package com.liang.component;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

@WebListener
public class MyListener2 implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("Listener内容初始化");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("Listener内容摧毁中");
    }
}

测试结果

可以知道通过注解扫描组件的方式注册web原生组件成功！