0

0

如何通过提取通用 REST 操作辅助方法避免重复代码

霞舞

霞舞

发布时间:2026-01-04 13:59:33

|

858人浏览过

|

来源于php中文网

原创

如何通过提取通用 REST 操作辅助方法避免重复代码

本文介绍如何将多个 rest 接口(如 get、delete)中重复的资源校验逻辑(如双 id 查找、归属关系验证)抽取为私有辅助方法,提升代码复用性与可维护性,并给出安全、清晰的实现范式。

在构建 RESTful 服务时,不同 HTTP 方法(如 GET、DELETE、PUT)常需执行相同的前置校验:根据 projectManagerId 和 questionnaireId 分别加载实体,并验证问卷是否归属该项目经理。若每处都重复编写查找 + 校验逻辑,不仅违反 DRY(Don’t Repeat Yourself)原则,还会增加维护成本和出错风险。

理想的解法是将共用逻辑封装为职责单一的私有方法。注意:该辅助方法不应直接返回 DTO 或 void,而应返回核心业务实体(Questionnaire),由调用方按需后续处理(如转换、删除、更新)。这样既保证了复用性,又保持了各接口行为的语义清晰。

以下是重构后的推荐实现:

@Override
public QuestionnaireDTO methodOne(long projectManagerId, long questionnaireId) {
    Questionnaire questionnaire = findById(projectManagerId, questionnaireId);
    return mapToDto(questionnaire); // GET:查后转 DTO
}

@Override
public QuestionnaireDTO methodTwo(long projectManagerId, long questionnaireId) {
    Questionnaire questionnaire = findById(projectManagerId, questionnaireId);
    questionnaireRepository.delete(questionnaire); // DELETE:查后删实体
    return mapToDto(questionnaire); // 可选:返回被删资源的快照(符合 REST 最佳实践)
}

/**
 * 公共校验方法:根据 projectManagerId 和 questionnaireId 加载并验证归属关系
 * @return 已通过权限校验的 Questionnaire 实体
 * @throws ResourceNotFoundException 当任一 ID 未找到时
 * @throws QuestionnaireApiException 当问卷不属于指定项目经理时
 */
private Questionnaire findById(long projectManagerId, long questionnaireId) {
    ProjectManager projectManager = projectManagerRepository.findById(projectManagerId)
            .orElseThrow(() -> new ResourceNotFoundException("ProjectManager", "id", projectManagerId));

    Questionnaire questionnaire = questionnaireRepository.findById(questionnaireId)
            .orElseThrow(() -> new ResourceNotFoundException("Questionnaire", "id", questionnaireId));

    if (!questionnaire.getProjectManager().getId().equals(projectManager.getId())) {
        throw new QuestionnaireApiException(HttpStatus.BAD_REQUEST,
                "Questionnaire not belonging to Project Manager");
    }

    return questionnaire;
}

关键设计要点说明:

Aha
Aha

全天候网红营销AI智能体平台

下载
  • 返回实体而非 DTO 或 void:确保调用方灵活决定后续操作(映射、删除、更新等),避免辅助方法承担过多职责;
  • 异常语义明确:复用原异常类型(ResourceNotFoundException、QuestionnaireApiException),保障全局异常处理器一致性;
  • 方法命名精准:findById 直观表达其核心能力(基于 ID 查找+校验),比泛称 validateAndLoad 更具可读性;
  • 无副作用:辅助方法仅做查询与校验,不修改状态,符合函数式设计思想,便于单元测试。

⚠️ 注意事项:

  • 若未来需支持其他资源(如 Survey、Report)的同类校验,可进一步泛型化或抽象为模板方法,但当前场景下简单私有方法已足够简洁高效;
  • 切勿在辅助方法中调用 repository.delete() 或 mapToDto() —— 这会耦合具体业务意图,破坏复用前提;
  • 建议为 findById 添加 JavaDoc,明确契约(输入、输出、异常),提升团队协作效率。

通过这一重构,不仅消除了 IntelliJ 的“duplicated code fragment”警告,更让业务逻辑主干更聚焦、校验逻辑更集中、后续扩展(如增加审计日志、缓存拦截)也有了统一入口。

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

145

2025.11.26

javascriptvoid(o)怎么解决
javascriptvoid(o)怎么解决

javascriptvoid(o)的解决办法:1、检查语法错误;2、确保正确的执行环境;3、检查其他代码的冲突;4、使用事件委托;5、使用其他绑定方式;6、检查外部资源等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

174

2023.11.23

java中void的含义
java中void的含义

本专题整合了Java中void的相关内容,阅读专题下面的文章了解更多详细内容。

95

2025.11.27

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1006

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

56

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

341

2025.12.29

数据库Delete用法
数据库Delete用法

数据库Delete用法:1、删除单条记录;2、删除多条记录;3、删除所有记录;4、删除特定条件的记录。更多关于数据库Delete的内容,大家可以访问下面的文章。

269

2023.11.13

drop和delete的区别
drop和delete的区别

drop和delete的区别:1、功能与用途;2、操作对象;3、可逆性;4、空间释放;5、执行速度与效率;6、与其他命令的交互;7、影响的持久性;8、语法和执行;9、触发器与约束;10、事务处理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

208

2023.12.29

java学习网站推荐汇总
java学习网站推荐汇总

本专题整合了java学习网站相关内容,阅读专题下面的文章了解更多详细内容。

6

2026.01.08

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.4万人学习

C# 教程
C# 教程

共94课时 | 6.3万人学习

Java 教程
Java 教程

共578课时 | 43.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号