如何结合OKHTTP3生成Allure报告？空报告问题排查

问题描述 #

使用OKHTTP3库做API测试，已通过AllureOkHttp3拦截器配置客户端，但测试运行后allure-reports目录生成的是HTML文件而非Allure所需的XML/JSON原始数据，执行allure serve后报告为空。

代码示例 #

OkHttpClient client = new OkHttpClient.Builder()
                .addInterceptor(new AllureOkHttp3())
                .build();

该客户端已用于所有测试请求。

问题根源分析 #

Allure的工作流程分为两步：

1. 收集原始测试结果：由对应测试框架的Allure适配器（如JUnit/TestNG适配器）生成XML/JSON格式的原始数据，默认存放在allure-results目录
2. 生成HTML报告：通过allure generate或allure serve命令，基于allure-results的原始数据生成HTML报告到allure-reports目录

你的问题本质是：

• 测试未生成Allure所需的原始结果数据（XML/JSON），或混淆了allure-results和allure-reports的作用
• AllureOkHttp3仅负责捕获HTTP请求细节，无法单独生成测试结果数据，必须配合测试框架的Allure适配器才能完成完整的报告数据收集

修复步骤 #

1. 补全Allure依赖，引入测试框架适配器 #

确保项目中同时包含allure-okhttp3和对应测试框架的Allure适配器（以下为常用示例）：

Maven依赖（JUnit5为例）

<!-- Allure JUnit5 核心适配器（负责生成测试结果数据） -->
<dependency>
    <groupId>io.qameta.allure</groupId>
    <artifactId>allure-junit5</artifactId>
    <version>2.24.0</version>
    <scope>test</scope>
</dependency>
<!-- Allure OKHTTP3 拦截器（负责捕获HTTP请求细节） -->
<dependency>
    <groupId>io.qameta.allure</groupId>
    <artifactId>allure-okhttp3</artifactId>
    <version>2.24.0</version>
    <scope>test</scope>
</dependency>

Gradle依赖（JUnit5为例）

testImplementation 'io.qameta.allure:allure-junit5:2.24.0'
testImplementation 'io.qameta.allure:allure-okhttp3:2.24.0'
testImplementation 'org.aspectj:aspectjweaver:1.9.20.1'

2. 确保测试执行命令正确生成原始结果 #

• 先删除现有allure-reports目录，避免旧文件干扰
• 执行测试命令生成原始结果到allure-results：
  • Maven：mvn clean test
  • Gradle：gradle clean test

3. 验证原始结果目录 #

测试执行完成后，检查allure-results目录下是否存在XML/JSON文件（如test-result.xml、container.json）：

• 若不存在：说明测试框架的Allure适配器未生效，需检查依赖版本兼容性、测试类是否使用了框架注解（如JUnit5的@Test）
• 若存在：继续下一步生成报告

4. 正确生成并查看Allure报告 #

使用allure serve命令时，需指定原始结果目录（而非allure-reports）：

allure serve allure-results

或通过构建工具生成：

• Maven：mvn allure:serve
• Gradle：gradle allureServe

5. 检查Allure配置的目录分离 #

确保构建工具配置中，Allure的结果目录和报告目录是分开的（以Maven插件为例）：

<plugin>
    <groupId>io.qameta.allure</groupId>
    <artifactId>allure-maven</artifactId>
    <version>2.19.0</version>
    <configuration>
        <resultsDirectory>${project.build.directory}/allure-results</resultsDirectory>
        <reportDirectory>${project.build.directory}/allure-reports</reportDirectory>
    </configuration>
</plugin>

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