当前位置:

首页 > 编程开发 > Java方法提取优化类内重复逻辑

Java方法提取优化类内重复逻辑

本文探讨了如何在Java类中通过方法提取来消除重复代码,特别是在处理实体集合并进行数据转换的场景。核心策略是将重复的业务逻辑封装到相关实体类的新方法中,从而提高代码的封装性、可读性和可维护性,同时避免在多个方法中重复编写相同的数据处理逻辑。

本文目录

    Java代码重构:通过方法提取优化类内重复逻辑

    本文探讨了如何在Java类中通过方法提取来消除重复代码,特别是在处理实体集合并进行数据转换的场景。核心策略是将重复的业务逻辑封装到相关实体类的新方法中,从而提高代码的封装性、可读性和可维护性,同时避免在多个方法中重复编写相同的数据处理逻辑。

    在软件开发中,代码重复是一个常见的问题,它不仅增加了维护成本,还容易引入潜在的bug。当一个类中的多个方法执行相似的数据转换或集合处理逻辑时,这通常是进行重构的信号。本教程将通过一个具体的案例,演示如何利用方法提取(Method Extraction)这一重构技术,有效地解决类内代码重复问题。

    识别重复代码模式

    考虑以下两个Java方法,它们分别负责映射用户实体到DTO和更新用户资源:

    原始方法一:map 方法

    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;
    }

    原始方法二:updateUser 方法

    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 中获取角色列表(List),然后将其转换为一个包含角色ID字符串的列表(List)。

    解决方案:方法提取与封装

    解决这种重复代码的最佳实践是将该逻辑封装到一个独立的方法中。关键在于选择合适的方法归属。考虑到这段逻辑是关于 UserEntity 内部角色数据的转换,将其直接添加到 UserEntity 类中是更符合面向对象设计原则的做法。这不仅提高了 UserEntity 的封装性,也使得 UserEntity 自身能够更好地管理和提供其内部数据的不同表示形式。

    1. 在 UserEntity 类中添加新方法

    我们将提取的逻辑封装为 getRoleIds() 方法,并将其添加到 UserEntity 类中。

    // UserEntity.java
    public class UserEntity {
        private Integer id;
        private String email;
        private Date lastAccessDate;
        private List roles; // 假设RoleEntity包含getId()方法
    
        // ... 其他属性、构造函数、getter/setter ...
    
        /**
         * 获取用户所有角色的ID列表。
         * 将List转换为List (角色ID)。
         * @return 包含角色ID字符串的列表。
         */
        public List getRoleIds() {
            if (this.roles == null) {
                return Collections.emptyList(); // 或根据业务需求返回null
            }
            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;
        }
        // ...
    }

    2. 更新调用方方法

    现在,原始方法中的重复代码可以被简洁地替换为对 entity.getRoleIds() 的调用。

    优化后的 map 方法

    protected UserDTO map(UserEntity entity) {
        var result = new UserDTO();
        var userRoles = entity.getRoleIds(); // 直接调用UserEntity中的新方法
        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()));
        // 确保optionalUser不为空,实际生产中应进行null检查或使用orElseThrow
        if (optionalUser.isPresent()) {
            updatedUser.setRoles(optionalUser.get().getRoleIds()); // 直接调用UserEntity中的新方法
            updatedUser.setLastAccessDate(optionalUser.get().getLastAccessDate());
        } else {
            // 处理用户不存在的情况,例如抛出异常
            throw new UserNotFoundException("User with username " + updatedUser.getUserName() + " not found.");
        }
        var entity = mapToUserEntity(updatedUser);
        userRepository.save(entity);
        return updatedUser;
    }

    注意事项与最佳实践

    1. 封装性提升: 将数据转换逻辑放在 UserEntity 内部,使得 UserEntity 对其自身的数据表示拥有更强的控制权,外部类无需关心其内部角色列表的具体转换细节,只需调用一个高层次的方法即可获取所需结果。
    2. 可读性与维护性: 新方法 getRoleIds() 具有清晰的名称,准确表达了其意图,使得调用方代码更加简洁易懂。如果未来角色ID的转换逻辑发生变化(例如,需要过滤特定类型的角色),只需修改 UserEntity 中的 getRoleIds() 方法,而无需改动所有调用它的地方。
    3. 选择合适的封装位置: 在本例中,将方法添加到 UserEntity 是最合适的,因为它处理的是 UserEntity 的内部数据。如果重复的逻辑不紧密依赖于某个特定实体,而是一个通用的工具函数,则可以考虑创建一个独立的工具类或私有辅助方法。
    4. 方法命名: 确保新方法的名称清晰、简洁,并准确反映其功能。例如,getRoleIds() 比 transformRolesToIds() 更为直接。
    5. 空值处理: 在 getRoleIds() 方法中,对 this.roles 进行空值检查是一个良好的实践,以避免 NullPointerException。

    总结

    通过方法提取和恰当的封装,我们成功地消除了类内的重复代码,提高了系统的可维护性和可读性。这个案例强调了在重构过程中,不仅要识别重复代码,更要思考将这些重复逻辑封装到何处才能最大化地提升代码质量和符合面向对象设计原则。将与特定实体数据紧密相关的逻辑放置在该实体类内部,是实现高内聚、低耦合的有效手段。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    QQ影音怎么加速播放视频课程
    QQ影音怎么加速播放视频课程

    播放时右键选播放速度,或点控制条倍速,1.25 到 1.5 倍看课最舒服;公式代码类内容别超过 1.25 倍。

    企业微信创建企业提示失败怎么办 实名与填写检查
    企业微信创建企业提示失败怎么办 实名与填写检查

    先看提示属于哪类:名称占用就加后缀,实名不一致就重填本人信息,证件不清晰就重拍。统一社会信用代码逐位核对,连续三次失败别改材料重投,直接联系客服人工核。

    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?
    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?

    说明源码提交对字符串、生成器和数组的识别边界,以及扫描命令与发行包核验限制。

    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?
    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?

    0.170.0 的语音更新限于终端通话协商能力的明确新增,同名工具服务器跨环境支持仍标注实验性质;连接部分则修复大请求回退、认证竞态和云端重连等具体问题。这份正式版公告不足以证明所有账户、所有客户端都已具备完整语音功能。

    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?
    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?

    了解Hy4 flash、FP8与base的适用任务,阅读官方安装及图文代码,并核对资源和MaaS许可条件。

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化
    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化。说明已核实的更新范围、类型兼容性和本地版本确认方法。

    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?
    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?

    OpenAI Java SDK 4.108.0 面向 Live MCP 工具接入与 Managed Agents 预算状态处理,说明新增模型、事件含义、正式发布范围和适用限制。

    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?
    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?

    Free Claude Code 6.19.37 在自动搜索时保留客户端工具及选择条件,代理执行搜索后仍返回普通调用。说明适用场景、历史信息保留、请求约束与第三方项目的版本边界。

    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?
    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?

    Google GenAI Go SDK 1.78.0 将 Gemini Developer API 默认改为 v1,可用 HTTPOptions.APIVersion 或环境变量保留 v1beta,Vertex AI 默认值不变。

    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?
    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?

    解释实验性实时支持、环境检查与生产评估中需要验证的条件。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。