Jqwik组合复用Arbitrary的技巧与方法

在 `jqwik` 中为复杂领域对象生成测试数据时，有效组合和复用 `Arbitrary` 定义至关重要。本文将探讨三种主要策略：通过静态方法直接调用、基于类型解析以及利用自定义注解来区分同类型但不同语义的生成器。这些方法能够帮助开发者构建结构清晰、可维护且高效的属性测试数据生成方案，从而提升测试的健壮性。

引言：jqwik 中复杂对象的 Arbitrary 构建挑战

在属性测试框架 jqwik 中，当需要为复杂的领域对象（例如包含多种特定格式字符串的类）生成测试数据时，如何有效地组合和复用已定义的 Arbitrary 变得尤为重要。开发者常常会遇到如何将为基本类型（如特定格式的 String）创建的 Arbitrary 实例集成到更高级的 Arbitrary 定义中的困惑。

考虑以下一个典型的复杂领域对象 MyComplexClass：

import java.util.UUID;

public class MyComplexClass {
  private final String id; // 正整数格式
  private final String recordId; // UUID 格式
  private final String creatorId; // 正整数格式
  private final String editorId; // 正整数格式
  private final String nonce; // UUID 格式
  private final String payload; // 随机字符串

  // 构造函数
  public MyComplexClass(String id, String recordId, String creatorId,
                        String editorId, String nonce, String payload) {
      this.id = id;
      this.recordId = recordId;
      this.creatorId = creatorId;
      this.editorId = editorId;
      this.nonce = nonce;
      this.payload = payload;
  }

  // 假设有对应的 Builder 类
  public static Builder newBuilder() {
      return new Builder();
  }

  public static class Builder {
      private String id;
      private String recordId;
      private String creatorId;
      private String editorId;
      private String nonce;
      private String payload;

      public Builder setId(String id) { this.id = id; return this; }
      public Builder setRecordId(String recordId) { this.recordId = recordId; return this; }
      public Builder setCreatorId(String creatorId) { this.creatorId = creatorId; return this; }
      public Builder setEditorId(String editorId) { this.editorId = editorId; return this; }
      public Builder setNonce(String nonce) { this.nonce = nonce; return this; }
      public Builder setPayload(String payload) { this.payload = payload; return this; }

      public MyComplexClass build() {
          return new MyComplexClass(id, recordId, creatorId, editorId, nonce, payload);
      }
  }
}

我们希望能够定义诸如生成 UUID 格式字符串和正整数格式字符串的 Arbitrary，并将其应用于 MyComplexClass 的不同字段。

import net.jqwik.api.Arbitraries;
import net.jqwik.api.Arbitrary;
import net.jqwik.api.Combinators;

import java.util.Set;
import java.util.UUID;

public class MyArbitraries {
  public static Arbitrary arbUuidString() {
      return Combinators.combine(
              Arbitraries.longs(), Arbitraries.longs(), Arbitraries.of(Set.of('8', '9', 'a', 'b')))
          .as((l1, l2, y) -> {
              StringBuilder b = new StringBuilder(new UUID(l1, l2).toString());
              b.setCharAt(14, '4'); // Version 4 UUID
              b.setCharAt(19, y);   // Variant
              return b.toString(); // 返回字符串，而非 UUID 对象
          });
  }

  public static Arbitrary arbNumericIdString() {
    return Arbitraries.shorts().map(Math::abs).map(i -> "" + i);
  }
}

接下来，我们将探讨几种在 jqwik 中实现这种组合和复用的策略。

策略一：通过静态方法直接调用 Arbitrary

最直接且“足够好”的策略是创建静态的 Arbitrary 生成器方法，并在需要时直接调用它们。这种方法适用于在单个领域上下文（DomainContextBase）内部或相关领域之间共享生成器。

import net.jqwik.api.*;
import net.jqwik.api.builders.ArbitraryBuilder;
import net.jqwik.api.domains.DomainContextBase;

// 假设 MyComplexClass 和 MyArbitraries 如上所示

public class MyDomain extends DomainContextBase {

  @Provide
  public Arbitrary arbMyComplexClass() {
    return ArbitraryBuilder.forType(MyComplexClass.class)
      .with(MyArbitraries.arb