SpringBoot整合三大組件(Servlet、Listener、Filter)

更多資源和教程請關注公衆號:非科班的科班
如果覺得我寫的還可以請給個贊,謝謝大家,你的鼓勵是我創作的動力

3.SpringBoot整合Servlet

3.1.方式一

步驟:

  • 寫一個類MyFirstServlet繼承HttpServlet,並重寫doGet方法。
  • 在類的上面用@WebServlet標識Servlet並指明name和urlPatterns。
  • 在標識有@SpringBootApplication的主類上加上@ServletComponentScan。

FirstServlet.java

package com.example.servlet.myservlet;

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

/**
 *SpringBoot整合Servlet方式一
 *@WebServlet(name="MyFirstServlet",urlPatterns="/myFirst")相當於如下:
 *
 *<servlet>
 * <servlet-name>MyFirstServlet</servlet-name>
 * <servlet-class>ah.szxy.servlet.FirstServlet</servlet-class>
 *</servlet>
 *<servlet-mapping>
 * <servlet-name>MyFirstServlet</servlet-name>
 * <url-pattern>/first</url-pattern>
 *</servlet-mapping>
 *
 */

@WebServlet(name="MyFirstServlet",urlPatterns="/myFirst")
public class FirstServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("MyFirstServlet init............");
    }
}

ServletApplication.java

package com.example.servlet;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@SpringBootApplication
@ServletComponentScan //在springBoot啓動時會掃描@WebServlet,並將該類實例化
public class ServletApplication {

   public static void main(String[] args) {
      SpringApplication.run(ServletApplication.class, args);
   }

}

然後啓動項目
在這裏插入圖片描述

最後在瀏覽器輸入localhost:8080/myFirstServlet,頁面顯示空白,在控制檯打印MyFirstServlet init…

3.2.方式二

步驟:

  • 創建一個類SecondServlet繼承HttpServlet,並重寫doGet方法。
  • 在@SpringBootApplication標識的主類中加@Bean的一個方法。
    SecondServlet.java
package com.example.servlet.myservlet;

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

/**
 * 整合Servlet的第二種方式
 */
public class SecondServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("MySecondServlet init..........");
    }
}

ServletApplication.java

package com.example.servlet;

import com.example.servlet.myservlet.SecondServlet;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
//@ServletComponentScan //在springBoot啓動時會掃描@WebServlet,並將該類實例化
public class ServletApplication {

   public static void main(String[] args) {
      SpringApplication.run(ServletApplication.class, args);
   }


  /**
 * 整合Servlet的第二種方式,創建ServletRegistrationBean並添加路徑
 * @return
 */
@Bean
public ServletRegistrationBean getServletRegistrationBean(){
   ServletRegistrationBean bean = new ServletRegistrationBean(new SecondServlet());
   bean.addUrlMappings("/mySecond");
   return bean;
}

然後啓動項目,在瀏覽器中訪問localhost:8080/mySecondServlet,頁面也是空白,在控制檯就會打印MySecondServlet init…
在這裏插入圖片描述
項目,結構如圖所示
在這裏插入圖片描述

結論:

  • 上面的兩種方式推薦使用第一種基於註解的整合。
  • 雖然現在幾乎用不到servlet了,但是學習SpringBoot整合servlet有助於學習的深入瞭解,更好的理解框架。

4.SpringBoot整合Filter

4.1.方式一

步驟:

  • 創建一個MyFirstFilter類實現Filter接口,並在類上面標註@WebFilter。
  • 在@SpringBootApplication的主類上加上@ServletComponentScan註解。

MyFirstFilter.java

package com.example.servlet.myfilter;

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

/**
 * 基於@WebFilter註解整合Filter方式一
 */
@WebFilter(filterName = "MyFirstFilter",urlPatterns = "/myFirst")
public class MyFirstFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2) throws IOException, ServletException {
        System.out.println("進入Filter中了.....");
        arg2.doFilter(arg0,arg1);
        System.out.println("離開Filter了.......");
    }

    @Override
    public void destroy() {

    }
}

ServletApplication.java

package com.example.servlet;

import com.example.servlet.myservlet.SecondServlet;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
@ServletComponentScan //在springBoot啓動時會掃描@WebServlet,並將該類實例化
public class ServletApplication {

   public static void main(String[] args) {
      SpringApplication.run(ServletApplication.class, args);
   }

   /**
    * 整合Servlet的第二種方式,創建ServletRegistrationBean並添加路徑
    * @return
    */
   @Bean
   public ServletRegistrationBean getServletRegistrationBean(){
      ServletRegistrationBean bean = new ServletRegistrationBean(new SecondServlet());
      bean.addUrlMappings("/mySecond");
      return bean;
   }
}

4.2.方式二

步驟:

  • 創建一個類MySecondFilter實現Filter接口,重寫方法。
  • 在@SpringBootApplication標識的主類中加@Bean的一個方法,將MySecondFilter對象注入容器中。

MySecondFilter.java

package com.example.servlet.myfilter;

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

/**
 * 整合Filter的第二種方式
 */
public class MySecondFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2) throws IOException, ServletException {
        System.out.println("進入MySecondFilter了......");
        arg2.doFilter(arg0, arg1);
        System.out.println("離開MySecondFilter了......");
    }

    @Override
    public void destroy() {

    }
}

ServletApplication.java

package com.example.servlet;

import com.example.servlet.myfilter.MySecondFilter;
import com.example.servlet.myservlet.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.ServletComponentScan;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
//@ServletComponentScan //在springBoot啓動時會掃描@WebServlet,並將該類實例化
public class ServletApplication {

   public static void main(String[] args) {
      SpringApplication.run(ServletApplication.class, args);
   }

   /**
    * 整合Filter的第二種方式
    * 註冊Filter
    */
   @Bean
   public FilterRegistrationBean getFilterRegistrationBean() {
      FilterRegistrationBean bean = new FilterRegistrationBean(new MySecondFilter());
      // bean.addUrlPatterns(new String[]{"*.do","*.jsp"});//攔截多個時
      bean.addUrlPatterns("/mySecond");
      return bean;
   }
}

然後在瀏覽器訪問localhost:8080/mySecond,就可以看到控制檯打印如下
在這裏插入圖片描述

5.SpringBoot整合Listener

5.1.方式一

步驟:

  • 創建一個類MyFirstListener實現ServletContextListener接口,重寫方法
  • 在該類上加上@WebListener註解
package com.example.servlet.mylistener;

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

/**
 * springBoot 整合Listener第一種方式
 * 創建一個Servlet上下文的監聽器
 * @WebListener 自動註冊,相當於在web.xml中添加如下代碼
 *
 *<listener>
 * <listener-class>ah.szxy.listener.FirstListener</listener-class>
 *</listener>
 */
@WebListener
public class MyFirstListener implements ServletContextListener {

    @Override
    public void contextDestroyed(ServletContextEvent arg0) {
        // TODO Auto-generated method stub
        System.out.println("MyFirstListener執行銷燬了。。。");
    }

    @Override
    public void contextInitialized(ServletContextEvent arg0) {
        // TODO Auto-generated method stub
        System.out.println("MyFirstListener執行初始化了。。。");
    }
}

執行項目會打印如下,因爲用了@ServletComponentScan註解,在項目啓動的時候就會掃描包中是否含有servlet,若有就初始化。由於FirstServlet是基於註解初始化的,所以在項目啓動的時候,就會執行初始化servlet,被Listener監聽到
在這裏插入圖片描述

5.1.方式二

步驟:

  • 創建一個類MySecondListener實現ServletContextListener接口,重寫方法。
  • 在@SpringBootApplication標識的主類中加@Bean的一個方法,將MySecondListener對象注入容器中。
package com.example.servlet.mylistener;

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

/**
 * 整合Listener的第二種方式
 */
public class MySecondListener implements ServletContextListener {

    @Override
    public void contextDestroyed(ServletContextEvent arg0) {
        // TODO Auto-generated method stub
        System.out.println("MySecondListener執行銷燬了。。。");
    }

    @Override
    public void contextInitialized(ServletContextEvent arg0) {
        // TODO Auto-generated method stub
        System.out.println("MySecondListener執行初始化了。。。");
    }

}
package com.example.servlet;

import com.example.servlet.myfilter.MySecondFilter;
import com.example.servlet.mylistener.MySecondListener;
import com.example.servlet.myservlet.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.ServletComponentScan;
import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
@ServletComponentScan //在springBoot啓動時會掃描@WebServlet,並將該類實例化
public class ServletApplication {

   public static void main(String[] args) {
      SpringApplication.run(ServletApplication.class, args);
   }

   /**
    * 註冊listener
    */
   @Bean
   public ServletListenerRegistrationBean<MySecondListener> getServletListenerRegistrationBean() {
      ServletListenerRegistrationBean<MySecondListener> bean = new ServletListenerRegistrationBean<MySecondListener>(
            new MySecondListener());
      return bean;
   }

}

執行項目,在控制檯可以看到輸出如下,兩個Servlet監聽器都執行了
在這裏插入圖片描述
總的項目目錄包結構如下:
在這裏插入圖片描述

更多資源和教程請關注公衆號:非科班的科班
如果覺得我寫的還可以請給個贊,謝謝大家,你的鼓勵是我創作的動力

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章