如何使用Gatling正确获取接口响应返回的Cookie值

问题原因说明 #

你之前的两种尝试都不符合Gatling的API设计逻辑，具体问题如下：

• 直接访问gatling.http.cookies属性：该属性存储的CookieJar是Gatling内部私有API，不对外暴露，强制访问不仅会编译失败，还会存在版本升级后兼容性失效的风险。
• 在自定义session函数中直接调用getCookieValue：该方法是Gatling的DSL构造器，本身不会直接返回Cookie值，只有作为exec的独立执行步骤运行时，才会真正读取Cookie并写入Session，单独调用只会得到构造器对象。

正确实现方案 #

推荐使用Gatling官方提供的公共DSL实现，无需触碰内部私有API，兼容性和稳定性都有保障。

实现步骤 #

1. 发起认证接口请求，让服务端返回目标Cookie
2. 调用getCookieValueDSL将指定Cookie值存入Session
3. 后续流程直接从Session中读取已经存储的Cookie值即可

完整代码示例 #

import io.gatling.core.Predef._
import io.gatling.http.Predef._
import scala.concurrent.duration._

class CookieFetchSimulation extends Simulation {
  val httpProtocol = http.baseUrl("https://你的目标服务域名")

  val testScn = scenario("Cookie获取测试流程")
    // 第一步：调用认证接口生成Cookie
    .exec(
      http("认证接口请求")
        .post("/你的认证接口路径")
        .formParam("username", "测试账号")
        .formParam("password", "测试密码")
    )
    // 第二步：用官方DSL获取指定Cookie，存入Session的targetCookie字段
    .exec(getCookieValue(CookieKey("你要获取的Cookie名称").saveAs("targetCookie")))
    // 第三步：从Session读取Cookie值使用
    .exec { session =>
      val cookieValue = session("targetCookie").as[String]
      println(s"获取到的目标Cookie值：$cookieValue")
      session
    }
    // 后续请求可以直接引用Cookie值，Gatling默认也会自动携带所有Cookie
    .exec(
      http("后续需要Cookie的业务接口请求")
        .get("/业务接口路径")
        // 示例：如果需要手动把Cookie放到自定义头中可以这么写
        .header("X-Custom-Cookie", "${targetCookie}")
    )

  setUp(testScn.inject(atOnceUsers(1))).protocols(httpProtocol)
}

特殊场景补充 #

如果你的Cookie存在domain、path的限定，可以给CookieKey增加匹配条件，精准定位目标Cookie：

getCookieValue(
  CookieKey("COOKIE_NAME")
    .withDomain("your-service.com")
    .withPath("/api")
    .saveAs("targetCookie")
)

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