在 Spring 库中模拟 OpenFeign 客户端进行单元测试，而不是用于 Spring Boot 应用程序

如何解决在 Spring 库中模拟 OpenFeign 客户端进行单元测试，而不是用于 Spring Boot 应用程序

我已经实现了一个基于此 official repository 调用 get API 的假客户端。我有一个规则类 UserValidationRule，它需要调用 get API call getUser() 并验证一些东西。这按预期工作，但是当我开始测试该规则类时，模拟 feign 客户端不成功，它继续调用实际的 API。我已经简化了情况，所以请忽略简单lol。这是我发现这个 stackoverflow 问题后的后续问题

API 返回此模型：

@Data
public class userModel {
    private long id;
    private String name;
    private int age;

}

与rest客户端方法的接口：

public interface UserServiceClient {

    @RequestLine("GET /users/{id}")
    UserModel getUser(@Param("id") int id);
}

在规则类中，我构建了 feign 客户端并调用了 API：

@RequiredArgsConstructor
@Component
public class UserValidationRule {

    private static final String API_PATH = "http://localhost:8080";

    private UserServiceClient userServiceClient;


    public void validate(String userId,...) {
            // some validations 
            validateUser(userId);

    }

    private void validateUser(String userId) {
            userServiceClient = getServiceClient();
            UserModel userModel = userServiceClient.gerUser(userId);
            
            // validate the user logic
        }
    }

    private UserServiceClient getServiceClient() {
           return Feign.builder()
                  .encoder(new GsonEncoder())
                  .decoder(new GsonDecoder())
                  .target(UserServiceClient.class,API_PATH);
    }
}

测试类来了：

public class UserValidationRuleTest {

    private UserServiceClient userServiceClient = mock(UserServiceClient.class);
    private UserValidationRule validationRule = new UserValidationRule();
    private UserModel userModel;

    @Before
    public void init() {
        userModel = generateUserModel();
    }


    @Test
    public void validateWhenAgeIsNotBlank() {

        doReturn(userModel).when(userServiceClient).getUser(any());
        validationRule.validate("123",...);
        // some logic ...
        assertEquals(.....);
        verify(userServiceClient).getUser(any());
    }



    private UserModel generateUserModel() {
        UserModel userModel = new UserModel();
        userModel.setName("Cody");
        userModel.setAge("22");
        return accountModel;
    }
}

当我调试 validateWhenAgeIsNotBlank() 时，我看到 userModel 不是在测试类中生成的那个，并且值都是空的。如果我传入一个实际的 userId，我会得到一个我的数据库中的实际 UserModel。

我认为问题在于 UserServiceClient 没有被嘲笑。 verify 失败，因为它表示未调用 getUser()。这可能与如何在 UserValidationRule 中使用 feign.builder() 声明 feign 客户端有关... 如果我错了，请纠正我，并告诉我我遗漏了什么或有关如何正确模拟它的任何建议。

解决方法

您没有使用 spring 管理的 UserServiceClient bean。每次调用 UserValidationRule.validate 时，它都会调用 validateUser，后者又调用 getServiceClient 方法。此 getServiceClient 为每次调用创建一个新的 UserServiceClient 实例。这意味着在测试模拟 UserServiceClient 时根本没有使用。

我会重新构造代码如下；

首先使用 UserServiceClient 将 @RequiredArgsConstructor 声明为 final 或将 @RequiredArgsConstructor 替换为 @AllArgsConstructor。此更改的目的是允许注入 UserServiceClient 的实例，而不是在服务方法内部创建。

@Component
@RequiredArgsConstructor
public class UserValidationRule {

    private final UserServiceClient userServiceClient;

.... // service methods

}

然后有一个单独的 Configuration 类，将 feign 客户端构建为 spring bean；

@Bean
private UserServiceClient userServiceClient() {
       return Feign.builder()
              .encoder(new GsonEncoder())
              .decoder(new GsonDecoder())
              .target(UserServiceClient.class,API_PATH);
}

在运行时，这个 bean 现在将被注入到 UserValidationRule 中。

至于单元测试更改，您正在正确创建模拟，但没有在任何地方设置/注入该模拟。您需要使用 @Mock 和 @InjectMocks 注释或在 UserValidationRule 方法中手动创建 @Before 的实例。

以下是 @Mock 和 @InjectMocks 的使用方式；

@RunWith(MockitoJUnitRunner.class)
public class UserValidationRuleTest {

    @Mock private UserServiceClient userServiceClient;
    @InjectMocks private UserValidationRule validationRule;
    ... rest of the code

或继续使用 mock(...) 方法并手动创建 UserValidationRule。

public class UserValidationRuleTest {

    private UserServiceClient userServiceClient = mock(UserServiceClient.class);
    private UserValidationRule validationRule;
    private UserModel userModel;

    @Before
    public void init() {
        validationRule = new UserValidationRule(userServiceClient);
        userModel = generateUserModel();
    }
    ... rest of the code

这将确保您在运行时使用 spring 管理的 feign client bean 的单个实例和模拟实例进行测试。