本示例演示了注解的用法，以便配置 Servlet。

在之前的教程中，我们使用部署描述符（web.xml文件）来配置我们的 servlet。 从 Servlet 3.0 开始，您可以改用@WebServlet注解。 该注解使您可以为 servlet 设置几个属性，例如名称，URL 等。

注解与部署描述符

有什么不同？ 好吧，很明显，部署描述符是一个单独的文件，您可以在其中以 XML 格式设置配置值，其中注解直接嵌入到源代码中。 如果您希望将代码和配置放在同一位置以提高可读性，请使用注解。 部署描述符恰恰相反 - 您将代码和配置分开。 这样，如果您要更改单个配置值，则无需重新编译整个项目。

对于许多 Java Enterprise 组件，都有两个版本可用 - 注解或描述符。 但其他配置则只能使用注解或通过部署描述符进行配置。 对于 Servlet，可以选择一种或另一种方法。

WebServlet注解属性

您可以选择几种属性来配置 Servlet。

必要

  • value或urlPatterns String[] – 指定该 servlet 的一个或多个 URL 模式。 可以使用任何一个属性，但不能同时使用。urlPatterns的默认值为{}，value默认值为""

可选

  • asyncSupported boolean – 声明 Servlet 是否支持异步操作模式。 默认值为假
  • name String – Servlet 的名称。 默认值为""
  • description String – Servlet 的描述。 默认值为""
  • displayName String – Servlet 的显示名称。 默认值为""
  • initParams WebInitParam[] – Servlet 的初始化参数。 默认值为{}
  • largeIcon String – Servlet 的大图标。 默认值为""
  • smallIcon String – Servlet 的小图标。 默认值为""
  • loadOnStartup int – Servlet 的启动时加载顺序。 默认值为 -1

用于 Servlet 的 POM 文件

我们将使用以下pom.xml文件构建本教程后面显示的示例。

  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>net.javatutorial.tutorials</groupId>
  6.     <artifactId>ServletAnnotation</artifactId>
  7.     <version>1</version>
  8.     <packaging>war</packaging>
  10.     <name>ServletAnnotation</name>
  11.     <url>https://javatutorial.net</url>
  13.     <properties>
  14.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  15.     </properties>
  17.     <dependencies>
  18.         <dependency>
  19.             <groupId>javax.servlet</groupId>
  20.             <artifactId>javax.servlet-api</artifactId>
  21.             <version>3.1.0</version>
  22.             <scope>provided</scope>
  23.         </dependency>
  24.     </dependencies>
  26.     <build>
  27.         <finalName>servletannotation</finalName>
  28.         <sourceDirectory>src/main/java</sourceDirectory>
  30.         <plugins>
  31.             <plugin>
  32.                 <groupId>org.apache.maven.plugins</groupId>
  33.                 <artifactId>maven-war-plugin</artifactId>
  34.                 <version>2.3</version>
  35.                 <configuration>
  36.                     <warSourceDirectory>src/main/webapp</warSourceDirectory>
  37.                 </configuration>
  38.             </plugin>
  39.             <plugin>
  40.                 <groupId>org.apache.maven.plugins</groupId>
  41.                 <artifactId>maven-compiler-plugin</artifactId>
  42.                 <version>3.1</version>
  43.                 <configuration>
  44.                     <source>1.8</source>
  45.                     <target>1.8</target>
  46.                 </configuration>
  47.             </plugin>
  48.         </plugins>
  49.     </build>
  50. </project>

使用注解时是否需要web.xml？

简短答案–不！ 如果您选择对所有 Servlet 配置依赖注解，则可以完全删除web.xml文件。 但我仍然鼓励您保留该文件，或者至少保留一个如以下示例所示的文件。Web.xml用于许多其他配置，因此您迟早需要在项目中使用它。

  1. <?xml version="1.0" encoding="UTF-8"?>
  3. <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.     xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
  5.     version="3.1">
  7.     <display-name>Servlet with Annotations Application</display-name>
  9. </web-app>

如果您希望完全跳过web.xml，则需要在 Maven 的pom.xml中告诉 war 插件停止搜索该文件。 您可以通过将failOnMissingWebXml设置为false来实现，如下所示：

  1. <plugin>
  2.     <groupId>org.apache.maven.plugins</groupId>
  3.     <artifactId>maven-war-plugin</artifactId>
  4.     <version>2.3</version>
  5.     <configuration>
  6.         <failOnMissingWebXml>false</failOnMissingWebXml>
  7.     </configuration>
  8. </plugin>

用一个 URL 模式注解的 Servlet

以下示例仅使用一个属性来注解 servlet 的 URL。 假设您在本地主机上运行应用程序并将其作为servletannotation.war部署，则 servlet 的路径将为http://localhost:8080/servletannotation/hello

  1. package net.javatutorial.tutorials;
  3. import java.io.IOException;
  5. import javax.servlet.ServletException;
  6. import javax.servlet.annotation.WebServlet;
  7. import javax.servlet.http.HttpServlet;
  8. import javax.servlet.http.HttpServletRequest;
  9. import javax.servlet.http.HttpServletResponse;
  11. @WebServlet("/hello")
  12. public class ServletWithAnnotations extends HttpServlet {
  14.     private static final long serialVersionUID = -3462096228274971485L;
  16.     @Override
  17.     protected void doGet(HttpServletRequest reqest, HttpServletResponse response) 
  18.             throws ServletException, IOException {
  19.         response.getWriter().println("Hello World!");
  20.     }
  22. }

具有多个属性的 Servlet 注解

在此示例中，我们将设置 servlet 名称，URL 和load-0n-startup加载优先级。 在我们的简单 Servlet 示例中，我们在web.xml文件中执行了以下操作：

  1. <?xml version="1.0" encoding="UTF-8"?>
  3. <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.     xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
  5.     version="3.1">
  7.     <display-name>Servlet with Annotations Application</display-name>
  9.     <servlet>
  10.         <servlet-name>simpleServlet</servlet-name>
  11.         <servlet-class>net.javatutorial.tutorials.ServletWithAnnotations</servlet-class>
  12.         <load-on-startup>1</load-on-startup>
  13.     </servlet>
  15.     <servlet-mapping>
  16.         <servlet-name>simpleServlet</servlet-name>
  17.         <url-pattern>/hello</url-pattern>
  18.     </servlet-mapping>
  20. </web-app>

…现在我们将使用WebServlet注解实现相同的配置：

  1. package net.javatutorial.tutorials;
  3. import java.io.IOException;
  5. import javax.servlet.ServletException;
  6. import javax.servlet.annotation.WebServlet;
  7. import javax.servlet.http.HttpServlet;
  8. import javax.servlet.http.HttpServletRequest;
  9. import javax.servlet.http.HttpServletResponse;
  11. @WebServlet(name = "simpleServlet", urlPatterns = { "/hello" }, loadOnStartup = 1)
  12. public class ServletWithAnnotations extends HttpServlet {
  14.     private static final long serialVersionUID = -3462096228274971485L;
  16.     @Override
  17.     protected void doGet(HttpServletRequest reqest, HttpServletResponse response) 
  18.             throws ServletException, IOException {
  19.         response.getWriter().println("Hello World!");
  20.     }
  22. }

具有多个 URL 模式的 Servlet 注解

urlPatterns属性接受一个数组作为值，因此您可以设置多个指向同一 servlet 的 URL：

  1. @WebServlet(urlPatterns = {"/hello", "/wellcome"})
  2. public class ServletWithAnnotations extends HttpServlet {
  4.     @Override
  5.     protected void doGet(HttpServletRequest reqest, HttpServletResponse response) 
  6.             throws ServletException, IOException {
  7.         // ... implementation goes here
  8.     }
  10. }

假设您在本地主机上运行应用程序并将其作为servletannotation.war部署，则可以访问http://localhost:8080/servletannotation/hello以及http://localhost:8080/wellcome上的 servlet

您可以在我们的 GitHub 存储库中找到此示例的源代码