基于JAX-RS的REST服务中Apache Commons Pool2初始化与跨类访问问题

嘿，这个问题我之前也碰到过！你在ServletContextListener里初始化了连接池，但FolderService拿不到它，核心就是两者的上下文没打通，我给你几个实用的解决方案，你可以根据项目情况选：

方案1：把连接池存到ServletContext，在FolderService中获取 #

这是最直接的方式，利用Servlet上下文作为全局存储容器，让服务类能拿到连接池实例：

首先修改你的TestPoolListener，在初始化时把连接池存入ServletContext：

package rest.pool;

import org.apache.commons.pool2.impl.GenericObjectPool;
import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

@WebListener
public class TestPoolListener implements ServletContextListener {
    // 定义一个常量作为属性key，避免硬编码出错
    private static final String CONNECTION_POOL_KEY = "APP_CONNECTION_POOL";

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        // 初始化连接池，替换成你实际的PooledObjectFactory实现
        GenericObjectPool<?> connectionPool = new GenericObjectPool<>(/* 你的Factory实例 */);
        // 设置连接池参数，比如最大连接数、空闲数等
        connectionPool.setMaxTotal(15);
        connectionPool.setMaxIdle(8);
        
        // 存入ServletContext
        ServletContext context = sce.getServletContext();
        context.setAttribute(CONNECTION_POOL_KEY, connectionPool);
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        // 应用关闭时销毁连接池，释放资源
        GenericObjectPool<?> connectionPool = (GenericObjectPool<?>) sce.getServletContext().getAttribute(CONNECTION_POOL_KEY);
        if (connectionPool != null) {
            connectionPool.close();
        }
    }
}

然后在FolderService里，通过JAX-RS的@Context注解注入ServletContext，进而获取连接池：

package rest.service;

import org.apache.commons.pool2.impl.GenericObjectPool;
import javax.servlet.ServletContext;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.core.Context;

@Path("/folders")
public class FolderService {

    @Context
    private ServletContext servletContext;

    @GET
    public String handleFolderRequest() {
        // 从上下文取出连接池
        GenericObjectPool<?> connectionPool = (GenericObjectPool<?>) servletContext.getAttribute("APP_CONNECTION_POOL");
        if (connectionPool == null) {
            throw new RuntimeException("连接池未完成初始化，请检查Listener配置");
        }

        // 后续操作：借连接、执行业务、归还连接
        try {
            Object connection = connectionPool.borrowObject();
            // 这里写你的业务逻辑，比如操作数据库或其他资源
            connectionPool.returnObject(connection);
        } catch (Exception e) {
            throw new RuntimeException("连接池操作失败", e);
        }
        return "操作完成";
    }
}

方案2：用依赖注入（推荐，适合中大型项目） #

如果你的项目用了CDI（比如Weld）或者Spring，直接把连接池做成受管Bean注入会更优雅，也符合JEE规范：

先修改TestPoolListener，加上CDI的注解并提供连接池的生产者方法：

package rest.pool;

import org.apache.commons.pool2.impl.GenericObjectPool;
import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.inject.Produces;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

@WebListener
@ApplicationScoped
public class TestPoolListener implements ServletContextListener {
    private GenericObjectPool<?> connectionPool;

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        connectionPool = new GenericObjectPool<>(/* 你的Factory实例 */);
        connectionPool.setMaxTotal(15);
        connectionPool.setMaxIdle(8);
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        if (connectionPool != null) {
            connectionPool.close();
        }
    }

    // 提供连接池的生产者方法，让CDI可以注入
    @Produces
    @ApplicationScoped
    public GenericObjectPool<?> getConnectionPool() {
        return connectionPool;
    }
}

然后在FolderService里直接注入连接池：

package rest.service;

import org.apache.commons.pool2.impl.GenericObjectPool;
import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;

@Path("/folders")
public class FolderService {

    @Inject
    private GenericObjectPool<?> connectionPool;

    @GET
    public String handleFolderRequest() {
        // 直接使用注入的连接池，无需手动获取
        try {
            Object connection = connectionPool.borrowObject();
            // 业务逻辑...
            connectionPool.returnObject(connection);
        } catch (Exception e) {
            throw new RuntimeException("连接池操作失败", e);
        }
        return "操作完成";
    }
}

方案3：单例模式封装连接池（适合小型项目） #

如果项目很小，不想引入额外框架，可以把连接池封装成单例，在Listener里初始化，服务类直接调用单例获取：

先写单例类：

package rest.pool;

import org.apache.commons.pool2.impl.GenericObjectPool;

public class ConnectionPoolHolder {
    private static GenericObjectPool<?> instance;

    // 私有构造方法，防止外部实例化
    private ConnectionPoolHolder() {}

    // 初始化方法，只能被Listener调用一次
    public static void initialize(GenericObjectPool<?> pool) {
        if (instance == null) {
            synchronized (ConnectionPoolHolder.class) {
                if (instance == null) {
                    instance = pool;
                }
            }
        }
    }

    // 获取连接池实例
    public static GenericObjectPool<?> getInstance() {
        if (instance == null) {
            throw new RuntimeException("连接池未初始化");
        }
        return instance;
    }

    // 销毁连接池
    public static void destroy() {
        if (instance != null) {
            instance.close();
            instance = null;
        }
    }
}

然后修改Listener：

@Override
public void contextInitialized(ServletContextEvent sce) {
    GenericObjectPool<?> connectionPool = new GenericObjectPool<>(/* 你的Factory实例 */);
    connectionPool.setMaxTotal(15);
    connectionPool.setMaxIdle(8);
    ConnectionPoolHolder.initialize(connectionPool);
}

@Override
public void contextDestroyed(ServletContextEvent sce) {
    ConnectionPoolHolder.destroy();
}

最后在FolderService里使用：

@GET
public String handleFolderRequest() {
    GenericObjectPool<?> connectionPool = ConnectionPoolHolder.getInstance();
    // 后续操作同上...
}

注意事项 #

• 不管用哪种方案，一定要在应用关闭时调用连接池的close()方法，避免资源泄漏
• 自定义连接类型时，要确保你的PooledObjectFactory实现了正确的对象创建、销毁、验证逻辑
• 依赖注入方案更便于测试和维护，适合中大型项目；ServletContext和单例方案适合小型快速开发的项目

内容的提问来源于stack exchange，提问作者SteamboatUsa