在软件开发中,代码重复是一个常见的问题,它会降低代码的可读性、可维护性,并增加引入bug的风险。当我们在同一个类中的不同方法中发现相同的代码片段时,这通常是一个明确的重构信号。
考虑以下两个Java方法,它们分别用于映射用户实体到DTO和更新用户资源:
// 方法一:将UserEntity映射到UserDTO protected UserDTO map(UserEntity entity) { var result = new UserDTO(); // 存在重复逻辑 var userRoles = entity.getRoles().stream() .map(RoleEntity::getId) .map(String::valueOf) .collect(Collectors.toList()); result.setId(entity.getId().toString()); result.setLastAccessDate(entity.getLastAccessDate()); result.setRoles(userRoles); if (entity.getEmail() != null) { var email = new UserDTO.Email(entity.getEmail(), EMAIL_TYPE); result.setEmails(List.of(email)); } return result; } // 方法二:更新用户资源 public UserResource updateUser(String id, UserResource updatedUser) { var optionalUser = userRepository.findById(Integer.valueOf(updatedUser.getUserName())); // 存在重复逻辑 updatedUser.setRoles(optionalUser.get().getRoles() .stream() .map(RoleEntity::getId) .map(String::valueOf) .collect(Collectors.toList())); updatedUser.setLastAccessDate(optionalUser.get().getLastAccessDate()); var entity = mapToUserEntity(updatedUser); userRepository.save(entity); return updatedUser; }
在这两个方法中,以下代码片段是重复的:
.getRoles() .stream() .map(RoleEntity::getId) .map(String::valueOf) .collect(Collectors.toList());
这段代码的目的是从UserEntity(或其关联的RoleEntity列表)中提取所有角色的ID,并将它们转换为字符串列表。这种重复不仅使得代码冗长,而且如果未来需要修改角色ID的提取逻辑,就必须在多个地方进行修改,极易出错。
为了消除这种重复,我们应遵循“Don't Repeat Yourself”(DRY)原则。最直接且符合面向对象设计原则的解决方案是,将这段与UserEntity紧密相关的逻辑封装到UserEntity类自身的一个新方法中。这样做的优点在于:
立即学习“Java免费学习笔记(深入)”;
我们将创建一个名为getRoleIds()的新方法,并将其添加到UserEntity类中。这个方法将负责执行提取角色ID并转换为字符串列表的所有逻辑。
首先,修改UserEntity类,添加getRoleIds()方法:
// UserEntity.java public class UserEntity { private Integer id; private String email; private Date lastAccessDate; private List<RoleEntity> roles; // 假设RoleEntity包含getId()方法 // ... 其他属性和getter/setter方法 ... /** * 获取用户所有角色的ID列表。 * @return 角色ID的字符串列表。 */ public List<String> getRoleIds() { if (this.roles == null) { return Collections.emptyList(); } return this.roles.stream() .map(RoleEntity::getId) .map(String::valueOf) .collect(Collectors.toList()); } } // RoleEntity.java (示例) public class RoleEntity { private Integer id; private String name; // ... getter/setter ... public Integer getId() { return id; } }
接下来,我们就可以在原始的map和updateUser方法中调用这个新方法,从而消除重复代码:
import java.util.Collections; import java.util.List; import java.util.stream.Collectors; // 方法一:重构后的map方法 protected UserDTO map(UserEntity entity) { var result = new UserDTO(); // 调用UserEntity的新方法,代码更简洁 var userRoles = entity.getRoleIds(); result.setId(entity.getId().toString()); result.setLastAccessDate(entity.getLastAccessDate()); result.setRoles(userRoles); if (entity.getEmail() != null) { var email = new UserDTO.Email(entity.getEmail(), EMAIL_TYPE); result.setEmails(List.of(email)); } return result; } // 方法二:重构后的updateUser方法 public UserResource updateUser(String id, UserResource updatedUser) { var optionalUser = userRepository.findById(Integer.valueOf(updatedUser.getUserName())); if (optionalUser.isPresent()) { // 调用UserEntity的新方法,代码更简洁 updatedUser.setRoles(optionalUser.get().getRoleIds()); updatedUser.setLastAccessDate(optionalUser.get().getLastAccessDate()); } var entity = mapToUserEntity(updatedUser); userRepository.save(entity); return updatedUser; }
通过这种方式,我们成功地将重复逻辑封装到了UserEntity类内部,使得调用方代码更加简洁和易读。
这种重构方法带来了多方面的好处:
在考虑这种重构时,需要注意以下几点:
通过将重复的代码逻辑封装到与其关联的领域模型(如UserEntity)中的新方法,我们不仅消除了代码重复,还提升了整体代码质量。这种方法使得代码更具可读性、可维护性,并更好地体现了面向对象的设计原则。在日常开发中,积极识别和重构此类重复代码是编写高质量、健壮软件的关键实践。
以上就是Java代码重构:通过领域模型扩展消除方法内重复逻辑的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 //m.sbmmt.com/ All Rights Reserved | php.cn | 湘ICP备2023035733号