RequestDispatcher

最新推荐文章于 2024-06-20 11:50:09 发布
最新推荐文章于 2024-06-20 11:50:09 发布
阅读量4.4k 收藏 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
关注
  • 4
    点赞
  • 踩
  • 13
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
Servlet关于RequestDispatcher的原理详解
08-26
Servlet关于RequestDispatcher的原理详解 RequestDispatcher是Servlet中的一种机制，可以将请求从一个Servlet或JSP目标资源转发到服务器上的另一个资源，如Servlet、JSP文件或HTML文件等。RequestDispatcher有两个...
HttpServletRequest对象与RequestDispatcher对象
daqi1983的博客
10-11 786
在Servlet API中，定义了一个HttpServletRequest接口，它继承自ServletRequest接口，专门用来封装HTTP请求消息。由于HTTP请求消息分为请求行、请求消息头和请求消息体三部分，因此，在HttpServletRequest接口中定义了获取请求行、请求头和请求消息体的相关方法。
javaweb基础——RequestDispatcher接口
qq_45169180的博客
09-05 800
在开发中访问到一个web资源后，需要服务器跳转到另一个资源去处理请求，可以通过sendRedirect重定向方法来实现，也可以通过RequestDispatcher转发对象的forWord方法来实现。 得到转发的对象：RequestDispatcher forWords = request.getRequestDispatcher(“另一个资源的路径”)； 常用方法： 实现请求转发：forWords.forword(request,response); 实现请求包含：forWords.include(req
JAVA系列---HttpServletRequest
最新发布
lipviolet的博客
06-20 1198
在代码中通过注解注入HttpServletRequest的方式，拿到的其实并不是真正的 HttpServletRequest，而是一个Spring项目启动时自动注入的代理对象org.springframework.web.context.support.``WebApplicationContextUtils.RequestObjectFactory。该对象跟ServletRequest.class做了映射关联，放入了Spring管理bean注入的map中。@Override。
getRequestDispatcher()转发和sendRedirect()重定向介绍与比较
记录分享编程与冲浪知识
01-16 3491
getRequestDispatcher()转发和sendRedirect()重定向介绍与比较
request.getRequestDispatcher().forward(request,response)和response.sendRedirect()的区别
phubing
02-11 6555
http://bbs.csdn.net/topics/391045457 在进行web开发时，跳转是最常见的，今天在这里来学习下2种跳转： 第一种是request.getRequestDispatcher().forward(request,response)： 1、属于转发，也是服务器跳转，相当于方法调用，在执行当前文件的过程中转向执行目标文件，两个文件(当前文件和目标文件)属...
java中，getRequestDispatcher是干什么的
weixin_58689039的博客
10-17 468
getRequestDispatcher是一个Java Servlet API中的方法，用于获取请求调度器。请求调度器用于将请求转发给其他资源（如Servlet、JSP或静态文件），以便处理该请求。通过使用getRequestDispatcher方法，可以将控制权从当前Servlet转发给其他资源，并在处理完该资源后返回到原来的Servlet。这个方法通常与forward或include方法一起使用，用于实现请求的转发和包含操作。
Servlet 请求转发
swadian2008的博客
02-11 2367
目录 请求转发 RequestDispatcher 接口 请求转发的工作原理 请求转发的特点 request 域对象 示例 Web 应用在处理客户端的请求时，经常需要多个 Web 资源共同协作才能生成响应结果。但由于 Serlvet 对象无法直接调用其他 Servlet 的 service() 方法，所以 Servlet 规范提供了 2 种解决方案： 请求转发 请求包含（了解即可） 下面我们主要对请求转发进行介绍。 请求转发 请求转发属于服务器行为。容器接收请求后，Servlet 会先
JavaWeb开发技术-RequestDispatcher对象.pptx
07-06
RequestDispatcher 对象在 JavaWeb 开发中的应用 RequestDispatcher 对象是 JavaWeb 开发中的一种重要对象，它允许开发者在服务器端将请求从一个资源传递给另一个资源，以实现更灵活的请求处理机制。在本文中，我们...
krislinzhao#StudyNotes#06RequestDispatcher请求转发1
07-25
它们分别是编号|方法|描述1|public void forward(ServletRequest request,ServletResponse respon
jsp下载RequestDispatcher方式和文件输出的方式
06-07
上传比较简单，共享下下载的程序。这里有RequestDispatcher方式和文件输出的方式，分别可以是相对路径和绝对路径，RequestDispatcher方式对应相对路径没有研究，希望有高手能补全。
【JavaWeb】关于request.getRequestDispatcher转发机制
m0_62638072的博客
06-01 522
注意：转发的时候：request和response这两个参数很重要，要将其传递给下一个资源（保证两个资源使用的request对象都是同一个，即保证两个Servlet是一次请求，无论后续继续转发多少次资源，保证都共享同一个request当中）.（1）获取请求转发器对象，相当于将“/B”（在web.xml里面配置的BServlet的url）此路径包装到请求转发器当中，实际上时将下一个将要跳转的资源的路径传递给了Tomcat服务器。（2）调用请求转发器。
关于request.getRequestDispatcher()的两个方法
qq_43842093的博客
04-19 6339
一、getRequestDispatcher() getRequestDispatcher()包含两个重要方法，分别是请求转发和请求包含。一个请求跨多个Servlet时，需要使用请求转发和请求包含。 首先需要获得一个RequestDispatcher 对象：RequestDispatcher rd = request.getRequestDispatcher("/MyServlet"); 请求转发： rd.forward( request , response ); 请求包含： rd.include( re
RequestDispatcher 的使用总结
热门推荐
ch717828的专栏
01-24 1万+
RequestDispatcher是一个Web资源的包装器，可以用来把当前request传递到该资源，或者把新的资源包括到当前响应中。RequestDispatcher接口中定义了两个方法：include/forward 由于只能指定固定的jsp文件名，不能动态指定jsp文件名。我们需要把翻译为Java code – RequestDispatcher.include();  用法：
RequestDispatcher报NullPointer异常的解决
生活在爪洼岛上
10-17 5839
RequestDispatcher rs=request.getRequestDispatcher(url);  rs.forward(request, response);  return ;总是报空指针异常，出错在上的第二行，检查了很久才发现是URL没有 修改逻辑，得到正确的url就不再报错了
servlet的请求转发和请求包含详解，以及请求转发和重定向的区别
weixin_42174718的博客
12-04 956
servlet的请求转发和请求包含详解RequestDispatcher接口的方法如何获取RequestDispatcher对象getRequestDispatcher方法的语法使用getRequestDispatcher方法的示例RequestDispatcher接口的示例index.htmlLogin.javaWelcomeServlet.javaweb.xml请求转发和重定向的区别 Req...
Servlet的request转发规则自述
weixin_43292394的博客
05-15 214
1，request 转发API request.getRequestDispatcher(servlet/jsp/html).forward(rep,resp). request.getRequestDispatcher(servlet/jsp/html).include(rep,resp). 实现请求转发（只能存在一个同一个web容器中）： 概念：一次请求，只有一次响应 RequestDispa...
requestdispatcher的用法
03-16
RequestDispatcher是Java Servlet API中的一个接口，用于将请求转发到另一个资源（Servlet、JSP或HTML文件）。 使用RequestDispatcher，可以将请求从一个Servlet转发到另一个Servlet或JSP，或者将请求从一个JSP转发到另一个JSP或Servlet。这样可以实现请求的处理和响应的分离，提高代码的复用性和可维护性。 RequestDispatcher的用法如下： 1. 获取RequestDispatcher对象 可以通过ServletRequest的getRequestDispatcher()方法或ServletContext的getRequestDispatcher()方法获取RequestDispatcher对象。 例如： RequestDispatcher dispatcher = request.getRequestDispatcher("/servlet/MyServlet"); 2. 转发请求 可以使用RequestDispatcher的forward()方法将请求转发到另一个资源。 例如： dispatcher.forward(request, response); 在转发请求之前，需要将请求和响应对象传递给forward()方法。 3. 包含资源 除了转发请求，还可以使用RequestDispatcher的include()方法包含另一个资源。 例如： dispatcher.include(request, response); 在包含资源时，需要将请求和响应对象传递给include()方法。 总之，RequestDispatcher是Java Servlet API中非常重要的一个接口，可以实现请求的转发和资源的包含，提高代码的复用性和可维护性。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值