RequestDispatcher

最新推荐文章于 2022-01-10 12:39:18 发布
最新推荐文章于 2022-01-10 12:39:18 发布
阅读量4.5k 收藏 13
点赞数 4
分类专栏： Servlet 文章标签： java servlet
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq844579582/article/details/109482117
版权

RequestDispatcher

1. 简介

见名知其义，RequestDispatcher实现的是请求转发。

请求转发的意思就是说通知其他web资源处理当前Servlet的请求。

RequestDispatcher对象由Servlet容器创建， 该对象用于接收客户端的请求并将请求发送到服务器上的任意资源（例如：Servlet，HTML文件或JSP文件）。因为对于RequestDispatcher对象来说，WEB资源都是可见的，可直接将请求转发到任意资源。

RequestDispatcher对象可用于将请求转发到资源或将资源包括在响应中。

RequestDispatcher对象本质是对某个资源的包装， 当指定forward方法时，会将请求转发到包装的资源路径上。

1.1 请求转发工作原理

image-20201104105731395

2. 获取RequestDispatcher的三种方式

2.1 ServletContext#getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

该方法返回一个RequestDispatcher对象，该对象充当位于给定路径的资源的包装，通过参数path指定资源的路径名。

注意：

1、路径名必须以"/“开头，”/"会被解析为相对于当前上下文的根路径。

2、如果ServletContext无法返回RequestDispatcher对象的话，则此方法返回null。

3、path指定的资源路径如果是文件资源（JSP，html）传递资源的绝对路径，如果是Servlet的话，那么传递的就是Servlet对应的urlPatterns解析的访问路径。

  • Servlet代码
package com.inconspicuousy.servlet;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
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;

/**
 * 请求转发
 *
 * @author peng.yi
 */
@WebServlet(value = "/dispatcher")
public class DispatcherServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 获取到 ServletContext上下文对象
        ServletContext servletContext = getServletContext();
        // 通过RequestDisPatcher对象对dispatcher.html进行包装
        RequestDispatcher requestDispatcher = servletContext.getRequestDispatcher("/dispatcher.html");
        // 利用forward方法实现请求的转发到指定的路径，此时请求会被转发到dispatcher.html上
        requestDispatcher.forward(req, resp);
    }
}

当前 dispatcher.html 文件位于webapp目录下，相当于在根路径下，当GET请求DispatcherServlet时，会被直接转发到dispatcher.html资源上。

2.2 ServletContext#getNamedDispatcher

public RequestDispatcher getNamedDispatcher(String name)

该方法返回一个RequestDispatcher对象，该对象实现对指定名称对应的Servlet的包装。

注意：

1、如果ServletContext由于任何原因无法返回RequestDispatcher对象，则此方法返回null。

2、Servlet名称可以通过web.xml中指定，也可通过WebServlet注解的name属性指定，WebServlet注解注册的Servlet默认的Servlet名称是全类名（包名+类名）。

3、JSP页面是一种特殊形式的Servlet，所以该方法也可以是某个JSP页面的包装。

  • Servlet代码
package com.inconspicuousy.servlet;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
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.util.Optional;

/**
 * @author peng.yi
 */
@WebServlet(value = "/named-dispatcher")
public class NamedDispatcherServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 获取到SevletContext上下文对象
        ServletContext servletContext = getServletContext();
        // 获取到Servlet名称(默认Servlet的名称为全类名)
        String servletName = "com.inconspicuousy.servlet.DispatcherServlet";
        // 根据名称获取到Servlet包装的RequestDispatcher对象
        RequestDispatcher namedDispatcher = servletContext.getNamedDispatcher(servletName);
        // 我们将请求转发到DispatcherServlet
        namedDispatcher.forward(req, resp);
    }
}

当前GET请求到NamedDispatcherServlet时会被转发到DispatcherServlet时，然后再次转发到dispatcher.html资源路径上。

2.3 ServletRequest#getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

该方法与 ServletContext#getRequestDispatcher 类似，不同在于该处的资源路径可以是相对路径，不一定是以 "/"开头。

  • Servlet代码
package com.inconspicuousy.servlet;

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;
import java.io.IOException;

/**
 * 利用Servlet对象获取到RequestDispatcher对象
 * @author peng.yi
 */
@WebServlet(value = "/servlet-dispatcher")
public class ServletDispatcherServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // dispatcher 会被解析成 /dispatcher, 因为当前Servlet的路径就是 /servlet-dispatcher, 相对路径的话就是 dispatcher
        // /dispatcher对应的Servlet就是DispatcherServlet
        RequestDispatcher requestDispatcher = req.getRequestDispatcher("dispatcher");
        if (requestDispatcher != null) {
            // 当前请求就会被转发到 DispatcherServlet
            requestDispatcher.forward(req, resp);
        }
    }
}

当GET请求访问 /servlet-dispatcher 会被转发到 /dispatcher ，然后再次会被转发到 /dispatcher.html资源路径。

3. 相关方法列表

方法名称方法签名描述注意
forwardpublic void forward(ServletRequest request, ServletResponse response) throws ServletException, IOException将请求从当前Servlet转发到服务器上的另一个资源（Servlet、JSP文件或者HTML文件）1、此方法允许一个Servlet对请求进行初步处理，而另一种资源则可以生成响应。
2、对于通过getRequestDispatcher（）获得的RequestDispatcher，ServletRequest对象的路径元素和参数已调整为与目标资源的路径匹配。
3、在将响应提交给客户端之前（在刷新响应主体输出之前），应调用forward。如果响应已经提交，则此方法引发IllegalStateException。
4、请求和响应参数必须与传递给调用servlet的服务方法的对象相同，或者是包装它们的ServletRequestWrapper或ServletResponseWrapper类的子类。
5、此方法将给定请求的调度程序类型设置为DispatcherType.FORWARD。
includepublic void include(ServletRequest request, ServletResponse response) throws ServletException, IOException在响应中包括资源的内容（servlet，JSP页面，HTML文件）。1、ServletResponse对象的路径元素和参数与调用方的参数保持不变。包含的servlet不能更改响应状态代码或设置标头。任何进行更改的尝试都将被忽略。
2、请求和响应参数必须与传递给调用servlet的服务方法的对象相同，或者是包装它们的ServletRequestWrapper或ServletResponseWrapper类的子类。
3、此方法将给定请求的调度程序类型设置为DispatcherType.INCLUDE。

我们采用GET请求演示include的使用。

  • 客户端直接请求的Servlet代码。
package com.inconspicuousy.servlet;

import javax.servlet.DispatcherType;
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;
import java.io.IOException;
import java.io.PrintWriter;

/**
 * RequestDispatchet include方法
 * @author inconspicuousy
 * @date 2020/11/3
 */
    @WebServlet(value = "/include")
public class IncludeServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

        System.out.println("=====处理请求包含指定资源的内容====");
        // 获取到请求转发的类型
        DispatcherType dispatcherType = req.getDispatcherType();
        System.out.println("调用include方法之前，dispatcherType = " + dispatcherType.name());

        // 我们这里将 include-post 路径对应的Servlet处理的响应信息包含在当前响应中
        RequestDispatcher requestDispatcher = req.getRequestDispatcher("/include-post");
        requestDispatcher.include(req, resp);

        PrintWriter writer = resp.getWriter();
        writer.println("include...");

    }
}
  • RequestDispatcher包含的Servlet代码
package com.inconspicuousy.servlet;

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;

/**
 * @author inconspicuousy
 * @date 2020/11/3
 */
// include 后置Servlet处理
@WebServlet(value = "/include-post")
public class IncludePostServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("===开始处理IncludePostServlet");
        System.out.println("调用include方法之后，dispatcherType = " + req.getDispatcherType().name());
        // 包含的Servlet不能更改响应信息，响应信息会被忽略
        resp.setStatus(404);
        PrintWriter writer = resp.getWriter();
        writer.println("IncludePostServlet....");
    }
}
  • 请求的地址
http://localhost:8080/servlet_annotation/include
  • 控制台打印信息
=====处理请求包含指定资源的内容====
调用include方法之前，dispatcherType = REQUEST
===开始处理IncludePostServlet
调用include方法之后，dispatcherType = INCLUDE
  • 页面输出信息

image-20201103234428059

从页面输出信息可以看出，include对应的资源会被包含在当前响应信息中。

yipengup
关注
专栏目录
Javaweb-RequstDispatcher转发
makeliwei1的博客
07-13 257
一、RequestDispatcher接口信息 1.1、定义 一个可以将客户端的请求转发到当前服务器中其他资源(Servlet、JSP、HTML)，让这些资源对请求进行响应 1.2、方法 方法一：使用forward()方法进行转发，只是用转发的那个Servlet、JSP、HTML进行响应。不能包括当前的Servlet或者是其他的Servlet的响应 forward(HttpRequest...
servlet中RequestDispatcher源码解析及使用
panda-star的博客
02-07 988
servlet中RequestDispatcher源码解析及使用 文章目录servlet中RequestDispatcher源码解析及使用一、简介二、RequestDispatcher2.1 RequestDispatcher获取2.2 源码2.3 转发方法2.3.1 forward2.3.2 include2.3.3 sendRedirect三、示例 一、简介 RequestDispatcher...
【Servlet】关于RequestDispatcher的原理
weixin_33774615的博客
09-04 510
RequestDispatcher简介 RequestDispatcher 代表请求的派发者。它有2个动作：forward 和 include 。客户端对于任何一个请求，可以根据业务逻辑需要，选择不同的处理办法： 1、请求的是谁，谁就自己处理并响应，例如请求的是一个html，则web浏览器显示的就是这个HTML的内容。 2、使用RequestDispatcher让其它的资源参与进来，协同完成...
04.RequestDispatcher
远方水木
04-09 399
RequestDispatcher 由Servlet容器创建的一个WEB资源的包装器，可以用来把当前的request传递到该资源，或者把新的资源包括到当前响应中。 方法 void forward(ServletRequest request, ServletResponse response)：将请求从一个servlet转发到另一个资源（servlet，jsp或HTML文件）。此方法允...
Servlet关于RequestDispatcher的原理详解
08-26
Servlet关于RequestDispatcher的原理详解 RequestDispatcher是Servlet中的一种机制，可以将请求从一个Servlet或JSP目标资源转发到服务器上的另一个资源，如Servlet、JSP文件或HTML文件等。RequestDispatcher有两个...
JavaWeb开发技术-RequestDispatcher对象.pptx
07-06
RequestDispatcher 对象在 JavaWeb 开发中的应用 RequestDispatcher 对象是 JavaWeb 开发中的一种重要对象，它允许开发者在服务器端将请求从一个资源传递给另一个资源，以实现更灵活的请求处理机制。在本文中，我们...
JavaWeb(补充RequestDispatcher实现请求转发)
qq_55702063的博客
01-10 1746
一、学习目标 1、RequestDispatcher实现请求转发 2、获取 RequestDispatcher 对象的方法 二、重点知识 1、RequestDispatcher实现请求转发 当一个 Web 资源收到客户端的请求后，如果希望服务器通知另外一个资源处理请求，那么这时可以通过 RequestDispatcher 接口的实例对象实现。ServletRequest 接口中定义了一个获取 RequestDispatcher 对象的方法，如表所示。
Servlet请求转发 RequestDispatcher接口
热门推荐
自强
06-16 3万+
在Servlet中，利用RequestDispatcher对象，可以将请求转发给另外一个Servlet或JSP页面，甚至是HTML页面，来处理对请求的响应。一，RequestDispatcher接口方法简介       1，RequestDispatcher对象由Servlet容器来创建，封装一个由路径所标识的服务器资源。         2，RequestDispatcher接口中定
request Dispatch
weixin_33872660的博客
04-18 435
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { System.out.println("forwardServlet doGet..."); //转发 request.setAttribute("name", "...
RequestDispatcher对象的应用——RequestDispatcher接口、请求转发、请求包含
醉瑾_的博客
04-24 4164
一.RequestDispatcher接口 当一个web资源收到客户端的请求后，如果希望服务器通知另外一个资源去处理请求，这时除了使用sendRedirect（）方法重定向外，还可以通过RequestDispatcher接口的实例对象来实现 获取RequestDispatcher对象的方法 方法声明 功能描述 RequestDispatcher getRequestDispatcher(String path) 返回封装了某个路径所指定资源的RequestDispatcher对象。参数pat
RequestDisPatcher的用法
firetaker的专栏
11-19 1218
RequestDisPatcher   dispatcher=requset.getRequestDisPatcher( "/admin/result.jsp") forward(request,   response);这句代码就是说将当前servlet的数据转发到result这个result.jsp, 它是服务器端转发，一般还要把request和response传过去 用法: RequestD
RequestDispatcher介绍(转)
11-04 1042
RequestDispatcher是一个Web资源的包装器，可以用来把当前request传递到该资源，或者把新的资源包括到当前响应中。RequestDispatcher接口中定义了两个方法：include/forward 由于只能指定固定的jsp文件名，不能动态指定jsp文件名。我们需要把翻译为Java code – RequestDispatcher.include(); 用法：
RequestDispatcher用法
05-06 4628
String path="/index.jsp";//这是当前应用中一个绝对路径的url   servlet: RequestDispatcher dispatcher=getServletContext().getRequestDispatcher(path);   jsp: RequestDispatcher dispatcher=application.getRequestDispatche
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值