怎么才可以写好一个程序,怎么保证自己的代码的可读性和可维护性?
我想首先需要我们有一个好的编码规范,并且按照规范严格执行。对Java或者Android的开发者当然最具权威的代码规范属于Google代码规范。这里提供一份中文版本文档:文档下载地址:https://download.csdn.net/download/maple_qqh/10746651
Google的编码规范为我们提供了文件规范,文件结构规范,格式规范,命名规范,编程规范,Javadoc的文档规范等等。
有了好的编码规范后,我们发现在代码的命名,可读性上发现有了质的提升,至少在表面上我们的代码可读性获得了成功。仔细阅读代码,具体到内容的时候,我们又可能发现代码冗余,代码耦合度过高,方法冗长等等的问题。那么具体到编码内容的时候,怎么保证代码的可读性和维护性呢?需要遵循什么原则呢?
Java编程最基本的原则就是要追求高内聚和低耦合的解决方案和代码模块设计,需要遵循以下五个原则又叫SOLID原则:
原则简写 | 名称 | 说明 |
---|---|---|
SRP | 单一责任原则 | 类或者方法责任或者功能单一: 一个类只只做一种类型的责任 一个方法只处理一个原子性的功能点 |
OCP | 开放封闭原则 | 软件实体应该是可扩展的而不是可修改的: 1.扩展功能时,通过增加代码而不是原有的代码 2.模块间通过接口来交互,客户模块不用关心服务模块的类型修改。服务模块可方便地扩展功能,并且服务模块修改服务时,客户模块不用有任何改动
|
LSP | 里氏替换原则 | 子类能够替换任何的父类实例 客户模块不应关心服务模块的是如何工作的;同样的接口模块之间,可以在不知道服务模块代码的情况下,进行替换。即接口或父类出现的地方,实现接口的类或子类可以代入。
|
ISP | 接口分离原则 | 不能强迫实现类去依赖那些他们不使用的接口,如果出现,就将接口分离,使用多个专门的接口比使用单一的总接口总要好 |
DIP | 依赖倒置原则 | 1. 高层模块不应该依赖于低层模块,二者都应该依赖于抽象 2. 抽象不应该依赖于细节,细节应该依赖于抽象 |
编码原则的举例,后续:
当我们有了好的代码规范和编码原则的时候,这个时候我们编写代码,设计模块都有据可循了。当然,每个人在执行规范和原则的时候会根据个人的理解水平的不同而不同,并且每个人在不同时期理解的程度也不一样,多以我们在设计一个模块,一个功能,一个类,或者取一个名称的时候如果主动的问下,这种设计是否遵循了规范,是否符合编码的原则,好处在哪里,后续怎么维护的时候,时间久了相信也一定可以写出优秀的框架级的代码。
参考文章 https://blog.csdn.net/u011680118/article/details/44592101