JavaWeb——ServletConfig

一、什么是 ServletConfig？

   ServletConfig 是 Servlet 规范中定义的一个接口，它的对象由 Servlet 容器（如 Tomcat）在初始化一个 Servlet 时创建，并传递给该 Servlet 的 init(ServletConfig config) 方法。

        简单来说，ServletConfig 是 Servlet 的“个人助理”或“配置说明书”。 它代表了一个特定 Servlet 的配置信息。每个 Servlet 都有自己独有的 ServletConfig 对象。

二、ServletConfig 的核心作用

        它的主要作用是向 Servlet 提供初始化的配置参数。这些参数不是在代码中写死的，而是配置在 Web 应用程序的 web.xml 文件（或通过注解）中。这样做的好处是，当需要修改配置时（比如数据库连接、文件路径等），你无需重新编译 Java 代码，只需修改配置文件即可。

三、如何配置初始化参数？

有两种主要方式为 Servlet 配置初始化参数：

方式一：在 web.xml 中配置（传统方式）

在 web.xml 中，使用 <init-param> 标签在 Servlet 声明内部进行配置。

<?xml version="1.0" encoding="UTF-8"?>
<web-app ...><!-- 1. 声明一个Servlet --><servlet><!-- Servlet的名称 --><servlet-name>MyTestServlet</servlet-name><!-- Servlet的完整类名 --><servlet-class>com.example.MyTestServlet</servlet-class><!-- ！！！配置该Servlet的初始化参数！！！ --><init-param><param-name>jdbcUrl</param-name><param-value>jdbc:mysql://localhost:3306/mydb</param-value></init-param><init-param><param-name>username</param-name><param-value>admin</param-value></init-param><init-param><param-name>cacheSize</param-name><param-value>100</param-value></init-param></servlet><!-- 2. 将Servlet映射到一个URL模式 --><servlet-mapping><servlet-name>MyTestServlet</servlet-name><url-pattern>/test</url-pattern></servlet-mapping>
</web-app>

方式二：使用 @WebInitParam 注解（现代方式）

在 Servlet 类上使用 @WebServlet 注解时，可以同时使用 initParams 属性来配置。

@WebServlet(name = "MyTestServlet",urlPatterns = {"/test"},initParams = {@WebInitParam(name = "jdbcUrl", value = "jdbc:mysql://localhost:3306/mydb"),@WebInitParam(name = "username", value = "admin"),@WebInitParam(name = "cacheSize", value = "100")}
)
public class MyTestServlet extends HttpServlet {// ... Servlet 代码
}

四、在 Servlet 中如何使用？

在 Servlet 的 init() 方法或 service()/doGet()/doPost() 等方法中，你可以通过 this.getServletConfig() 来获取到当前 Servlet 的 ServletConfig 对象。

最佳实践：通常我们会在 init() 方法中读取这些一次性配置，并将其保存为 Servlet 的实例变量，以便在后续的请求处理中重复使用。

public class MyTestServlet extends HttpServlet {private String jdbcUrl;private String username;private int cacheSize;@Overridepublic void init(ServletConfig config) throws ServletException {// 必须首先调用父类的init(config)super.init(config);// 1. 通过 config 对象获取参数jdbcUrl = config.getInitParameter("jdbcUrl");username = config.getInitParameter("username");String cacheSizeStr = config.getInitParameter("cacheSize");try {cacheSize = Integer.parseInt(cacheSizeStr);} catch (NumberFormatException e) {cacheSize = 50; // 默认值}// 2. 也可以直接使用 this.getServletConfig()// String jdbcUrl = this.getServletConfig().getInitParameter("jdbcUrl");System.out.println("Servlet初始化完成，配置参数已加载。");System.out.println("JDBC URL: " + jdbcUrl);}@Overrideprotected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {resp.setContentType("text/plain");PrintWriter out = resp.getWriter();// 使用在init中加载的配置out.println("连接到数据库: " + jdbcUrl);out.println("缓存大小是: " + cacheSize);// 如果需要，也可以在这里临时读取某个参数String username = getServletConfig().getInitParameter("username");out.println("用户名是: " + username);// 遍历所有初始化参数 (演示 getInitParameterNames)out.println("\n所有配置参数:");Enumeration<String> paramNames = getServletConfig().getInitParameterNames();while (paramNames.hasMoreElements()) {String name = paramNames.nextElement();String value = getServletConfig().getInitParameter(name);out.println("- " + name + " = " + value);}}
}