Mockito测试中Optional类型返回值默认行为与正确Stubbing实践

@Override
public UserDTO updateUser(String id, UserDTO updatedUser) {
    // 根据updatedUser的userName字段查找用户
    Optional<UserEntity> databaseUser = userRepository.findById(Integer.valueOf(updatedUser.getUserName()));
    if (databaseUser.isEmpty()) {
        // 如果未找到，抛出异常
        throw new UserNotFoundException("User with the this id is not found");
    }
    // 映射DTO到实体，并保存
    UserEntity entity = mapToUserEntity(updatedUser);
    return map(userRepository.save(entity));
}

@Test
void updateUserTest(){
    final int id = 1;
    final long roleId = 2L;

    UserDTO userDto = new UserDTO();
    userDto.setUserName(String.valueOf(12)); // 用于findById的查找ID
    userDto.setId(String.valueOf(id));
    // ... 其他属性设置

    // 模拟roleRepository，与当前问题无关
    when(roleRepository.findById(any())).thenReturn(Optional.of(new UserDTO().setId(roleId)));

    // 将DTO映射为实体，此实体通常是更新后的状态
    UserEntity userEntity = userService.mapToUserEntity(userDto);

    // 模拟userRepository.save()方法
    when(userRepository.save(any())).thenReturn(userEntity.setId(id));

    // 调用待测试方法
    var actualUser = userService.updateUser(String.valueOf(id), userDto);

    // 断言
    // userDto.setUserName(String.valueOf(id)); // 此行可能导致混淆，应删除或提前处理
    assertEquals(actualUser, userDto);
}

// 模拟userRepository.findById(12)方法，使其返回一个包含userEntity的Optional
when(userRepository.findById(12)).thenReturn(Optional.of(userEntity));
// 模拟userRepository.save()方法
when(userRepository.save(any())).thenReturn(userEntity.setId(id));

// 调用待测试方法
userService.updateUser(String.valueOf(id), userDto); // 第一次调用，触发findById和save
var actualUser = userService.updateUser(String.valueOf(id), userDto); // 第二次调用，获取返回值进行断言

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

import java.time.LocalDateTime;
import java.util.List;
import java.util.Optional;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;

// 假设UserDTO, UserEntity, UserService, UserRepository, RoleRepository已定义
// 并且UserDTO.Name, UserDTO.Email是嵌套类
// UserNotFoundException是自定义异常

class UserServiceTest {

    @Mock
    private UserRepository userRepository;

    @Mock
    private RoleRepository roleRepository; // 假设存在

    @InjectMocks
    private UserService userService; // 假设UserService中包含mapToUserEntity方法

    @BeforeEach
    void setUp() {
        MockitoAnnotations.openMocks(this);
        // 通常在这里进行一些公共的初始化或mock行为设置
    }

    @Test
    void updateUserTest(){
        final int id = 1;
        final long roleId = 2L; // 示例角色ID

        UserDTO userDto = new UserDTO();
        userDto.setUserName(String.valueOf(12)); // userName用于findById的查找
        userDto.setId(String.valueOf(id)); // DTO本身的ID
        userDto.setName(new UserDTO.Name("surname", "firstname", "patronymic"));
        userDto.setActive(true);
        userDto.setEmails(List.of(new UserDTO.Email("email@example.com", "external")));
        userDto.setRoles(List.of("2")); // 示例角色ID
        userDto.setLastAccessDate(LocalDateTime.of(2022, 10, 25, 4, 20));
        userDto.setUnit(null); // 示例null值

        // 模拟roleRepository，如果updateUser方法依赖于此
        when(roleRepository.findById(any())).thenReturn(Optional.of(new UserDTO().setId(roleId)));

        // 创建一个UserEntity，用于模拟findById和save的返回值
        // 这个userEntity通常代表了更新前的或期望更新后的实体状态
        UserEntity userEntity = userService.mapToUserEntity(userDto);
        // 对于findById，它应该返回一个“找到的”实体，这里我们使用userEntity作为示例
        // 实际上，findById应该返回一个“现有”实体，save会接收一个“更新后”的实体。
        // 为了简化和解决当前问题，我们让findById返回这个userEntity。
        userEntity.setId(Integer.valueOf(userDto.getId())); // 确保实体ID与DTO ID一致

        // 核心修正：模拟userRepository.findById()方法，使其返回非空Optional
        // findById的参数是Integer.valueOf(updatedUser.getUserName())，即12
        when(userRepository.findById(12)).thenReturn(Optional.of(userEntity));

        // 模拟userRepository.save()方法，使其返回保存后的实体
        // save方法的参数是any()，因为我们不关心具体传入的实例，只关心返回值
        when(userRepository.save(any(UserEntity.class))).thenReturn(userEntity); // save通常返回保存后的实体

        // 调用待测试方法，只调用一次并获取结果
        UserDTO actualUser = userService.updateUser(String.valueOf(id), userDto);

        // 断言：验证返回的DTO是否符合预期
        assertEquals(userDto, actualUser);
    }
}