核心代码,注释必读
// download:3w 52xueit com
vue 2.x 响应式
Object.defineProperty
爱学it学无止境
在Java的世界里,编码规范不仅仅是一堆乏味的规则和条款,它们是通往代码优雅之路的黄砖路。想象一下,没有编码规范的Java代码库就像是一场没有裁判的足球赛,混乱不堪,每个人都在按自己的规则踢球。但别担心,今天我们将带你走进编码规范的奇妙世界,探索那些让你的代码从"看起来还行"升级为"哇,这是谁写的神仙代码"的秘密。
我们将一起探索为什么命名一个变量为temp123可能会让你的同事在code review时掉头就跑,为何空格和缩进在代码中的角色比配角还重要,以及如何通过简单的规则让你的代码变得更加清晰、易读,就像是在阅读一篇畅销小说。
准备好了吗?让我们一起开始我们的编码规范之旅,让你的Java代码不仅仅是运行的艺术,更是视觉的享受。 Buckle up(系好安全带),这将是一次有趣的旅程!
二、为什么要重视编码规范
想要成为代码界的建筑大师吗?嗯,让我们从最基础的部分讲起——基础的重要性。你有没有听过那句老话,“只要功夫深,铁杵磨成针”?如果你想让你的代码像针一样锋利、精确,那么你得开始磨练你的基础功夫了。
想象一下,你正在建造一座高楼。如果地基不牢固,那么不管你的建筑有多华丽,最终都会成为倾斜的比萨塔的亲戚。同样的,编程也是这样。如果你的基础不牢固,那么不管你用了多少高级技巧,你的代码最终可能就是一个功能混乱的软件比萨塔。
记住,“千里之行,始于足下”。每一行代码,每一个函数,都是你软件高楼的一砖一瓦。而这些砖瓦的质量,取决于你对基础知识的掌握程度。正如“滴水石穿”,持之以恒的练习和对基础的不断打磨,最终会让你的编程技能坚不可摧。
再来,你听说过“冰冻三尺,非一日之寒”吗?优秀的代码库也是如此,它们的优秀并非一蹴而就,而是基于坚实的基础,经过长时间的积累和迭代。
最后,让我们以“愚公移山”的精神结束这段讨论。面对看似无穷无尽的编程知识,我们可能会感到力不从心。但只要我们坚持不懈,就没有什么山是移不走的,没有什么基础是打不牢的。
所以,亲爱的代码工匠们,让我们从今天开始,把握好每一个学习的机会,把基础打得牢牢的。记住,伟大的软件建筑,都是从一行简单的代码开始的。
三、编码细则极其背后的深因
命名规范
1.类名使用UpperCamelCase风格,必须遵从驼峰形式,但以下情形例外:(领 域模型的相关命名)DO / BO / DTO / VO / DAO
深因:
一致性:类名遵循UpperCamelCase(大驼峰式)增加了代码的一致性,使得类名容易识别和区分。
可读性:大驼峰式命名使得多个单词的组合在视觉上更为清晰,有助于理解类的用途。
领域模型例外:DO (Data Object), BO (Business Object), DTO (Data Transfer Object), VO (Value Object), DAO (Data Access Object) 是业界广泛认可的缩写,代表了特定的设计模式和概念。它们的使用在领域驱动设计中具有特定含义,保持这些缩写可以让开发人员快速理解类的职责。
正例(遵循规范):
UserProfile - 明确遵从大驼峰式命名。
UserDTO - 表示一个用于数据传输的对象,DTO作为普遍接受的缩写被保留。
反例(违反规范):
userProfile - 类名以小写字母开头,不符合大驼峰式命名规则。
UserDataObject - 应缩写为UserDO,因为DO是一个被广泛认可的领域模型命名缩写。
通过此规范,可以确保代码的整洁性、一致性和专业性,同时也尊重了行业内的共识和最佳实践。
2.抽象类命名使用Abstract或Base开头
深因:
明确性:以Abstract或Base开头的命名立即明确了该类的抽象性质,让其他开发者一眼就能识别出这是一个不应被直接实例化的类。
可维护性:当项目规模扩大时,清晰的命名规范有助于维持代码的可维护性,减少查找和理解各个类之间关系的时间。
一致性:统一的命名规范有助于保持代码库的一致性,使得新加入的开发人员能更快地熟悉代码库。
避免命名冲突:在有些情况下,抽象类和具体实现类可能会有相似的功能描述,以Abstract或Base开头可以减少命名上的冲突。
正例(遵循规范):
AbstractVehicle:一个定义了交通工具通用属性和方法的抽象类,正确地使用了Abstract前缀。
BaseService:定义了服务层基本功能的抽象类,使用了Base前缀,明确表示这是一个基础类,用于被继承。
领取专属 10元无门槛券
私享最新 技术干货