阅读笔记——《代码整洁之道》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

相关文章

SpringBoot基于MyBatis-Plus实现Lambda Query查询的示例代码

《SpringBoot基于MyBatis-Plus实现LambdaQuery查询的示例代码》MyBatis-Plus是MyBatis的增强工具,简化了数据库操作,并提高了开发效率,它提供了多种查询方... 目录引言基础环境配置依赖配置(Maven)application.yml 配置表结构设计demo_st

SpringCloud集成AlloyDB的示例代码

《SpringCloud集成AlloyDB的示例代码》AlloyDB是GoogleCloud提供的一种高度可扩展、强性能的关系型数据库服务,它兼容PostgreSQL,并提供了更快的查询性能... 目录1.AlloyDBjavascript是什么?AlloyDB 的工作原理2.搭建测试环境3.代码工程1.

Java调用Python代码的几种方法小结

《Java调用Python代码的几种方法小结》Python语言有丰富的系统管理、数据处理、统计类软件包,因此从java应用中调用Python代码的需求很常见、实用,本文介绍几种方法从java调用Pyt... 目录引言Java core使用ProcessBuilder使用Java脚本引擎总结引言python

Java中ArrayList的8种浅拷贝方式示例代码

《Java中ArrayList的8种浅拷贝方式示例代码》:本文主要介绍Java中ArrayList的8种浅拷贝方式的相关资料,讲解了Java中ArrayList的浅拷贝概念,并详细分享了八种实现浅... 目录引言什么是浅拷贝?ArrayList 浅拷贝的重要性方法一:使用构造函数方法二:使用 addAll(

JAVA利用顺序表实现“杨辉三角”的思路及代码示例

《JAVA利用顺序表实现“杨辉三角”的思路及代码示例》杨辉三角形是中国古代数学的杰出研究成果之一,是我国北宋数学家贾宪于1050年首先发现并使用的,:本文主要介绍JAVA利用顺序表实现杨辉三角的思... 目录一:“杨辉三角”题目链接二:题解代码:三:题解思路:总结一:“杨辉三角”题目链接题目链接:点击这里

SpringBoot使用注解集成Redis缓存的示例代码

《SpringBoot使用注解集成Redis缓存的示例代码》:本文主要介绍在SpringBoot中使用注解集成Redis缓存的步骤,包括添加依赖、创建相关配置类、需要缓存数据的类(Tes... 目录一、创建 Caching 配置类二、创建需要缓存数据的类三、测试方法Spring Boot 熟悉后,集成一个外

轻松掌握python的dataclass让你的代码更简洁优雅

《轻松掌握python的dataclass让你的代码更简洁优雅》本文总结了几个我在使用Python的dataclass时常用的技巧,dataclass装饰器可以帮助我们简化数据类的定义过程,包括设置默... 目录1. 传统的类定义方式2. dataclass装饰器定义类2.1. 默认值2.2. 隐藏敏感信息

opencv实现像素统计的示例代码

《opencv实现像素统计的示例代码》本文介绍了OpenCV中统计图像像素信息的常用方法和函数,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录1. 统计像素值的基本信息2. 统计像素值的直方图3. 统计像素值的总和4. 统计非零像素的数量

IDEA常用插件之代码扫描SonarLint详解

《IDEA常用插件之代码扫描SonarLint详解》SonarLint是一款用于代码扫描的插件,可以帮助查找隐藏的bug,下载并安装插件后,右键点击项目并选择“Analyze”、“Analyzewit... 目录SonajavascriptrLint 查找隐藏的bug下载安装插件扫描代码查看结果总结Sona

Python开发围棋游戏的实例代码(实现全部功能)

《Python开发围棋游戏的实例代码(实现全部功能)》围棋是一种古老而复杂的策略棋类游戏,起源于中国,已有超过2500年的历史,本文介绍了如何用Python开发一个简单的围棋游戏,实例代码涵盖了游戏的... 目录1. 围棋游戏概述1.1 游戏规则1.2 游戏设计思路2. 环境准备3. 创建棋盘3.1 棋盘类