快捷導(dǎo)航

Spring Boot 中的Servlet簡(jiǎn)單使用

更新時(shí)間：2017年04月24日 11:31:58 作者：牛頭人

在spring boot中添加自己的Servlet有兩種方法，代碼注冊(cè)Servlet和注解自動(dòng)注冊(cè)（Filter和Listener也是如此）。這篇文章主要介紹了Spring Boot 中的Servlet簡(jiǎn)單使用,需要的朋友可以參考下

當(dāng)使用spring-Boot時(shí)，嵌入式Servlet容器通過(guò)掃描注解的方式注冊(cè)Servlet、Filter和Servlet規(guī)范的所有監(jiān)聽(tīng)器（如HttpSessionListener監(jiān)聽(tīng)器）。

Spring boot 的主 Servlet 為 DispatcherServlet，其默認(rèn)的url-pattern為“/”。也許我們?cè)趹?yīng)用中還需要定義更多的Servlet，該如何使用SpringBoot來(lái)完成呢？

在spring boot中添加自己的Servlet有兩種方法，代碼注冊(cè)Servlet和注解自動(dòng)注冊(cè)（Filter和Listener也是如此）。

一、代碼注冊(cè)通過(guò)ServletRegistrationBean、 FilterRegistrationBean 和 ServletListenerRegistrationBean 獲得控制。

也可以通過(guò)實(shí)現(xiàn) ServletContextInitializer 接口直接注冊(cè)。

二、在 SpringBootApplication 上使用@ServletComponentScan 注解后，Servlet、Filter、Listener 可以直接通過(guò) @WebServlet、@WebFilter、@WebListener 注解自動(dòng)注冊(cè)，無(wú)需其他代碼。

1.通過(guò)代碼注冊(cè)Servlet示例代碼

1).SpringBootSimpleApplication.Java類(lèi)：

package com.example;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import com.example.servlet.MyServlet;
@SpringBootApplication
public class SpringBootSimpleApplication {
  /**
   * 使用代碼注冊(cè)Servlet（不需要@ServletComponentScan注解）
   */
  @Bean
  public ServletRegistrationBean servletRegistrationBean() {
    return new ServletRegistrationBean(new MyServlet(), "/st/*");// ServletName默認(rèn)值為首字母小寫(xiě)，即myServlet
  }
  public static void main(String[] args) {
    SpringApplication.run(SpringBootSimpleApplication.class, args);
  }
}

2).MyServlet.java類(lèi)：

package com.example.servlet;
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class MyServlet extends HttpServlet{
  @Override
  protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    System.out.println(">>>>>>>>>>doGet()<<<<<<<<<<<");
    doPost(req, resp);
  }
  @Override
  protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    System.out.println(">>>>>>>>>>doPost()<<<<<<<<<<<");
    resp.setContentType("text/html"); 
    resp.setCharacterEncoding("utf-8");
    PrintWriter out = resp.getWriter(); 
    out.println("<html>"); 
    out.println("<head>"); 
    out.println("<title>Hello World</title>"); 
    out.println("</head>"); 
    out.println("<body>"); 
    out.println("<h1>大家好，我的名字叫Servlet</h1>"); 
    out.println("</body>"); 
    out.println("</html>"); 
  }
}

2.使用注解注冊(cè)Servlet示例代碼

1).SpringBootSimpleApplication.java類(lèi)：

package com.example;
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;
import com.example.servlet.MyServlet;
@SpringBootApplication
@ServletComponentScan
public class SpringBootSimpleApplication {
  /**
   * 使用代碼注冊(cè)Servlet（不需要@ServletComponentScan注解）
   */
  @Bean
  public ServletRegistrationBean servletRegistrationBean() {
    return new ServletRegistrationBean(new MyServlet(), "/st/*");// ServletName默認(rèn)值為首字母小寫(xiě)，即myServlet
  }
  public static void main(String[] args) {
    SpringApplication.run(SpringBootSimpleApplication.class, args);
  }
}

2).MyServlet2.java類(lèi)：

package com.example.servlet;
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
// 不指定name的情況下，name默認(rèn)值為類(lèi)全路徑，即com.example.servlet.MyServlet2
@WebServlet(urlPatterns="/st/myservlet2", description="Servlet的說(shuō)明")
public class Myservlet2 extends HttpServlet{
  @Override
  protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    System.out.println(">>>>>>>>>>doGet2()<<<<<<<<<<<");
    doPost(req, resp);
  }
  @Override
  protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    System.out.println(">>>>>>>>>>doPost2()<<<<<<<<<<<");
    resp.setContentType("text/html");
    resp.setCharacterEncoding("utf-8");
    PrintWriter out = resp.getWriter(); 
    out.println("<html>"); 
    out.println("<head>"); 
    out.println("<title>Hello World</title>"); 
    out.println("</head>"); 
    out.println("<body>"); 
    out.println("<h1>大家好，我的名字叫Servlet2</h1>"); 
    out.println("</body>"); 
    out.println("</html>"); 
  }
}

使用 @WebServlet 注解，其中可以設(shè)置一些屬性。

3.訪(fǎng)問(wèn)結(jié)果

4.DispatcherServlet默認(rèn)攔截

DispatcherServlet 默認(rèn)攔截“/”，MyServlet 攔截“/st/*”，MyServlet2 攔截“/st/myservlet”，那么在我們?cè)L問(wèn) http://localhost:8080/st/myservlet2 的時(shí)候系統(tǒng)會(huì)怎么處理呢？如果訪(fǎng)問(wèn) http://localhost:8080/st/abc的時(shí)候又是什么結(jié)果呢？其結(jié)果是“匹配的優(yōu)先級(jí)是從精確到模糊，復(fù)合條件的Servlet并不會(huì)都執(zhí)行”。

既然系統(tǒng)DispatcherServlet 默認(rèn)攔截“/”，那么我們是否能做修改呢，答案是肯定的，我們?cè)赟pringBootSampleApplication中添加代碼：

 /**
   * 修改DispatcherServlet默認(rèn)配置
   */
  @Bean
  public ServletRegistrationBean dispatcherRegistration(DispatcherServlet dispatcherServlet) {
    ServletRegistrationBean registration = new ServletRegistrationBean(dispatcherServlet);
    registration.getUrlMappings().clear();
    registration.addUrlMappings("*.do");
    registration.addUrlMappings("*.json");
    return registration;
  }

可以通過(guò)注入DispatcherServlet 然后用ServletRegistrationBean包裹一層動(dòng)態(tài)的加上一些初始參數(shù)。

您可能感興趣的文章: