word-by-word(教你如何写出整洁的代码文案)

0.前言本篇文章是<>的学习总结,通过这篇文章你将了解到整洁的代码对项目、公司和你的重要性,以及如何书写整洁的代码.通过命名、类、函数、测试这四个章节,使我们的代码变得整洁.1.为什么要保持代码整洁?

不整洁的代码随着时间的增加而增加时,生产力会随之降低.导致的结果就是:代码不易扩展或扩展容易引发其他问题程序崩溃加班增加公司成本(加人)甚至可能造成公司倒闭一图胜千言

1.1所以从一开始就要保持整洁所以在一开始就要写整洁的代码,如果有不整洁的代码就要及时的整改.绝对不要有以后再改,以后再说的想法，因为！later equal never想想是不是这个道理,你有多少以后再说、以后再改的东西都抛诸脑后了.

如果是一定要做的事情,那就趁早做!1.2如何写出整洁的代码?那么现在的问题就是,怎样的代码才算是整洁的代码呢:可读性要高:代码要像散文一样优雅易读,见码知意拒绝重复代码满足设计模式原则单一职责开闭原则里氏替换原则依赖倒转原则接口隔离原则迪米特法则合成复用法则

2.命名好的命名可提高代码的可读性,让人见码知意,降低理解成本,提高效率,减少加班.2.1不好的命名方式没有任何意义的命名方式public interface Animal { void abc();}

现在我们有一个动物的接口,里面有一个方法abc(),看了让人一头雾水,调用这个方法的人也完全不知道这个方法是干什么的,因为他的命名毫无意义有意义的命名方式:public interface Animal { void cry();}

我们将方法名命名为cry(喊叫,呼喊),调用的人就知道这个方法的作用是什么了.所以命名一定要有意义且让人见码知意.命名前后不一致这种情况体现在明明是同一行为,但是却有不同的命名,前后不一致,让人造成混淆.

public interface StudentRepository extends JpaRepository{ Student findOneById(@Param("id") String id ); List

queryAllStudent();}上面两个方法都是查询xxx,但是命名一会叫query一会叫find,这种情况应该加以规范,保持一致,修改后:public interface StudentRepository extends JpaRepository

{ Student findOneById(@Param("id") String id ); List findAll();}命名冗余体现在命名有很多没必要的成分在里面,并且这些"废话"并不能帮助区分它们的区别,例如在变量命名中添加了Variable这个词,在表名中添加了Table这个词.

所以命名中不要出现冗余的单词,并且提前约定好命名的规范.//获取单个对象的方法用get做前缀getXxx();//获取多个对象用list做前缀listXxxx();3.类整洁的类应满足一下内容:单一职责开闭原则高内聚性

3.1单一职责类应该短小,类或模块应有且只有一条加以修改的理由,如果一个类过于庞大的话,那么说明它承担的职责过多了.优点:降低类的复杂度提高类的可读性提高系统的可维护性降低变更引起的风险如何判定类是否足够短小?通过计算类的职责来判断是否够短小,类的名称描述其全责,如果无法为某个类命以准确的名称,这个类大概就太长了,类名越含糊,可能拥有越多的职责.

职责过多的例子,可以看到以下类有两个职责:public abstract class Sql {//操作SQL的职责 public abstract void insert();//统计SQL操作的职责 public abstract void countInsert();}

将统计的职责抽取到另一个类public abstract class CountSql { public abstract void countInsert();}3.2开闭原则开闭原则:面向修改关闭,面向扩展开放.

面向修改关闭意味着增加新的逻辑不会修改原有的代码,降低了出错的可能性.面向扩展开放则是提高了代码的可扩展性,可很容易的增加新的代码逻辑.不满足开闭原则的例子:public abstract class Sql { public abstract void insert(); public abstract void update(); public abstract void delete();}

如果我们现在要新增查询的操作,就需要修改Sql这个类,没有做到面向修改关闭重构后:public abstract class Sql { public abstract void generate();}public class CreateSql extends Sql {@java.lang.Override public void generate(){ //省略实现}}public class UpdateSql extends Sql {@Override public void generate(){ //省略实现}}

当我们要增加删除方法时可以很容易的扩展.使用大量的短小的类看似比使用少量庞大的类增加了工作量(增加了更多的类),但是真的是这样吗?这里有一个很好的类比:你是想把工具归置到有许多抽屉、每个抽屉中装有定义和标记良好的组件的工具箱呢,还是想要少数几个能随便吧所有东西扔进去的抽屉?

最终的结论:系统应该由许多短小的类而不是少量巨大的类组成,每个小类封装一个权责,只有一个修改的原因,并与少数其他类一起协同达成期望的系统行为.3.3内聚方法操作的变量越多,就约粘聚到类上.如果一个类中的每个变量都被每个方法所使用,则该类永具有最大的内聚性.我们应该将类的内聚性保持在较高的位置.内聚性高意味着方法和变量互相依赖,互相结合成一个逻辑整体.

为什么要保持高内聚?保持内聚性就会得到许多短小的类,就越满足单一职责.内聚性低怎么办?如果类的内聚性就不够高,就将原有的类拆分为新的类和方法.4.函数要想让函数变得整洁,应保证:只做一件事好的命名整洁的参数注意返回内容

4.1只做一件事what?函数的第一规则是短小第二规则是更短小短小到只做一件事情.(没错和类的原则很像)why?函数越短小,越能满足单一职责.how?以下是重构前的代码,这个方法有三个职责,并且该方法很长达到了80+50+5= 135行

public class PicService { public String upload(){//校验图片的方法伪代码80行//压缩图片的方法伪代码50行//返回成功或失败标识0,1伪代码5行 return "0";}}

原有的upload方法做了很多的事情,重构后只做了一件事情:把大一些的概念(换言之,函数的名称)拆分为另一抽象层上的一系列步骤:public String upload(){//校验图片的方法 check();//压缩图片的方法 compress();//返回成功或失败标识0,1 return "0";}

而里面的每个方法,也都有着自己各自的职责(校验图片、压缩图片、返回结果).4.2函数命名函数名应见名知意函数拥有描述性的名称，不要害怕长名称.不好的命名方式:public String addCharacter(String originString, char ch);

这个函数，一咋看，还不错，从函数字面意思看是给某个字符串添加一个字符但是到底是在原有字符串首部添加，还是在原有字符串末尾追加呢？亦或是在某个固定位置插入呢？从函数名字完全看不出来这个函数的真正意图，只能继续往下读这个函数的具体实现才知道。

而下面这几个名字就比上面要好得多：//追加到末尾public String appendCharacter(String originString, char ch);//插入指定位置public String insertCharacter(String originString, char ch, int insertPosition);

函数应该无副作用函数应该无副作用，意思就是函数应该只做一件事，但是做这件事的时候做了另一件有副作用的事情.例如:校验密码时会初始化session，导致会话丢失如果无法移除这种副作用，应该在方法名中展示出来，避免用户误用 checkPasswordasswordAndInitializeSession,从命名上就要体现副作用.。

亲爱的读者们，感谢您花时间阅读本文。如果您对本文有任何疑问或建议，请随时联系我。我非常乐意与您交流。