如何通过Karate提取Java服务接口调用后设置的变量值

问题背景 #

调用dummyEndpoint接口后，Java服务MyService中的dummyVariable会被设置为true或false，需要在Karate的feature文件中提取该变量值并根据值执行不同操作（判断实验开启状态），但使用exists()方法无效。

核心原因 #

Karate是HTTP测试框架，默认无法直接访问Java服务的内部本地变量——exists()方法仅用于校验HTTP响应体中的字段是否存在，而dummyVariable是服务端内存中的变量，不会自动出现在接口响应里，因此exists()无法生效。

解决方案 #

方案1：修改接口，将变量值加入HTTP响应 #

最直接的方式是让接口返回中包含dummyVariable的值，这样Karate可以直接从响应体提取：

1. 修改Java服务的接口实现，在响应中添加变量字段：

import org.springframework.http.ResponseEntity;
import java.util.HashMap;
import java.util.Map;

public ResponseEntity<Map<String, Object>> myFunction() {
    boolean dummyVariable = dummyVariableSetter.isDummyVaribaleOn();
    Map<String, Object> responseBody = new HashMap<>();
    responseBody.put("businessResult", dummyVariable ? 1 : 0); // 保留原有业务返回值
    responseBody.put("dummyVariable", dummyVariable); // 新增变量字段到响应
    return ResponseEntity.ok(responseBody);
}

2. 在Karate feature文件中提取并分支执行：

Scenario: 调用服务并根据实验状态执行不同操作
  Given url baseUrl
  And path '/some-path'
  And header Authorization = api
  And param environment = env
  And request req
  When method POST
  Then status 200
  * def dummyVar = response.dummyVariable
  # 根据变量值分支操作
  * if (dummyVar) {
      print "实验已开启，执行操作A"
      # 这里编写实验开启后的测试步骤
    } else {
      print "实验未开启，执行操作B"
      # 这里编写实验关闭后的测试步骤
    }

方案2：直接在Karate中调用Java类方法（无需修改接口） #

如果不能修改原有接口，可以利用Karate的Java集成能力，直接调用服务端的Java方法获取变量值：

情况1：DummyVariableSetter是独立可实例化的类

Scenario: 调用服务后通过Java类获取变量值
  Given url baseUrl
  And path '/some-path'
  And header Authorization = api
  And param environment = env
  And request req
  When method POST
  Then status 200
  # 加载并实例化Java类（替换为实际包路径）
  * def dummySetter = Java.type("com.your.package.DummyVariableSetter")
  * def dummyVar = dummySetter.isDummyVaribaleOn()
  # 分支执行操作
  * if (dummyVar) {
      # 实验开启的操作
    } else {
      # 实验关闭的操作
    }

情况2：DummyVariableSetter是Spring Bean

如果类是通过Spring依赖注入的，需要先获取Spring上下文：

Scenario: 调用服务后通过Spring Bean获取变量值
  Given url baseUrl
  And path '/some-path'
  And header Authorization = api
  And param environment = env
  And request req
  When method POST
  Then status 200
  # 获取Spring应用上下文
  * def appContext = Java.type("org.springframework.context.ApplicationContext").getApplicationContext()
  # 获取Bean实例（替换为实际Bean名称或类型）
  * def dummySetter = appContext.getBean(DummyVariableSetter.class)
  * def dummyVar = dummySetter.isDummyVaribaleOn()
  # 分支执行操作
  * if (dummyVar) {
      # 实验开启的操作
    } else {
      # 实验关闭的操作
    }

注意事项 #

• 原代码中isDummyVaribaleOn存在拼写错误（应为isDummyVariableOn），请确保调用的方法名称与实际Java类一致。
• 若使用方案2，需确保DummyVariableSetter类及其方法在Karate测试的类路径下可访问。

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