现场重构一段代码,展示什么叫「好代码,都在表达自己的意图」
代码能跑不代表代码容易读。很多代码刚写完的时候觉得没什么问题可过了几个月再回头看就得一行一行去推逻辑。要是当初没留下合适的注释理解起来就更费劲了。这种情况在项目里很常见的功能没有问题可读性却不高。下面以一个用户注册的方法为例。它完成的事情其实比较简单校验输入、检查密码强度、判断邮箱是否已经注册、加密密码然后保存用户。但是如果第一眼看到是下面这段代码我不知道你会作何感想。publicUserregisterUser(Useruser){if(!validateUserInput(user)){thrownewRuntimeException(u105);}Pattern[]rules{Pattern.compile([a-z]),Pattern.compile([A-Z]),Pattern.compile([0-9]),Pattern.compile([^a-zA-Z0-9])};if(user.getPassword().length()8Arrays.stream(rules).allMatch(r-r.matcher(user.getPassword()).find())){if(userRepository.findByEmail(user.getEmail())!null){thrownewRuntimeException(u212);}}else{thrownewRuntimeException(u201);}user.setPassword(passwordEncoder.encode(user.getPassword()));returnuserRepository.save(user);}这段代码问题很多的比如u105、u212这些错误码是什么意思光看代码根本不知道密码校验逻辑直接写在方法里一堆正则表达式直接把业务逻辑给扰乱了if-else一层套一层阅读的时候老是得停顿下来最后还修改了传进来的user对象这个是有副作用的。我们下面一步一步的改进我用的是java 17。给错误起一个有意义的名字代码里最先要处理的就是这些魔法字符串。thrownewRuntimeException(u105);看到u105没人知道发生了什么。我们可以自定义一个叫BizException的异常类支持填入错误码和对应的中文描述。thrownewBizException(InvalidParam,输入不合法);看到BizException(UserAlreadyExists, 邮箱已被注册)自然知道是邮箱已经被注册了这样做不仅更容易读也更容易维护。给错误一个有意义的名字读代码的人就不用去猜了。把实现细节藏起来原来的registerUser()方法里还有一大段密码校验逻辑。password.length()8...每次看到这里都要重新看一遍正则表达式。其实大多数人并不关心密码到底是怎么校验的他们更关心的是这里是不是在校验密码。所以把它抽成一个独立的方法。privatestaticfinalListPatternPASSWORD_RULESList.of(Pattern.compile([a-z]),Pattern.compile([A-Z]),Pattern.compile([0-9]),Pattern.compile([^a-zA-Z0-9]));privatebooleanisPasswordStrong(Stringpassword){returnpassword.length()8PASSWORD_RULES.stream().allMatch(r-r.matcher(password).find());}这样以后看到isPasswordStrong(password)就知道这里是在检查密码强度至于底层到底用了正则、字典还是别的策略不影响阅读这段业务代码。如果以后密码规则调整也只需要改一个地方。让代码按顺序往下读原来的代码还有一个问题就是嵌套太深。密码通过了再检查邮箱邮箱没问题再继续执行。阅读的时候思路一直在不同的缩进之间跳来跳去。Java里比较常见的写法就是使用「快速失败」条件不满足直接返回或者抛异常不再进入后面的逻辑。改完之后整个方法会变成一条直线。先校验输入。再校验密码。然后检查邮箱。最后保存用户。每一步都是一个独立的业务动作不需要再跟着if-else一层层往里面看。不要悄悄修改入参还有一个容易忽略的问题。user.setPassword(passwordEncoder.encode(user.getPassword()));这行代码修改了调用方传进来的对象。调用这个方法的人很可能并不知道user会在里面被改掉。Java 17的record比较适合作为这种请求对象。publicrecordUserRegistrationRequest(Stringusername,Stringemail,Stringpassword){}record本身就是不可变的没有setter也不会在方法里被修改。这样registerUser()就不用去改请求对象而是直接创建一个新的User实体。调用方也不用担心自己传进去的数据会被悄悄改掉。小结改完之后代码大概是下面这样。publicUserregisterUser(UserRegistrationRequestrequest){if(!validateUserInput(request)){thrownewBizException(InvalidParam,输入不合法);}if(!isPasswordStrong(request.password())){thrownewBizException(InvalidPassword,需包含大小写字母、数字和特殊字符且不少于8位);}if(userRepository.findByEmail(request.email())!null){thrownewBizException(UserAlreadyExists,邮箱已被注册);}returnuserRepository.save(newUser(request.username(),request.email(),passwordEncoder.encode(request.password())));}代码改造完毕后就清晰很多了校验输入、校验密码、检查邮箱、保存用户。阅读的人不需要去猜u105是什么意思也不用盯着一堆正则表达式研究密码规则因为这些实现细节已经被隐藏到了更合适的地方。提示代码清晰度是控制复杂度其中一种非常好的方式。

相关新闻

为什么 Dropout 能抑制过拟合:原理、数学推导与工程实现

为什么 Dropout 能抑制过拟合:原理、数学推导与工程实现

为什么 Dropout 能抑制过拟合:原理、数学推导与工程实现 一句话概括: Dropout 在训练阶段随机关闭一部分神经元,让模型无法长期依赖某一组固定特征组合;这迫使网络学习更分散、更稳健的表示,并近似实现许多子网络的模型…

2026/10/16 0:57:37 阅读更多 →
EhTagTranslator终极指南:如何快速实现E绅士标签中文化

EhTagTranslator终极指南:如何快速实现E绅士标签中文化

EhTagTranslator终极指南:如何快速实现E绅士标签中文化 【免费下载链接】EhTagTranslator 将e绅士页面TAG换成中文,最全数据库。 项目地址: https://gitcode.com/gh_mirrors/eh/EhTagTranslator 还在为E绅士网站上密密麻麻的英文标签而困扰吗&…

2026/10/16 12:49:56 阅读更多 →
AutoUnipus:5分钟掌握U校园自动答题的完整指南

AutoUnipus:5分钟掌握U校园自动答题的完整指南

AutoUnipus:5分钟掌握U校园自动答题的完整指南 【免费下载链接】AutoUnipus U校园脚本,支持全自动答题,百分百正确 2024最新版 项目地址: https://gitcode.com/gh_mirrors/au/AutoUnipus 还在为U校园平台繁重的网课任务而烦恼吗?AutoUnipus是一款…

2026/10/17 8:27:04 阅读更多 →

最新新闻

Unity3D汽车游戏源码调校指南:WheelCollider与Rigidbody物理参数详解

Unity3D汽车游戏源码调校指南:WheelCollider与Rigidbody物理参数详解

简介:这是一份基于Unity3D引擎开发的汽车驾驶类游戏项目源码,面向Unity初学者与有一定经验的游戏开发者,可用于学习赛车游戏的完整实现流程。项目围绕汽车轮转动这一核心效果展开,涉及刚体组件、物理引擎、C#脚本控制、碰撞检测与…

2026/10/17 23:12:06 阅读更多 →
告别LLM-as-a-Judge:用语义表征让小模型做精准评估

告别LLM-as-a-Judge:用语义表征让小模型做精准评估

我先说一个判断:LLM-as-a-Judge 这个方向,到了该“往回拉一拉”的时候了。过去一年我主要精力都放在怎么让大模型当裁判这件事上。一开始确实惊艳,给一段回答,让大模型打个分、挑个错,效果比传统的 BLEU、ROUGE 不知道…

2026/10/17 23:12:06 阅读更多 →
意大利餐厅H5响应式网站源码解析:手写HTML+CSS+JS项目拆解

意大利餐厅H5响应式网站源码解析:手写HTML+CSS+JS项目拆解

简介:这是一份面向Web前端初学者与进阶开发者的意大利风味餐厅响应式网页源码,基于HTML5、CSS3与JavaScript构建,能够自适应桌面、平板与手机屏幕,适用于餐饮企业官网、品牌展示、菜品宣传等场景,可直接作为练习或项目…

2026/10/17 23:12:06 阅读更多 →
Atari强化学习数据管线:图片预处理、状态堆叠与经验回放初始化

Atari强化学习数据管线:图片预处理、状态堆叠与经验回放初始化

我做Atari游戏训练,一般不会一上来就写完整训练循环,而是先把最枯燥但最关键的数据入口搞定:图片处理、state更新、经验回放数据初始化。这一篇就专门聊这套流程,并且会用Jupyter Notebook作为调试现场。对刚开始做DQN类强化学习的…

2026/10/17 23:12:06 阅读更多 →
【实战】低配云服务器部署 Hermes Agent + Python 量化选股全流程:把 settings 改到 TaoToken

【实战】低配云服务器部署 Hermes Agent + Python 量化选股全流程:把 settings 改到 TaoToken

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/17 23:12:06 阅读更多 →
H5扫码不是加个库就行:浏览器能力、权限与解码全链路解析

H5扫码不是加个库就行:浏览器能力、权限与解码全链路解析

1. 为什么H5扫码不是“加个库就完事”——从一次线上事故说起去年底,某电商类H5活动页上线后第三天,客服后台突然涌入大量用户反馈:“扫不了码”“摄像头打不开”“点扫码按钮没反应”。当时我正负责该页面的前端维护,紧急排查发现…

2026/10/17 23:11:05 阅读更多 →

日新闻

DeepSeek选型与部署:V3/R1、Ollama、API全攻略

DeepSeek选型与部署:V3/R1、Ollama、API全攻略

简介:《DeepSeek使用方法.pdf》是一份面向DeepSeek入门及进阶用户的完整使用指南,重点围绕V3与R1两款模型的能力差异与适用场景展开,帮助读者根据任务类型与成本选择合适的模型。资源共1个PDF文件,压缩包大小约311KB,篇…

2026/10/17 0:00:25 阅读更多 →
200+Deepseek润色指令拆解:从底层原理到场景落地的完整指南

200+Deepseek润色指令拆解:从底层原理到场景落地的完整指南

简介:这是一份聚焦DeepSeek提示词优化的《200Deepseek润色指令》PDF文档,共收录两百余条可直接套用的润色指令,涵盖语法修正、风格统一、逻辑梳理、表达精炼等维度,并针对商务写作、学术论文、广告文案等场景给出差异化建议。文档…

2026/10/17 0:00:25 阅读更多 →
OpenCV轮廓法物体计数系统:轻量、可控、可落地的工业级实现

OpenCV轮廓法物体计数系统:轻量、可控、可落地的工业级实现

简介:本资源是一份基于OpenCV的本科课程设计完整报告,面向计算机视觉初学者、图像处理学习者及高校通信/信息类专业学生,解决物体智能计数与检测结果结构化记录的实际问题。项目覆盖图像预处理、轮廓检测、边界框绘制、轨迹栏交互式参数调节、…

2026/10/17 0:00:25 阅读更多 →

周新闻

流感时间序列预测实战:ARIMA/LSTM全流程拆解与避坑指南

流感时间序列预测实战:ARIMA/LSTM全流程拆解与避坑指南

简介:基于 ARIMA、LSTM、Transformer 等模型的流感时间序列预测 Python 源码,面向计算机相关专业课程设计与期末大作业学生,以及项目实战学习者。内容覆盖预处理、平稳性检验、定阶、残差分析、多模型对比预测的完整时序建模流程,…

2026/10/16 21:35:51 阅读更多 →
影刀RPA新手教程:键盘模拟输入实战——输入文本与模拟按键的区别

影刀RPA新手教程:键盘模拟输入实战——输入文本与模拟按键的区别

影刀RPA新手教程:键盘模拟输入实战——输入文本与模拟按键的区别 做影刀RPA自动化,十个新手有八个栽在"往输入框里填东西"这件事上:要么填不进去,要么填了一半,要么直接把原来内容追加在后面。这背后的根因&…

2026/10/17 1:44:59 阅读更多 →
影刀RPA新手教程:阅文起点小说数据采集实战——书籍信息与章节内容

影刀RPA新手教程:阅文起点小说数据采集实战——书籍信息与章节内容

影刀RPA新手教程:阅文起点小说数据采集实战——书籍信息与章节内容 1. 认识影刀:什么场景该用RPA采小说数据 起点中文网的页面结构相对稳定——分类榜单、书籍详情、章节内容三块独立页面,跳转链路清晰。这种场景非常适合影刀自动化&#x…

2026/10/16 15:04:24 阅读更多 →

月新闻

我发现了一个新思路:用 Remotion + Claude Code 像写代码一样自动化生成短视频

我发现了一个新思路:用 Remotion + Claude Code 像写代码一样自动化生成短视频

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/16 21:54:38 阅读更多 →
Windows下 Codex 中 Chrome 和 Computer Use 插件不可用问题排查及解决参考方式:TaoToken 统一 Key 配置与验证

Windows下 Codex 中 Chrome 和 Computer Use 插件不可用问题排查及解决参考方式:TaoToken 统一 Key 配置与验证

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/17 17:22:31 阅读更多 →
黑夜航拍船只数据集训练YOLOV5模型全流程解析

黑夜航拍船只数据集训练YOLOV5模型全流程解析

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/16 14:23:36 阅读更多 →