本文探讨在Java类中消除重复代码的有效策略。针对在不同方法中处理同一实体（如UserEntity）的重复逻辑，文章提出将通用数据转换逻辑封装到实体自身的新方法中。通过将角色ID提取逻辑移至UserEntity的getRoleIds()方法，不仅简化了调用方代码，还提升了代码的可读性、可维护性，并遵循了面向对象的设计原则。
识别与消除代码重复
在软件开发中，代码重复是一个常见的问题，它会降低代码的可读性、可维护性，并增加引入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免费学习笔记（深入）”；
- 封装性增强：将数据（RoleEntity列表）和处理数据（提取角色ID）的逻辑放在一起，符合对象的单一职责原则。
- API清晰：UserEntity现在提供了一个更高级别的、语义化的方法来获取角色ID列表，而不是暴露其内部的RoleEntity集合并让外部进行处理。
- 简化调用方：其他方法可以直接调用这个新方法，而无需关心内部实现细节。
实现细节：在UserEntity中添加辅助方法
我们将创建一个名为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类内部，使得调用方代码更加简洁和易读。
优点与最佳实践
这种重构方法带来了多方面的好处：
- 提高代码可读性：通过语义化的方法名（如getRoleIds()），代码的意图变得一目了然。
- 增强可维护性：如果角色ID的提取逻辑需要修改，只需在一个地方（UserEntity.getRoleIds()）进行修改，大大降低了维护成本和引入新bug的风险。
- 遵循面向对象原则：将与UserEntity数据相关的行为封装在UserEntity内部，符合封装性和单一职责原则。这使得UserEntity成为一个更“智能”的领域对象。
- 减少错误：重复的代码是错误的温床。消除重复可以有效减少因复制粘贴错误或遗漏修改导致的bug。
在考虑这种重构时，需要注意以下几点：
- 逻辑归属：判断重复逻辑是否与某个特定实体紧密相关。如果是，将其下沉到该实体类中是最佳选择。
- 方法可见性：新创建的方法通常可以设置为public，以便其他需要获取该信息的部分调用。
- 空值处理：在新方法中，应妥善处理可能为空的集合（如roles列表），避免NullPointerException。示例中已包含Collections.emptyList()的处理。
总结
通过将重复的代码逻辑封装到与其关联的领域模型（如UserEntity）中的新方法，我们不仅消除了代码重复，还提升了整体代码质量。这种方法使得代码更具可读性、可维护性，并更好地体现了面向对象的设计原则。在日常开发中，积极识别和重构此类重复代码是编写高质量、健壮软件的关键实践。
评论（已关闭）
评论已关闭