1.3 编写基础的Servlet应用程序

1.3 编写基础的Servlet应用程序

其实,编写Servlet应用程序出奇简单。只需要创建一个目录结构,并把Servlet类放在某个目录下。本节将教你如何编写一个名为app01aServlet应用程序。最初,它会包含一个Servlet,即MyServlet,其效果是向用户发出一条问候。 要运行Servlet,还需要一个Servlet容器Tomcat是一个开源的Servlet容器,它是免费的,并且可以在任何能跑Java的平台上运行。如果你到现在都还没有安装 Tomcat,先安装Tomcat.

1.3.1编写和编译Servlet类

确定你的机器上有了Servlet容器后,下一步就要编写和编译一个Servlet类。本例中的Servlet类是MyServlet,按照惯例,Servlet类的名称要以Servlet作为后缀。

MyServlet类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package app01a;
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.Servlet;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebServlet;
@WebServlet(
name = "MyServlet",
urlPatterns ={"/my"}
)
public class MyServlet
implements
Servlet
{
private transient ServletConfig servletConfig;
@Override
public void init(ServletConfig servletConfig)
throws ServletException
{
this.servletConfig = servletConfig;
}
@Override
public ServletConfig getServletConfig()
{
return servletConfig;
}
@Override
public String getServletInfo()
{
return "My Servlet";
}
@Override
public void service(ServletRequest request,
ServletResponse response)
throws ServletException,IOException
{
String servletName = servletConfig.getServletName();
response.setContentType("text/html");
PrintWriter writer = response.getWriter();
writer.print("<html><head></head>" +
"<body>Hello from " +
servletName +
"</body></html>");
}
@Override
public void destroy()
{}
}

代码详解

WebServlet注解

1
2
3
4
@WebServlet(
name = "MyServlet",
urlPatterns = { "/my" }
)

WebServlet注解用来声明一个Servlet。命名Servlet时,还可以告诉容器,是哪个URL调用这个Servletname属性是可选的,如有,通常用Servlet类的名称。重要的是urlPatterns属性,它也是可选的,但是一般都是有的。在MyServlet中,urlPatterns告诉容器,当URL样式为:/my时应该调用MyServlet
注意,**URL样式必须用一个正斜杠开头**。

init方法

Servletinit方法只被调用一次,并将private transient变量ServletConfig设为传给该方法的ServletConfig对象:

1
2
3
4
5
6
7
private transient ServletConfig servletConfig;
@Override
public void init(ServletConfig servletConfig)
throws ServletException
{
this.servletConfig = servletConfig;
}

如果想通过Servlet内部使用ServletConfig,只需要将被传入的ServletConfig赋给一个类变量。

service方法

service方法发送字符串“Hello from MyServlet”给浏览器。对于每一个针对Servlet进来的HTTP请求,都会调用service方法

Servlet程序目录结构

Servlet应用程序必须在某一个目录结构下部署。图1.2展示了app01a的应用程序目录。
这个目录结构最上面的 app01a目录就是应用程序目录。在应用程序目录下,是WEB-INF目录。它有两个子目录:

  • classesServlet类及其他Java类必须放在这里面。类以下的目录反映了类包的结构。在图1.2中,只部署了一个类:app01a.MyServlet
  • libServlet应用程序所需的JAR文件要在这里部署。但Servlet APIJAR文件不需要在这里部署,因为Servlet容器已经有它的备份。在这个应用程序中,lib目录是空的。空的lib目录可以删除。

Servlet/JSP应用程序一般都有JSP页面、HTML文件、图片文件以及其他资料。这些应该放在应用程序目录下,并且经常放在子目录下。例如,所有的图片文件可以放在一个image目录下,所有的JSP页面可以放在jsp目录下,等等。
放在应用程序目录下的任何资源,用户只要输入资源URL,都可以直接访问到

WEB-INF目录

如果想让某一个资源可以被Servlet访问,但不可以被用户访问,那么就要把它放在WEB-INF目录下

手动部署

现在,准备将应用程序部署到Tomcat。使用Tomcat时,一种部署方法是将应用程序目录复制到Tomcat安装目录下的webapps目录中。也可以通过在Tomcatconf目录中编辑server.xml文件实现部署,或者单独部署一个XML文件,这样就不需要编辑server.xml了。其他的Servlet容器可能会有不同的部署规则。

部署为WAR文件

部署Servlet/JSP应用程序时,建议将它部署成一个WAR文件。WAR文件其实就是以.war作为扩展名的JAR文件。利用带有JDK或者类似WinZip工具的JAR软件,都可以创建WAR文件。然后,将WAR文件复制到Tomcatwebapps目录下。当开始启动Tomcat时,Tomcat就会自动解压这个war文件。部署成WAR文件在所有Servlet容器中都适用。我们将在第13章讨论更多关于部署的细节。

1.3.3调用Servlet

要测试这个Servlet,需要启动或者重启Tomcat,并在浏览器中打开下面的URL(假设Tomcat配置为监听端口8080,这是它的默认端口):
http://localhost:8080/app01a/my
浏览器显示效果如下:
这里有一张图片