前言:所谓书读百遍,其意自现。今天来重温一下代码整洁之道这本书,看是否有新的体会。
第2章 有意义的命名
1、名副其实
为变量、类、函数选个好的名字,的确很花时间。但一个好的名字省下来的时间比花的多。名字所传递出来的信息,告诉着你,它为什么存在,它做了什么事,应该如何使用。那么这里需要注意的是,如果变量、类、函数需要注释来补充,那也不算名副其实。
2、避免误导
错误示例
int O = 0;
int l = 1;
int a = l;
3、做有意义的区分
错误示例
public static void copyChars(Char a1[], Char a2[]) {}
ProductInfo、ProductData
int numberVariable;
String nameString;
BigDecimal moneyAmount;
tb_user
第二章总结一下,类和对象指的是一类事物,对其命名也应该是名词,方法是动作,应该是动词。好的命名对程序的可读性还是非常有帮助的。
第3章 函数
1、短小
写函数的第一条规则是短小,第二条规则是还要更短小。个人经验啊,一个方法最好不要超过50行,所以方法还是要分层的,分层的话,意思明了,结构清晰,往后的维护的人没有那么痛苦。
2、只做一件事
一个方法要不要分层,能不能分层,怎么样去分层的评判规则就是这个方法是否只做了这一件事情,并且把这件事给做好了。
3、函数参数
错误示例
public void checkCreateMerchant(
String merchantId,
String merchantName,
String merchantAddress,
String merchantEmail) {
}
Java是面向对象编程的语言,希望大家不要面向参数编程。方法两个参数就行了,超过了的方法参数,还是写个参数类吧。
4、try/catch
说实话try/catch好丑啊,try/catch跟业务半毛钱关系没有,就不应该放到controller层。但之前项目都是这样做的,就很烦。try/catch放到AOP处理,controller层多简洁漂亮,还节约开发时间。
第4章 注释
1、写注释是一种失败
写注释是一种失败,因为你的代码很糟糕,没有表达力,所以要写注释来解释你的代码,听懂掌声。说实话作者就被注释骗过,太坑了,只有代码才能表达真正的意思。这是因为后来维护代码的人改了代码之后不一定会改注释的。耶,就很烦。所以只有代码才是唯一准确的信息来源。
2、好的注释
正确示例
// sourceNumber > targetNumber 阐述注释
if (sourceNumber.compareTo(targetNumber) == 1) {
// TODO 注释
}
第4章总结,能用变量名、方法名解释就不要用注释。