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

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

相关文章

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)

《SpringBoot3.4.3基于SpringWebFlux实现SSE功能(代码示例)》SpringBoot3.4.3结合SpringWebFlux实现SSE功能,为实时数据推送提供... 目录1. SSE 简介1.1 什么是 SSE?1.2 SSE 的优点1.3 适用场景2. Spring WebFlu

java之Objects.nonNull用法代码解读

《java之Objects.nonNull用法代码解读》:本文主要介绍java之Objects.nonNull用法代码,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录Java之Objects.nonwww.chinasem.cnNull用法代码Objects.nonN

SpringBoot实现MD5加盐算法的示例代码

《SpringBoot实现MD5加盐算法的示例代码》加盐算法是一种用于增强密码安全性的技术,本文主要介绍了SpringBoot实现MD5加盐算法的示例代码,文中通过示例代码介绍的非常详细,对大家的学习... 目录一、什么是加盐算法二、如何实现加盐算法2.1 加盐算法代码实现2.2 注册页面中进行密码加盐2.

python+opencv处理颜色之将目标颜色转换实例代码

《python+opencv处理颜色之将目标颜色转换实例代码》OpenCV是一个的跨平台计算机视觉库,可以运行在Linux、Windows和MacOS操作系统上,:本文主要介绍python+ope... 目录下面是代码+ 效果 + 解释转HSV: 关于颜色总是要转HSV的掩膜再标注总结 目标:将红色的部分滤

在C#中调用Python代码的两种实现方式

《在C#中调用Python代码的两种实现方式》:本文主要介绍在C#中调用Python代码的两种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C#调用python代码的方式1. 使用 Python.NET2. 使用外部进程调用 Python 脚本总结C#调

Java时间轮调度算法的代码实现

《Java时间轮调度算法的代码实现》时间轮是一种高效的定时调度算法,主要用于管理延时任务或周期性任务,它通过一个环形数组(时间轮)和指针来实现,将大量定时任务分摊到固定的时间槽中,极大地降低了时间复杂... 目录1、简述2、时间轮的原理3. 时间轮的实现步骤3.1 定义时间槽3.2 定义时间轮3.3 使用时