java类的命名规范_浅谈Java中的命名规范
现代软件架构的复杂性需要协同开发完成,如何高效地协同呢?
答案是:制定一整套统一的规范。
无规矩不成方圆,无规范难以协同,比如,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没有限速,没有红绿灯,谁还敢上路行驶?
本文将从Java代码的命名规范这一维度,来探讨一下,如何写出健壮的、可读性强的代码,提高项目的可维护性。最重要的是提高我们的编程幸福感。
1.包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例:应用工具包名为com.java.util、类名为StringUtils
2.类名、接口名使用UpperCamelCase风格,必须遵从驼峰形式,但以下情形例外:DO/BO/DTO/VO/AO/PO/UID等。
正例:UserLoginCheckService/UserDO
反例:userlogincheckservice/UserDo
3.方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。
正例:userServiceImpl
反例:userserviceimpl
4.常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
正例:MAX_BOOK_COUNT/CACHE_EXPIRED_TIME
反例:MAX_COUNT/EXPIRED_TIME
5.为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意,即要做到“见名知意”。
正例:在 JDK 中,表达原子更新的类名为:AtomicReferenceFieldUpdater
反例:String a = "李四"; // 天啦噜,鬼知道你这个a是啥意思啊
6.定义数组时,类型与中括号紧挨相连
正例:
int[] array = new int[10];
int array[] = new int[10]; // 不建议这样写
7.抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。
正例:AbstractService/CommonException/DemoTest
8.杜绝完全不规范的缩写,避免望文不知义。
反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写” 命名成 condi,此类随意缩写严重降低了代码的可阅读性。
9.如果模块、 接口、类、方法使用了设计模式,在命名时需体现出具体模式
说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。
正例:public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
10.对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用Impl 的后缀与接口区别。
正例:CacheServiceImpl实现CacheService接口
11.如果是形容能力的接口名称,取对应的形容词为接口名(通常是–able 的形容词)。
正例:JDK中的Comparable接口
12.在long或者Long赋值时,数值后使用大写的 L,不能是小写的 l,小写容易跟数字 1 混淆,造成误解。
说明:Long a = 2l;写的是数字的 21,还是 Long 型的 2 ??
13.不允许任何魔法值(即未经预先定义的常量)直接出现在代码中
正例:
public static final ORDER_REDIS_KEY_PREFIX = "orderId_";
String orderRedisKey = ORDER_REDIS_KEY_PREFIX + orderId;
反例:
String redisKey = "orderId_" + orderId;
14.枚举类名带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。
正例:枚举名字为ProcessStatusEnum的成员名称:SUCCESS / UNKNOWN_REASON
java类的命名规范_浅谈Java中的命名规范相关推荐
- java方法区对象类型_浅谈Java内存区域与对象创建过程
一.java内存区域 Java虚拟机在执行Java程序的过程中会把它所管理的内存划分为若干个不同的数据区域.这些区域都有各自的用途,以及创建和销毁的时间,有的区域随着虚拟机进程的启动而存在,有的区域则 ...
- java中单例的应用_浅谈Java中单例模式的几种应用
目录 浅谈Java中单例模式的几种应用 第一种:懒汉式 第二种:饿汉式 第三种:双重检索式 第四种:注册登记式 第五种:内部类形式 浅谈Java中单例模式的几种应用 日常开发中,为了提高我们系统中对象 ...
- java的向下转型_浅谈Java向下转型的意义
一开始学习 Java 时不重视向下转型.一直搞不清楚向下转型的意义和用途,不清楚其实就是不会,那开发的过程肯定也想不到用向下转型. 其实向上转型和向下转型都是很重要的,可能我们平时见向上转型多一点,向 ...
- java变量命名规则_浅谈JAVA开发规范与开发细节(上)
开发团队在开发过程中,由于每个人的开发习惯,以及对于技术的理解深浅程度不一,往往一个项目在开发过程中,代码的质量,代码的风格都不尽相似,所以有一份适合团队的代码规范是非常有必要的,而一个团队的代码规范 ...
- java什么是适配器类?作用是什么?_浅谈Java适配器模式
假期刚结束不久,也没什么好写的,今天就水下文章,讲讲设计模式对开发时的影响,做开发到现在,感觉设计模式对开发的影响还是挺大的. 这次就简单谈谈适配器模式.可能适配器模式感觉比较鸡肋,但是用到的地方还挺 ...
- java字符串常量存哪里_浅谈JAVA中字符串常量的储存位置
在讲述这些之前我们需要一些预备知识: Java的内存结构我们可以通过两个方面去看待它. 从该角度看的话Java内存结构包含以下部分:该部分内容可以结合:JVM简介(更加详细深入的介绍) 1.栈区:由编 ...
- php和java的区别菜鸟教程_浅谈Java和PHP的主要区别
当谈到PHP与Java的差异性问题时,更多的是回答初学者的一些疑问.对于刚接触IT的同学来说,他们需要做好对未来职业的选择.所以是选择PHP还是选择Java更有利于自身的技术特点和发展前景.所以在解决 ...
- java final类为什么不能继承_浅谈Java之终止继承:Final类和Fianl方法
前言 关键字Final不仅可以用来修饰变量,而且对类及其方法的继承也有很大的影响,本文将从类与方法两个方面介绍final关键字的功能. Final类 当关键字final用来修饰类时,其含义是该类不能再 ...
- java四种内部类区别_浅谈Java中的四种内部类
如果你看过一些JDK和框架源码的话,就经常会发现一般在类的定义中,都会再定义一些其他的类,这些类也同样会被编译成字节码文件,这样的类就被叫做 内部类 ,按照一般的分法,大致可以分为以下四类: 成员内部 ...
最新文章
- squid rebuild 阶段swap.state 持续增大耗尽磁盘
- rsync定时加脚本实现本地到阿里的ftp文件同步
- 远控免杀专题 13----zirikatu免杀
- python输出结果每5个换行_python for循环 - python基础入门(11)
- spark 2.2 读取 Hadoop3.0 数据异常 org.apache.hadoop.hdfs.web.HftpFileSystem cannot access its superinterfa
- MySQL (一)(未完成)
- 关于java中的位运算
- python生成随机整数
- 英特尔傲腾驱动下载_什么是英特尔傲腾内存?
- CMMI4 培训计划
- esp8266使用BME280实时上传温湿度气压
- Android8.0 页面崩溃问题
- 专利代理人资格考试怎么准备
- linux下oob_cmd命令,linux下 OOB 炸弹的制作
- flutter 聊天界面+表情图片
- 如何彻底卸载win10预装的office365等
- RealAI:清华团队打造第三代安全可控人工智能 | 百万人学AI评选
- 通过JAVA编写DOMINO服务器端插件程序
- 渗透测试之信息收集 -tryhackme-Content Discovery
- 算法——AcWing算法提高课中代码和题解
热门文章
- ajax 入参为list_ajax传递给后台数组参数方式
- python pandas dataframe 转json_python将相类不同key的json对象转化为pandas的dataframe(上篇)...
- springmvc jsp页面提交表单乱码
- Visual C++——设置光标Cursor
- PHPMySQL——防止SQL注入-代码片段
- BZOJ 2733 | 洛谷 P3224 [HNOI2012]永无乡
- CG CTF WEB 综合题
- Ricky’s RealDan’s Ricky
- 2017c语言预测,2017计算机二级C语言上机最终预测题
- php psr-2,「PSR 规范」PSR-2 编码风格规范