Servlet的两种配置方式：web.xml和@WebServlet注解

Love The Way You Lie 2023-07-25 08:48 14阅读 0赞

### Servlet配置：WEB\_INF/web.xml和@WebServlet注解 ###

*   *  1. 文件配置：WEB\_INF/web.xml
     *  2. 注解配置：@WebServlet
     *  3. 两者同时使用注意事项

Servlet2.5 规范之前，Java Web应用的绝大部分组件都通过 web.xml 文件来配置管理。  
Servlet3.0 规范可通过 Annotation 来配置管理Web组件，极大简化了原有的配置信息。

> 在`Servlet3.0 以后`，我们可以不需要在 web.xml 里面配置 servlet，只需要加上 `@WebServlet` 注解就可以修改该 Servlet 的属性了。

## 1. 文件配置：WEB\_INF/web.xml ##

<?xml version="1.0" encoding="UTF-8"?>
    <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">
    
        
        
        <servlet>
            
            <servlet-name>demo01</servlet-name>
            
            <servlet-class>com.demo.servlet.DemoServlet</servlet-class>
            
            <load-on-startup>0</load-on-startup>
        </servlet>
    
        
        <servlet-mapping>
            
            <servlet-name>demo01</servlet-name>
            
            <url-pattern>/demo</url-pattern>
        </servlet-mapping>
    
        
        <context-param>
            <param-name>username</param-name>
            <param-value>root</param-value>
        </context-param>
        <context-param>
            <param-name>password</param-name>
            <param-value>1234</param-value>
        </context-param>
    
        
        <welcome-file-list>
            <welcome-file>demo.html</welcome-file>
            <welcome-file>demo.htm</welcome-file>
            <welcome-file>demo.jsp</welcome-file>
        </welcome-file-list>
    
        
        <error-page>
            <error-code>404</error-code>
            
            <location>/error/404.html</location>
        </error-page>
    
    </web-app>

## 2. 注解配置：@WebServlet ##

@WebServlet 的属性列表：

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>类型</th> 
   <th align="left">注解描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong><code>name</code></strong></td> 
   <td>String</td> 
   <td align="left">指定Servlet 的 name 属性，等价于 &lt;servlet-name&gt;。如果没有显式指定，则该 Servlet 的取值即为类的全限定名</td> 
  </tr> 
  <tr> 
   <td><strong>value</strong></td> 
   <td>String[]</td> 
   <td align="left">该属性等价于 urlPatterns 属性。<code>两个属性不能同时使用</code></td> 
  </tr> 
  <tr> 
   <td><strong><code>urlPatterns</code></strong></td> 
   <td>String[]</td> 
   <td align="left">指定一组 Servlet 的 URL 匹配模式。等价于&lt;url-pattern&gt;标签</td> 
  </tr> 
  <tr> 
   <td><strong><code>loadOnStartup</code></strong></td> 
   <td>int</td> 
   <td align="left">指定 Servlet 的加载顺序，等价于 &lt;load-on-startup&gt;标签</td> 
  </tr> 
  <tr> 
   <td><strong><code>initParams</code></strong></td> 
   <td>WebInitParam[]</td> 
   <td align="left">指定一组 Servlet 初始化参数，等价于&lt;init-param&gt;标签</td> 
  </tr> 
  <tr> 
   <td><strong>asyncSupported</strong></td> 
   <td>boolean</td> 
   <td align="left">声明 Servlet 是否支持异步操作模式，等价于&lt;async-supported&gt; 标签</td> 
  </tr> 
  <tr> 
   <td><strong>description</strong></td> 
   <td>String</td> 
   <td align="left">该 Servlet 的描述信息，等价于 &lt;description&gt;标签</td> 
  </tr> 
  <tr> 
   <td><strong>displayName</strong></td> 
   <td>String</td> 
   <td align="left">该 Servlet 的显示名，通常配合工具使用，等价于 &lt;display-name&gt;标签</td> 
  </tr> 
 </tbody> 
</table>

注解配置代码示例：

@WebServlet(
            name = "TestWebServlet",
            /*value = {"/demo", "/web"},*/
            urlPatterns = { "/demo01", "/web01"},
            loadOnStartup = 1,
            initParams = { 
                    @WebInitParam(name = "username", value = "root"),
                    @WebInitParam(name = "password", value = "123456"),
            }
    )
    public class TestWebServlet extends HttpServlet { 
        protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { 
            System.out.println("TestWebServlet 执行...");
        }
    
        protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { 
            doPost(request, response);
        }
    }

## 3. 两者同时使用注意事项 ##

如果使用@WebServlet Annotation（注解）来配置Servlet，需要注意：

① 不要在 web.xml 文件的根元素（<web-app—/>）中指定 metadata-complete=“true”；  
② 不要在 web.xml 文件中再次配置该 Servlet 相关属性。