非OSGI环境下如何创建暴露MBeans的Apache Jackrabbit Oak仓库？

核心逻辑 #

Oak的MBean在OSGI环境中会自动注册，非OSGI环境需手动通过MBeanServer完成注册，同时在仓库初始化阶段配置监控相关组件。

具体实现步骤 #

1. 依赖准备 #

以Maven为例，确保项目引入Oak核心、Lucene索引及JMX监控相关依赖：

<dependencies>
    <!-- Oak核心依赖 -->
    <dependency>
        <groupId>org.apache.jackrabbit</groupId>
        <artifactId>oak-core</artifactId>
        <version>最新稳定版</version>
    </dependency>
    <!-- Lucene索引支持 -->
    <dependency>
        <groupId>org.apache.jackrabbit</groupId>
        <artifactId>oak-lucene</artifactId>
        <version>最新稳定版</version>
    </dependency>
    <!-- Oak JMX监控组件 -->
    <dependency>
        <groupId>org.apache.jackrabbit</groupId>
        <artifactId>oak-jmx</artifactId>
        <version>最新稳定版</version>
    </dependency>
    <!-- JCR API规范 -->
    <dependency>
        <groupId>javax.jcr</groupId>
        <artifactId>jcr</artifactId>
        <version>2.0</version>
    </dependency>
</dependencies>

2. 编程创建仓库并注册MBean #

以下是完整代码示例，包含仓库初始化、MBean注册逻辑：

import javax.jcr.Repository;
import javax.jcr.Session;
import javax.jcr.SimpleCredentials;
import javax.management.MBeanServer;
import javax.management.ObjectName;
import java.lang.management.ManagementFactory;
import org.apache.jackrabbit.oak.Oak;
import org.apache.jackrabbit.oak.jmx.JmxRegistration;
import org.apache.jackrabbit.oak.plugins.index.lucene.LuceneIndexProvider;
import org.apache.jackrabbit.oak.spi.whiteboard.Whiteboard;
import org.apache.jackrabbit.oak.spi.whiteboard.WhiteboardImpl;
import org.apache.jackrabbit.oak.commons.jmx.AnnotatedMBean;

public class OakRepositoryWithJmx {

    public static void main(String[] args) throws Exception {
        // 创建Whiteboard，Oak监控组件依赖它实现组件发现
        Whiteboard whiteboard = new WhiteboardImpl();

        // 获取系统默认MBeanServer，确保VisualVM能识别
        MBeanServer mBeanServer = ManagementFactory.getPlatformMBeanServer();

        // 初始化Oak仓库，配置Lucene索引与JMX监控
        Repository repository = new Oak()
                .with(new LuceneIndexProvider()) // 启用Lucene索引
                .with(new JmxRegistration(whiteboard, mBeanServer)) // 关键：注册JMX监控组件
                .createRepository();

        // 可选：手动注册仓库统计MBean（补充自动注册覆盖不到的场景）
        ObjectName statsObjectName = new ObjectName("org.apache.jackrabbit.oak:name=RepositoryStats,type=Repository");
        AnnotatedMBean statsMBean = AnnotatedMBean.create(repository);
        mBeanServer.registerMBean(statsMBean, statsObjectName);

        // 测试仓库连接
        Session session = repository.login(new SimpleCredentials("admin", "admin".toCharArray()));
        System.out.println("仓库初始化完成，MBean已注册");
        session.logout();

        // 保持程序运行，便于VisualVM查看MBean
        Thread.sleep(Long.MAX_VALUE);
    }
}

3. 验证MBean有效性 #

启动程序后打开VisualVM：

• 连接到当前运行的Java进程
• 切换到「MBeans」标签，查找org.apache.jackrabbit.oak命名空间，即可看到仓库、索引等相关监控项

关键注意事项 #

• Whiteboard必须配置：Oak监控组件依赖Whiteboard发现可注册的MBean，必须手动创建并传入JmxRegistration
• 依赖版本保持一致：所有Oak相关依赖的版本需统一，避免兼容性问题
• 使用系统默认MBeanServer：确保VisualVM能识别并读取MBean数据

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