@WebInitParam注解具有什么功能呢?

@WebInitParam注解简介

`@WebInitParam`是Java Servlet 3.0引入一个注解(Annotation)
  用于为`@WebServlet`、`@WebFilter` 或 `@Weblistener` 注解标注组件(如 Servlet、Filter)
    配置初始化参数

其功能类似传统`web.xml`中
 `<init-param>`作用

`@WebInitParam`主要功能

@WebInitParam注解定义(简化版)

public @interface WebInitParam {
    String name();
    String value();
    String description() default "";
}

例 1：结合 `@WebServlet` 使用初始化参数

@WebServlet(
    urlPatterns = "/config",
    initParams = {
        @WebInitParam(name = "adminEmail", value = "admin@example.com"),
        @WebInitParam(name = "maxLoginAttempts", value = "5")
    }
)

public class ConfigServlet extends HttpServlet {

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

        // 获取初始化参数
        String adminEmail = config.getInitParameter("adminEmail");
        String maxAttempts = config.getInitParameter("maxLoginAttempts");

        System.out.println("Admin Email: " + adminEmail);
        System.out.println("Max Login Attempts: " + maxAttempts);
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws IOException {
        response.getWriter().write("ConfigServlet 初始化完成");
    }
}
 
访问地址：
     http://localhost:8080/your-app/config
 
控制台输出：
	Admin Email: admin@example.com
	Max Login Attempts: 5

例2:结合`@WebFilter`使用初始化参数

@WebFilter(
    filterName = "AuthFilter",
    urlPatterns = "/*",
    initParams = {
        @WebInitParam(name = "loginPage", value = "/login.jsp"),
        @WebInitParam(name = "allowedPaths", value = "/public/*,/css/*,/js/*")
    }
)

public class AuthFilter implements Filter {

    private String loginPage;
    private List<String> allowedPaths;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        loginPage = filterConfig.getInitParameter("loginPage");
        allowedPaths = Arrays.asList(filterConfig.getInitParameter("allowedPaths").split(","));
        
        System.out.println("Login Page: " + loginPage);
        System.out.println("Allowed Paths: " + allowedPaths);
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 过滤逻辑...
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {
        // 清理资源
    }
}

@WebInitParam注解 与`web.xml`对比

使用`web.xml`传统写法：
 
<servlet>
    <servlet-name>ConfigServlet</servlet-name>
    <servlet-class>com.example.ConfigServlet</servlet-class>
    <init-param>
        <param-name>adminEmail</param-name>
        <param-value>admin@example.com</param-value>
    </init-param>
    <init-param>
        <param-name>maxLoginAttempts</param-name>
        <param-value>5</param-value>
    </init-param>
</servlet>
 

使用 `@WebInitParam` 后，可以完全省去 XML 配置，使代码更简洁、模块化更强。

@WebInitParam注解注意事项

推荐用于开发小型或中型项目
简化配置，提升可维护性
不要传递敏感信息
   如密码等，建议使用外部配置文件或加密处理 
不要忘记 `@WebServlet` 或 `@WebFilter`
   单独使用 `@WebInitParam` 没有意义 
支持多参数组合  
    可以配置多个`@WebInitParam`参数

@WebInitParam注解适用场景《/好》

配置登录页面路径
  在 Filter 中使用`@WebInitParam`设置跳转路径
设置最大登录次数
  在登录验证 Servlet 中限制尝试次数
定义API基础路径
  在RESTful API入口 Filter 中设置前缀
多环境配置支持
  开发/测试/生产环境使用不同参数
日志记录
  记录启动参数、配置信息等