阅读笔记——《代码整洁之道》ch3

2024-05-16 08:20

本文主要是介绍阅读笔记——《代码整洁之道》ch3,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

引言

clean-code ch3阅读笔记

短小

函数的第一规则是要短小,一般来说不要一个函数体不要超过半个屏幕。

只做一件事情

函数应该做一件事。做好这件事情。只做一件事。

编写函数毕竟是为了把大一些的概念拆分为另一抽象层上的一系列步骤。只做一件事的函数无法被合理地切分为多个区段。

switch语句

使用抽象工厂来实现switch语句。

如果switch如果只是出现一次,用于创建多态对象,而且隐藏在某个继承关系中,在系统其他部分看不到,就还能容忍。

PS:就算使用抽象工厂来重构switch,当有新类型增加时,还是需要修改代码同样违反了开放闭合原则。

使用描述性的名称

别害怕长名称。长而具有描述性的名称,要比短而令人费解的名称好。

函数参数

最理想的参数数量是零,其次是一,再次是二,尽量避免三。

避免使用输出参数而非返回值

void includeSetupPageInfo(StringBuffer pageText);

上述函数在函数体中修改了pageText的值,结果往往会让人费解。

避免标识参数

使用标识参数,则本函数不止做一件事情。

render(boolean isSuite);

可以将函数一分为二

renderForSuite();renderForSignleTest();

超过三个参数考虑使用参数对象或参数列表

参数对象

Circle makeCircle(double x, double y, double radius);

上述函数可修改为

Circle makeCricle(Point center, double radius);

参数列表

例如String.format()方法

String.format("%s worked %.2f hours.". name, hours);

无副作用

public class UserValidator {private Cryptographer cryptographer;public boolean checkPassword(String userName, String password) {User user = ....;if ("Valid Password".equals(phrase)) {Session.initialize(); // 初始化session的副作用return true;}}
}

上述代码如果只看函数名称大概率是不知道会初始化session的,应将函数名称修改为checkPasswordAndInitialSession();

使用异常代替返回错误码

如果使用异常代替返回错误码,错误处理代码就能从主路径代码中分离出来,得到简化:

try {deletePage(page);registry.deleteReference(page.name);configKeys.deleteKey(page.name.makeKey());
} catch(Exception e) {logger.log(e.getMessage());
}

抽离try/catch代码块

最好把try和catch代码块的主体部分抽离出来,另外形成函数。

public void delete(Page page) {try {deletePageAndAllReferences(page);} catch (Exception e) {logError(e);}
}private void deletePageAndAllReferences(Page page) throws Exception {deletePage(page);registry.deleteReference(page.name);configKeys.deleteKey(page.name.makeKey());
}private void logError(Exception e) {logger.log(e.getMessage()); 
}

别重复自己

算法在函数体中重复了4次,修改时则需要重新修改4个地方,同时也会增加4次放过错误的可能性。

这篇关于阅读笔记——《代码整洁之道》ch3的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

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代码量统计总结项目场景在项目中,有时候我们需要统计