原文链接: http://tieba.baidu.com/p/5057895435?pn=1
优秀的代码基本遵循这四个特性:可维护性、可扩展性、可读性和可移植性。
1.代码格式,驼峰标识,缩进,命名规范:
建议使用一致的代码格式,采用驼峰命名法,统一的缩进风格,并遵循良好的命名规范,以提高代码的可读性。
2.写代码时请先想后写,不要边想边写:
强调在写代码之前先进行思考,明确功能需要使用哪些类,类与类之间的关系是什么,确保在开始编写代码之前有清晰的设计思路。
3.一个类里请不要写太多方法(实体类除外):
提倡单一职责原则,一个类应该有一个单一的责任。在类中限制方法数量,保持高内聚性,提高代码的可维护性和可读性。
4.一个方法里不要写太多代码:
强调方法的简洁性和可维护性,一个方法应该专注于完成一个特定的任务,不要将过多的逻辑堆积在一个方法中。
5.当一段代码被你复制到多个地方使用时,请封装这段代码:
提倡遵循“不重复原则”,当一段代码需要在多个地方使用时,将其封装成一个方法或类,以便在多处调用。
6.继承可以帮你节约很多代码,但请尽量少用继承:
警示过度使用继承可能引发的问题,提倡多用组合而不是继承,以避免继承带来的复杂性和脆弱性。
7.组合和继承相反,是一种松散的结构,因此用组合来代替继承是一种很好的设计:
强调使用组合来构建松散耦合的结构,以提高系统的灵活性和可维护性。
8.思考一个功能时不要考虑先干什么后干什么,正确的思考方式是:
强调功能设计时应该首先考虑需要使用哪些类,类与类之间的关系是什么,而不是着眼于具体的实现细节。
9.将接口作为入参是一种很好的设计方式,请在你的代码中尝试使用它:
提倡使用接口来定义入参,以提高代码的可扩展性和灵活性。
10.接口职责请尽量单一,5个接口协同完成一个功能要远远超过一个接口完成5个功能:
提倡接口的单一职责原则,一个接口应该只有一个理由发生变化,以降低系统的耦合度。
11.如果你用一个字符串作为标识,请尝试把它设计成数据字典或配置文件:
建议使用数据字典或配置文件来管理字符串标识,提高代码的可维护性和可配置性。
11.如果你实在懒得写数据字典或配置文件请至少把它写成枚举:
即使不使用数据字典或配置文件,也建议将字符串标识定义为枚举,以提高代码的可读性和维护性。
11.如果你实在懒得写枚举,请至少把它写成常量:
即使不使用枚举,也应该将字符串标识定义为常量,以提高代码的可维护性和防止魔法数字。
11.软件设计中有很多原则,大部分你可以不记,但请务必记住其中的一个“开闭原则”:
强调开闭原则,即软件实体应该对扩展开放,对修改关闭。设计时应该使系统具有良好的扩展性,而不是频繁修改已有代码。
"开闭原则"是面向对象设计中的一个重要原则,它指导着软件实体(类、模块、函数等)应该对扩展开放,而对修改关闭。这意味着在不修改现有代码的情况下,能够通过扩展来添加新的功能。
具体而言,当系统需要进行变更时,应该通过增加新代码而不是修改已有代码来实现。这有助于降低对现有代码的影响,减少引入新问题的风险,同时提高系统的可维护性和可扩展性。
以下是一个简单的例子来说明开闭原则:
假设有一个图形绘制系统,最初只能绘制矩形:
class Rectangle {
void draw() {
// 绘制矩形的具体逻辑
System.out.println("Drawing a rectangle");
}
}
现在,如果需要添加对圆形的绘制支持而不修改 Rectangle 类,我们可以通过创建新的图形类 Circle 来实现:
class Circle {
void draw() {
// 绘制圆形的具体逻辑
System.out.println("Drawing a circle");
}
}
通过扩展而非修改现有代码,符合开闭原则。客户端代码可以使用这两个类来绘制矩形和圆形,而不需要改动原有的 Rectangle 类。这种设计使得系统更容易扩展,同时不会破坏已有的功能。
总的来说,开闭原则的目标是使系统更加灵活,能够适应变化,同时保持稳定性。