@WebServlet注解的使用

本文介绍在Servlet3.0及以上版本中如何利用@WebServlet注解替代web.xml配置文件进行Servlet配置的方法。包括@WebServlet注解的各项属性说明及一个简单的示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

在servlet3.0以后,我们可以不用再web.xml里面配置servlet,只需要加上@WebServlet注解就可以修改该servlet的属性了。web.xml可以配置的servlet属性,在@WebServlet中都可以配置。

@WebServlet属性列表:

属性名类型描述
nameString指定Servlet 的 name 属性,等价于 <servlet-name>。如果没有显式指定,则该 Servlet 的取值即为类的全限定名。
valueString[]该属性等价于 urlPatterns 属性。两个属性不能同时使用。
urlPatternsString[]指定一组 Servlet 的 URL 匹配模式。等价于<url-pattern>标签。
loadOnStartupint指定 Servlet 的加载顺序,等价于 <load-on-startup>标签。
initParamsWebInitParam[]指定一组 Servlet 初始化参数,等价于<init-param>标签。
asyncSupportedboolean声明 Servlet 是否支持异步操作模式,等价于<async-supported> 标签。
descriptionString该 Servlet 的描述信息,等价于 <description>标签。
displayNameString该 Servlet 的显示名,通常配合工具使用,等价于 <display-name>标签。

简单实例:

package com.lht.demo;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@WebServlet(asyncSupported = true, value = "/myServlet")
public class MyServlet extends HttpServlet {
	private static final long serialVersionUID = 1L;

	public MyServlet() {
		super();
	}

	@Override
	protected void doGet(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {
		response.setContentType("text/html;charset=UTF-8");
		PrintWriter out = response.getWriter();
		out.println("<html>");
		out.println("<head>");
		out.println("<title>A Servlet</title>");
		out.println("</head>");
		out.println("<body>");
		out.print(this.getClass());
		out.println(", using the GET method");
		out.println("/body>");
		out.append("Served at: ").append(request.getContextPath());
		out.flush();
		out.close();
	}

	@Override
	protected void doPost(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {
		doGet(request, response);
	}
	
}

转载来自:http://blog.youkuaiyun.com/maozi_bsz/article/details/46431189

### @WebServlet 注解的作用 `@WebServlet` 是 Java Servlet 3.0 规范中引入的一个注解,用于简化在 Web 应用程序中定义 Servlet 的过程。通过该注解,开发者无需再手动编辑 `web.xml` 文件来配置 URL 映射,而是可以直接在 Servlet 类上使用注解进行声明,从而提高开发效率和代码可读性[^2]。 其主要作用包括: - **替代传统 XML 配置**:将 Servlet 的配置信息直接写入代码中,减少外部配置文件的依赖。 - **简化部署描述符**:使得 `web.xml` 文件可以更简洁,甚至完全省略对某些简单项目来说不必要的配置。 - **增强代码可维护性**:URL 映射等信息与对应的类绑定在一起,便于理解和维护。 ### 如何使用 @WebServlet 注解 #### 1. 启用注解支持 确保项目的 `web.xml` 中 `<web-app>` 标签内的版本号为 3.0 或更高,并且没有设置 `metadata-complete="true"` 属性,否则容器会忽略所有注解配置。示例声明如下: ```xml <web-app 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" version="3.0"> </web-app> ``` #### 2. 定义一个继承 HttpServlet 的类 创建一个新的 Java 类并让它继承 `HttpServlet`,然后重写需要的方法如 `doGet()` 或 `doPost()` 来处理 HTTP 请求。 #### 3. 添加 @WebServlet 注解 在类级别添加 `@WebServlet` 注解,并指定希望映射到此 Servlet 的 URL 路径。例如: ```java import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.IOException; @WebServlet("/example") public class ExampleServlet extends HttpServlet { @Override protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException { // 处理GET请求逻辑 response.getWriter().write("Hello from ExampleServlet!"); } @Override protected void doPost(HttpServletRequest request, HttpServletResponse response) throws IOException { // 处理POST请求逻辑 } } ``` #### 4. 测试 Servlet 部署应用至支持 Servlet 3.0 的服务器(如 Tomcat 7+),然后通过浏览器访问指定的 URL 路径以测试是否能够正确触发该 Servlet。 ### 示例对比:@WebServlet 与 web.xml 配置 假设有一个简单的 Servlet 需要被访问路径 `/test` 映射: - 使用 `@WebServlet` 方式: ```java @WebServlet("/test") public class TestServlet extends HttpServlet { /* ... */ } ``` - 对应的传统 `web.xml` 配置方式: ```xml <servlet> <servlet-name>TestServlet</servlet-name> <servlet-class>com.example.TestServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>TestServlet</servlet-name> <url-pattern>/test</url-pattern> </servlet-mapping> ``` 两种方法都能达到相同的效果,但使用 `@WebServlet` 更加直观便捷。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值