Java 语言编码规范Word文档格式.docx
《Java 语言编码规范Word文档格式.docx》由会员分享，可在线阅读，更多相关《Java 语言编码规范Word文档格式.docx（13页珍藏版）》请在冰点文库上搜索。
制订本规范的目的是为培养规范设计和编程，养成良好的习惯，增强JAVA类软件产品的稳定、健壮、可靠性;
同时也为提高软件的可读性，可以让程序员尽快而彻底地理解新的代码，使产品可维护性提高而制定的强制性规范，同时也是代码复审的依据。
2范围
本规范适用于公司JAVA类代码（包括JSP）的代码编写标准。
适用于代码编写阶段和代码维护阶段。
3参考文档
《SUNJAVA代码编写规范》。
4说明
本文档包括java编码规范，jsp编码规范，servlet编码规范。
struts代码规范请参阅《struts编码规范.doc》。
二、java编码规范
1.1.1开头注释（BeginningComments）
所有的源文件都应该在开头有一个Java语言风格的注释，其中列出标题、描述、日期和版权声明：
/**
*<
p>
Title:
标题<
/p>
Description:
描述<
Copyright:
Copyright（c）2007<
Company:
华胜天成<
*@author:
张三
*@version1.0
*/
1.1.2包和引入语句（PackageandImportStatements）
在多数Java源文件中，第一个非注释行是包语句。
在它之后可以跟引入语句。
例如：
packagejava.awt;
importjava.awt.peer.CanvasPeer;
注：
避免使用以下方式
importjava.awt.*;
2缩进排版（Indentation）
4个空格常被作为缩进排版的一个单位。
缩进的确切解释并未详细指定（空格vs.制表符）。
一个制表符等于8个空格（而非4个）。
2.1行长度（LineLength）
尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理之。
注意：
用于文档中的例子应该使用更短的行长，长度一般不超过70个字符。
3注释（Comments）
Java程序原有两类注释：
实现注释（implementationcomments）和文档注释（documentcomments），我们自己又增加了一种注释叫标记注释。
实现注释是那些在C++中见过的，使用/*...*/和//界定的注释。
文档注释（被称为"
doccomments"
）是Java独有的，并由/**...*/界定。
文档注释可以通过javadoc工具转换成HTML文件。
实现注释用以注释代码或者实现细节。
文档注释从实现自由（implementation-free）的角度描述代码的规范。
它可以被那些手头没有源码的开发人员读懂。
注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。
注释应该仅包含与阅读和理解程序有关的信息。
例如，相应的包如何被建立或位于哪个目录下之类的信息不应包括在注释中。
在注释里，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应避免提供代码中己清晰表达出来的重复信息。
多余的的注释很容易过时。
通常应避免那些代码更新就可能过时的注释。
频繁的注释有时反映出代码的低质量。
当你觉得被迫要加注释的时候，考虑一下重写代码使其更清晰。
注释不应写在用星号或其他字符画出来的大框里。
注释不应包括诸如制表符和回退符之类的特殊字符。
总之：
注释要明确注明文件、页面、函数、算法之功能，用途，以及创建、修改信息等。
4声明（Declarations）
4.1每行声明变量的数量（NumberPerLine）
推荐一行一个声明，因为这样以利于写注释。
亦即，
intlevel;
//indentationlevel
intsize;
//sizeoftable
要优于，
intlevel,size;
不要将不同类型变量的声明放在同一行，例如：
intfoo,fooarray[];
//WRONG!
上面的例子中，在类型和标识符之间放了一个空格，另一种被允许的替代方式是使用制表符：
intlevel;
intsize;
ObjectcurrentEntry;
//currentlyselectedtableentry
4.2初始化（Initialization）
尽量在声明局部变量的同时初始化。
唯一不这么做的理由是变量的初始值依赖于某些先前发生的计算。
5空白（WhiteSpace）
5.1空行（BlankLines）
空行将逻辑相关的代码段分隔开，以提高可读性。
下列情况应该总是使用两个空行：
-一个源文件的两个片段（section）之间
-类声明和接口声明之间
下列情况应该总是使用一个空行：
-两个方法之间
-方法内的局部变量和方法的第一条语句之间
-一个方法内的两个逻辑段之间，用以提高可读性
5.2空格（BlankSpaces）
下列情况应该使用空格：
操作符之间应该有空格。
6命名规范（NamingConventions）
命名规范使程序更易读，从而更易于理解。
它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。
标识符类型
命名规则
例子
包（Packages）
一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO3166标准所指定的标识国家的英文双字符代码。
包名的后续部分根据不同机构各自内部的命名规范而不尽相同。
这类命名规范可能以特定目录名的组成来区分部门（department），项目（project），机器（machine），或注册名（loginnames）。
com.sun.eng
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese
类（Classes）
命名规则：
类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。
尽量使你的类名简洁而富于描述。
使用完整单词，避免缩写词（除非该缩写词被更广泛使用，像URL，HTML）
classRaster;
classImageSprite;
接口（Interfaces）
大小写规则与类名相似
interfaceRasterDelegate;
interfaceStoring;
方法（Methods）
方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
run（）;
runFast（）;
getBackground（）;
变量（Variables）
除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。
变量名应简短且富于描述。
变量名的选用应该易于记忆，即，能够指出其用途。
尽量避免单个字符的变量名，除非是一次性的临时变量。
临时变量通常被取名为i，j，k，m和n，它们一般用于整型；
c，d，e，它们一般用于字符型。
charc;
inti;
floatmyWidth;
实例变量（InstanceVariables）
大小写规则和变量名相似，除了前面需要一个下划线
int_employeeId;
String_name;
Customer_customer;
常量（Constants）
类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。
（尽量避免ANSI常量，容易引起错误）
staticfinalintMIN_WIDTH=4;
staticfinalintMAX_WIDTH=999;
staticfinalintGET_THE_CPU=1;
7性能考虑
7.1使用StringBuffer对象
在处理String的时候要尽量使用StringBuffer类，StringBuffer类是构成String类的基础。
String类将StringBuffer类封装了起来，（以花费更多时间为代价）为开发人员提供了一个安全的接口。
当我们在构造字符串的时候，我们应该用StringBuffer来实现大部分的工作，当工作完成后将StringBuffer对象再转换为需要的String对象。
比如：
如果有一个字符串必须不断地在其后添加许多字符来完成构造，那么我们应该使用StringBuffer对象和她的append（）方法。
如果我们用String对象代替StringBuffer对象的话，会花费许多不必要的创建和释放对象的CPU时间。
避免太多的使用synchronized关键字避免不必要的使用关键字synchronized，应该在必要的时候再使用她，这是一个避免死锁的好方法。
7.2可移植性
BorlandJbulider不喜欢synchronized这个关键字，如果你的断点设在这些关键字的作用域内的话，调试的时候你会发现的断点会到处乱跳，让你不知所措。
除非必须，尽量不要使用。
7.3换行
如果需要换行的话，尽量用println来代替在字符串中使用"
\n"
。
你不要这样：
System.out.print（"
Hello,world!
）;
要这样：
System.out.println（"
"
或者你构造一个带换行符的字符串，至少要象这样：
Stringnewline=System.getProperty（"
line.separator"
Helloworld"
+newline）;
7.4PrintStream
PrintStream已经被不赞成（deprecated）使用，用PrintWrite来代替她。
三、Jsp编码规范
（1）整个jsp/jspbean表示层应当尽可能的瘦和简单化。
（2）牢记大多数的JSP都应当是只读的视图，而由页面bean来提供模型。
（3）在尽可能合理的情况下，把业务逻辑从JSP中移走。
具体于HTTP的逻辑（如，对Cookie的处理）属于bean或支持类中，而不是JSP中。
（4）尽量把条件逻辑放在控制器中而不是放在视图中。
（5）应当在JSP中避免使用页面引入指令。
import指令会促使类的实列化而不是jspbean的实例化
不用：
<
%@pageimport="
com.java.util.*"
%>
而用：
%java.util.Listl=newjava.util.LinkedList（）;
（6）jsp不应该直接去访问请求参数。
bean应当执行这样的处理过程并且输出所处理的模型数据。
（7）jsp不应当访问属性文件，或者使用JNDI。
bean可以访问属性。
（8）应当避免设计既显示表单又处理结果的页面。
（9）在jsp中避免代码重复。
把要重复的功能放在一个包含的jsp、bean或标记扩展中，使得它能够被重用。
（10）jspbean应当永远不要去产生HTML
（11）在jsp中应该避免使用out.pringln（）发放来产生页面内容。
（12）jsp层不应该直接访问数据，这包括JDBC数据库访问和EJB访问。
（13）在长度上，scriptlests的代码最好不要超过5行。
（14）除了jspbean之外，jsp不应当去实例化复杂的可读写的对象。
如果这样的话，就有可能在jsp中去执行不适当的业务逻辑。
（15）如果使用了<
jsp:
forward>
和<
include标记>
，并且必须使用简单类型的值来与外部页面进行通讯的话，就应当使用一个或多个<
param>
元素
（16）应当谨慎地使用<
标记，在jsp中它是一个等价的goto。
（17）应当使用隐藏的注释来阻止输出的HTML过大。
（18）在jsp中避免进行异常处理
（19）每个jsp文件中都应当使用一个错误页面来处理不能够从中恢复的异常。
（20）在jsp错误页面中，使用HTML注释来显示传递到该页面中的异常跟踪信息。
（21）只有在能够获得性能上的好处时，才使用jspInin（）方法和jspDestroy（）方法。
获取和放弃资源是jspbeans和标记处理器的事，而不是由jsp来负责的。
（22）如果没有充分的理由，就不要在jsp中定义方法和内部类。
四、Servlet编码规范
Servlet编码规范遵循java代码编写规范，为了明确标明此java文件是servlet程序，规定所有Servlet文件名都以Servlet结尾，例如：
UploadServlet.java。
五、Jsp和servlet编程注意事项
在编写Servlet/JSP程序时，对实例变量一定要小心使用。
因为实例变量是非线程安全的。
在Servlet/JSP中，变量可以归为下面的几类：
1.类变量
request，response，session，config，application，以及JSP页面内置的page,pageContext。
其中除了application外，其它都是线程安全的。
2.实例变量
实例变量是实例所有的，在堆中分配。
在Servlet/JSP容器中，一般仅实例化一个Servlet/JSP实例，启动多个该实例的线程来处理请求。
而实例变量是该实例所有的线程所共享，所以，实例变量不是线程安全的。
3.局部变量
局部变量在堆栈中分配，因为每一个线程有自己的执行堆栈，所以，局部变量是线程安全的。
所以应该在Servlet/JSP中尽量避免使用实例变量
六、代码范例（CodeExamples）
11.1Java源文件范例（JavaSourceFileExample）
下面的例子，展示了编程规范中部分用例。
packagecom.java;
publicclassTemplate
{
//常量需要说明函义，并且加final修饰符
publicfinalStringSTR="
HelloWord"
;
/**
*构造函数
publicTemplate（）
{
}
*函数功能描述
*@paramstr:
变量说明
*@return:
返回值说明
publicStringtestOut（Stringstr）
//判断是否为空
if（str==null）
return"
else
returnstr;
*主函数
*@paramargs
publicstaticvoidmain（String[]args）
Strings=null;
//定义变量
Templatetemplate=newTemplate（）;
//调用方法
s=template.testOut（template.STR）;
System.out.println（"
s="
+s）;
}
升级会员 