web.xml 可以定義兩種參數,作用範圍與讀取方式完全不同,搞混就會出現「明明設了卻讀到 null」的狀況。
存放於 ServletContext,作用範圍是整個 web 應用(一個 Context,也就是一個虛擬目錄),任何 Servlet 都讀得到。
<context-param>
<param-name>context/param</param-name>
<param-value>avalible during application</param-value>
</context-param>
定義在 <servlet> 標籤內,只有該 Servlet 讀得到,且只能在它的 init() 方法中取得。
<servlet>
<servlet-name>MainServlet</servlet-name>
<servlet-class>com.wes.controller.MainServlet</servlet-class>
<init-param>
<param-name>param1</param-name>
<param-value>avalible in servlet init()</param-value>
</init-param>
<load-on-startup>0</load-on-startup>
</servlet>
package com.qisentech.controller;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
public class MainServlet extends HttpServlet {
public MainServlet() {
super();
}
public void init() throws ServletException {
// 讀取 init-param(僅限本 Servlet)
System.out.println(this.getInitParameter("param1"));
// 讀取 context-param(整個應用程式)
System.out.println(getServletContext().getInitParameter("context/param"));
}
}
| context-param | init-param | |
|---|---|---|
| 定義位置 | web.xml 根層,<servlet> 之外 | <servlet> 標籤內 |
| 作用範圍 | 整個應用程式(ServletContext) | 單一 Servlet(ServletConfig) |
| 讀取方式 | getServletContext().getInitParameter() | getServletConfig().getInitParameter() 或直接 getInitParameter() |
| 典型用途 | 資料庫連線字串、共用設定、上傳路徑 | 單一 Servlet 專屬的參數 |
context-param 的 param-name 不建議用斜線。範例中的 context/param 是合法字串,但斜線容易讓人以為有巢狀結構,實務上直接命名為 dbDriver、uploadPath 之類即可。
init-param 的讀取時機有限制。在 doGet/doPost 中呼叫 getInitParameter("param1") 技術上不會報錯,但語意上它只在容器建立 Servlet 實例後的初始化階段有意義。需要提前使用時,應在 init() 中讀出並存成成員變數。
load-on-startup 決定初始化時機。設為 0 或正整數時,容器啟動即建立該 Servlet 並呼叫 init();未設定則在第一次收到請求時才初始化。若 init() 中有需要及早失敗的設定檢查,應加上這個元素。
敏感資訊不該放在 web.xml。資料庫密碼、API 金鑰等明文寫在 web.xml 會隨原始碼進入版控。建議改用環境變數、JNDI 資源或外部設定檔,並在部署時注入。