javaweb的servlet使用指南

最新推荐文章于 2023-09-26 16:56:49 发布

bingo_liu

最新推荐文章于 2023-09-26 16:56:49 发布

阅读量298

点赞数

分类专栏： javaweb

本文链接：https://blog.csdn.net/bingo_liu/article/details/55519331

版权

javaweb 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

Servlet类由我们来写，但对象由服务器来创建，并且由服务器来调用相应的方法。
Servlet.class等类都在servlet-api.jar中

生命周期

void init(ServletConfig)：出生之后（1次）；
void service(ServletRequest request, ServletResponse response)：每次处理请求时都会被调用；
void destroy()：临死之前（1次）；

特性

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

实现方式

实现javax.servlet.Servlet接口；
继承javax.servlet.GenericServlet类；
继承javax.servlet.http.HttpServlet类；（常用）

第一个应用

项目准备

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

HelloServlet.java

public class HelloServlet implements 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!");
    }
}

web.xml
把访问路径与一个Servlet绑定到一起

<servlet>
    <servlet-name>hello</servlet-name>
    <servlet-class>com.servlet.HelloServlet</servlet-class>
</servlet>

<servlet-mapping>
    <servlet-name>hello</servlet-name>
    <!-- 访问路径，如:http://localhost:8080/helloworld -->
    <url-pattern>/helloworld</url-pattern>
</servlet-mapping>

Servlet的出生

服务器会在Servlet第一次被访问时创建Servlet，或者是在服务器启动时创建Servlet。如果服务器启动时就创建Servlet，那么还需要在web.xml文件中配置。
一个Servlet类型，服务器只创建一个实例对象，例如在我们首次访问http://localhost:8080/helloservlet/helloworld时，服务器通过“/helloworld”找到了绑定的Servlet名称为com.servlet.HelloServlet，然后服务器查看这个类型的Servlet是否已经创建过，如果没有创建过，那么服务器才会通过反射来创建HelloServlet的实例。当我们再次访问http://localhost:8080/helloservlet/helloworld时，服务器就不会再次创建HelloServlet实例了，而是直接使用上次创建的实例。
在Servlet被创建后，服务器会马上调用Servlet的void init(ServletConfig)方法。这个方法只会被调用一次。我们可以把一些对Servlet的初始化工作放到init方法中！

Servlet服务

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

Servlet的离去

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

Servlet接口相关类型

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

如果在service() 方法中希望使用HTTP相关的功能，那么可以把ServletRequest和ServletResponse强转成HttpServletRequest和HttpServletResponse。为了避免强转，我们可以使用HttpServlet。

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.520.com”)，表示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()方法获取！

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-name>One</servlet-name>
  <servlet-class>com.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

GenericServlet

概述

GenericServlet是Servlet接口的实现类，我们可以通过继承GenericServlet来编写自己的Servlet。

GenericServlet.java

public abstract class GenericServlet implements Servlet, ServletConfig,
        java.io.Serializable {
    private static final long serialVersionUID = 1L;
    private transient ServletConfig config;

    public GenericServlet() {}
    @Override
    public void destroy() {}
    @Override
    public String getInitParameter(String name) {
        return getServletConfig().getInitParameter(name);
    }
    @Override
    public Enumeration<String> getInitParameterNames() {
        return getServletConfig().getInitParameterNames();
    }
    @Override
    public ServletConfig getServletConfig() {
        return config;
    }
    @Override
    public ServletContext getServletContext() {
        return getServletConfig().getServletContext();
    }
    @Override
    public String getServletInfo() {
        return "";
    }
    @Override
    public void init(ServletConfig config) throws ServletException {
        this.config = config;
        this.init();
    }
    public void init() throws ServletException {}
    public void log(String msg) {
getServletContext().log(getServletName() + ": " + msg);
    }
    public void log(String message, Throwable t) {
getServletContext().log(getServletName() + ": " + message, t);
    }
    @Override
    public abstract void service(ServletRequest req, ServletResponse res)
            throws ServletException, IOException;
    @Override
    public String getServletName() {
        return config.getServletName();
    }
}

GenericServlet的init()方法

在GenericServlet中，定义了一个ServletConfig config实例变量，并在init(ServletConfig)方法中把参数ServletConfig赋给了实例变量。然后在该类的很多方法中使用了实例变量config。
如果子类覆盖了GenericServlet的init(StringConfig)方法，那么this.config=config这一条语句就会被覆盖了，也就是说GenericServlet的实例变量config的值为null，那么所有依赖config的方法都不能使用了。如果真的希望完成一些初始化操作，那么去覆盖GenericServlet提供的init()方法，它是没有参数的init()方法，它会在init(ServletConfig)方法中被调用。

实现了ServletConfig接口

GenericServlet还实现了ServletConfig接口，所以可以直接调用getInitParameter()、getServletContext()等ServletConfig的方法。

HttpServlet

HttpServlet类是GenericServlet的子类，它提供了对HTTP请求的特殊支持，所以通常我们都会通过继承HttpServlet来完成自定义的Servlet。

HttpServlet覆盖了service()方法

HttpServlet类中提供了service(HttpServletRequest,HttpServletResponse)方法，这个方法是HttpServlet自己的方法，不是从Servlet继承来的。在HttpServlet的service(ServletRequest,ServletResponse)方法中会把ServletRequest和ServletResponse强转成HttpServletRequest和HttpServletResponse，然后调用service(HttpServletRequest,HttpServletResponse)方法，这说明子类可以去覆盖service(HttpServletRequest,HttpServletResponse)方法即可，这就不用自己去强转请求和响应对象了。
其实子类也不用去覆盖service(HttpServletRequest,HttpServletResponse)方法，因为HttpServlet还要做另一步简化操作，下面会介绍。

HttpServlet.java

public abstract class HttpServlet extends GenericServlet {
    protected void service(HttpServletRequest req, HttpServletResponse resp)
        throws ServletException, IOException {
        //……
    }

    @Override
    public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException {
        HttpServletRequest  request;
        HttpServletResponse response;

        try {
                request = (HttpServletRequest) req;
                response = (HttpServletResponse) res;
            } catch (ClassCastException e) {
                throw new ServletException("non-HTTP request or response");
            }
        service(request, response);
}
//……
}

doGet()和doPost()

在HttpServlet的service(HttpServletRequest,HttpServletResponse)方法会去判断当前请求是GET还是POST，如果是GET请求，那么会去调用本类的doGet()方法，如果是POST请求会去调用doPost()方法，这说明我们在子类中去覆盖doGet()或doPost()方法即可。

public class AServlet extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
           throws ServletException, IOException {
       System.out.println("hello doGet()...");
    }
}
public class BServlet extends HttpServlet {
    public void doPost(HttpServletRequest request, HttpServletResponse response)
           throws ServletException, IOException {
       System.out.println("hello doPost()...");
    }
}

Servlet细节

不要在Servlet中创建成员！创建局部变量即可！
可以创建无状态成员！
可以创建有状态的成员，但状态必须为只读的！

Servlet与线程安全

因为一个类型的Servlet只有一个实例对象，那么就有可能会出现一个Servlet同时处理多个请求，所以我们不应该在Servlet中便宜创建成员变量，因为可能会存在一个线程对这个成员变量进行写操作，另一个线程对这个成员变量进行读操作。

让服务器在启动时就创建Servlet

<servlet>
   <servlet-name>hello1</servlet-name>
   <servlet-class>com.servlet.Hello1Servlet</servlet-class>
   <load-on-startup>0</load-on-startup>[c5] 
</servlet>
<servlet-mapping>
   <servlet-name>hello1</servlet-name>
   <url-pattern>/hello1</url-pattern>
</servlet-mapping>

<servlet>
   <servlet-name>hello2</servlet-name>
   <servlet-class>com.servlet.Hello2Servlet</servlet-class>
   <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
   <servlet-name>hello2</servlet-name>
   <url-pattern>/hello2</url-pattern>
</servlet-mapping>

<servlet>
   <servlet-name>hello3</servlet-name>
   <servlet-class>com.servlet.Hello3Servlet</servlet-class>
   <load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
   <servlet-name>hello3</servlet-name>
   <url-pattern>/hello3</url-pattern>
</servlet-mapping>

在元素中配置元素可以让服务器在启动时就创建该Servlet，其中元素的值必须是大于等于的整数，它的使用是服务器启动时创建Servlet的顺序。上例中，根据的值可以得知服务器创建Servlet的顺序为Hello1Servlet、Hello2Servlet、Hello3Servlet。

:
的子元素，用来指定Servlet的访问路径，即URL。它必须是以“/”开头！
1)可以在中给出多个，例如：

<servlet-mapping>
  <servlet-name>AServlet</servlet-name>
  <url-pattern>/AServlet</url-pattern>
  <url-pattern>/BServlet</url-pattern>
</servlet-mapping>

说明一个Servlet绑定了两个URL，无论访问/AServlet还是/BServlet，访问的都是AServlet。

2)使用通配符，所谓通配符就是星号“*”，星号可以匹配任何URL前缀或后缀，使用通配符可以命名一个Servlet绑定一组URL，例如：

<url-pattern>/servlet/*<url-patter>：/servlet/a、/servlet/b，都匹配/servlet/*；
<url-pattern>*.do</url-pattern>：/abc/def/ghi.do、/a.do，都匹配*.do；
<url-pattern>/* <url-pattern>：匹配所有URL；

注意：通配符要么为前缀，要么为后缀，不能出现在URL中间位置，也不能只有通配符。例如：/.do就是错误的，因为星号出现在URL的中间位置上了。.*也是不对的，因为一个URL中最多只能出现一个通配符。

ServletContext

JavaWeb四大域对象之一

一个项目只有一个ServletContext对象！
在服务器启动时就创建，在服务器关闭时才销毁！
ServletContext对象的作用是在整个Web应用的动态资源之间共享数据！例如在AServlet中向ServletContext对象中保存一个值，然后在BServlet中就可以获取这个值，这就是共享数据了。

在Servlet中获取ServletContext对象：

public class MyServlet implements Servlet {
    public void init(ServletConfig config) {
        ServletContext context = config.getServletContext();
    }
    //…
}

public class MyServlet extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response) {
        ServletContext context = this.getServletContext();
    }
}

域对象

PageContext；
ServletRequest；
HttpSession；
ServletContext；

所有域对象都有存取数据的功能，因为域对象内部有一个Map，用来存储数据，下面是ServletContext对象用来操作数据的方法：

void setAttribute(String name, Object value)：用来存储一个对象，也可以称之为存储一个域属性，例如：servletContext.setAttribute(“xxx”, “XXX”)，在ServletContext中保存了一个域属性，域属性名称为xxx，域属性的值为XXX。请注意，如果多次调用该方法，并且使用相同的name，那么会覆盖上一次的值，这一特性与Map相同；
Object getAttribute(String name)：用来获取ServletContext中的数据，当前在获取之前需要先去存储才行，例如：String value = (String)servletContext.getAttribute(“xxx”);，获取名为xxx的域属性；
void removeAttribute(String name)：用来移除ServletContext中的域属性，如果参数name指定的域属性不存在，那么本方法什么都不做；
Enumeration getAttributeNames()：获取所有域属性的名称；

获取应用初始化参数

Servlet也可以获取初始化参数，但它是局部的参数；也就是说，一个Servlet只能获取自己的初始化参数，不能获取别人的，即初始化参数只为一个Servlet准备！
可以配置公共的初始化参数，为所有Servlet而用！这需要使用ServletContext才能使用！
还可以使用ServletContext来获取在web.xml文件中配置的应用初始化参数！注意，应用初始化参数与Servlet初始化参数不同：

web.xml

<web-app>
  <context-param>
    <param-name>paramName1</param-name>
    <param-value>paramValue1</param-value>   
  </context-param>
  <context-param>
    <param-name>paramName2</param-name>
    <param-value>paramValue2</param-value>   
  </context-param>
</web-app>

ServletContext context = this.getServletContext();
String value1 = context.getInitParameter("paramName1");
String value2 = context.getInitParameter("paramName2");
System.out.println(value1 + ", " + value2);

Enumeration names = context.getInitParameterNames();
while(names.hasMoreElements()) {
    System.out.println(names.nextElement());
}

获取资源相关方法

获取真实路径

获取a.txt的真实路径：String realPath = servletContext.getRealPath(“/a.txt”)，realPath的值为a.txt文件的绝对路径：F:\tomcat6\webapps\hello\a.txt；
获取b.txt的真实路径：String realPath = servletContext.getRealPath(“/WEB-INF/b.txt”)；

获取资源流

获取a.txt资源流：InputStream in = servletContext.getResourceAsStream(“/a.txt”)；
获取b.txt资源流：InputStream in = servletContext.getResourceAsStream(“/WEB-INF/b.txt”)；

获取指定目录下所有资源路径

Set set = context.getResourcePaths("/WEB-INF");//必须以“/”开头
System.out.println(set);
/*
[/WEB-INF/lib/, /WEB-INF/classes/, /WEB-INF/b.txt, /WEB-INF/web.xml]
*/