重构艺术 | 如何优雅地“提炼函数“

在工作中总数遇到非常多的长代码,俗称“屎山”,这类代码读起来特别费劲。自己想重构一遍,但是总感觉缺乏经验指导,因此,多读书,读好书可能是最优解之一。读《重构改善即有代码的设计》有感,便写下此篇博客,积累经验!

在软件开发的浩瀚星河中,函数是最基本的代码单元。当我们面对臃肿冗长的函数时,《重构》一书给出的第一剂良方便是"提炼函数"。这个看似简单的重构手法,实则是提升代码质量的关键转折点。

一、重构动机:代码的诗意重构

当函数膨胀到需要滚动三屏才能读完时,它就变成了代码的"黑洞"——既吞噬可读性,又掩盖复用价值。更致命的是,这样的函数往往混杂着多个抽象层级,就像把说明书、操作手册和维修指南揉成一团。提炼函数的本质,是在混沌中建立秩序,让每个函数都成为一首表达清晰意图的代码诗。

二、长度迷思:质量的新度量衡

传统认知中,20行是函数长度的黄金分割点。但Martin Fowler给出了更深刻的见解:函数名称与函数本体之间的语义距离才是核心标准。一个命名精准的函数,即使略长,只要每个代码块都在同一抽象层呼吸,就值得保留。就像好的文学作品,章节长短不重要,重要的是思想的连贯性。

三、重构四部曲

  1. 命名即设计:如同给新生儿取名,新函数的名字要能完整表达其使命。例如"计算税费"比"处理数据"更直指本质
  2. 安全过渡:通过复制粘贴建立新函数的雏形,保留原始函数的执行流程
  3. 参数手术:识别需要传递的局部变量,像外科医生般精确处理;具体情况参考下面的处理方案对照表。
  4. 替换仪式:将原函数中的代码块替换为对新函数的调用,完成重构的最后一舞

参数处理方案对照表

参数类型特征描述解决方案代码示例片段
无参数被提取代码块不依赖任何外部变量直接提取为无参数函数function newFunc() { /* 原代码块 */ }
只读参数原代码块读取但不会修改外部变量将变量作为参数传入新函数function newFunc(readVar) { /* 使用readVar */ }
可修改参数原代码块会修改外部变量1. 传入参数并返回修改后的值
2. 直接修改传入的对象属性
function newFunc(input) { return input + 1; }
function update(obj) { obj.value++ }
共享参数原函数和提取函数共同修改同一变量1. 通过返回值更新变量
2. 使用引用类型参数
3. 封装为对象操作
value = modify(value);
modifyInPlace(&value);
container.updateValue();
多参数混合同时包含只读和可修改参数组合使用上述策略:
- 只读参数直接传入
- 可修改参数通过返回值/引用
function calc(readOnly, &output) {return readOnly}

四、复杂场景破局之道

当遇到多返回值困境时,解决方案如月光穿透迷雾:

  1. 构建临时对象封装多个返回值
  2. 改用集合类型(数组/元组)打包数据
  3. 重新审视函数职责,拆分为更细粒度的函数
  4. 在支持语言中利用元组解构等语法糖
// 重构前
function printOwing(invoice) {let outstanding = 0;console.log("***********************");console.log("**** Customer Owes ****");console.log("***********************");// 计算未结金额for (const o of invoice.orders) {outstanding += o.amount;}// 记录到期日const today = Clock.today;invoice.dueDate = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 30);// 打印详情console.log(`name: ${invoice.customer}`);console.log(`amount: ${outstanding}`);console.log(`due: ${invoice.dueDate.toLocaleDateString()}`);
}// 重构后
function printOwing(invoice) {printBanner();const outstanding = calculateOutstanding(invoice);recordDueDate(invoice);printDetails(invoice, outstanding);
}

五、重构哲学:在秩序与混沌之间

提炼函数不是简单的代码搬家,而是一场思维革命。每个提炼动作都应使代码更接近"自解释文档"的理想状态。当函数名能准确传达意图,当参数列表清晰描绘输入输出,当每个函数都保持单一职责,代码就会自然生长出优雅的形态。

重构大师的终极追求,是让代码像散文般流畅,如数学公式般精确。当我们用提炼函数的手法雕刻代码时,其实也在雕刻自己的思维——将混沌的灵感,淬炼成精妙的艺术。

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

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

相关文章

每天学一个 Linux 命令(13):touch

Linux 文件管理命令:touch touch 是 Linux 中一个简单但高频使用的命令,主要用于创建空文件或修改文件的时间戳(访问时间、修改时间)。它是文件管理和脚本操作的实用工具。 1. 命令作用 创建空文件:快速生成一个或多个空白文件。更新时间戳:修改文件的访问时间(Access …

STM32HAL库学习笔记

目录 定时器 一些小细节 输入捕获计算信号频率 输入捕获计算占空比与频率 使用定时器不改变占空比的同时改变频率的方法 串口 重定向原理 重定向代码 怎么从串口接收到的字符串数据中解析出float型的数据 strchr sscanf memset 第一种实现方法 RTC实时时钟 LCD显…

Docker 镜像、容器与数据卷的高效管理:最佳实践与自动化脚本20250411

Docker 镜像、容器与数据卷的高效管理:最佳实践与自动化脚本 引言 在现代软件开发中,容器化技术正变得越来越重要。Docker 作为容器化的代表工具,在各大企业中得到了广泛的应用。然而,随着容器化应用的增多,如何高效…

Selenium之Actions事件

鼠标、键盘组合键 在使用selenium的时候,有的时候我们需要鼠标单击、双击、拖动;或者是按下键盘的某个键,松开某个按键,以及组合键的使用;今天我们就来看一看,怎么样实现上面的操作 先把准备工作做好&…

如何在 CentOS 7 系统上以容器方式部署 GitLab,使用 ZeroNews 通过互联网访问 GitLab 私有仓库,进行代码版本发布与更新

第 1 步: 部署 GitLab 容器​ 在开始部署 GitLab 容器之前,您需要创建本地目录来存储 GitLab 数据、配置和日志: #创建本地目录 mkdir -p /opt/docker/gitlab/data mkdir -p /opt/docker/gitlab/config mkdir -p /opt/docker/gitlab/log#gi…

.py文件和.ipynb文件的区别:完整教程

一、概述 Python开发者常用的两种文件格式.py和.ipynb各有特点,本教程将通过对比分析、代码示例和场景说明,帮助开发者全面理解二者的区别与联系。 二、核心区别对比 1. 文件格式本质 特性.ipynb文件.py文件文件类型JSON结构化文档纯文本文件存储内容…

Go 字符串四种拼接方式的性能对比

简介 使用完整的基准测试代码文件,可以直接运行来比较四种字符串拼接方法的性能。 for 索引 的方式 for range 的方式 strings.Join 的方式 strings.Builder 的方式 写一个基准测试文件 echo_bench_test.go package mainimport ("os""stri…

从代码学习深度学习 - Bahdanau注意力 PyTorch版

文章目录 1. 前言为什么选择Bahdanau注意力本文目标与预备知识2. Bahdanau注意力机制概述注意力机制简述加性注意力与乘性注意力对比Bahdanau注意力的数学原理与流程图数学原理流程图可视化与直观理解3. 数据准备与预处理数据集简介数据加载与预处理1. 读取数据集2. 预处理文本…

19【动手学深度学习】卷积层

1. 从全连接到卷积 2. 图像卷积 3. 图形卷积代码 互相关操作 import torch from torch import nn from d2l import torch as d2ldef corr2d(X, K):"""计算2维互相关运算"""h, w K.shapeY torch.zeros((X.shape[0]-h1, X.shape[1]-w 1))for …

Linux xorg-server 解析(一)- 编译安装Debug版本的xorg-server

一:下载代码 1. 配置源,以Ubuntu24.04 为例( /etc/apt/sources.list.d/ubuntu.sources): 2. apt source xserver-xorg-core 二:编译代码 1. sudo apt build-dep ./ 2. DEB_BUILD_OPTIONS="nostrip" DEB_CFLAGS_SET="-g -O0" dpkg-buildpac…

大模型SFT用chat版还是base版 SFT后灾难性遗忘怎么办

大模型SFT用chat版还是base版 进行 SFT 时,基座模型选用 Chat 还是 Base 模型? 选 Base 还是 Chat 模型,首先先熟悉 Base 和 Chat 是两种不同的大模型,它们在训练数据、应用场景和模型特性上有所区别。 在训练数据方面&#xf…

【图像生成之21】融合了Transformer与Diffusion,Meta新作Transfusion实现图像与语言大一统

论文:Transfusion: Predict the Next Token and Diffuse Images with One Multi-Modal Model 地址:https://arxiv.org/abs/2408.11039 类型:理解与生成 Transfusion模型‌是一种将Transformer和Diffusion模型融合的多模态模型,旨…

动态多目标进化算法:基于知识转移和维护功能的动态多目标进化算法(KTM-DMOEA)求解CEC2018(DF1-DF14)

一、KTM-DMOEA介绍 在实际工程和现实生活中,许多优化问题具有动态性和多目标性,即目标函数会随着环境的变化而改变,并且存在多个相互冲突的目标。传统的多目标进化算法在处理这类动态问题时面临着一些挑战,如收敛速度慢、难以跟踪…

部署NFS版StorageClass(存储类)

部署NFS版StorageClass存储类 NFS版PV动态供给StorageClass(存储类)基于NFS实现动态供应下载NFS存储类资源清单部署NFS服务器为StorageClass(存储类)创建所需的RBAC部署nfs-client-provisioner的deployment创建StorageClass使用存储类创建PVC NFS版PV动态供给StorageClass(存储…

Vue使用el-table给每一行数据上面增加一行自定义合并行

// template <template><el-table:data"flattenedData":span-method"objectSpanMethod"borderclass"custom-header-table"style"width: 100%"ref"myTable":height"60vh"><!-- 订单详情列 -->&l…

vue项目使用html2canvas和jspdf将页面导出成PDF文件

一、需求&#xff1a; 页面上某一部分内容需要生成pdf并下载 二、技术方案&#xff1a; 使用html2canvas和jsPDF插件 三、js代码 // 页面导出为pdf格式 import html2Canvas from "html2canvas"; import jsPDF from "jspdf"; import { uploadImg } f…

大模型LLM表格报表分析:markitdown文件转markdown,大模型markdown统计分析

整体流程&#xff1a;用markitdown工具文件转markdown&#xff0c;然后大模型markdown统计分析 markitdown https://github.com/microsoft/markitdown 在线体验&#xff1a;https://huggingface.co/spaces/AlirezaF138/Markitdown 安装&#xff1a; pip install markitdown…

Linux 第二讲 --- 基础指令(二)

前言 这是基础指令的第二部分&#xff0c;但是该部分的讲解会大量使用到基础指令&#xff08;一&#xff09;的内容&#xff0c;为了大家的观感&#xff0c;如果对Linux的一些基本指令不了解的话&#xff0c;可以先看基础指令&#xff08;一&#xff09;&#xff0c;同样的本文…

python格式化字符串漏洞

什么是python格式化字符串漏洞 python中&#xff0c;存在几种格式化字符串的方式&#xff0c;然而当我们使用的方式不正确的时候&#xff0c;即格式化的字符串能够被我们控制时&#xff0c;就会导致一些严重的问题&#xff0c;比如获取敏感信息 python常见的格式化字符串 百…

LLaMA-Factory双卡4090微调DeepSeek-R1-Distill-Qwen-14B医学领域

unsloth单卡4090微调DeepSeek-R1-Distill-Qwen-14B医学领域后&#xff0c;跑通一下多卡微调。 1&#xff0c;准备2卡RTX 4090 2&#xff0c;准备数据集 医学领域 pip install -U huggingface_hub export HF_ENDPOINThttps://hf-mirror.com huggingface-cli download --resum…