Java开发编码规范.docx

《Java开发编码规范.docx》由会员分享，可在线阅读，更多相关《Java开发编码规范.docx（13页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。

1、或寿信.恕肾吃Chengdu University of Information Technology计算机学院*项目名称*Java开发编码规范小组序号:01编 撰 人:XXX年级班级： 201I级应用X班 指导教师:提交日期： 2013年 月 日目录第一章代码开发规范及其指南11.1 目的11.2 : 内,.”.11.3 文件 m名规范21.4 Java文件样式21.5 代码编写格式6第二章程序编写规范方法82.1权限修饰8第三章其他要求12第一章代码开发规范及其指南1.1 目的定义这个规范的目的是让项目中所有的文档都看起来像个人写的,增 加可读性,减少项目组中因为换人而带来的损失。(这些规

2、范并不是一定要绝 对遵守,但是一定要让程序有良好的可读性)1.2 程序内命名规范 Package的命名:Package的名字应该都是由一个小写单词组成。 Class的命名:Class的名字必须由大写字母开头而其他字母都小写的单词 组成 Class变量的命名:变量的名字必须用个小写字母开头。后面的单词用大 写字母开头。 Static Fina!变量的命名：Static Fina!变量的名字应该都大写,并且指出完 整含义。 参数的命名：参数的名字必须和变量的命名规范一致。 数组的命名：数组应该总是用下面的方式来命名：byte buffer;而不是 byte buffer;方法的参数:使用有意义的参

3、数命名,如果可能的话,使用和要赋值的字 段样的名字：SetCounter(int size)this.size = size;)1.3 文件命名规范 文件名由英文单词组成,每个单词的首字母大写,不要超过4个单词, 如 ShipOrder.jspo Java文件的文件名要与程序中的public类名相同。 Servet 文件要以 Servlet 做为结尾,如 AddCompanyServlet.java 业务处理组件JavaBean要以Bean为结尾,如ProcessBean.java1.4 Java文件样式所有的Java(*.java)文件都必须遵守如下的样式规则头部版权信息版权信息必须在jav

4、a文件的开头,比如:/* Copyright 2002 Sun Microsystems, Inc. All rights reserved.*/其他不需要出现在javadoc的信息也可以包含在这里。 Package/Importspackage行要在import行之前,import中标准的包名要在本地的包名之 前,而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目 录,则应该用来处理。package .stats;import java.io.*;import java.util.Observable;import hotlava.util.Application;这里 j

5、ava.io. 使用来代替 InputStream and OutputStream 的。 Class接下来的是类的注释,一般是用来解释类的相关信息,包括标题、描述、。* Title: Example* Description: AuditApplicationExample* Copyright: Copyright (c) 200x* Company: xxxxx* author xxxxxx* version 1.0* /接下来是类定义,包含了在不同的行的extends和implementspublic class CounterSet extends Observable implem

6、ents Cloneable Class Fields接下来是类的成员变量:/* Packet counters*/protected int packets;public 的成员变量必须生成文档（JavaDoc） protected private和 package 定义的成员变量如果名字含义明确的话,可以没有注释。存取方法接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值 的话,可以简单的写在一行上。/* Get the counters* return an array containing the statistical data. This array has been

7、* freshly allocated and can be modified by the caller.*/public int getPackets() return copyArray(packets, offset); public int getBytes() return copyArray(bytes, offset); public int getPackets() return packets; public void setPackets(int packets) this.packets = packets; 其它的方法不要写在一行上 构造函数接下来是构造函数,它应该用

8、递增的方式写(比如:参数多的写在后 面)。访问类型(public, private等.)和任何static, final或synchronized 应该在一行中。Public CounterSet (int size)this.size = size; 克隆方法如果这个类是可以被克隆的,那么下一步就是clone方法:public Object clone() try (CounterSet obj = (CounterSet)super.clone();obj.packets = (int)packets.clone();obj. size = size;return obj;catch(Cl

9、oneNotSupportedException e) throw new InternalError( Unexpected CloneNotSUpportedException: + e.getMessage();) 类方法下面开始写类的方法:* Set the packet counters* (such as when restoring from a database)* /protected finalvoid setArray(int rl, int r2, int r3, int r4) throws IllegalArgumentException ( / Ensure th

10、e arrays are of equal size/if (rl.length != r2.length II rl.length != r3.length II rl.length != r4.1ength) throw new IllegalArgumentException(Arrays must be of the same size toString 方法无论如何,每个类都应该定义toString方法: publicString toStringO String retval 二 CounterSet: ； for (int i = 0; i 0) i + ;/Z 错误,和在同一行

11、if (i0) i +;正确,单独作为一行语句永远单独作为行.如果语句应该缩进到与其相对应的那一行相对齐的位置。1.1左括号和后一个字符之间不应该出现空格,同样,右括号和前个字符之间 也不应该出现空格.下面的例子说明括号和空格的错误及正确使用:CallProc( AParameter); /Z 错误CallProc(AParameter); / 正确不要在语句中使用无意义的括号.括号只应该为达到某种目的而出现在源代码 中。下面的例子说明错误和正确的用法:if(I) = 42) 错误一括号毫无意义if(I = 42) or (J = 42) then / 正确-的确需要括号第二章程序编写规范方法

12、1.2 权限修饰Java中权限修饰符有三个:public, private, protected,另外一种是不写这三种的 任何个,称为（default）.1）对于外部类,只能用public或（default）,而且-个文件中最多只能有一个 public类。但是内部类这四种都可以使用。2）如果对某些数据或方法只允许其所在类使用,用private修饰。3）如果对某些数据或方法允许本类或同包类使用,用（default）,即不写任 何修饰符。4）如果对某些数据或方法允许本类,同包类,或非同包子类使用,用 protected.如果对某些数据或方法允许任何类使用,用public修饰。1.3 其他规范 ex

13、it（）exit除了在main中可以被调用外，其他的地方不应该调用。因为这样做不 给任何代码代码机会来截获退出。个类似后台服务的程序不应该因为某个 库模块决定了要退出就退出。 异常关键操作如涉及到数据库操作和多个关键处理步骤时应当采用try,catch语 句,以便于捕获异常（各类Exception）和异常处理。 垃圾收集JAVA使用成熟的后台垃圾收集技术来代替引用计数。但是这样会导致个 问题:必须在使用完对象的实例以后进行清场工作。除非输出流出作用域就关闭,非引用计数的程序语言,比如JAVA,是不 能自动完成变量的清场工作的。必须象下面一样写:FileOutputStream fos = ne

14、w FileOutputStream(projectFile);project.save(fbs, nIDE Project File);fos.close(); Clone下面是种有用的方法:implements CloneablepublicObject clone() ( try (ThisClass obj = (ThisClass)supei fina! 类绝对不要因为性能的原因将类定义为final的(除非程序的框架要求) 如果一个类还没有准备好被继承,最好在类文档中注明,而不要将她定义为 final的。这是因为没有人可以保证会不会由于什么原因需要继承她。访问类的成员变量大部分的类成

15、员变量应该定义为protected的来防止继承类使用他们。.clone。;obj.field 1 = (int)field 1 .clone。；obj.field2 = field2; return obj; catch(CloneNotSupportedException e) throw new InternalError( Unexpected CloneNotSUpportedException: + e.getMessage。)；) )注意,要用”int口 packets,而不是int packets口”,后种永远也不要用。 public void setPackets(int pa

16、ckets) this.packets = packets; CounterSet(int size) this.size = size;2.3编程指南1、byte 数组转换到 characters为了将byte数组转换到characters.可以这么做:Hello world!.getBytes();2、Utility 类Utility类(仅仅提供方法的类)应该被申明为抽象的来防止被继承或被初 始化。3、初始化下面的代码是种很好的初始化数组的方法:object Arguments = new Object arguments ;4、枚举类型JAVA对枚举的支持不好,但是下面的代码是种很有用的

17、模板：class Colour public static final Colour BLACK = new Colour(0, 0, 0);public static final Colour RED = new Colour(0xFF, 0, 0);public static final Colour GREEN = new Colour(0, OxFF, 0);public static final Colour BLUE = new Colour(0, 0, OxFF);public static final Colour WHITE = new Colour(0xFF, OxFF,

18、OxFF);)这种技术实现了 RED, GREEN, BLUE等可以象其他语言的枚举类型样使 用的常量。他们可以用=操作符来比较。但是这样使用有一个缺陷:如果一 个用户用这样的方法来创建颜色BLACKnew Colour(0,0,0)那么这就是另外一个对象,=操作符就会产生错误。她的equal()方法仍 然有效。由于这个原因,这个技术的缺陷最好注明在文档中,或者只在自己的 包中使用。性能1、在写代码的时候,从头至尾都应该考虑性能问题,要注意代码的效率。2、不必要的对象构造3、不要在循环中构造和释放对象4、使用 StringBuffer 对象在处理String的时候要尽量使用StringBuff

19、er类，StringBuffer类是构成 String类的基础。String类将StringBuffer类封装了起来,(以花费更多时间为 代价)为开发人员提供了一个安全的接口。当我们在构造字符串的时候,我们 应该用StringBuffer来实现大部分的工作,当工作完成后将StringBuffer对象再 转换为需要的String对象。比如:如果有一个字符串必须不断地在其后添加许 多字符来完成构造，那么我们应该使用StringBuffer对象和她的叩pend。方法。 如果我们用String对象代替StringBuffer对象的话，会花费许多不必要的创建和 释放对象的CPU时间。5、避免太多的使用s

20、ynchronized关键字避免不必要的使用关键字synchronized,应该在必要的时候再使用她，这是 一个避免死锁的好方法。6、可移植性为了保证整个系统的可移植性,尽量避免使用synchronized关键字7、PrintStreamPrintStream已经被不赞成(deprecated)使用,用PrintWrite来代替她。第三章其他要求 在control1层或该层之后关闭数据库连接,不能在页面里关闭 不能用select 的査询语句 数据的提取工作不在页面内完成 若是中文参数值,尽量用post方式,不用url方式 在将自己的代码提交到版本控制服务器之前一定要做好单元测试,不能提 交含有

21、单元测试就应该解决的bug的代码 异常处理要得当,不允许任何异常都是Exception,要尽量处理可以预料到 的异常。 在使用了 jdbc的事务时,处理结束后,一定要将事务提交如:Cmit();如果中间出现了异常,要将事务回滚后再关闭连接。 import对于import语句,如果某个包中引用的类不超过三个(包括三个),不 允许用import xxx.*;格式。变量定义及方法的返回值不允许使用全包名，如java.lang.String,除非在不同 的包中有相同名字的类,必须用全名来区分。对于类中属性的存取要用方法 (getXXX/setXXX, booleanisXXX/setXXX),不要直接引用。