Servlet教學 » Servlet RequestDispatcher請求轉發

Servlet RequestDispatcher請求轉發

RequestDispatcher介面提供將請求轉傳送到另一個資源的功能，它可能是html，servlet或jsp等。 此介面也可用於包括另一資源的內容。它是servlet共同作業的一種方式。

在RequestDispatcher介面中定義了兩種方法。它們分別是 -

編號 方法 描述
1 public void forward(ServletRequest request,ServletResponse response)throws ServletException,java.io.IOException 將servlet的請求轉發到伺服器上的另一個資源(servlet，JSP檔案或HTML檔案)。
2 public void include(ServletRequest request,ServletResponse response)throws ServletException,java.io.IOException 在響應中包含資源的內容(servlet，JSP頁面或HTML檔案)。

如上圖所示，第一個servlet轉發請求到第二個servlet的響應傳送給用戶端。 第一個servlet的響應不會顯示給使用者。

如上圖所示，第二個servlet的響應將包含在傳送給用戶端的第一個servlet的響應中。

如何獲取RequestDispatcher的物件？

ServletRequest介面的getRequestDispatcher()方法返回RequestDispatcher的物件。

getRequestDispatcher方法的語法如下 - 

public RequestDispatcher getRequestDispatcher(String resource);

使用getRequestDispatcher方法的範例

RequestDispatcher rd=request.getRequestDispatcher("servlet2");  
//servlet2 is the url-pattern of the second servlet  
rd.forward(request, response);//method may be include or forward

RequestDispatcher介面範例

在這個例子中，驗證使用者輸入的密碼。如果密碼是：mypasswd，它會將請求轉發到WelcomeServlet，否則會顯示一條錯誤訊息：sorry username or password error！ 在這個程式中，使用的是寫死(即：直接在程式碼中指定密碼)。大部分應用中都是在資料庫中儲存使用者資訊和密碼的，在接下來的教學文章我們也會介紹和學習。在這個例子中，建立了以下幾個檔案：

  • index.html：用於從使用者處獲取輸入。
  • Login.java：用於處理響應的servlet類。如果使用者輸入的密碼是mypasswd，它會將請求轉發給WelcomeServlet。
  • WelcomeServlet.java：用於顯示歡迎訊息的servlet類。
  • web.xml：包含有關servlet資訊的部署描述符檔案。

工作流程，請參考下圖 -

開啟Eclipse，建立一個名稱為：ReqDispatcher 的動態Web專案，其完整的專案結構如下圖所示 -

下面是這個專案中相關檔案的程式碼實現 -

檔案：index.html - 

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>登入</title>
</head>
<body>
<div style="text-align:center;">
    <form action="/ReqDispatcher/login" method="post">
        使用者名:<input type="text" name="userName" /><br /> 
        密碼:<input type="password" name="userPass" /><br /> 
        <input type="submit" value="登入" />
    </form>
</div>
</body>
</html>

檔案：Login.java - 

package com.yiibai;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.RequestDispatcher;
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 Login
 */
public class Login extends HttpServlet {
    private static final long serialVersionUID = 1L;

    /**
     * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse
     *      response)
     */
    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        // TODO Auto-generated method stub
        response.setCharacterEncoding("utf-8");//設定伺服器端編碼
        response.setContentType("text/html;charset=utf-8");
        PrintWriter out = response.getWriter();

        String name = request.getParameter("userName");
        String passwd = request.getParameter("userPass");

        // 使用者輸入的密碼是否為：mypasswd
        if (passwd.equals("mypasswd") && name.equals("admin")) {
            RequestDispatcher rd = request.getRequestDispatcher("welcome");
            System.out.println("Username is : "+name);
            rd.forward(request, response);
        } else {
            out.print("Sorry UserName or Password Error!");
            RequestDispatcher rd = request.getRequestDispatcher("/index.html");
            rd.include(request, response);
        }
    }

}

檔案：WelcomeServlet.java - 

package com.yiibai;

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;

/**
 * Servlet implementation class WelcomeServlet
 */
public class WelcomeServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;

    /**
     * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse
     *      response)
     */
    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setCharacterEncoding("utf-8");//設定伺服器端編碼
        response.setContentType("text/html;charset=utf-8");
        String name = request.getParameter("userName");
        if(name==null || name=="") {
            name = "";
        }
        PrintWriter out = response.getWriter();
        //String chset = response.getCharacterEncoding(); 
        out.print("<!DOCTYPE html>\r\n" + 
                "<html>\r\n" + 
                "<head>\r\n" + 
                "<meta charset=\"UTF-8\">\r\n" + 
                "<title>登入成功</title>\r\n" + 
                "</head>\r\n" + 
                "<body>");
        out.print("<b>登入成功啦lala  ~ </b><hr/>");
        out.print("Welcome, " + name);
        out.close();
    }
}

檔案：web.xml - 

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://xmlns.jcp.org/xml/ns/javaee"
    xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
    id="WebApp_ID" version="3.1">
    <display-name>ReqDispatcher</display-name>
    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
    <servlet>
        <servlet-name>Login</servlet-name>
        <servlet-class>com.yiibai.Login</servlet-class>
    </servlet>
    <servlet>
        <servlet-name>WelcomeServlet</servlet-name>
        <servlet-class>com.yiibai.WelcomeServlet</servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>Login</servlet-name>
        <url-pattern>/login</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>WelcomeServlet</servlet-name>
        <url-pattern>/welcome</url-pattern>
    </servlet-mapping>
</web-app>

存取專案的URL為： http://localhost:8080/ReqDispatcher/ ，如果程式碼沒有錯誤，那麼應該會看到類似如下的介面 -

當輸入使用者名和密碼分別為：admin 和 mypasswd，然後提交登陸，應該會看到類似如下的介面 -

如果使用者名或密碼錯誤，應該會看到有一條錯誤提示資訊： Sorry UserName or Password Error!