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

相关文章

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》:本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.

使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

《使用sql-research-assistant进行SQL数据库研究的实战指南(代码实现演示)》本文介绍了sql-research-assistant工具,该工具基于LangChain框架,集... 目录技术背景介绍核心原理解析代码实现演示安装和配置项目集成LangSmith 配置(可选)启动服务应用场景

Python中顺序结构和循环结构示例代码

《Python中顺序结构和循环结构示例代码》:本文主要介绍Python中的条件语句和循环语句,条件语句用于根据条件执行不同的代码块,循环语句用于重复执行一段代码,文章还详细说明了range函数的使... 目录一、条件语句(1)条件语句的定义(2)条件语句的语法(a)单分支 if(b)双分支 if-else(

MySQL数据库函数之JSON_EXTRACT示例代码

《MySQL数据库函数之JSON_EXTRACT示例代码》:本文主要介绍MySQL数据库函数之JSON_EXTRACT的相关资料,JSON_EXTRACT()函数用于从JSON文档中提取值,支持对... 目录前言基本语法路径表达式示例示例 1: 提取简单值示例 2: 提取嵌套值示例 3: 提取数组中的值注意

CSS3中使用flex和grid实现等高元素布局的示例代码

《CSS3中使用flex和grid实现等高元素布局的示例代码》:本文主要介绍了使用CSS3中的Flexbox和Grid布局实现等高元素布局的方法,通过简单的两列实现、每行放置3列以及全部代码的展示,展示了这两种布局方式的实现细节和效果,详细内容请阅读本文,希望能对你有所帮助... 过往的实现方法是使用浮动加

JAVA调用Deepseek的api完成基本对话简单代码示例

《JAVA调用Deepseek的api完成基本对话简单代码示例》:本文主要介绍JAVA调用Deepseek的api完成基本对话的相关资料,文中详细讲解了如何获取DeepSeekAPI密钥、添加H... 获取API密钥首先,从DeepSeek平台获取API密钥,用于身份验证。添加HTTP客户端依赖使用Jav

Java实现状态模式的示例代码

《Java实现状态模式的示例代码》状态模式是一种行为型设计模式,允许对象根据其内部状态改变行为,本文主要介绍了Java实现状态模式的示例代码,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来... 目录一、简介1、定义2、状态模式的结构二、Java实现案例1、电灯开关状态案例2、番茄工作法状态案例

nginx-rtmp-module模块实现视频点播的示例代码

《nginx-rtmp-module模块实现视频点播的示例代码》本文主要介绍了nginx-rtmp-module模块实现视频点播,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习... 目录预置条件Nginx点播基本配置点播远程文件指定多个播放位置参考预置条件配置点播服务器 192.

CSS自定义浏览器滚动条样式完整代码

《CSS自定义浏览器滚动条样式完整代码》:本文主要介绍了如何使用CSS自定义浏览器滚动条的样式,包括隐藏滚动条的角落、设置滚动条的基本样式、轨道样式和滑块样式,并提供了完整的CSS代码示例,通过这些技巧,你可以为你的网站添加个性化的滚动条样式,从而提升用户体验,详细内容请阅读本文,希望能对你有所帮助...

深入解析Spring TransactionTemplate 高级用法(示例代码)

《深入解析SpringTransactionTemplate高级用法(示例代码)》TransactionTemplate是Spring框架中一个强大的工具,它允许开发者以编程方式控制事务,通过... 目录1. TransactionTemplate 的核心概念2. 核心接口和类3. TransactionT