【架构】-----Service 层代码太长太乱?试试这套 “见名知意” 的命名规范!

news2026/3/18 21:41:26
前言java服务层业务比较复杂导致单个函数行数太多可读性极低怎么解决让函数名本身就清晰告知开发者它的类型、职责、适用场景。以下是可落地的、行业通用的命名规范体系兼顾简洁性和辨识度一、核心命名原则不分类前提下前缀区分类型用固定前缀标识函数类型是最直观的方式优先级高于其他命名规则。动词名词体现职责前缀后紧跟核心动作业务对象明确函数做什么、针对什么业务。统一后缀/修饰符对特殊场景如共用、辅助增加后缀避免歧义。拒绝模糊词汇禁用“doSomething”“handleData”“processInfo”等无意义命名。二、分类型命名规范无物理分类以下是针对不同函数类型的具体命名规则附示例以订单业务为例函数类型命名规则前缀/后缀示例订单业务说明入口函数核心动词 业务对象无特殊前缀无核心动词开头createOrder(OrderDTO dto)queryOrderById(Long id)cancelOrder(String orderNo)入口函数是控制层直接调用的核心函数无特殊前缀用最简洁的核心动词体现业务动作是命名体系的“基础层”。校验函数validate 校验维度 业务对象前缀validatevalidateOrderParam(OrderDTO dto)validateOrderStatus(String orderNo)validateOrderAmount(BigDecimal amount)前缀固定为validate后接“校验维度”参数/状态/金额 业务对象明确校验的具体内容。共用函数核心功能 业务对象 Common后缀后缀CommonformatOrderNoCommon(String no)calculateTaxCommon(BigDecimal amount)convertDateCommon(Date date)后缀固定为Common标识是跨场景共用的通用逻辑无业务上下文依赖可在多个入口函数中复用。辅助函数辅助动作 目标对象 For 场景可选前缀build/parse/assemblebuildOrderDTOForDetail(OrderDO order)parseOrderGoodsFromJson(String json)assembleOrderCondition(OrderQueryDTO query)前缀用build组装、parse解析、assemble拼装等后缀可加For场景如ForDetail/ForList明确辅助的具体场景。抽取函数do 具体操作 业务对象前缀dodoCalculateOrderAmount(OrderDTO dto)doGenerateOrderNo()doUpdateOrderStatus(String orderNo, Integer status)前缀固定为do标识是从复杂业务中拆分的“子逻辑”仅被本类其他函数调用通常设为private不对外暴露。复杂业务函数process 业务场景 业务对象前缀processprocessOrderPay(OrderDTO dto)processOrderRefund(String orderNo, BigDecimal refundAmount)processOrderTimeout(String orderNo)前缀固定为process标识处理核心/复杂业务规则可调用do开头的抽取函数是入口函数的“业务实现层”。三、完整代码示例无物理分类以下是一个不做分类的OrderService示例仅通过命名区分所有函数类型保持代码内聚且可读性强/** * 订单服务无物理分类仅通过命名区分函数类型 * 核心规则入口函数无特殊前缀其他函数通过前缀/后缀标识类型 */ServicepublicclassOrderService{AutowiredprivateOrderMapperorderMapper;// ---------------------- 入口函数控制层直接调用无特殊前缀 ----------------------publicOrderDTOcreateOrder(OrderDTOdto){// 1. 调用校验函数validateOrderParam(dto);// 2. 调用复杂业务函数OrderDOorderDOprocessOrderCreate(dto);// 3. 调用辅助函数OrderDTOresultbuildOrderDTOForDetail(orderDO);returnresult;}publicOrderDTOqueryOrderById(Longid){OrderDOorderDOorderMapper.selectById(id);returnbuildOrderDTOForDetail(orderDO);}// ---------------------- 校验函数前缀validate ----------------------publicvoidvalidateOrderParam(OrderDTOdto){if(dtonull){thrownewBusinessException(PARAM_NULL,订单参数不能为空);}if(StringUtils.isBlank(dto.getOrderNo())){thrownewBusinessException(PARAM_ERROR,订单号不能为空);}}privatevoidvalidateOrderStatus(StringorderNo){OrderDOorderDOorderMapper.selectByOrderNo(orderNo);if(orderDO.getStatus()!0){thrownewBusinessException(STATUS_ERROR,订单非待支付状态无法操作);}}// ---------------------- 复杂业务函数前缀process ----------------------privateOrderDOprocessOrderCreate(OrderDTOdto){// 调用抽取函数BigDecimalamountdoCalculateOrderAmount(dto);StringorderNodoGenerateOrderNo();OrderDOorderDOnewOrderDO();orderDO.setOrderNo(orderNo);orderDO.setAmount(amount);orderDO.setCreateTime(newDate());orderMapper.insert(orderDO);returnorderDO;}// ---------------------- 抽取函数前缀do私有 ----------------------privateBigDecimaldoCalculateOrderAmount(OrderDTOdto){returndto.getGoodsList().stream().map(GoodsDTO::getPrice).reduce(BigDecimal.ZERO,BigDecimal::add);}privateStringdoGenerateOrderNo(){returnORDER_System.currentTimeMillis()RandomUtils.nextInt(1000,9999);}// ---------------------- 辅助函数前缀build/parse ----------------------privateOrderDTObuildOrderDTOForDetail(OrderDOorderDO){OrderDTOdtonewOrderDTO();dto.setOrderNo(orderDO.getOrderNo());dto.setAmount(orderDO.getAmount());// 调用共用函数dto.setCreateTime(formatDateCommon(orderDO.getCreateTime()));returndto;}// ---------------------- 共用函数后缀Common ----------------------privateStringformatDateCommon(Datedate){if(datenull){return;}SimpleDateFormatsdfnewSimpleDateFormat(yyyy-MM-dd HH:mm:ss);returnsdf.format(date);}}四、补充规范无分类场景必加即便仅靠命名区分也需要配套少量规则保证可读性避免命名混乱访问修饰符约束入口函数public对外暴露控制层调用。校验/复杂业务函数public或protected可被同包其他Service复用。抽取/辅助/共用函数private仅本类使用如需跨类复用升级为public并保持命名规则。参数命名约束业务对象参数用业务对象名缩写/全称如OrderDTO dto、Long orderId。基础类型参数加语义前缀如String orderNo而非String no、BigDecimal orderAmount而非BigDecimal amount。注释简化约束因命名已体现类型注释只需说明“业务规则”无需说明“函数类型”。示例/** * 创建订单核心入口 * 业务规则1. 校验参数 2. 计算金额 3. 生成订单号 4. 持久化 * param dto 订单入参 * return 订单详情 */publicOrderDTOcreateOrder(OrderDTOdto){...}五、避坑点无分类命名的关键禁止前缀混用不要把do用在入口函数如doCreateOrder也不要把validate用在业务函数如validateOrderCreate。禁止缩写模糊不要用cOrder代替createOrder不要用vParam代替validateOrderParam缩写仅在团队完全共识的前提下使用如query可简写为qry。禁止函数过长即便命名规范单个函数行数也不能超过50行否则再清晰的命名也无法掩盖逻辑混乱。总结仅靠命名规范区分服务层函数的核心是固定前缀用validate/do/process等前缀标识函数类型入口函数无特殊前缀。语义完整前缀后紧跟“动作业务对象”明确函数职责。特殊后缀用Common标识共用函数用For场景标识辅助函数。修饰符配合通过public/private区分函数是否对外暴露减少调用歧义。这套方案无需拆分类/包适合中小型项目或快速迭代场景既能保证代码可读性新人看函数名就知道类型和用途又能避免过度设计平衡规范和开发效率。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2424211.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

SpringBoot-17-MyBatis动态SQL标签之常用标签

文章目录 1 代码1.1 实体User.java1.2 接口UserMapper.java1.3 映射UserMapper.xml1.3.1 标签if1.3.2 标签if和where1.3.3 标签choose和when和otherwise1.4 UserController.java2 常用动态SQL标签2.1 标签set2.1.1 UserMapper.java2.1.2 UserMapper.xml2.1.3 UserController.ja…

wordpress后台更新后 前端没变化的解决方法

使用siteground主机的wordpress网站,会出现更新了网站内容和修改了php模板文件、js文件、css文件、图片文件后,网站没有变化的情况。 不熟悉siteground主机的新手,遇到这个问题,就很抓狂,明明是哪都没操作错误&#x…

网络编程(Modbus进阶)

思维导图 Modbus RTU(先学一点理论) 概念 Modbus RTU 是工业自动化领域 最广泛应用的串行通信协议,由 Modicon 公司(现施耐德电气)于 1979 年推出。它以 高效率、强健性、易实现的特点成为工业控制系统的通信标准。 包…

UE5 学习系列(二)用户操作界面及介绍

这篇博客是 UE5 学习系列博客的第二篇,在第一篇的基础上展开这篇内容。博客参考的 B 站视频资料和第一篇的链接如下: 【Note】:如果你已经完成安装等操作,可以只执行第一篇博客中 2. 新建一个空白游戏项目 章节操作,重…

IDEA运行Tomcat出现乱码问题解决汇总

最近正值期末周,有很多同学在写期末Java web作业时,运行tomcat出现乱码问题,经过多次解决与研究,我做了如下整理: 原因: IDEA本身编码与tomcat的编码与Windows编码不同导致,Windows 系统控制台…

利用最小二乘法找圆心和半径

#include <iostream> #include <vector> #include <cmath> #include <Eigen/Dense> // 需安装Eigen库用于矩阵运算 // 定义点结构 struct Point { double x, y; Point(double x_, double y_) : x(x_), y(y_) {} }; // 最小二乘法求圆心和半径 …

使用docker在3台服务器上搭建基于redis 6.x的一主两从三台均是哨兵模式

一、环境及版本说明 如果服务器已经安装了docker,则忽略此步骤,如果没有安装,则可以按照一下方式安装: 1. 在线安装(有互联网环境): 请看我这篇文章 传送阵>> 点我查看 2. 离线安装(内网环境):请看我这篇文章 传送阵>> 点我查看 说明&#xff1a;假设每台服务器已…

XML Group端口详解

在XML数据映射过程中&#xff0c;经常需要对数据进行分组聚合操作。例如&#xff0c;当处理包含多个物料明细的XML文件时&#xff0c;可能需要将相同物料号的明细归为一组&#xff0c;或对相同物料号的数量进行求和计算。传统实现方式通常需要编写脚本代码&#xff0c;增加了开…

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器的上位机配置操作说明

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器专为工业环境精心打造&#xff0c;完美适配AGV和无人叉车。同时&#xff0c;集成以太网与语音合成技术&#xff0c;为各类高级系统&#xff08;如MES、调度系统、库位管理、立库等&#xff09;提供高效便捷的语音交互体验。 L…

(LeetCode 每日一题) 3442. 奇偶频次间的最大差值 I (哈希、字符串)

题目&#xff1a;3442. 奇偶频次间的最大差值 I 思路 &#xff1a;哈希&#xff0c;时间复杂度0(n)。 用哈希表来记录每个字符串中字符的分布情况&#xff0c;哈希表这里用数组即可实现。 C版本&#xff1a; class Solution { public:int maxDifference(string s) {int a[26]…

【大模型RAG】拍照搜题技术架构速览:三层管道、两级检索、兜底大模型

摘要 拍照搜题系统采用“三层管道&#xff08;多模态 OCR → 语义检索 → 答案渲染&#xff09;、两级检索&#xff08;倒排 BM25 向量 HNSW&#xff09;并以大语言模型兜底”的整体框架&#xff1a; 多模态 OCR 层 将题目图片经过超分、去噪、倾斜校正后&#xff0c;分别用…

【Axure高保真原型】引导弹窗

今天和大家中分享引导弹窗的原型模板&#xff0c;载入页面后&#xff0c;会显示引导弹窗&#xff0c;适用于引导用户使用页面&#xff0c;点击完成后&#xff0c;会显示下一个引导弹窗&#xff0c;直至最后一个引导弹窗完成后进入首页。具体效果可以点击下方视频观看或打开下方…

接口测试中缓存处理策略

在接口测试中&#xff0c;缓存处理策略是一个关键环节&#xff0c;直接影响测试结果的准确性和可靠性。合理的缓存处理策略能够确保测试环境的一致性&#xff0c;避免因缓存数据导致的测试偏差。以下是接口测试中常见的缓存处理策略及其详细说明&#xff1a; 一、缓存处理的核…

龙虎榜——20250610

上证指数放量收阴线&#xff0c;个股多数下跌&#xff0c;盘中受消息影响大幅波动。 深证指数放量收阴线形成顶分型&#xff0c;指数短线有调整的需求&#xff0c;大概需要一两天。 2025年6月10日龙虎榜行业方向分析 1. 金融科技 代表标的&#xff1a;御银股份、雄帝科技 驱动…

观成科技:隐蔽隧道工具Ligolo-ng加密流量分析

1.工具介绍 Ligolo-ng是一款由go编写的高效隧道工具&#xff0c;该工具基于TUN接口实现其功能&#xff0c;利用反向TCP/TLS连接建立一条隐蔽的通信信道&#xff0c;支持使用Let’s Encrypt自动生成证书。Ligolo-ng的通信隐蔽性体现在其支持多种连接方式&#xff0c;适应复杂网…

铭豹扩展坞 USB转网口 突然无法识别解决方法

当 USB 转网口扩展坞在一台笔记本上无法识别,但在其他电脑上正常工作时,问题通常出在笔记本自身或其与扩展坞的兼容性上。以下是系统化的定位思路和排查步骤,帮助你快速找到故障原因: 背景: 一个M-pard(铭豹)扩展坞的网卡突然无法识别了,扩展出来的三个USB接口正常。…

未来机器人的大脑:如何用神经网络模拟器实现更智能的决策?

编辑&#xff1a;陈萍萍的公主一点人工一点智能 未来机器人的大脑&#xff1a;如何用神经网络模拟器实现更智能的决策&#xff1f;RWM通过双自回归机制有效解决了复合误差、部分可观测性和随机动力学等关键挑战&#xff0c;在不依赖领域特定归纳偏见的条件下实现了卓越的预测准…

Linux应用开发之网络套接字编程(实例篇)

服务端与客户端单连接 服务端代码 #include <sys/socket.h> #include <sys/types.h> #include <netinet/in.h> #include <stdio.h> #include <stdlib.h> #include <string.h> #include <arpa/inet.h> #include <pthread.h> …

华为云AI开发平台ModelArts

华为云ModelArts&#xff1a;重塑AI开发流程的“智能引擎”与“创新加速器”&#xff01; 在人工智能浪潮席卷全球的2025年&#xff0c;企业拥抱AI的意愿空前高涨&#xff0c;但技术门槛高、流程复杂、资源投入巨大的现实&#xff0c;却让许多创新构想止步于实验室。数据科学家…

深度学习在微纳光子学中的应用

深度学习在微纳光子学中的主要应用方向 深度学习与微纳光子学的结合主要集中在以下几个方向&#xff1a; 逆向设计 通过神经网络快速预测微纳结构的光学响应&#xff0c;替代传统耗时的数值模拟方法。例如设计超表面、光子晶体等结构。 特征提取与优化 从复杂的光学数据中自…