Servlet注釋的方式有哪些

這篇文章主要講解了“ Servlet注釋的方式有哪些”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“ Servlet注釋的方式有哪些”吧！

值得注意的是，部署描述符優(yōu)先于注釋。換句話說(shuō)，部署描述符覆蓋通過(guò)注釋機(jī)制所規(guī)定的配置信息。

Web 部署描述符的 3.0 版本在 web-app 元素上包含一種名為 metadata-complete 的新屬性。該屬性定義了 web 描述符是否完整，或者 web 應(yīng)用程序的類文件是否針對(duì)指定部署信息的注釋而進(jìn)行檢查。如果該屬性被設(shè)置為 true，則部署工具必須忽略類文件中所存在的任何 servlet注釋，并只使用描述符中所提及的配置細(xì)節(jié)。否則，如果沒(méi)有指定該值或者該值被設(shè)置為 false，容器必須針對(duì)注釋而掃描應(yīng)用程序的所有類文件。這個(gè)屬性提供了在應(yīng)用程序啟動(dòng)階段啟用或者禁用注釋掃描以及對(duì)注釋的處理。

在 Servlet 3.0 中所引入的所有注釋都可以在 javax.servlet.http.annotation 和 javax.servlet.http.annotation.jaxrs 軟件包中找到。

@Servlet：javax.servlet.http.annotation.Servlet 是一個(gè)類級(jí)別的注釋，確認(rèn)經(jīng)過(guò)注釋的類為一個(gè) servlet 并保存關(guān)于所聲明的 servlet 的元數(shù)據(jù)。urlMappings 屬性是指定 URL 模式(調(diào)用該 servlet)的 @Servlet 的強(qiáng)制屬性。當(dāng)接收到了一個(gè)請(qǐng)求時(shí)，容器將請(qǐng)求中的 URL 與 servlet 的 urlMappings 進(jìn)行匹配，且如果 URL 模式匹配，則調(diào)用相應(yīng)的 servlet 以響應(yīng)該項(xiàng)請(qǐng)求。該注釋的所有其他屬性都是可選的，并帶有合理的默認(rèn)值。Servlet 類中必須有一種使用像 GET、PUT、POST、HEAD 或者 DELETE 這樣的 HttpMethod 注釋進(jìn)行注釋的方法。這些方法應(yīng)將 HttpServletRequest 和 HttpServletResponse 作為方法參數(shù)。與以前的版本相反，servlets 3.0 的版本可以作為簡(jiǎn)單傳統(tǒng) Java 對(duì)象(Plain Old Java Objects，POJOs)而實(shí)現(xiàn);也就是 servlets 不必再擴(kuò)展像 HTTPServlet 或者 GenericServlet 這樣的基礎(chǔ) servlet 實(shí)現(xiàn)類。

為了進(jìn)行比較，在此給出了使用傳統(tǒng) Servlet 2.5 API 編寫(xiě)的 Java servlet 代碼片段，如下所示。在 Servlet 2.5 中，只要在部署描述符中配置了 servlet 的詳細(xì)信息，web 容器就將初始化 servlet。

public class MyServlet extends HttpServlet {  public void doGet (HttpServletRequest req,  HttpServletResponse res) {  ....  }  }

Deployment descriptor (web.xml)

<web-app> <servlet> <servlet-name>MyServlet</servlet-name> <servlet-class>samples.MyServlet</servlet-class> </servlet>  <servlet-mapping> <servlet-name>MyServlet</servlet-name> <url-pattern>/MyApp</url-pattern> </servlet-mapping> ...   </web-app>

這里給出的是使用 Servlet 3.0 API 編寫(xiě)的較為簡(jiǎn)化的版本。當(dāng) MyServlet 使用 @Servlet注釋而被注釋為一個(gè) servlet 時(shí)，則在 web 容器的啟動(dòng)期間對(duì)其初始化。注意，在這種情況下部署描述符是可選的。

@Servlet(urlMappings={"/MyApp"})  public class MyServlet {  @GET  public void handleGet(HttpServletRequest req,  HttpServletResponse res) {  ....  }  }  Deployment descriptor (web.xml)   optional

@ServletFilter 和 @FilterMapping：您可以使用 javax.servlet.http.annotation.ServletFilter 注釋來(lái)注釋過(guò)濾器類，從而輕松創(chuàng)建一個(gè) servlet 過(guò)濾器。該注釋封裝正被聲明的過(guò)濾器的有關(guān)元數(shù)據(jù)。在過(guò)濾器類上具有 @FilterMapping 注釋也是強(qiáng)制性的。@FilterMapping 注釋定義用于過(guò)濾器的 URL 模式。@ServletFilter 的所有其他屬性都是可選的，并帶有合理的默認(rèn)值。V3.0 過(guò)濾器類現(xiàn)在類似 POJO 類，并且沒(méi)有用于這些類所需的 Filter 接口或者非參數(shù)公用構(gòu)造器。以下給出了使用 Servlet v2.5 API 的過(guò)濾器類的代碼片段：

public class MyFilter implements Filter {  public void doFilter(ServletRequest req,  ServletResponse res,  FilterChain chain)  throws IOException, ServletException {  ......  }  }   Deployment descriptor (web.xml)   <web-app> <filter> <filter-name>My Filter</filter-name> <filter-class>samples.MyFilter</filter-class> </filter>  <filter-mapping> <filter-name>My Filter</filter-name> <url-pattern>/foo</url-pattern> </filter-mapping> ...  </web-app>

使用 Servlet 3.0 編寫(xiě)的一個(gè)示例過(guò)濾器類如下所示。因?yàn)樵擃愂褂?ServletFilter 注釋，所以容器將 MyFilter 標(biāo)記為一個(gè)過(guò)濾器類。MyFilter 截取所有收到的請(qǐng)求，其中該請(qǐng)求的 URL 匹配模式 /foo。Servlet 3.0 為過(guò)濾器配置提供了可選的部署描述符。

@ServletFilter  @FilterMapping("/foo")  public class MyFilter {  public void doFilter(HttpServletRequest req,  HttpServletResponse res) {  .....  }  }   Deployment descriptor (web.xml)   optional

@InitParam：該注釋可以用來(lái)定義必須傳遞給 servlet 或者過(guò)濾器類的任意初始化參數(shù)。它是 @Servlet 和 @ServletFilter 注釋的一個(gè)屬性。以下代碼示例解釋了如何將具有 english 值、稱作 lang 的初始化參數(shù)傳遞給一個(gè) servlet 類。

@Servlet(urlMappings={"/MyApp"}, initParams ={@InitParam
(name="lang", value="english")})  
public class MyServlet {  
@GET  
public void handleGet(HttpServletRequest req,  
HttpServletResponse res) {  
....  
}  
} 

@ServletContextListener：javax.servlet.http.annotation.ServletContextListener 注釋將該類聲明為一個(gè) servlet 上下文偵聽(tīng)器。當(dāng) web 容器創(chuàng)建或者銷毀 ServletContext 時(shí)，該上下文偵聽(tīng)器接收注釋。上下文偵聽(tīng)器是一個(gè) POJO 類，且不必實(shí)現(xiàn) ServletContextListener 接口。使用 Servlet 2.5 API 編寫(xiě)的偵聽(tīng)器類如下所示。當(dāng)且僅當(dāng)您在部署描述符中配置了該偵聽(tīng)器類，容器才識(shí)別它。

public class MyListener implements ServletContextListener {  public void contextInitialized(ServletContextEvent sce) {   }  .....  }   Deployment Descriptor (web.xml)   <web-app> <listener> <listener-class>samples.MyListener</listener-class> </listener> ....  </web-app>

使用 Servlet 3.0 API 編寫(xiě)的一個(gè)得到極大簡(jiǎn)化的偵聽(tīng)器類，如下所示。

@ServletContextListener  public class MyListener {  public void contextInitialized (ServletContextEvent sce) {   }  .....  }   Deployment Descriptor (web.xml)   optional

感謝各位的閱讀，以上就是“ Servlet注釋的方式有哪些”的內(nèi)容了，經(jīng)過(guò)本文的學(xué)習(xí)后，相信大家對(duì) Servlet注釋的方式有哪些這一問(wèn)題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是億速云，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！