Servlet是JavaEE规范中提供Web服务的最基础的组件。用户浏览器发起的HTTP请求后会交给Servlet进行处理,处理完成后,再把对应的页面或是错误消息返回给用户浏览器。编写Servlet组件非常简单,我们使用的Wildfly等JavaEE应用容器已经替我们把业务不相关的部分封装好了,我们只要在Servlet中针对GET,POST等请求类型编写相应函数逻辑即可。
这篇笔记我们介绍Servlet组件的编写和使用。
在Servlet3.0规范之后,声明Servlet类有两种方法,一种是通过XML声明,另一种方式是通过注解声明。无论如何,我们都需要创建一个Java类并继承HttpServlet
,在该类中我们可以覆写HTTP方法对应的函数,如doGet()
、doPost()
等,下面是一个例子。
DemoServlet.java
package com.gacfox.demo.demoweb;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
public class DemoServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
String msg = "Served at: " + request.getContextPath();
response.getWriter().append(msg);
}
}
上面代码我们定义了一个DemoServlet
类,该Servlet组件处理HTTP协议的GET请求,并输出当前应用的ContextPath信息。
使用XML注册Servlet是最基础的方法,下面是一个配置例子。
web.xml
<servlet>
<servlet-name>DemoServlet</servlet-name>
<servlet-class>com.gacfox.demo.demoweb.DemoServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>DemoServlet</servlet-name>
<url-pattern>/demo</url-pattern>
</servlet-mapping>
为了注册该Servlet,我们需要在工程的web.xml
中编写如上配置,配置中声明了Servlet的名字、类全名以及对应的HTTP路径。例如上面我们声明了该Servlet注册在/demo
路径下,假如我们工程的ContextPath是/demoweb
,那么此时就可以通过浏览器访问/demoweb/demo
来指定该Servlet的doGet()
方法。
用注解注册Servlet比较灵活,不过注意该功能需要在web.xml
中开启,配置如下。
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0"
metadata-complete="false">
</web-app>
web.xml
的<web-app>
配置中我们配置metadata-complete
属性为false
,此时应用启动时会通过注解扫描加载类路径下标注了@WebServlet
注解的Servlet组件。
DemoServlet.java
@WebServlet(name = "DemoServlet", urlPatterns = "/demo")
public class DemoServlet extends HttpServlet {
// ... 具体业务逻辑
}
在Servlet类中,我们标注@WebServlet
注解,并设置了其name
和urlPatterns
属性,我们可以发现其配置内容和XML是完全相同的。
尽管注解配置Servlet十分方便,但它的缺点是配置分散不好管理,此外对于类似SpringMVC等框架,它们通常需要配置一些核心转发Servlet,这些Servlet位于框架的类库Jar包中,此时我们也需要使用XML方式来配置这些Servlet组件。
Servlet组件支持通过<init-param>
配置一些初始化参数键值对,下面是一个例子。
web.xml
<servlet>
<servlet-name>DemoServlet</servlet-name>
<servlet-class>com.gacfox.demo.demoweb.DemoServlet</servlet-class>
<init-param>
<param-name>text</param-name>
<param-value>Hello, world!</param-value>
</init-param>
</servlet>
在Servlet类的代码中,我们可以通过getInitParameter()
方法读取这些初始化参数。
package com.gacfox.demo.demoweb;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
public class DemoServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
String text = getInitParameter("text");
response.getWriter().append(text);
}
}
Servlet规范没有明确规定它是单例的还是多例的,它取决于Servlet容器的实现,不过一般来说,Servlet通常是单例的。Servlet组件中,我们可以通过覆写init()
方法和destroy()
方法编写初始化和销毁的回调逻辑,下面是一个例子。
package com.gacfox.demo.demoweb;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
public class DemoServlet extends HttpServlet {
@Override
public void init() throws ServletException {
System.out.println("Servlet初始化");
}
@Override
public void destroy() {
System.out.println("Servlet销毁");
}
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
String msg = "Served at: " + request.getContextPath();
response.getWriter().append(msg);
}
}
在默认情况下,Servlet实例通常会在第一次请求到来时初始化,而在应用程序卸载时销毁。不过如果Servlet配置了load-on-startup
,则会在应用启动时初始化。
<servlet>
<servlet-name>DemoServlet</servlet-name>
<servlet-class>com.gacfox.demo.demoweb.DemoServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
如果有多个Servlet设置了load-on-startup
,它们将按照配置的顺序进行加载。上面例子中我们将Servlet的load-on-startup
配置为了1
,该值越小启动的优先级越高。