Servlet學習筆記

scu醬油仔發表於2019-01-19
Servlet筆記

Servlet學習筆記

工作以來就一直在用各種web框架，比如SpringMVC，Spring Cloud這些，向外提供介面都很方便，但是一直在想它的內部是怎樣對外暴露服務的，正好之前學習java基礎的時候也沒好好看servlet這塊，抽個時間學習總結一下，也能更好的理解掌握現在的web框架。

1. servlet簡介

servlet的全稱是server applet，服務端小程式，是執行在伺服器端用java編寫的程式，用於處理及響應客戶端的需求，動態生成web內容。

Servlet是個特殊的java類，這個類必須繼承HtppServlet，每個Servlet可以響應客戶端的請求。Servlet提供不同的方法用於響應客戶端請求：

  • doGet：用於響應客戶端的get請求；
  • doPost：用於響應客戶端的post請求；
  • doPut：用於響應客戶端的put請求；
  • doDelete：用於響應客戶端的delete請求；

大部分時候，Servlet對所有請求的響應都是完全一樣的，這個時候，我們就可以採用重寫service()方法來代替上面的幾個方法。

void service(HttpServletRequest req, HttpServletResponse resp)

一般情況下，在MVC應用中，Servlet扮演控制器的角色：

  • Model：對應JavaBean；
  • View：對應JSP頁面；
  • Controller：對應Servlet；

所以，在SpringMVC中對外暴露介面的本質就是一個servlet，它的名字是：org.springframework.web.servlet.DispatcherServlet。

2. servlet例項

大概瞭解了servlet之後，我們通過新建一個工程來使用原始的servlet對外暴露服務。

2.1 新建工程

使用eclipse新建一個動態web專案，

圖片描述

專案建好後目錄結構應該是這樣的：

│  .classpath
│  .project
│
├─.settings
│      .jsdtscope
│      org.eclipse.jdt.core.prefs
│      org.eclipse.wst.common.component
│      org.eclipse.wst.common.project.facet.core.xml
│      org.eclipse.wst.jsdt.ui.superType.container
│      org.eclipse.wst.jsdt.ui.superType.name
│
├─build
│  └─classes
├─src
└─WebContent
    ├─META-INF
    │      MANIFEST.MF
    │
    └─WEB-INF
        └─lib

2.2 新建servlet

圖片描述

圖片描述

新建好後的java程式碼如下：

package com.servletDemo.servlet;

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

/**
 * Servlet implementation class MyServlet
 */
@WebServlet("/MyServlet")
public class MyServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
       
    /**
     * @see HttpServlet#HttpServlet()
     */
    public MyServlet() {
        super();
        // TODO Auto-generated constructor stub
    }

    /**
     * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
     */
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        response.getWriter().append("Served at: ").append(request.getContextPath());
    }

    /**
     * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
     */
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        doGet(request, response);
    }

}

2.3 編譯打包

圖片描述

將匯出的war包丟進tomcat的webapps下面，重啟tomcat。訪問：http://localhost:8080/servletDemo/MyServlet，就可以看到返回結果。沒錯，就是這個簡單！

圖片描述

2.4 配置Servlet的兩種方式

使用servlet有兩種配置方式：

  • Servlet類上使用@WebServlet註解進行配置
  • 在web.xml檔案中配置

1）@WebServlet註解

在上面的例子中就是使用WebServlet註解的方式配置的，@WebServlet("/MyServlet")的意思是如果請求是/MyServlet，則由MyServlet類的例項提供服務。@WebServlet註解還有很多其他屬性，如下：

屬性 型別 是否必須 說明
asyncSupported boolean 否 指定Servlet是否支援非同步操作模式
displayName String 否 指定Servlet顯示名稱
initParams WebInitParam[] 否 配置初始化引數
loadOnStartup int 否 標記容器是否在應用啟動時就載入這個Servlet
name String 否 指定Servlet名稱
urlPatterns/value String[] 否 這兩個屬性作用相同，指定Servlet處理的url

比如上面的類註解可以新增一些其他屬性：

@WebServlet(  
    name="servletdemo",   
    urlPatterns={"/MyServlet"},   
    loadOnStartup=1 
)  
public class MyServlet extends HttpServlet {
    
}

2）web.xml配置

除了註解的方式，還可以通過web.xml配置，在WEB-INF下新建web.xml，進行servlet配置：

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
  <display-name>My web app</display-name>
  
  <servlet>
      <servlet-name>servletdemo</servlet-name>
      <servlet-class>
         com.servletDemo.servlet.MyServlet
      </servlet-class>
      <!-- 表示啟動容器時初始化此Servelt,呼叫init方法 -->
      <load-on-startup>1</load-on-startup>
   </servlet>

   <servlet-mapping>
      <servlet-name>servletdemo</servlet-name>  <!-- 需要和上面的servlet-name保持一致 -->
      <url-pattern>/MyServlet</url-pattern> <!-- url的匹配規則-->
   </servlet-mapping>
</web-app>

注意：配置了web.xml就需要把@WebServlet註解刪掉，否則啟動tomcat容器的時候會報錯兩個servlet指向同一個URL。

再重新編譯打包丟進容器，重啟並訪問：http://localhost:8080/servletDemo/MyServlet。結果是一樣的：

圖片描述

2.5 一個Servlet處理多個URL請求

當瀏覽器傳送了一次請求到伺服器時，servlet容器會根據請求的url-pattern找到對應的Servlet類，執行對應的doPost或doGet方法，再將響應資訊返回給瀏覽器，這種情況下，一個具體的Servlet類只能處理對應的web.xml中配置的url-pattern請求，一個Servlet類，一對配置資訊。 但是我們知道現在大部分的javaweb框架都是可以編寫一個java類而可以處理多個url請求的。那麼使用原生的servlet如何做到呢？

有兩種方法。一是根據請求的地址，擷取其中的具體方法名，然後使用if-else判斷匹配，再執行具體的方法。二是根據擷取出來的方法名，使用反射機制，來執行具體的方法。

具體解決方案可以參考：https://blog.csdn.net/codeMas…。

2. Filter介紹

Filter可以認為是Servlet的一種“加強版”。它主要是對使用者請求進行預處理，也可以對HttpServletResponse進行後續處理，是個典型的處理鏈。使用Filter的完整流程一般是：Filter對使用者請求進行預處理，接著請求交給Servlet進行處理並生成響應，最後Filter再對伺服器響應進行後續處理。

Filter可以攔截多個請求或響應，一個請求或響應也可以被多個Filter攔截。

建立Filter類需要實現javax.servlet.Filter介面，該介面定義瞭如下三個方法：

  • void init(FilterConfig config)
  • void destory()
  • void doFilter(ServletRequest request, ServletResponse respone, FilterChain chain)

Filter例項：

1）編寫Filter類

package com.servletDemo.servlet;

import java.io.IOException;
import java.util.Date;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

public class MyFilter implements Filter {
    public MyFilter() {
        
    }

    public void destroy() {
        System.out.println("進入Filter的destroy方法...時間：" + new Date());
    }

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        System.out.println("進入Filter的doFilter方法...時間：" + new Date());
        chain.doFilter(request, response);
    }

    public void init(FilterConfig fConfig) throws ServletException {
        System.out.println("進入Filter的init方法...時間：" + new Date());
    }

}

2）配置web.xml

和servlet的配置一樣，也需要配置url匹配策略，新增了Filter的web.xml如下：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:web="http://xmlns.jcp.org/xml/ns/javaee">
    <display-name>My web app</display-name>

    <filter>
        <filter-name>MyFilter</filter-name>
        <filter-class>com.servletDemo.servlet.MyFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>MyFilter</filter-name>
        <url-pattern>/MyServlet</url-pattern>
    </filter-mapping>

    <servlet>
        <servlet-name>servletdemo</servlet-name>
        <servlet-class>
            com.servletDemo.servlet.MyServlet
        </servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>servletdemo</servlet-name>
        <url-pattern>/MyServlet</url-pattern>
    </servlet-mapping>
</web-app>

將工程部署上去，訪問：

http://localhost:8080/servletDemo/MyServlet，

從控制檯列印的日誌可以看出，http請求先經過了filter再到servlet。日誌列印順序：

......
進入Filter的init方法...時間：Wed Sep 05 16:54:08 CST 2018
九月 05, 2018 4:54:08 下午 org.apache.catalina.startup.HostConfig deployWAR
資訊: Deployment of web application archive D:softwareapache-tomcat-7.0.90webappsservletDemo.war has finished in 74 ms
......
資訊: Deployment of web application directory D:softwareapache-tomcat-7.0.90webappsROOT has finished in 56 ms
九月 05, 2018 4:54:12 下午 org.apache.coyote.AbstractProtocol start
資訊: Starting ProtocolHandler ["http-apr-8080"]
九月 05, 2018 4:54:12 下午 org.apache.coyote.AbstractProtocol start
資訊: Starting ProtocolHandler ["ajp-apr-8009"]
九月 05, 2018 4:54:12 下午 org.apache.catalina.startup.Catalina start
資訊: Server startup in 9575 ms
進入Filter的doFilter方法...時間：Wed Sep 05 16:54:15 CST 2018
進入servlet的doget方法...時間：Wed Sep 05 16:54:15 CST 2018

3. Listener介紹

當web應用在web容器中執行時，web應用內部會不斷的發生各種事件：web應用被啟動、web應用被停止、使用者session開始、使用者session結束、使用者請求到達等，通常來這些web事件對開發者是透明的，但是Servlet API提供了大量的監聽器來監聽web應用的內部事件，從而允許當web內部事件發生時回撥事件監聽器內的方法。使用Listener需要兩步（和Servlet、Filter一樣）：

  • 定義Listener實現類；
  • 通過註解或web.xml配置。

常用的web事件監聽器介面有如下幾個：

  • ServletContextListener：用於監聽web應用的啟動和關閉；
  • ServletContextAttributeListener：用於監聽ServletContext範圍（applocation）內屬性的改變；
  • ServletRequestListener：用於監聽使用者請求；
  • ServletRequestAttributeListener：用於監聽ServletRequest範圍（request）內屬性的改變；
  • HttpSessionListener：用於監聽使用者session的開始和結束；
  • HttpSessionAttributeListener：用於監聽HttpSession範圍（session）內屬性的改變；

Listener例項

1）編寫Listenter類，此處以監聽web容器的啟動和關閉作為例子，其他監聽型別類似。

package com.servletDemo.servlet;

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

@WebListener
public class MyListener implements ServletContextListener {

    public MyListener() {
        
    }

    public void contextDestroyed(ServletContextEvent paramServletContextEvent)  { 
        System.out.println("web應用關閉了...");
    }

    public void contextInitialized(ServletContextEvent paramServletContextEvent)  { 
        System.out.println("web應用啟動了...");
    }
    
}

2）配置web.xml

listener的配置比較簡單，只需要配置一個節點就可以了。

<listener>
    <listener-class>
        com.servletDemo.servlet.MyListener
    </listener-class>
</listener>

重啟部署到tomcat，容器啟動的時候會列印日誌：

......
九月 05, 2018 5:13:37 下午 org.apache.catalina.startup.HostConfig deployWAR
資訊: Deploying web application archive D:softwareapache-tomcat-7.0.90webappsservletDemo.war
web應用啟動了...
進入Filter的init方法...時間：Wed Sep 05 17:13:38 CST 2018
九月 05, 2018 5:13:38 下午 org.apache.catalina.startup.HostConfig deployWAR
資訊: Deployment of web application archive D:softwareapache-tomcat-7.0.90webappsservletDemo.war has finished in 127 ms
......
資訊: Starting ProtocolHandler ["http-apr-8080"]
九月 05, 2018 5:13:42 下午 org.apache.coyote.AbstractProtocol start
資訊: Starting ProtocolHandler ["ajp-apr-8009"]
九月 05, 2018 5:13:42 下午 org.apache.catalina.startup.Catalina start
資訊: Server startup in 10147 ms

專案原始碼：https://github.com/WangJun-SC…

參考：

https://baike.baidu.com/item/…

https://www.cnblogs.com/xdp-g…

https://blog.csdn.net/codeMas…

https://www.cnblogs.com/whgk/…

Servlet工作原理解析：https://www.ibm.com/developer…

http://www.runoob.com/servlet…

相關文章