JAVA编码规范.doc

《JAVA编码规范.doc》由会员分享，可在线阅读，更多相关《JAVA编码规范.doc（17页珍藏版）》请在得力文库 - 分享文档赚钱的网站上搜索。

1、1. 命名规范命名要使用具有实际意义的英文单词，或者单词的缩写，不要使用单个的字母来命名一个变量，一个好的命名，几乎不用看文档就能知道该方法或者变量的意义，如同Java API，它的命名还是很值得借鉴的。命名的一般规范：1. 尽量使用完整的英文描述符（除非特别必要，尽量不要使用汉语拼音缩写形式）。2. 采用适用于相关领域的术语（如url之类的术语，但术语必须是大家认可的）。3. 采用大小写混合使名字可读。4. 尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一，一些常用的缩写可以参考Java API 如message的缩写可以为msg。5. 避免使用长的名字（小于 15 个字母是个好主

2、意）。6. 避免使用类似的名字，或者仅仅是大小写不同的名字。7. 避免使用下划线（除静态常量等）。1.1. package 的命名package 的名字应该都是由小写字母单词组成,名字的前两级为com.highsoft，三级名称为模块名。例如：包名com.highsoft.demo.action表示demo模块下处理类包名。1.2. Class 的命名Class 的名字必须由大写字母开头而其他字母都小写的单词组成，对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。例如：public class ThisAClassName1.3. 变量的命名 对于变量的命名，要尽量达

3、到能通过变量名知道这个变量表达的含义，变量采用小写字母开头，对于由多个单词组成的变量名，所有单词都应紧靠在一起，而且大写中间单词的首字母。对于常量（static final类型）采用如下方式命名：字母全部大写并使用下划线分隔单词（如：DB_CONFIG）。1.4. 参数的命名 参数的名字必须和变量的命名规范一致。1.5. 数组的命名 数组命名和变量命名类似，主要是能体现出这是一组数据。1.6. 方法的参数使用有意义的参数命名。同时请参照“变量的命名”条目。对于javabean中简单的set和get方法，可以使用和要赋值的字段一样的名字。setSize(int size) this.size =

4、 size;1.7. 方法的命名方法的命名遵循变量的命名，方法的名字必须用一个小写字母开头。后面的单词用大写字母开头。1.8. 特定类的命名对于Servlet类，在对象后加后缀Servlet来命名，如：UserServlet 。对于Applet类，在对象后加后缀Applet来命名，如：GraphApplet 。对于JUnit和测试类，在对象后加后缀Test来命名，如UserTest。其他的特定类命名以后将不断补充进本标准中。2. 注释规范2.1. 使用代码注释的目的和关键1. 文字说明代码的作用（即为什么要用编写该代码，而不是如何编写）； 2. 明确指出该代码的编写思路和逻辑方法；3. 使阅读

5、者注意到代码中的重要转折点；4. 使阅读者不必在他们的头脑中仿真运行代码的执行方法。5. 何时书写注释：1）请在每个if语句的前面加上注释；2）在每个switch语句的前面加上注释。与if语句一样，switch语句用于评估对程序执行产生影响的表达式。 3）在每个循环的前面加上注释。每个循环都有它的作用，许多情况下这个作用不清楚直观。 2.2. Java的注释单行注释：/ 注释一行多行注释：/* . */ 注释若干行文档注释：/* . */ 注释若干行，并写入 javadoc 文档 ，对共有变量、方法，使用该种注释。说明：提供给客户程序员使用的接口、公用类要严格按照文档注释进行注释，并生成doc

6、文档，做到客户程序员通过阅读doc来使用共有类，而不是阅读源代码来使用一个公共接口或者类。l 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。l 注释要简单明了。l 要区分两种注释的区别，一种是文档注释，是给客户程序员使用的，他们不会阅读你的源代码，因此要尽可能的提供更多的信息，让他们使用起来方便；另一种是非文档注释，是提供给代码的维护人看的，是为了给代码的维护人员看的，他们是要看到你的源代码的，因此非文档注释要简单明了。下面是一个公用类的注释：package java.blah;import java.blah.blahdy.BlahBlah; * 对类的用途的描述.

7、* author Firstname Lastname（作者信息）* date system date （创建/修改时间） * see (位置)public class MyClass extends SomeClass /* 对公有成员变量的注释（单行的格式），建议采用单行的格式，节省版面*/ public int classVar1; * 对共有成员变量的注释（多行的格式） * more than one line long private Object classVar2; * .对该方法用途的描述 * param userName对参数userName的描述 * param passw

8、ord 对参数password的描述 * exception 对抛出异常的说明 * return String 对返回值的描述 public String classMethod(String userName,String password) / 对代码片断的注释（如，以下用于密码验证） if( flag = true)/对代码逻辑块进行注释（如：如果密码验证通过）else/对代码逻辑块进行注释（如：如果密码验证未通过）2.3. JSP中注释%- comment -% JSP注释，也称为“隐藏注释”。JSP引擎将忽略它。标记内的所有JSP脚本元素、指令和动作都将不起作用。这种注释不会出现载J

9、SP编译后的JSP页面中，建议使用。!- comment - HTML注释，也称为“输出的注释”，直接出现在结果HTML文档中。标记内的所有JSP脚本元素、指令和动作正常执行。2.4. 使用javadoc注释在自定义类中必须使用javadoc注释以保证客户程序员通过使用java自动编译生成的doc文档就能够使用你的类。这里的注释请通过eclipse开发工具辅助生成，对参数、返回值等要做必要的说明。2.5. 变更注释为了方便的让代码维护者看到文件的变更信息及历史，对于重要的修改请使用变更注释。在javadoc的version条目下请标明版本信息、修改日期、修改关键字和简单的修改说明信息。在修改代

10、码的开始和结束处使用修改标识和关键字进行标示。注释时尽量不要删除变更前代码。同时保证其他人员可以使用变更关键字来查找变更位置（后起的关键字必须保证和前面的关键字不重复并尽量保证非类似）。举例如下：/变更修改注释：变更关键字：modify。张三（2019-04-26）。因为错误进行了变更修改。/*首先注释修改前的代码*/开始进行变更修改/变更修改完毕。变更关键字：modify3. 代码编写格式3.1. 缩进都使用tab键进行缩进，等式前后都要留有空格，代码编写完成后使用ctrl+shift+f进行格式化。标准写法：（等号、逗号、运算符号等符号之间留有空格）int age = 23, age2 =

11、 0;age2 = age + 12;非标准写法：（等号、逗号、运算符号等符号之间无空格）int age=23,age2=0;age2=age+12;3.2. 页宽为80字符页宽应该设置为80字符。源代码超过这个宽度可能导致无法完整显示，但这一设置也可以灵活调整。在任何情况下，超长的语句应该在一个逗号或者一个操作符后折行。一条语句折行后，应该比原来的语句再缩进一个tab。3.3. if-else语句块if-else语句块的格式如下，else紧接着if的结束大括号。if（） else即使if条件语句语句后面如果只有一行代码，最好也放在大括号中如：if( flag = true) flag = f

12、alse;String username new String();而非以下形式：if( flag = true) flag = false;String username new String();3.4. try-catch语句块try-catch语句块应遵循如下格式：trycatch(Exception ex)finally3.5. 方法与方法之间或者方法体内的逻辑块之间以空行分隔方法与方法之间，或者一个方法体中的逻辑块之间用空行来分割，增强代码的可读性。3.6. public方法和public变量要优先排列前面变量的排列顺序：首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没

13、有访问修饰符，access modifier)，最后是私有变量方法的排列顺序：同变量的排列顺序。这样使得首先看到得是类得公有变量和公有成员函数。3.7. 用三目运算符代替简单的ifelse块在判断关系简单并且稳定不变的地方使用可以增强代码可读性和提高性能。3.8. 运算符的排版格式一元符与操作数之间不要空格，如i+，i-，i与+之间不要空格。二元操作符与操作数之间要空格分开，如a = b + c;加号两端都加空格。3.9. 使用圆括号来避免运算符优先级问题即使运算符的优先级对你而言可能很清楚，但对其他人未必如此。你不能假设别的程序员和你一样清楚运算符的优先级。应该在表达式中明确的制定优先级，避

14、免难以理解的代码出现。3.10. import使用规定引入jdk及j2ee标准类时可以使用*，如import java.io.*；引入自定义类时，请一个类一条import语句，以增强代码可读性。如import dfjh.basic.db.dbaccess；4. Exception异常处理通常的思想是只对错误采用异常处理：逻辑和编程错误，设置错误，被破坏的数据，资源耗尽等。通常的法则是系统在正常状态下以及无重载和硬件失效状态下，不应产生任何异常。异常处理时可以采用适当的日志机制来报告异常，包括异常发生的时刻。不要使用异常实现来控制程序流程结构。4.1. 分别捕获子类的异常而非父类Exceptio

15、n比较合理的做法是分别捕获各个子类异常之后，分别处理不同的异常，不要一个方法内就一个trycatch()块。4.2. 使用Exception来返回异常，而非返回值尽量使用Exception来反映函数运行中的异常，而不是使用返回值来反映，除非有充分理由这样做。越是底层的类越应该使用Exception来反映函数运行中的异常。4.3. 禁止使用空的catch()代码绝对不允许代码中出现catch()而什么也没做。因为这样做还不如直接把异常抛出，让使用该方法的人来处理。同时只要你catch了一个异常，JVM就认为你已经处理了该异常，其实你什么也没有做，这样就使很多的异常可能隐藏起来了。4.4. Exc

16、eption信息输出在每一个catch到一个异常的时候，在调试状态下请使用ex.printStackTrace()来输出错误信息；在运行状态下请使用ex.getMessege()来输出错误信息。通常情况下应该加上比较容易读懂的中文信息的输出。5. 性能优化（推荐标准）5.1. 避免不必要的对象构造有的时候，构造了一个变量由于某种原因，您可能没有使用它，每构造一个对象可能会花销一定得CPU时间，正确的做法是先申明，到需要使用的时候才构造它的一个对象。一般不要在申明时构造一个对象（尤其是针对类变量）。5.2. 不要在循环中构造和释放对象不要象一下代码一样构造对象：for(int i = 0;i 5

17、0 ;i +) Double doubleObj = new Double; doubleObj = ；而应该使用如下方法：Double doubleObj = new Double;for(int i = 0;i 50 ;i +) doubleObj = ；5.3. 使用 StringBuffer 对象在处理 String 的时候要尽量使用 StringBuffer 类，StringBuffer 类是构成 String 类的基础。String 类将 StringBuffer 类封装了起来，（以花费更多时间为代价）为开发人员提供了一个安全的接口。当我们在构造字符串的时候，我们应该用 Strin

18、gBuffer 来实现大部分的工作，当工作完成后将 StringBuffer 对象再转换为需要的 String 对象。比如：如果有一个字符串必须不断地在其后添加许多字符来完成构造，那么我们应该使用 StringBuffer 对象和它的 append() 方法。如果我们用 String 对象代替 StringBuffer 对象的话，会花费许多不必要的创建和释放对象的 CPU 时间。例如：常用的是定义SQL语句时，你可能会用到过+=来扩充SQL语句的内容，由于String对象是长度不能改变的，其实使用+=是每次构造一个新的String对象。该字符串的内容是原来字符串内容与新加入的内容之和,再把新字

19、符串赋值给原来的字符串变量。 比较合理的做法是使用StringBuffer类来代替String。 StringBuffer stringBuffer = new StringBuffer(初始内容); StringBuffer.append(加上新的内容); StringBuffer.toString(); StringBuffer的append还重载了许多实用方法，如append(int intValue)等等，支持基本数据类型的，省去了你再将基本数据类型转换为对应的String ，再使用+=连接字符串的麻烦。说明：在字符串长度大于100时，必须使用本标准。5.4. 避免太多的使用 sync

20、hronized 关键字 避免不必要的使用关键字 synchronized，应该在必要的时候再使用它。5.5. 不是必要的时候不要使用Vector、Hashtable等同步化的数据结构这些数据结构是同步化的，会对性能造成一定的影响，因此，不是必要的时候不要使用，可以使用他们的替代品ArrayList和HashMap代替。6. 设计类和方法的原则6.1. 创建具有很强内聚力的类方法的重要性往往比类的重要性更容易理解，方法是指执行一个统一函数的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。之所以不能正确的认识类的

21、功能，原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时会带来很大的影响。类应该用来将相关的方法组织在一起。当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以为这些不合群的方法创建一个综合性收容类。创建类时，应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当

22、独立的程序单元。6.2. 创建松散连接和高度专用的方法6.2.1. 使所有方法都执行专门的任务 每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同任务的方法。创建专用方法有许多好处。首先调试将变得更加容易。6.2.2. 尽量使方法成为自成一体的独立方法 当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法会使调试和修改变得比较困难，因为它牵涉到更多的因素。松散连接的方法优于紧密连接的方法，但你不可能使每个方法都成为独立的方法。若要使方法具备较强的独立性，方法之一是尽量减少类变量。创建方法时，设法将每个方法视为一个黑箱，其他例程不应要求了解该

23、方法的内部工作情况，该方法也不应要求了解它外面的工程情况。这就是为什么你的方法应依靠参数而不应依靠全局变量的原因。创建专用方法时，请考虑下列指导原则：1. 将复杂进程放入专用方法。如果应用程序使用复杂的数学公式，请考虑将每个公式放入它自己的方法中。这样使用这些公式的其他方法就不包含用于该公式的实际代码。这样也可以更容易发现与公式相关的问题。 2. 将数据输入/输出（I/O）放入专用方法。 3. 将专用方法中可能要修改的代码隔离。如果你知道某个进程经常变更，请将这个多变的代码放入专用方法，以便以后可以更容易的进行修改，并减少无意中给其他进程带来问题的可能性。 4. 将业务规则封装在专用方法中。业务规则常属于要修改的代码类别，应与应用程序的其余部分隔开。其他方法不应知道业务规则，只有要调用的方法才使用这些规则。 6.2.3. 设计类和方法时，要达到下列目的： 1. 创建更加容易调试和维护的方法；2. 创建具有强大内聚力的类；3. 创建高度专用的方法；4. 创建松散连接的方法；5. 尽量使方法具有独立性；6. 提高方法的扇入性；7. 降低方法的扇出性。第 17 页