Servlet3.0下@WebServlet註解配置Servlet

@WebServlet註解配置Servlet

從Servlet3.0開始，配置Servlet支持註解方式，但還是保留了配置web.xml方式，所有使用Servlet有兩種方式：

1. Servlet類上使用@WebServlet註解進行配置
2. web.xml文件中配置

@WebServlet常用屬性

屬性	類型	是否必須	說明
asyncSupported	boolean	否	指定Servlet是否支持異步操作模式
displayName	String	否	指定Servlet顯示名稱
initParams	WebInitParam[]	否	配置初始化參數
loadOnStartup	int	否	標記容器是否在應用啓動時就加載這個Servlet
name	String	否	指定Servlet名稱
urlPatterns/value	String[]	否	這兩個屬性作用相同，指定Servlet處理的url

測試代碼如下：

1.UserServlet

通過註解方式配置，web.xml中不需要配置該Servlet

@WebServlet(name = "myUserServlet",
    urlPatterns = "/user/test",
    loadOnStartup = 1,
    initParams = {
            @WebInitParam(name="name", value="小明"),
            @WebInitParam(name="pwd", value="123456")
    }
)
public class UserServlet extends HttpServlet {
    private static final long serialVersionUID = 7109220574468622594L;

    @Override
    public void init(ServletConfig config) throws ServletException {
        super.init(config);

        System.out.println("servlet初始化...");
    }

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setContentType("text/html");
        response.setCharacterEncoding("utf-8");
        PrintWriter pw = response.getWriter();

        pw.append("Hello Servlet!<br>" );

        //servletName
        pw.append("servletName：" + getServletName() + "<br>");

        //initParam
        ServletConfig servletConfig = this.getServletConfig();
        Enumeration<String> paramNames = servletConfig.getInitParameterNames();
        while (paramNames.hasMoreElements()) {
            String paramName = paramNames.nextElement();
            pw.append(paramName + "：" + servletConfig.getInitParameter(paramName) + "<br>");
        }

        pw.close();

    }


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

2.測試結果

2.1應用啓動時，servlet就會初始化，因爲配置了loadOnStartup=1

2.2訪問/user/test，頁面上顯示結果；表名參數正確初始化以及自定義的servlet名稱

3.注

(1).loadOnStartup屬性：標記容器是否在啓動應用時就加載Servlet，默認不配置或數值爲負數時表示客戶端第一次請求Servlet時再加載；0或正數表示啓動應用就加載，正數情況下，數值越小，加載該Servlet的優先級越高；

(2).name屬性：可以指定也可以不指定，通過getServletName()可以獲取到，若不指定，則爲Servlet的完整類名，如：cn.edu.njit.servlet.UserServlet

(3).urlPatterns/value屬性： String[]類型，可以配置多個映射，如：urlPatterns={"/user/test", "/user/example"}

(4).在使用註解方式時，需要注意：

• <web-app> </web-app>根元素中不能配置屬性metadata-complete="true"，否則無法加載Servlet。metadata-complete屬性表示通知Web容器是否尋找註解，默認不寫或者設置false，容器會掃描註解和Web分片，爲Web應用程序構建有效的元數據；設置true，表示將由部署描述符爲Web程序提供所有的配置信息
  
• web.xml中不能再配置該Servlet

(5).urlPatterns的常用規則：

• /*或者/：攔截所有
• *.do：攔截指定後綴
• /user/test：攔截路徑
• /user/*.do、/*.do、test*.do都是非法的，啓動時候會報錯

(6).urlPatterns的配置規則：精確匹配、擴展名匹配、路徑匹配以及會包含一些優先級，這些在以後會整理。