Java开发规范

Java文件命名规范（总体遵循驼峰式命名规则，见名知意原则）

  1、命名规则：

    1）Java程序源文件的后缀必须是.java;

    2）通常情况下，Java程序源文件的主文件名可以是任意的。但是有一种情况例外：如果Java程序源代码里定义了一个public类，则该源文件的主文件名必须与该public类（也就是该类定义使用了public关键字修饰）的类名相同。

      由于Java程序源文件的文件名必须与public类的类名相同，因此，一个java源文件里最多只能定义一个public类，但是一个Java源文件里可以定义多个类。

    3）类名：各单词首字母大写(不同的类应该放在相应的包下)

      异常类以 Exception 作为后缀；

      工具类以 Utils 作为后缀；

      实现类与接口用后缀 Impl 区别；

    4）变量名：第一个单词的首字母小写，其后单词的首字母大写，例如：initParam；

    5）常量名/枚举值：全部使用大写字母，用下划线“_”分割单词，例如INIT_PARAM；

    6）测试类：被测试的业务 + Test、被测试的接口 + Test、被测试的类 + Test；

    7）测试方法：test + 被测方法；

 2.注释规范：

    1）类的注释，说明类的描述，类名（可有可无），所属公司，类的创建人，创建日期，如下图示例：

        

    2）方法注释：方法功能描述，方法参数说明，方法返回值说明，方法编辑人

        

  3、开发细节：（旨在提高代码质量）

    1）尽量少使用全局变量，原因使用全局变量可能会造成覆盖赋值的错误，而且可读性差。极端的举例，所有的变量都可以换成全局变量，试想一下，假如所有的变量都是全局变量，那开发的过程中开发者自己当时都会觉得难度极大，更何况是以后阅读的难度；

    2）慎用session，常规数据不要放在session中，后端响应到前端除登录信息之外的数据不要放到session中，原因是session是保存在服务器端空间的数据，不必要的数据放到session中会造成服务器空间浪费；

    3）适当空行，比如两段相对完整的逻辑代码之间空一行，空行空一行即可。适用于完整但不独立而且代码行数不多的代码块，如果是行数大，则建议方法抽取；

    4）尽量方法抽取，一段完整独立的逻辑块最好抽取成一个独立的方法，然后方法调用，这样做的好处是逻辑清晰，不至于一个方法有很多行代码，而且很多人空行不合适，造成逻辑混乱，可读性也极低；

    5）适当缩进，这是所有语言开发都力挺的一种规范。有的人写出来的代码层次不齐，可读性相当差，给后来人接手造成完全没必要的而且是相当大的代码阅读难度。现在各种编辑器都有代码格式化功能，但是有些时候格式化还是会不尽人如意，比如eclipse开发编辑HTML文本格式化的时候就不是那么完美，所以强烈建议，编辑的过程中主动注意这种格式的控制，写出整齐的代码，毕竟编辑器格式化功能只是我们开发过程中格式控制的辅助功能。

4、阿里巴巴java开发手册-命名规约 网址：https://mp.weixin.qq.com/s/md3K1H6FIWrjebcnOwgISw?