03、Servlet

一、Servlet

1.1、Servet简介

Servlet是sun公司提供的一门用于开发动态web资源的技术。

Sun公司在其API中提供了一个servlet接口，用户若想用发一个动态web资源，需要完成以下2个步骤：

1、编写一个Java类，实现servlet接口。

2、把开发好的Java类部署到web服务器中。

按照一种约定俗成的称呼习惯，通常我们也把实现了servlet接口的java程序，称之为Servlet

1.2、Servlet运行过程

Servlet程序是由WEB服务器调用，web服务器收到客户端的Servlet访问请求后：

①Web服务器首先检查是否已经装载并创建了该Servlet的实例对象。如果是，则直接执行第④步，否则，执行第②步。

②装载并创建该Servlet的一个实例对象。

③调用Servlet实例对象的init()方法。

④创建一个用于封装HTTP请求消息的HttpServletRequest对象和一个代表HTTP响应消息的HttpServletResponse对象，

然后调用Servlet的service()方法并将请求和响应对象作为参数传递进去。

⑤WEB应用程序被停止或重新启动之前，Servlet引擎将卸载Servlet，并在卸载之前调用Servlet的destroy()方法。

1.3、Eclipse开发Servlet

在eclipse中新建一个web project工程，eclipse会自动创建下图所示目录结构：

JavaWebDemo：web工程名称，该工程部署时，在webapps目录下会有一个javaWebDemo的应用。
src：Java程序的开发目录，该目录下编写的所有程序在部署时，会自动部署到JavaWebDemo/WEB-INF/classes目录下。
Webroot：对应web应用的根目录，该目录下所有子目录和文件夹在部署时，会原封不动的发布到Web应用目录下。

1.4、Servlet接口实现类

Servlet接口SUN公司定义了两个默认实现类，分别为：GenericServlet、HttpServlet。

HttpServlet指能够处理HTTP请求的servlet，它在原有Servlet接口上添加与HTTP协议处理方法，通常继承该类。

HttpServlet在实现Servlet接口时通常只需要覆写doGet或doPost方法，而不要去覆写service方法。

1.5、Eclipse配置Tomcat

依次选择Window -> Preferences -> service -> tomcat来添加本地的tomcat

可以通过下方的两个小图标来部署应用和在Eclipse中开启Tomcat

当应用部署时，会将当前项目原封不动部署到tomcat7.0\webapps目录下。这样我们可以正常访问了。

注意：webapps下的目录名称是可以在Eclipse配置中修改的，但是建议默认和项目名称保存一致即可。

1.6、创建和编写Servlet

右键项目 -> new -> servlet来创建一个Servlet程序。

a)我们就通过Eclipse帮我们创建好一个名字为ServletDemo1的Servlet，创建好的ServletDemo01里面会有如下代码：

public class ServletDemo1 extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.getWriter().write("time：" + new Date().toLocaleString());
    }
    
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

在web.xml文件中多两对标签<servlet>和<servlet-mapping>，用来配置ServletDemo1的，如下所示：

然后我们就可以通过浏览器访问ServletDemo1这个Servlet，如下图所示：

1.7、Servlet开发细节

1、Servlet访问Url映射配置

Servlet程序若想被外界访问，必须把servlet程序映射到一个URL地址上，在web.xml文件中使用<servlet>元素和<servlet-mapping>元素完成。

<servlet>元素用于注册Servlet：<servlet-name>和<servlet-class>，分别用于设置Servlet的注册名称和Servlet的完整类名。

<servlet-mapping>元素用于映射一个已注册的Servlet的一个对外访问路径，它包含有两个子元素：<servlet-name>和<url-pattern>，

分别用于指定Servlet的注册名称和Servlet的对外访问路径。

<servlet>
  <description>This is the description of my J2EE component</description>
  <display-name>This is the display name of my J2EE component</display-name>
  <servlet-name>ServletDemo1</servlet-name>
  <servlet-class>cn.legend.server.ServletDemo1</servlet-class>
</servlet>
<servlet-mapping>
  <servlet-name>ServletDemo1</servlet-name>
  <url-pattern>/servlet/ServletDemo1</url-pattern>
</servlet-mapping>

同一个Servlet可以被映射到多个URL上，即多个<servlet-mapping>元素的<servlet-name>子元素的设置值可以是同一个Servlet的注册名

<servlet>
  <description>This is the description of my J2EE component</description>
  <display-name>This is the display name of my J2EE component</display-name>
  <servlet-name>ServletDemo1</servlet-name>
  <servlet-class>cn.legend.server.ServletDemo1</servlet-class>
</servlet>
<servlet-mapping>
  <servlet-name>ServletDemo1</servlet-name>
  <url-pattern>/servlet/ServletDemo1</url-pattern>
</servlet-mapping>
<servlet-mapping>
   <servlet-name>ServletDemo1</servlet-name>
   <url-pattern>/1.htm</url-pattern>
 </servlet-mapping>
  <servlet-mapping>
   <servlet-name>ServletDemo1</servlet-name>
   <url-pattern>/2.jsp</url-pattern>
 </servlet-mapping>

通过上面的配置，当我们想访问名称是ServletDemo1的Servlet，可以使用如下的几个地址去访问：

http://localhost:8080/JavaWebDemo/servlet/ServletDemo1
http://localhost:8080/JavaWebDemo/1.htm
http://localhost:8080/JavaWebDemo/2.jsp

2、Servlet的Url通配符

在Servlet映射到的URL中也可以使用*通配符，但是只能有两种固定的格式：

格式是"*.扩展名"
格式是以正斜杠（/）开头并以"/*"结尾

<servlet-mapping>
  <servlet-name>ServletDemo1</servlet-name>
  <url-pattern>/servlet/ServletDemo1</url-pattern>
</servlet-mapping>
 
<servlet-mapping>
  <servlet-name>ServletDemo1</servlet-name>
  <url-pattern>/*</url-pattern>
</servlet-mapping>

可以匹配任意的字符，所以此时可以用任意的URL去访问ServletDemo1这个Servlet，如下图所示：

3、映射关系的问答

对于如下的一些映射关系：

Servlet1 映射到 /abc/*
Servlet2 映射到 /*
Servlet3 映射到 /abc
Servlet4 映射到 *.do

问题：

a) 当请求URL为“/abc/a.html”，“/abc/*”和“/*”都匹配，哪个servlet响应

答：Servlet引擎将调用Servlet1。

b) 当请求URL为“/abc”时，“/abc/*”和“/abc”都匹配，哪个servlet响应

答：Servlet引擎将调用Servlet3。

c) 当请求URL为“/abc/a.do”时，“/abc/*”和“*.do”都匹配，哪个servlet响应

答：Servlet引擎将调用Servlet1。

d) 当请求URL为“/a.do”时，“/*”和“*.do”都匹配，哪个servlet响应

答：Servlet引擎将调用Servlet2。

e) 当请求URL为“/xxx/yyy/a.do”时，“/*”和“*.do”都匹配，哪个servlet响应

答：Servlet引擎将调用Servlet2。

总结：匹配的原则就是"谁长得更像就找谁"

1.8、Servlet与类的区别

Servlet是一个供其他Java程序（Servlet引擎）调用的Java类，它不能独立运行，它的运行完全由Servlet引擎来控制和调度。

针对客户端的多次Servlet请求，通常情况下，服务器只会创建一个Servlet实例对象，也就是说Servlet实例对象一旦创建，

它就会驻留在内存中，为后续的其它请求服务，直至web容器退出，servlet实例对象才会销毁。

在Servlet的整个生命周期内，Servlet的init方法只被调用一次。而对一个Servlet的每次访问请求都导致Servlet引擎调用一次servlet的service方法。

对于每次访问请求，Servlet引擎都会创建一个新的HttpServletRequest请求对象和一个新的HttpServletResponse响应对象，然后将这两个对象作为参数

传递给它调用的Servlet的service()方法，service方法再根据请求方式分别调用doXXX方法。

如果在<servlet>元素中配置了一个<load-on-startup>元素，那么WEB应用程序在启动时，就会装载并创建Servlet的实例对象、

以及调用Servlet实例对象的init()方法。

<servlet>
    <servlet-name>invoker</servlet-name>
    <servlet-class>
        org.apache.catalina.servlets.InvokerServlet
    </servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>

用途：为web应用写一个InitServlet，这个servlet配置为启动时装载，为整个web应用创建必要的数据库表和数据。

1.9、缺省Servlet

如果某个Servlet的映射路径仅仅为一个正斜杠（/），那么这个Servlet就成为当前Web应用程序的缺省Servlet。

凡是在web.xml文件中找不到匹配的<servlet-mapping>元素的URL，它们的访问请求都将交给缺省Servlet处理。

<servlet>
    <servlet-name>ServletDemo1</servlet-name>
    <servlet-class>gacl.servlet.study.ServletDemo1</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>
   
<!-- 将ServletDemo1配置成缺省Servlet -->
<servlet-mapping>
    <servlet-name>ServletDemo1</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

2.0、Servlet线程安全问题

1、Servlet线程安全隐患

当多个客户端并发访问同一个Servlet时，web服务器会为每一个客户端的访问请求创建一个线程，并在这个线程上调用Servlet的service方法，

因此service方法内如果访问了同一个资源的话，就有可能引发线程安全问题

a) 存在线程安全的代码

public class ServletDemo1 extends HttpServlet {
    int i = 1;
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        i++;
        try {
            Thread.sleep(4* 1000);
        } catch (Exception e) {
            e.printStackTrace();
        }
        response.getWriter().write(String.valueOf(i));
    } 
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

多线程并发访问该servlet时会产生线程安全问题，因为i是成员变量，是所有客户端所共享的，并发访问会导致安全问题。

b) 解决线程安全的代码

public class ServletDemo1 extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        int i = 1;
        i++;
        try {
            Thread.sleep(4* 1000);
        } catch (Exception e) {
            e.printStackTrace();
        }
        response.getWriter().write(String.valueOf(i));
    } 
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

由于i是局部变量，每个线程都会有自己的一份，所以不存在线程安全的问题。

c) 同步解决线程安全问题（不推荐）

public class ServletDemo1 extends HttpServlet {  
    int i = 1;
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        synchronized(this) {
            i++;
            try {
                Thread.sleep(4* 1000);
            } catch (Exception e) {
                e.printStackTrace();
            }
            response.getWriter().write(String.valueOf(i));
        }
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

现在这种做法是给Servlet对象加了一把锁，保证任何时候都只有一个线程在访问该Servlet对象里面的资源，这样就不存在线程安全问题。

注意：不过这种做法非常不推荐，因为如果有10000人去访问时，必须会分先后顺序排队去访问。

2、官方解决线程安全问题

针对Servlet的线程安全问题，Sun公司是提供有解决方案的：

让Servlet去实现一个SingleThreadModel接口，如果某个Servlet实现了SingleThreadModel(标记接口)，那么Servlet引擎将以单线程模式来调用其service方法。

eadModel接口并不能真正解决Servlet的线程安全问题，因为Servlet引擎会创建多个Servlet实例对象，而真正意义上解决多线程安全问题是指一个Servlet实例

对象被多个线程同时调用的问题。事实上，在Servlet API 2.4中，已经将SingleThreadModel标记为Deprecated（过时的）。

二、ServletConfig

1.1、配置Servlet初始化参数

在Servlet的配置文件web.xml中，可以使用一个或多个<init-param>标签为servlet配置一些初始化参数。

<servlet>
   <servlet-name>ServletConfigDemo</servlet-name>
   <servlet-class>cn.legend.service.ServletConfigDemo</servlet-class>
   <!-- 配置ServletConfigDemo的初始化参数 -->
   <init-param>
       <param-name>username</param-name>
       <param-value>legend</param-value>
   </init-param>
   <init-param>
       <param-name>password</param-name>
       <param-value>123456</param-value>
   </init-param>
   <init-param>
       <param-name>charset</param-name>
       <param-value>UTF-8</param-value>
   </init-param>
</servlet>

1.2、获取Servlet初始化参数

当servlet配置了初始化参数后，web容器在创建servlet实例对象时，会自动将这些初始化参数封装到ServletConfig对象中，

并在调用servlet的init方法时，将ServletConfig对象传递给servlet。进而，我们通过ServletConfig对象就可以得到当前servlet的初始化参数信息。

public class ServletConfigDemo extends HttpServlet {
    /**定义ServletConfig对象来接收配置的初始化参数*/
    private ServletConfig config;
    @Override
    public void init(ServletConfig config) throws ServletException {
        this.config = config;
    }
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        // 获取在web.xml配置的初始化参数
        String username = config.getInitParameter("username");
        response.getWriter().print(username);     
        response.getWriter().print("<hr/>");
        // 获取所有的初始化参数
        Enumeration<String> enumeration = config.getInitParameterNames();
        while(enumeration.hasMoreElements()){
            String nameTag = enumeration.nextElement();
            String name = config.getInitParameter(nameTag);
            response.getWriter().print(nameTag + "=" + name + "<br/>");
        }
    }
    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

运行结果如下：

三、ServletContext

WEB容器在启动时，它会为每个WEB应用程序都创建一个对应的ServletContext对象，它代表当前web应用。

ServletContext servletContext = config.getServletContext();

由于一个WEB应用中的所有Servlet共享同一个ServletContext对象，因此Servlet对象之间可以通过ServletContext对象来实现通讯。

ServletContext对象通常也被称之为context域对象。

1.1、ServletContext的应用

1、Servlet数据共享

范例：ServletContextDemo1和ServletContextDemo2通过ServletContext对象实现数据共享。

a) ServletContextDemo1

public class ServletContextDemo1 extends HttpServlet {
    private ServletConfig servletConfig;
    @Override
    public void init(ServletConfig config) throws ServletException {
        this.servletConfig = config;
    }
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        String data = "legend";
        ServletContext servletContext = servletConfig.getServletContext();
        servletContext.setAttribute("data", data);
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

b) ServletContextDemo2

public class ServletContextDemo2 extends HttpServlet {  
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        ServletContext servletContext = this.getServletContext();
        // 从ServletContext对象中取出数据
        String data = (String) servletContext.getAttribute("data");
        response.getWriter().print(data);
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

先运行ServletContextDemo1，将数据data存储到ServletContext对象，然后运行ServletContextDemo2就可以从ServletContext对象中取出数据。

2、获取Web应用的初始化参数

在web.xml文件中使用<context-param>标签配置WEB应用的初始化参数，如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
  <!-- 配置Web初始化参数 -->
  <context-param>
      <param-name>url</param-name>
      <param-value>jdbc:mysql://localhost:3306/test</param-value>
  </context-param>
  <welcome-file-list>
      <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
</web-app>

获取Web应用的初始化参数，代码如下：

public class ServletContextDemo3 extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        ServletContext servletContext = this.getServletContext();
        // 第一种方式： 获取web站点的初始化参数
        String url = servletContext.getInitParameter("url");
        response.getWriter().print(url);
        response.getWriter().print("<hr/>");
        
        // 第二种方式： 获取web站点的初始化参数
        Enumeration<String> enumeration = servletContext.getInitParameterNames();
        while(enumeration.hasMoreElements()){
            String tag = enumeration.nextElement();
            String value = servletContext.getInitParameter(tag);
            response.getWriter().print(tag + "=" + value);
        }
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

输出结果：

3、ServletContext实现请求转发

a) ServletContextDemo4

public class ServletContextDemo4 extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        String data = "<h1><font color='red'>legend</font></h1>";
        response.getOutputStream().write(data.getBytes());
        ServletContext servletContext = this.getServletContext();
        // 获取请求并转发对象
        RequestDispatcher dispatcher = servletContext.getRequestDispatcher("/servlet/ServletContextDemo5");
        dispatcher.forward(request, response);
        
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

b) ServletContextDemo5

public class ServletContextDemo5 extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.getOutputStream().write("servletDemo5".getBytes());
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

访问的是ServletContextDemo4，浏览器显示的却是ServletContextDemo5的内容，这就是使用ServletContext实现了请求转发

4、ServletContext读取资源文件

项目结构如下:

使用ServletContext获取资源：

public class ServletContextDemo6 extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        // response.setContentType("text/html;charset=UTF-8");
        response.setHeader("content-type","text/html;charset=UTF-8");
        
        response.getWriter().println("读取src目录下的properties配置文件：");
        String db1Path = "/WEB-INF/classes/db1.properties";
        readPropertiesFile(response, db1Path, false);
        response.getWriter().println("<hr/>");
        
        response.getWriter().println("读取WebRoot目录下的properties配置文件：");
        String db2Path = "/db2.properties";
        readPropertiesFile(response, db2Path, false);
        response.getWriter().println("<hr/>");
        
        response.getWriter().println("读取src目录下的db.config包中的db3.properties配置文件：");
        String db3Path = this.getServletContext().getRealPath("/WEB-INF/classes/db/config/db3.properties");
        readPropertiesFile(response, db3Path, true);
        response.getWriter().println("<hr/>");
        
        response.getWriter().println("读取src目录下的gacl.servlet.study包中的db4.properties配置文件：");
        String db4Path = "/WEB-INF/classes/cn/legend/service/db4.properties";
        readPropertiesFile(response, db4Path, false);
        response.getWriter().println("<hr/>");
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    } 
    /**
     * 读取文件的方法
     * @param response 响应
     * @param path    文件路径
     * @throws IOException
     */
    private void readPropertiesFile(HttpServletResponse response, String path, boolean flag) throws IOException {
        InputStream inputStream;
        // 只有db3的读取有略微区别，用flag判断
        if(flag){
            inputStream = new FileInputStream(path);
        }else {
            inputStream = this.getServletContext().getResourceAsStream(path);
        }
        Properties prop = new Properties();
        prop.load(inputStream);
        String driver = prop.getProperty("driver");
        String url = prop.getProperty("url");
        String username = prop.getProperty("username");
        String password = prop.getProperty("password");
        String format = MessageFormat.format("driver={0},url={1},username={2},password={3}", driver,url, username, password);
        response.getWriter().println(format);
    }
}