使用QAF API通用步骤时getMessageBody()返回null的问题求助

问题复现 #

你遇到的这个问题很典型：在qaf-support-ws:3.1.0版本中，调用new RestTestBase().getResponse().getMessageBody()总是返回null，但响应状态码、Header都能正常获取；而在3.0.1版本中完全没有这个问题，且已有多个全局步骤依赖该方法获取响应体。

你调试时执行的代码：

System.out.println("Status is:" + new RestTestBase().getResponse().getStatus().name());
System.out.println("Header is:" + new RestTestBase().getResponse().getHeaders());
System.out.println("Body is:" + new RestTestBase().getResponse().getMessageBody());

以及调用内置步骤：

WsStep.responseShouldHaveValueContainsIgnoringCase(expectedvalue, jpath);

输出结果符合你的描述：

Status is:OK
Header is:{CF-RAY=[708ac4150dcfa03f-SIN], ..... charset=utf-8]}
Body is:null

甚至自定义步骤时，同样遇到getMessageBody()返回null的情况：

public static void responseShouldHaveValueIgnoringCase(String expectedValue, String path) {
    Object actual = JsonPath.read(new RestTestBase().getResponse().getMessageBody(), getPath(path));
    assertThat(String.valueOf(actual), Matchers.equalToIgnoringCase(expectedValue));
}

核心原因分析 #

从版本差异来看，3.1.0版本的QAF WS支持模块在响应体的处理逻辑上做了变更：

• 实例获取错误：每次new RestTestBase()都会创建一个新的实例，这个新实例并没有关联当前请求的响应上下文，自然拿不到响应体；而3.0.1版本可能对实例管理做了兼容，导致偶然能拿到。
• 响应体存储策略变更：3.1.0版本默认可能不再主动将响应体缓存到getMessageBody()对应的字段中，需要主动从响应流读取。

解决方案 #

方案1：获取当前测试上下文的RestTestBase实例

不要每次新建RestTestBase，而是通过QAF提供的全局方法获取当前关联了请求响应的实例：

// 获取当前测试上下文的RestTestBase实例
RestTestBase currentRestBase = (RestTestBase) QAFTestBase.getTestBase();

// 调试打印
System.out.println("Status is:" + currentRestBase.getResponse().getStatus().name());
System.out.println("Header is:" + currentRestBase.getResponse().getHeaders());
System.out.println("Body is:" + currentRestBase.getResponse().getMessageBody());

// 修改你的自定义步骤
public static void responseShouldHaveValueIgnoringCase(String expectedValue, String path) {
    RestTestBase currentRestBase = (RestTestBase) QAFTestBase.getTestBase();
    Object actual = JsonPath.read(currentRestBase.getResponse().getMessageBody(), getPath(path));
    assertThat(String.valueOf(actual), Matchers.equalToIgnoringCase(expectedValue));
}

方案2：直接从响应流读取实体

如果方案1仍无法获取，可以绕过getMessageBody()，直接调用JAX-RS的readEntity()方法读取响应体：

public static void responseShouldHaveValueIgnoringCase(String expectedValue, String path) {
    RestTestBase currentRestBase = (RestTestBase) QAFTestBase.getTestBase();
    // 直接从响应流读取字符串格式的响应体
    String responseBody = currentRestBase.getResponse().readEntity(String.class);
    Object actual = JsonPath.read(responseBody, getPath(path));
    assertThat(String.valueOf(actual), Matchers.equalToIgnoringCase(expectedValue));
}

方案3：检查并调整QAF配置

部分情况下，3.1.0版本新增了响应体存储的配置项，默认关闭了缓存。可以在你的QAF配置文件（比如application.properties）中添加：

# 开启响应体缓存，让getMessageBody()能获取到内容
ws.response.store.body=true

验证建议 #

优先尝试方案1，因为这是最符合QAF测试上下文设计的方式；如果仍无效，再尝试方案2或方案3。调整后重新运行你的测试步骤，应该就能正常获取响应体了。

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