如何在IntelliJ插件中访问运行中Spring应用上下文及Actuator Bean？

核心思路 #

IntelliJ官方Spring Boot插件API已封装了访问运行中Spring应用上下文的能力，无需自行实现反射或远程连接。关键是依赖com.intellij.spring.boot模块，通过Spring Boot应用管理类获取上下文，进而提取目标Bean。

步骤实现 #

1. 配置插件依赖 #

在插件的plugin.xml中声明对Spring Boot插件的依赖：

<depends>com.intellij.spring.boot</depends>

同时在构建脚本（如build.gradle.kts）中引入对应API依赖：

intellij {
    plugins.set(listOf("com.intellij.spring.boot"))
}

2. 获取运行中的Spring Boot应用实例 #

通过SpringBootApplicationManager可获取不同范围的运行中应用：

• getApplications(Project project)：获取指定项目关联的运行中应用
• getApplications()：获取IDE中所有运行中的应用

3. 提取上下文与目标Bean #

每个SpringBootApplication实例关联SpringApplicationContext，直接调用getBean()方法即可获取Actuator组件（如HealthEndpoint）。

完整代码示例 #

import com.intellij.openapi.project.Project;
import com.intellij.openapi.service.Service;
import com.intellij.spring.boot.SpringBootApplication;
import com.intellij.spring.boot.SpringBootApplicationManager;
import com.intellij.spring.boot.context.SpringApplicationContext;
import com.intellij.spring.boot.context.event.SpringApplicationContextInitializedEvent;
import com.intellij.util.messages.MessageBusConnection;
import org.springframework.boot.actuate.health.HealthEndpoint;

@Service(Service.Level.PROJECT)
class SpringBootActuatorService {

    private final Project project;

    // 构造函数注入Project实例
    public SpringBootActuatorService(Project project) {
        this.project = project;
        // 监听上下文初始化事件，确保操作时机正确
        subscribeToContextInitEvent();
    }

    // 打印当前项目下所有运行中应用的健康状态
    public void printAllAppHealthStatus() {
        SpringBootApplicationManager manager = SpringBootApplicationManager.getInstance();
        for (SpringBootApplication app : manager.getApplications(project)) {
            SpringApplicationContext context = app.getSpringApplicationContext();
            if (context != null && context.isInitialized()) {
                try {
                    HealthEndpoint healthEndpoint = context.getBean(HealthEndpoint.class);
                    String status = healthEndpoint.health().getStatus().getCode();
                    System.out.printf("应用[%s] 健康状态: %s%n", app.getName(), status);
                } catch (Exception e) {
                    System.err.printf("应用[%s] 获取HealthEndpoint失败: %s%n", app.getName(), e.getMessage());
                }
            } else {
                System.out.printf("应用[%s] 上下文未初始化%n", app.getName());
            }
        }
    }

    // 根据应用名称获取指定应用的健康状态
    public String getHealthStatusByAppName(String appName) {
        SpringBootApplicationManager manager = SpringBootApplicationManager.getInstance();
        for (SpringBootApplication app : manager.getApplications()) {
            if (app.getName().equals(appName)) {
                SpringApplicationContext context = app.getSpringApplicationContext();
                if (context == null || !context.isInitialized()) {
                    return "应用上下文未就绪";
                }
                try {
                    HealthEndpoint endpoint = context.getBean(HealthEndpoint.class);
                    return endpoint.health().getStatus().getCode();
                } catch (Exception e) {
                    return "获取失败: " + e.getMessage();
                }
            }
        }
        return "未找到目标应用";
    }

    // 监听Spring上下文初始化事件
    private void subscribeToContextInitEvent() {
        MessageBusConnection connection = project.getMessageBus().connect();
        connection.subscribe(SpringApplicationContextInitializedEvent.TOPIC, event -> {
            SpringApplicationContext context = event.getApplicationContext();
            String appName = event.getApplication().getName();
            try {
                HealthEndpoint endpoint = context.getBean(HealthEndpoint.class);
                System.out.printf("应用[%s] 上下文初始化完成，健康状态: %s%n", appName, endpoint.health().getStatus().getCode());
            } catch (Exception e) {
                System.err.printf("应用[%s] 上下文初始化后获取Bean失败: %s%n", appName, e.getMessage());
            }
        });
    }
}

多应用场景处理 #

针对IDE中同时运行多个应用的情况，可通过以下方式通用访问目标应用：

• 按项目筛选：使用getApplications(project)获取当前插件所在项目的关联应用，适合项目级插件场景
• 全局枚举选择：通过getApplications()获取所有运行中应用，提供UI下拉列表让用户选择目标应用
• 关联运行配置：结合RunManager获取当前选中的运行配置，匹配对应的SpringBootApplication实例

注意事项 #

• 只有通过IntelliJ的Run/Debug配置启动、且Spring Boot插件已启用的Spring Boot应用，才能被识别并获取上下文
• 必须通过isInitialized()判断或监听SpringApplicationContextInitializedEvent事件，确保上下文已初始化
• 若目标应用未引入Spring Actuator依赖，调用getBean()会抛出异常，需做好异常捕获

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