jakarta.servlet.ServletConfig

jakarta.servlet.ServletConfig 是 Jakarta Servlet API 里的一个关键接口，它在 Servlet 初始化阶段提供必要的配置信息，帮助 Servlet 完成初始化工作，实现与 Servlet 容器的交互。以下从多个方面详细介绍该接口：

接口概述

jakarta.servlet.ServletConfig 接口定义了一组方法，用于获取 Servlet 的配置信息，这些信息通常在部署描述文件（如 web.xml ）或者使用注解的方式进行配置。Servlet 容器在创建 Servlet 实例后，会调用 Servlet 接口的 init(ServletConfig config) 方法，并传入一个 ServletConfig 对象，Servlet 可以通过这个对象获取所需的配置信息。

主要方法

String getServletName()
- 功能：获取 Servlet 的名称。这个名称通常在部署描述文件中配置，用于标识该 Servlet。
- 示例：

import jakarta.servlet.Servlet;
import jakarta.servlet.ServletConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import java.io.IOException;

public class MyServlet implements Servlet {
    @Override
    public void init(ServletConfig config) throws ServletException {
        String servletName = config.getServletName();
        System.out.println("Servlet 名称: " + servletName);
    }

    // 其他方法实现
    @Override
    public ServletConfig getServletConfig() {
        return null;
    }

    @Override
    public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException {

    }

    @Override
    public String getServletInfo() {
        return null;
    }

    @Override
    public void destroy() {

    }
}

ServletContext getServletContext()
- 功能：获取 Servlet 上下文对象 ServletContext。ServletContext 代表整个 Web 应用程序，通过它可以实现 Servlet 之间的通信、访问应用程序的资源等。
- 示例：

@Override
public void init(ServletConfig config) throws ServletException {
    jakarta.servlet.ServletContext context = config.getServletContext();
    // 可以通过 context 做更多操作，如获取应用程序初始化参数
    String appParam = context.getInitParameter("appParamName");
}

String getInitParameter(String name)
- 功能：获取指定名称的初始化参数的值。初始化参数是在部署描述文件中为 Servlet 配置的参数，用于传递一些自定义的配置信息。
- 示例：

@Override
public void init(ServletConfig config) throws ServletException {
    String paramValue = config.getInitParameter("myParam");
    System.out.println("初始化参数 myParam 的值: " + paramValue);
}

java.util.Enumeration<String> getInitParameterNames()
- 功能：获取所有初始化参数的名称，返回一个 Enumeration 对象，通过遍历该对象可以获取所有初始化参数的名称。
- 示例：

@Override
public void init(ServletConfig config) throws ServletException {
    java.util.Enumeration<String> paramNames = config.getInitParameterNames();
    while (paramNames.hasMoreElements()) {
        String paramName = paramNames.nextElement();
        String paramValue = config.getInitParameter(paramName);
        System.out.println("参数名: " + paramName + ", 参数值: " + paramValue);
    }
}

配置方式

基于 `web.xml` 配置

在传统的 Java Web 应用中，可以在 web.xml 文件中为 Servlet 配置名称和初始化参数：

<servlet>
    <servlet-name>myServlet</servlet-name>
    <servlet-class>com.example.MyServlet</servlet-class>
    <init-param>
        <param-name>myParam</param-name>
        <param-value>paramValue</param-value>
    </init-param>
</servlet>

基于注解配置

在 Servlet 3.0 及以上版本中，也可以使用注解的方式为 Servlet 配置名称和初始化参数：

import jakarta.servlet.ServletConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebInitParam;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet(name = "myServlet", urlPatterns = {"/myServlet"}, initParams = {
        @WebInitParam(name = "myParam", value = "paramValue")
})
public class MyServlet extends HttpServlet {
    @Override
    public void init(ServletConfig config) throws ServletException {
        super.init(config);
        // 使用 config 获取配置信息
    }

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        super.doGet(req, resp);
    }
}