可读代码编写炸鸡十二 - 剪子挥舞的时候臃肿就需要畏惧自己的消亡

2023-11-23 06:59

本文主要是介绍可读代码编写炸鸡十二 - 剪子挥舞的时候臃肿就需要畏惧自己的消亡,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!


大家好,我是多选参数的一员 —— 大炮。

本篇炸鸡大抵是这个系列炸鸡最后一篇了,感谢各位的阅读和支持。本篇炸鸡依旧是 在编码前就考虑如何减少不好代码 的角度提供一些代码可读的建议。

公众号后台输入「少写代码」关键字,获取源文件

上一篇炸鸡主要是讲了 「小黄鸭编码法」,是提供一个与自己对话的机会,再将想法写成代码的一个过程。在之前的炸鸡中,我们就知道变量的命名就可以加入更多的信息来提高可读性,但是如果加入过多的信息就可能导致命名过长,可读性反而下降。

这种反弹行为在小黄鸭编码法中也会出现。如果我的想法过大,那么接下来为之的编码也是庞大的,这时候就需要权衡,这样的想法是否必要。

因为我们为项目添加的代码,通常来说,真正的覆盖率是很低的。而且添加的代码由于存在影响范围不确定的可能,需要大量的测试(当然,有些项目就不会这么干,小作坊,但对自己的要求还是不要放松)。同时代码的庞大会导致代码的抽取成库,这些库也会 臃肿,更何况是为了 许多意义不大的代码 而抽取成的库。

剪子

说了这么多,会发现过于庞大的代码会带来高代价成本,其实就是为了提出一个有丶废话的建议 —— 少 写 代 码。

在写代码前,就应该手持一把剪子,去剪裁可能出现的臃肿。而在上文的引子里,不难发现臃肿是从想法开始生长的 。

剪需求

我在的项目里头,策划提供的需求案子永远是经历 「混乱 - 复杂 - 逐渐清晰 - 简练」这一过程。但很遗憾,这个过程每个阶段我都要为之付出大量无意义的编码。(完全就是在为不专业擦屁股,这是一件非常 NT 的事情)

而这一个过程,其实就是不断剪裁需求的过程。当然不单单是需求方的需求剪裁,我们在设计代码的时候,其实也是对代码提出了一个需求,我们也需要剪裁设计,避免过度设计。

例如我们有一个纯业务需求 checkXXX()  中却大量存在检查剩余内存的逻辑,就是为了在极小内存环境下也能做出反应。这种业务操底层的心也是一种过度设计。

也好像以前的软件,总是想做一个超级工厂,啥东西啥功能全都要,这就是过度设计。

function superApp()-- 可以买东西-- 可以抽奖-- 可以社交-- 可以智能控制-- ...-- ...
end

所以直接操起剪子,剪去过度设计带来的臃肿,checkXXX() 直接删去检查内存的大量逻辑,不必去感到肉痛。

superApp 则可以拆分为 buyApp/lotteryApp/socialApp/AICtrlApp

function buyApp() end
function lotteryApp() end
function socialApp() end
function AICtrlApp() end

然后你会发现,这不就是 一次只做一件事 的做法吗。所以还是之前说的:

代码可读性的提升方法,其本质上都是相似的,在于你怎么去理解与使用。

剪实现

需求上的逐渐确定后,就可以开始实现了。当然你还是可以先让小黄鸭游进脑子,但是手上依旧需要持一把剪子,去剪裁代码实现中出现的臃肿。

熟悉一些 API 帮助剪子挥舞

假设我们需要实现一个存放无重复数据的数据的列表,我身为一个不太熟悉 API  的辣鸡,我可能就是这么写的:

# 利用 map 的 key 来做无重复
def unique(elements):unique_map = {}for elem in elements:unique_map[elem] = Truereturn unique_map.keys()

但是如果你知道有个东西叫做 set,它就是用来存放无重复数据的结构,那么代码的实现就更简单,写的东西就少了。

# 利用 map 的 key 来做无重复
def unique(elements):return list(set(elements))

所以,熟悉一定的 API 接口会帮助你提高效率,少写代码。可以试着每天花一些时间阅读以下相关的开发文档, 这样当你进行代码实现的时候,很可能会发现:

诶,这个好像用哪个库就可以帮助实现。

当然许多人包括我是很不喜欢 调包侠 这个称谓的,但是这些库的存在就是为了减轻你的负担,将心思专注于真正的工作 —— 思维转为代码。

但重复造轮子也不应该遭人唾弃,只有试着仿造轮子,你才能有真正的理解与学习,工作中的学习大多都是熟悉更多的轮子,而自己的提升永远离不开造轮子的岁月。

Linux 命令已经是稳定的工具

如题所示,我们很容易会忽视强大的 linux 命令。如果你想开发一个文本分割工具,可能会这样:

def text_split(source, split, pattern):............

其实使用 awk, cat, grep 等命令就可以实现了,我在我们项目的服务器中,一些工具就是直接使用这些命令组合来实现。

小结

本篇炸鸡主要讲述为什么要少写代码,和如何少写代码。少写代码不过带一把剪子就好,想法上与实现上都要用其剪裁。

  1. 需求上避免过度设计

  2. 实现上可以多利用已存在的代码库来实现,提高工作效率

好了,大致是最后一篇炸鸡小结了,感谢各位的阅读与支持,让我有动力将这个系列的炸鸡写下去。这个系列的炸鸡完全是阅读一本书时的一时兴起,但实在没有想到能够写到现在,为「多选参数」的成长提供一份浇灌。

我其实自认为, 我学习的还是不够深,从而导致写的东西还是不够好,再加上工作上的怪力乱神,使得一段时间没有动笔过这个系列的炸鸡。但是程序锅同我说,是有人催更这个炸鸡的,这很是鼓舞我,于是我便鼓着气力,开始继续将这个系列的炸鸡写完。

所以再次感谢这位读者,要不然我现在也不会在高铁上写完这篇炸鸡。

至于后头的打算,我还想藏着掖着。因为我对自己的学习还在打磨,还在考虑如何输出更有价值的东西,这是我乃至整个多选参数作者们都在思考的事情。而且我目前也在跨行学习的阵痛期,容易间歇性迷茫,还没有绝对的打算。

但是,当所有人都不相信你的时候,你相信自己,并且走上自己所相信的道路,这便是英雄。

不甘于「本该如此」,「多选参数 」值得关注

这篇关于可读代码编写炸鸡十二 - 剪子挥舞的时候臃肿就需要畏惧自己的消亡的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/416190

相关文章

C#实现千万数据秒级导入的代码

《C#实现千万数据秒级导入的代码》在实际开发中excel导入很常见,现代社会中很容易遇到大数据处理业务,所以本文我就给大家分享一下千万数据秒级导入怎么实现,文中有详细的代码示例供大家参考,需要的朋友可... 目录前言一、数据存储二、处理逻辑优化前代码处理逻辑优化后的代码总结前言在实际开发中excel导入很

SpringBoot+RustFS 实现文件切片极速上传的实例代码

《SpringBoot+RustFS实现文件切片极速上传的实例代码》本文介绍利用SpringBoot和RustFS构建高性能文件切片上传系统,实现大文件秒传、断点续传和分片上传等功能,具有一定的参考... 目录一、为什么选择 RustFS + SpringBoot?二、环境准备与部署2.1 安装 RustF

Python实现Excel批量样式修改器(附完整代码)

《Python实现Excel批量样式修改器(附完整代码)》这篇文章主要为大家详细介绍了如何使用Python实现一个Excel批量样式修改器,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一... 目录前言功能特性核心功能界面特性系统要求安装说明使用指南基本操作流程高级功能技术实现核心技术栈关键函

Redis实现高效内存管理的示例代码

《Redis实现高效内存管理的示例代码》Redis内存管理是其核心功能之一,为了高效地利用内存,Redis采用了多种技术和策略,如优化的数据结构、内存分配策略、内存回收、数据压缩等,下面就来详细的介绍... 目录1. 内存分配策略jemalloc 的使用2. 数据压缩和编码ziplist示例代码3. 优化的

Python 基于http.server模块实现简单http服务的代码举例

《Python基于http.server模块实现简单http服务的代码举例》Pythonhttp.server模块通过继承BaseHTTPRequestHandler处理HTTP请求,使用Threa... 目录测试环境代码实现相关介绍模块简介类及相关函数简介参考链接测试环境win11专业版python

Python从Word文档中提取图片并生成PPT的操作代码

《Python从Word文档中提取图片并生成PPT的操作代码》在日常办公场景中,我们经常需要从Word文档中提取图片,并将这些图片整理到PowerPoint幻灯片中,手动完成这一任务既耗时又容易出错,... 目录引言背景与需求解决方案概述代码解析代码核心逻辑说明总结引言在日常办公场景中,我们经常需要从 W

使用Spring Cache本地缓存示例代码

《使用SpringCache本地缓存示例代码》缓存是提高应用程序性能的重要手段,通过将频繁访问的数据存储在内存中,可以减少数据库访问次数,从而加速数据读取,:本文主要介绍使用SpringCac... 目录一、Spring Cache简介核心特点:二、基础配置1. 添加依赖2. 启用缓存3. 缓存配置方案方案

MySQL的配置文件详解及实例代码

《MySQL的配置文件详解及实例代码》MySQL的配置文件是服务器运行的重要组成部分,用于设置服务器操作的各种参数,下面:本文主要介绍MySQL配置文件的相关资料,文中通过代码介绍的非常详细,需要... 目录前言一、配置文件结构1.[mysqld]2.[client]3.[mysql]4.[mysqldum

Python多线程实现大文件快速下载的代码实现

《Python多线程实现大文件快速下载的代码实现》在互联网时代,文件下载是日常操作之一,尤其是大文件,然而,网络条件不稳定或带宽有限时,下载速度会变得很慢,本文将介绍如何使用Python实现多线程下载... 目录引言一、多线程下载原理二、python实现多线程下载代码说明:三、实战案例四、注意事项五、总结引

IDEA与MyEclipse代码量统计方式

《IDEA与MyEclipse代码量统计方式》文章介绍在项目中不安装第三方工具统计代码行数的方法,分别说明MyEclipse通过正则搜索(排除空行和注释)及IDEA使用Statistic插件或调整搜索... 目录项目场景MyEclipse代码量统计IDEA代码量统计总结项目场景在项目中,有时候我们需要统计