使用PowerMockito测试私有方法时遇参数匹配器错误求助

问题场景 #

测试PermissionServiceImpl的getPermissions方法时，需要Stub其内部调用的私有方法getUserRoles，但运行测试时抛出参数匹配器误用的错误。

实现类关键代码 #

@Service
public class PermissionServiceImpl implements PermissionService {

    @Autowired
    private PermissionRepository permissionRepository;

    @Autowired
    private UserRoleRepository roleRepository;

    @Override
    public Set<PermissionType> getPermissions(String accessToken, String clientId) {
        Map<String, List<String>> userRoles = getUserRoles(accessToken);
        List<UserRole> currRole = getCurrRole(userRoles, clientId);
        return getCurrentPermissions(currRole);
    }

    private Map<String, List<String>> getUserRoles(String accessToken) {
        Map<String, List<String>> roles = new HashMap<>();
        UserAccessTokenInfo userAccessTokenInfo = 
        SessionValidatorWithOKTA.getTokenMap().get(accessToken);
        if (userAccessTokenInfo != null) {
            roles = userAccessTokenInfo.getRoles();
        }
        return roles;
    }
}

原测试用例代码 #

@RunWith(PowerMockRunner.class)
@PrepareForTest(PermissionServiceImpl.class)
@ExtendWith(MockitoExtension.class)
public class PermissionServiceImplTest {

    @InjectMocks
    PermissionService permissionService = new PermissionServiceImpl();

    @Mock
    PermissionRepository permissionRepository;

    @Mock
    UserRoleRepository roleRepository;

    @Test
    public void testGetPermissions() {
        Set<PermissionType> permissionTypes = permissionService.getPermissions(ConstantsMock.ACCESS_TOKEN, ConstantsMock.CLIENT_ID);
        assertEquals(permissionTypes, new HashSet<>());
    }

    @Test
    public void testGetPermissions_withRoles() throws Exception {
        Map<String, List<String>> roles = new HashMap();
        roles.put(ConstantsMock.CLIENT_ID, new ArrayList<>(Arrays.asList("admin")));
        PermissionServiceImpl mocked = PowerMockito.spy(new PermissionServiceImpl());
        PowerMockito.when(mocked, method(PermissionServiceImpl.class, "getUserRoles", String.class))
                .withArguments(anyString())
                .thenReturn(roles);

        mocked.getPermissions(ConstantsMock.ACCESS_TOKEN, ConstantsMock.CLIENT_ID);
    }
}

错误信息 #

Misplaced or misused argument matcher detected here:

-> at PermissionServiceImplTest.testGetPermissions_withRoles(PermissionServiceImplTest.java:51)

You cannot use argument matchers outside of verification or stubbing.
Examples of correct usage of argument matches:
when(mock.get(anyInt())).thenReturn(null);
doThrow(new RuntimeException()).when(mock).someVoidMethod(anyObject());
verify(mock).someMethod(contains("foo"))

This message may appear after an NullPointerException if the last matcher is returning an object like any() but the stubbed method signature expect a primitive argument, in this case, use primitive alternatives.
when(mock.get(any())); // bad use, will raise NPE
when(mock.get(anyInt())); // correct usage use

Also, this error might show up because you use argument matchers with methods that cannot be mocked.
Following methods cannot be stubbed/verified: final/private/equals()/hashCode().
Mocking methods declared on non-public parent classes is not supported.

错误原因 #

1. JUnit版本冲突：同时使用了JUnit4的@RunWith(PowerMockRunner.class)和JUnit5的@ExtendWith(MockitoExtension.class)，两者不能混用，会导致Mockito的参数匹配器机制异常。
2. 私有方法Stub语法错误：PowerMock针对私有方法的Stub，使用withArguments(anyString())的方式不符合要求，参数匹配器的使用方式不正确。
3. Spy对象未注入依赖：直接new PermissionServiceImpl()创建的Spy对象，没有注入permissionRepository和roleRepository的Mock实例，后续方法调用可能出现空指针或未预期行为。

修复方案 #

步骤1：移除JUnit5扩展注解 #

删除@ExtendWith(MockitoExtension.class)，保持测试类仅使用JUnit4的PowerMockRunner。

步骤2：正确Stub私有方法 #

使用PowerMock的doReturn语法来Stub私有方法，同时确保Spy对象被正确注入依赖。

修改后的测试用例 #

@RunWith(PowerMockRunner.class)
@PrepareForTest(PermissionServiceImpl.class)
public class PermissionServiceImplTest {

    @Mock
    PermissionRepository permissionRepository;

    @Mock
    UserRoleRepository roleRepository;

    @InjectMocks
    private PermissionServiceImpl permissionService;

    @Test
    public void testGetPermissions() {
        Set<PermissionType> permissionTypes = permissionService.getPermissions(ConstantsMock.ACCESS_TOKEN, ConstantsMock.CLIENT_ID);
        assertEquals(permissionTypes, new HashSet<>());
    }

    @Test
    public void testGetPermissions_withRoles() throws Exception {
        // 准备测试数据
        Map<String, List<String>> roles = new HashMap<>();
        roles.put(ConstantsMock.CLIENT_ID, new ArrayList<>(Arrays.asList("admin")));
        
        // 创建Spy对象并注入依赖
        PermissionServiceImpl spyService = PowerMockito.spy(permissionService);
        
        // Stub私有方法getUserRoles
        PowerMockito.doReturn(roles).when(spyService, "getUserRoles", anyString());
        
        // 执行测试方法
        Set<PermissionType> result = spyService.getPermissions(ConstantsMock.ACCESS_TOKEN, ConstantsMock.CLIENT_ID);
        
        // 可添加断言验证结果，示例：
        // assertNotNull(result);
        // ... 其他业务相关断言逻辑
    }
}

额外说明 #

• 若需验证私有方法调用，可使用PowerMockito.verify(spyService, times(1)).invoke("getUserRoles", anyString());
• 确保@PrepareForTest注解包含需要Mock/Spy的类，此处为PermissionServiceImpl.class
• 若getCurrRole或getCurrentPermissions方法有外部依赖，需对应添加Mock或Stub处理

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