能否将Gatling整合进Spring项目？Gradle运行场景下的技术问询

核心结论 #

完全可以将Gatling作为Spring项目的一部分运行，借助Spring的依赖注入、Bean管理、配置加载等特性重构仿真代码，同时保留Gatling的性能测试能力和报告生成功能。

具体实现步骤 #

1. 调整项目构建配置（以Gradle为例） #

在build.gradle中，同时引入Gatling插件和Spring相关依赖，并确保Gatling的运行classpath包含Spring上下文所需的资源：

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.2.0'
    id 'io.gatling.gradle' version '3.10.3'
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    // 按需添加其他Spring依赖，比如spring-boot-starter-web用于HTTP配置
    gatlingImplementation 'io.gatling.highcharts:gatling-charts-highcharts:3.10.3'
    gatlingImplementation 'org.springframework.boot:spring-boot-starter'
}

// 让Gatling任务能访问Spring的配置文件
gatling {
    srcDirs = [file("src/test/gatling")]
    resources.srcDirs += file("src/main/resources")
}

2. 编写Spring配置类 #

创建@Configuration类，注册需要复用的Bean，比如API配置、自定义数据提供者、HTTP客户端参数等：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class GatlingConfig {
    @Value("${api.base-url}")
    private String apiBaseUrl;

    @Bean
    public ApiProperties apiProperties() {
        return new ApiProperties(apiBaseUrl);
    }

    // 注册其他需要的Bean，比如数据生成器、认证token提供者等
}

record ApiProperties(String baseUrl) {}

3. 改造Gatling仿真类，集成Spring上下文 #

在仿真类中初始化Spring上下文，并注入所需的Bean，用Spring管理的配置来构建测试场景：

import io.gatling.javaapi.core.Simulation;
import io.gatling.javaapi.http.HttpProtocolBuilder;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import static io.gatling.javaapi.core.CoreDsl.*;
import static io.gatling.javaapi.http.HttpDsl.http;

public class SpringPoweredSimulation extends Simulation {
    private final ApiProperties apiProps;

    public SpringPoweredSimulation() {
        // 加载Spring配置，初始化上下文
        var context = new AnnotationConfigApplicationContext(GatlingConfig.class);
        this.apiProps = context.getBean(ApiProperties.class);

        // 用Spring注入的配置构建HTTP协议
        HttpProtocolBuilder httpProtocol = http
                .baseUrl(apiProps.baseUrl())
                .acceptHeader("application/json");

        // 构建测试场景
        var testScenario = scenario("Spring-backed API Test")
                .exec(http("Fetch Data")
                        .get("/data")
                        .check(status().is(200)));

        // 配置并发用户和执行逻辑
        setUp(
                testScenario.injectOpen(rampUsers(100).during(60))
        ).protocols(httpProtocol);
    }
}

如果是Spring Boot项目，也可以用SpringApplication来启动上下文，支持更复杂的Spring特性（比如自动配置、Spring Cloud集成）：

import org.springframework.boot.SpringApplication;
import org.springframework.context.ConfigurableApplicationContext;

public class SpringBootGatlingSimulation extends Simulation {
    private final ApiProperties apiProps;

    public SpringBootGatlingSimulation() {
        ConfigurableApplicationContext context = SpringApplication.run(SpringBootGatlingApp.class);
        this.apiProps = context.getBean(ApiProperties.class);
        // 构建场景和配置...
    }
}

4. 选择运行方式 #

方式一：保留原Gatling命令

依然可以用gradle gatlingRun命令运行，此时Gatling会自动加载仿真类，而仿真类内部会初始化Spring上下文，复用Spring管理的Bean。

方式二：作为Spring应用的一部分运行

创建CommandLineRunner组件，在Spring Boot应用启动时自动触发Gatling仿真：

import io.gatling.app.Gatling;
import io.gatling.core.config.GatlingPropertiesBuilder;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class GatlingSimulationRunner implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        var gatlingProps = new GatlingPropertiesBuilder()
                .simulationClass("com.example.SpringPoweredSimulation")
                .resultsDirectory("build/gatling-spring-results");

        // 启动Gatling仿真
        Gatling.fromMap(gatlingProps.build());
    }
}

运行gradle bootRun即可启动Spring应用并自动执行性能测试，测试报告会生成在指定的目录中。

注意事项 #

• Bean兼容性：Gatling采用非阻塞异步模型，避免注入线程不安全的Bean（比如有状态的服务类），优先使用无状态的配置类或工具类。
• 上下文初始化：Spring上下文在仿真类构造函数中初始化即可，确保只加载一次，避免重复初始化带来的性能开销。
• 版本兼容：确保Gatling版本与Spring/Spring Boot版本兼容，避免依赖冲突（可通过Gradle的dependencyInsight命令排查）。

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