JavaWeb三大组件之一Servlet【Servlet接口】

时间：2022-03-05 13:11:10

1:-2:-3:-4:-13

Servlet概述

生命周期方法：

void init(ServletConfig):Servlet在第一次被创建对象后，由web服务器马上调用init方法。对象从被创建直到被销毁时，只调用一次。
void service(ServletRequest request,ServletResponse response):每次处理浏览器（客户端）请求时都会被web服务器调用；调用多次。
void destroy():Servlet对象被销毁之前。对象从被创建直到被销毁时，只调用一次。由web服务器调用。

特性：

  • 单例，一个类只有一个对象，当然可能存在多个Servlet类！！
  • 线程不安全的，所以它的效率是高的！

Servlet类由我们来写，但对象由web服务器创建，并由web服务器来调用相应的方法。

比如这里的init方法：在Servlet接口里面就有这样的声明。

    /**
     * Called by the servlet container to indicate to a servlet that the servlet------>大体意思是由web容器调用。
     * is being placed into service.
     *
     * <p>
     * The servlet container calls the <code>init</code> method exactly once
     * after instantiating the servlet. The <code>init</code> method must
     * complete successfully before the servlet can receive any requests.
     *
     * <p>
     * The servlet container cannot place the servlet into service if the
     * <code>init</code> method
     * <ol>
     * <li>Throws a <code>ServletException</code>
     * <li>Does not return within a time period defined by the Web server
     * </ol>
     *
     *
     * @param config
     *            a <code>ServletConfig</code> object containing the servlet's
     *            configuration and initialization parameters
     *
     * @exception ServletException
     *                if an exception has occurred that interferes with the
     *                servlet's normal operation
     *
     * @see UnavailableException
     * @see #getServletConfig
     */
    public void init(ServletConfig config) throws ServletException;```

其它两个方法也是由web容器调用，service、destroy。也就是说生命周期方法由web容器调用。

剩下的什么public ServletConfig getServletConfig();这个方法是由开发者调用。

提示：在我们学习一个东西的时候，我们一般是这样学的：是什么，能干什么，怎么做，最高境界就是为什么这么做。

什么是Servlet

Servlet 是 JavaWeb 的 三大组件之一 ，它属于动态资源。Servlet 的作用是处理请求，web服务器会把接受到的请求交给Servlet来处理，在Servlet中通常需要：

  • 接受请求数据；
  • 处理请求；
  • 完成响应；

例如客户端发出登录请求，或者发出注册请求，这些请求都应该由Servlet来完成处理！Servlet 需要我们自己来编写，每个Servlet 必须实现javax.servlet.Servlet 接口。

实现Servlet的方式（由我们自己来写！）

实现Servlet有三种方式：

  • 实现javax.servlet.Servlet接口；
  • 继承javax.servlet.GenericServlet类；
  • 继承javax.servlet.http.HttpServlet类；

通常我们会去继承HttpServlet类来完成我们的Servlet，但学习Servlet还要从javax.servlet.Servlet接口开始学习。

Servlet接口源码：

package javax.servlet;

import java.io.IOException;

/**
 * Defines methods that all servlets must implement.
 */
public interface Servlet {

/**
 * Called by the servlet container to indicate to a servlet that the servlet
 */
public void init(ServletConfig config) throws ServletException;

/**
 *
 * Returns a {@link ServletConfig} object, which contains initialization and
 */
public ServletConfig getServletConfig();

/**
 * Called by the servlet container to allow the servlet to respond to a
 */
public void service(ServletRequest req, ServletResponse res)
throws ServletException, IOException;

/**
 * Returns information about the servlet, such as author, version, and
 * copyright.
 */
public String getServletInfo();

/**
 * Called by the servlet container to indicate to a servlet that the servlet
 */
public void destroy();
}

创建HelloServlet应用

我们开始第一个Servlet应用吧！首先在webapps目录下创建helloservlet目录，它就是我们的应用目录了，然后在helloservlet目录中创建准备JavaWeb应用所需内容：

  • 创建/helloservlet/WEB-INF目录；
  • 创建/helloservlet/WEB-INF/classes目录；
  • 创建/helloservlet/WEB-INF/lib目录；
  • 创建/helloservlet/WEB-INF/web.xml文件；

接下来我们开始准备完成Servlet，完成Servlet需要分成两步：

  • 编写Servlet类；
  • 在web.xml文件中配置 Servlet；

HelloServlet源码：

public class HelloServlet impliments Servlet{

public void init(ServletConfig config) throws ServletException{}

public ServletConfig getServletConfig(){return null;}

public void destroy(){}

public String getServletInfo(){return null;}

public void service(ServletRequest req,ServletResponse res) throws ServletException,IOException{
        System.out.println("hello servlet!");
    }
}

我们暂时忽略Servlet中其它是个方法，只关心service()方法，因为它是用来处理请求的方法。我们在该方法内给出了一条输出语句！

web.xml中的配置：


<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
<display-name>SpringMVC</display-name>

<servlet>
<servlet-name>hello</servlet-name>
<servlet-class>cn.domarvel.servlet.HelloServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>hello</servlet-name>
<url-pattern>/helloworld</url-pattern>
</servlet-mapping>

<welcome-file-list>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
<welcome-file>index.jsp</welcome-file>
<welcome-file>default.html</welcome-file>
<welcome-file>default.htm</welcome-file>
<welcome-file>default.jsp</welcome-file>
</welcome-file-list>
</web-app>

在web.xml中配置Servlet的目的只有一个，就是把浏览器访问路径与一个Servlet类绑定到一起，上面配置是把访问路径：”/helloworld” 与 “cn.domarvel.servlet.HelloServlet” 绑定到一起。

- <servlet>:在里面指定Servlet的类路径。servlet标签里面的servlet-name和servlet-mapping标签里面的servlet-name是绑定在一起的。
- <servlet-mapping>：指定/helloworld浏览器访问路径，通过servlet-name和servlet标签里面的servlet-class是绑定在一起的。

<servlet>和<servlet-mapping>通过<servlet-name>这个元素关联在一起了！

接下来，我们编译HelloServlet，注意，编译HelloServlet时需要导入servlet-api.jar，因为Servlet.class等类都在servlet-api.jar中。

javac -classpath F:/tomcat6/lib/servlet-api.jar -d . HelloServlet.java

然后把HelloServlet.class放到/helloworld/WEB-INF/classes/目录下，然后启动Tomcat，在浏览器中访问：http://localhost:8080/helloservlet/helloworld即可在控制台上看到输出！

Servlet接口

Servlet的生命周期

所谓Servlet的生命周期，就是说Servlet的创建、服务，以及销毁。与Servlet的生命周期相关的方法有：

    void init(ServletConfig)；
void service(ServletRequest,ServletResponse)；
void destroy()；

Servlet的创建

服务器会在Servlet第一次被访问时创建Servlet对象，或者是在服务器启动时创建Servlet。如果服务器启动时就创建Servlet，那么还需要在web.xml文件中配置。也就是说默认情况下，Servlet是在第一次被访问时由服务器创建的。

而且一个Servlet类型，服务器只创建一个实例对象，例如在我们首次访问http://localhost:8080/helloservlet/helloworld时，服务器通过“/helloworld”找到了绑定的Servlet名称为cn.itcast.servlet.HelloServlet，然后服务器查看这个类型的Servlet是否已经创建过，如果没有创建过，那么服务器才会通过反射来创建HelloServlet的实例。当我们再次访问http://localhost:8080/helloservlet/helloworld时，服务器就不会再次创建HelloServlet实例了，而是直接使用上次创建的实例。

在Servlet被创建后，服务器会马上调用Servlet的void init(ServletConfig)方法。请记住， Servlet出生后马上就会调用init()方法，而且一个Servlet的一生。这个方法只会被调用一次。

我们可以把一些对Servlet的初始化工作放到init方法中！

Servlet服务

当服务器每次接收到请求时，都会去调用Servlet的service()方法来处理请求。服务器接收到一次请求，就会调用service() 方法一次，所以service()方法是会被调用多次的。正因为如此，所以我们才需要把处理请求的代码写到service()方法中！

Servlet的销毁

Servlet是不会轻易离去的，通常都是在服务器关闭时Servlet才会离去！在服务器被关闭时，服务器会去销毁Servlet，在销毁Servlet之前服务器会先去调用Servlet的destroy()方法，我们可以把Servlet的临终遗言放到destroy()方法中，例如对某些资源的释放等代码放到destroy()方法中。

测试生命周期方法

修改HelloServlet如下，然后再去访问http://localhost:8080/helloservlet/helloworld

public class HelloServlet implements Servlet {
public void init(ServletConfig config) throws ServletException {
        System.out.println("Servlet被创建了！");
    }
public ServletConfig getServletConfig() {return null;}
public void destroy() {
        System.out.println("Servlet被销毁了！");
    }
public String getServletInfo() {return null;}

public void service(ServletRequest req, ServletResponse res)
throws ServletException, IOException {
        System.out.println("hello servlet!");
    }
}

可以看到：在首次访问HelloServlet时，init方法会被执行，而且也会执行service方法。再次访问时，只会执行service方法，不再执行init方法。在关闭Tomcat时会调用destroy方法。

Servlet接口相关类型

在Servlet接口中还存在三个我们不熟悉的类型：

  • ServletRequest：service() 方法的参数，它表示请求对象，它封装了所有与请求相关的数据，它是由服务器创建的；
  • ServletResponse：service()方法的参数，它表示响应对象，在service()方法中完成对客户端的响应需要使用这个对象；
  • ServletConfig：init()方法的参数，它表示Servlet配置对象，它对应Servlet的配置信息，对应web.xml文件中的<servlet>元素。

ServletRequest和ServletResponse（在后续文章中会详细讲解这两个对象）

ServletRequest和ServletResponse是Servlet#service() 方法的两个参数，一个是请求对象，一个是响应对象，可以从ServletRequest对象中获取请求数据，可以使用ServletResponse对象完成与客户端浏览器的响应。

ServletRequest和ServletResponse的实例由服务器创建，然后传递给service()方法。如果在service() 方法中希望使用HTTP相关的功能，那么可以把ServletRequest和ServletResponse强转成HttpServletRequest和HttpServletResponse。这也说明我们经常需要在service()方法中对ServletRequest和ServletResponse进行强转，这是很心烦的事情。不过后面会有一个类来帮我们解决这一问题的。

HttpServletRequest的主要方法：

  • String getParameter(String paramName)：获取指定请求参数的值；
  • String getMethod()：获取请求方法，例如GET或POST；
  • String getHeader(String name)：获取指定请求头的值；
  • void setCharacterEncoding(String encoding)：设置请求体的编码！因为GET请求没有请求体，所以这个方法只只对POST请求有效。当调用request.setCharacterEncoding(“utf-8”)之后，再通过getParameter()方法获取参数值时，那么参数值都已经通过了转码，即转换成了UTF-8编码。所以，这个方法必须在调用getParameter()方法之前调用！

HttpServletResponse的主要方法：

  • PrintWriter getWriter()：获取字符响应流，使用该流可以向客户端输出响应信息。例如response.getWriter().print("<h1>Hello JavaWeb!</h1>")；
  • ServletOutputStream getOutputStream()：获取字节响应流，当需要向客户端响应字节数据时，需要使用这个流，例如要向客户端响应图片；
  • void setCharacterEncoding(String encoding)：用来设置字符响应流的编码，例如在调用setCharacterEncoding(“utf-8”);之后，再response.getWriter()获取字符响应流对象，这时的响应流的编码为utf-8，使用response.getWriter()输出的中文都会转换成utf-8编码后发送给客户端；
  • void setHeader(String name, String value)：向客户端添加响应头信息，例如setHeader(“Refresh”, “3;url=http://www.itcast.cn”)，表示3秒后自动刷新到http://www.itcast.cn；
  • void setContentType(String contentType)：该方法是setHeader(“content-type”, “xxx”)的简便方法，即用来添加名为content-type响应头的方法。content-type响应头用来设置响应数据的MIME类型，例如要向客户端响应jpg的图片，那么可以setContentType(“image/jepg”)，如果响应数据为文本类型，那么还要台同时设置编码，例如setContentType(“text/html;chartset=utf-8”)表示响应数据类型为文本类型中的html类型，并且该方法会调用setCharacterEncoding(“utf-8”)方法；
  • void sendError(int code, String errorMsg)：向客户端发送状态码，以及错误消息。例如给客户端发送404：response(404, “您要查找的资源不存在！”)。

ServletConfig的主要方法：

ServletConfig对象对应web.xml文件中的<servlet>元素。例如你想获取当前Servlet在web.xml文件中的配置名，那么可以使用servletConfig.getServletName()方法获取！

JavaWeb三大组件之一Servlet【Servlet接口】

ServletConfig对象是由服务器创建的，然后传递给Servlet的init()方法，你可以在init()方法中使用它！

  • String getServletName()：获取Servlet在web.xml文件中的配置名称，即<servlet-name>指定的名称；
  • ServletContext getServletContext()：用来获取ServletContext对象，ServletContext会在后面讲解(非常重要！)；
  • String getInitParameter(String name)：用来获取在web.xml中配置的初始化参数，通过参数名来获取参数值；
  • Enumeration getInitParameterNames()：用来获取在web.xml中配置的所有初始化参数名称；

在<servlet>元素中还可以配置初始化参数：

  <servlet>
<servlet-name>One</servlet-name>
<servlet-class>cn.itcast.servlet.OneServlet</servlet-class>
<init-param>
<param-name>paramName1</param-name>
<param-value>paramValue1</param-value>
</init-param>
<init-param>
<param-name>paramName2</param-name>
<param-value>paramValue2</param-value>
</init-param>
</servlet>
在OneServlet中，可以使用ServletConfig对象的getInitParameter()方法来获取初始化参数，例如：
String value1 = servletConfig.getInitParameter(“paramName1”);//获取到paramValue1
标签：

相关文章