Java开发规范
北京韩金网络技术有限公司Java项目开发规范
（2015版）
北京韩金网络技术有限公司
二○一五年十二月
审定：审核：编写：
目录
第一章引言 (4)
第一节编写目的 (4)
第二节预期读者 (4)
第三节本文的约定 (5)
第四节本文的内容 (5)
第五节适用范围 (6)
第二章开发环境 (7)
第一节操作系统环境 (7)
第二节开发工具 (7)
第三节版本管理工具 (8)
第三章软件开发框架 (9)
第一节整体结构规范 (9)
第二节开发框架的使用 (11)
第三节代码结构规范 (11)
第四节模块命名规范 (13)
第五节配置文件位置及规范 (13)
第四章公共组件的选用 (15)
第一节基础框架组件的选用 (15)
第二节日志组件的选用 (16)
第三节jquery的选用 (16)
第五章公司开发技术组件 (17)
第六章公司开发模块 (18)
第一节模块开发规范 (18)
第二节模块应用规范 (18)
第三节模块的使用 (19)
第七章技术支持和信息反馈 (20)
第一节信息反馈 (20)
第二节技术支持 (20)
第一章引言
第一节编写目的
本规范的目的是使本公司所有的软件开发部门能以统一的、规范的方式开发应用软件系统。通过建立编码规范，提高代码的可靠性、可读性、可修改性、可维护性和一致性等，增进团队协作能力，保证软件产品的质量。
通过建立统一的Java软件开发框架，树立公司清晰的、有远见的技术方向，明确Java软件项目的基础构件和接口，减少基础框架研究和构建的成本，统一的开发接口和规范还能保证公司软件模块在不同的项目中可以共享，从而提供开发效率和软件产品质量。同时本文也是一份J2EE开发指南，用于指导公司软件工程师开发java软件项目。
第二节预期读者
本文预期读者为公司的参与软件项目开发的项目经理、开发人员及质量管理部门相关人员。
第三节本文的约定
为了使本Java规范具有可操作、可用性、可持续等特性，本文做以下约定：
1.统一公司Java开发技术，以公司软件资源共享、节省软件开发工作量、
提供工作效率和软件产品质量为目标；
2.本Java软件开发规范具有可操作性，软件框架要有一定的伸缩性和适应
性，能够在公司不同的Java项目中执行；
3.针对某一问题，技术实现有很多种方式，并且各种技术方案都有自身的
优缺点，本文应该尽力选择最适合本公司应用的软件技术方案，一旦技
术方案确定即成为公司技术规范的依据；
4.本文发布以后，应该对相关开发人员进行培训；
5.本文发布以后，技术研发一部负责收集大家反馈的问题和新需求，并在
必要时对Java规范进行修改和补充；
6.本开发规范应该根据公司的积累不断的补充，定期升级公司J2EE规范，
并发布新版本。
第四节本文的内容
本文的内容比较宽泛，涉及公司Java项目各个方面，如开发工具选择、开发框架的定义、组件的选择等方面，如下表所示：
表1 java项目涉及到的主要方面
本文定义的内容将根据需要，定期进行修订和补充。
第五节适用范围
本文规定的所有规范适用于公司所有Java软件项目。对于特殊情况未能遵守本规范的项目，请保留项目技术评审相关结果记录。
第二章开发环境
统一规定公司的所有软件项目的开发环境，使公司的所有软件项目都在统一的开发环境下进行开发，以便于软件项目的移植，同时也避免了因为环境不一致而导致的软件项目不能共享和开发不能协作等问题。
第一节操作系统环境
Java开发操作系统环境为Windows 环境（32位或64位）。任何使用第三方文本编辑系统的情况，请使用UTF-8编码。
第二节开发工具
开发工具的指定，是从开发工具的版权、开发工具的功能以及软件的可扩展性等多方面进行考虑的，集成开发环境、JRE、应用服务器分别指定如下：
?集成开发环境：Eclipse EE5 (Eclipse Web开发版本)在Eclipse发行新版本后，由公司统一升级版本。MyEclipse涉及版权问题，不作为公司指定开发工具，只能作为开发人员学习研究的工具。
?JRE：JDK 1.8.0 （对于指定JDK版本的项目，请使用指定版本的JDK，应用服务器：Tomcat 7 （对于需要运行在指定应用服务器的项目，需要同时具备指定应用服务器的运行环境）。
开发工具、JRE、应用服务器都使用文件夹拷贝方式进行部署，最新的开发工具部署包从技术研发一部获取。开发工具中已经集成部分本规范规定的插件，如GIT插件、maven同步工具插件。
第三节版本管理工具
2.3.1 代码管理服务器
公司所有软件项目采用统一的代码管理服务器存储，新建项目和分配权限由项目经理提出申请，配置管理员操作执行。
2.3.2 代码管理工具
公司所有java项目开发版本管理使用git版本控制工具。
?服务器端：GITSERVER该软件部署在公司的开发服务器上。
?客户端：source tree
第三章软件开发框架
本章主要阐述java项目目录结构的规定及各部分命名规范。关于框架的组件选用将后面的章节给出规定。
第一节整体结构规范
java项目采用统一结构，以便于系统项目的维护以及多个项目之间共享资源。该项目规范是指maven Web应用的项目（客户端应用程序的结构规范属于子集，即不包括app部分的规范）。项目整体目录结构规范如下：
图 1 Java项目基本结构图
编号目录目录说明1 Src/main/java Java代码目录，存放java代码
Java代码目录测试用例目录
webapp目录配置文件目录合
系统内库入口
表2 目录结构说明
注：项目文档统一使用公司项目管理系统—文档管理来实现，临时项目文件由各项目经理自行安排存储与交换方式。
第二节开发框架的使用
项目开始开发（编码）时，项目组首先从代码服务器上获取最新版本的系统框架，系统框架包括系统整体框架、相关组件包（jar包）、框架界面、登录界面等。系统框架默认包括权限管理模块的最新版本，用于管理系统用户、模块及权限。
项目开发的下一步工作是按照项目需求加入公司已经开发完成的模块，以及按照项目需求开发新的业务模块。
第三节代码结构规范
本文阐述公司java项目的目录及命名规范。
其中java代码目录规范如下图所示：
图 2 J2EE 代码结构
表3 java代码包结构说明
基于java平台的项目，所有包名均以com.hanjin.<业务模块>开头。命名规则是：com.hanjin.业务模块.模块名称，如用户登录模块名称为：
https://www.360docs.net/doc/501170676.html,erconter.login。
第四节模块命名规范
模块是指系统中的各个业务功能模块，各个模块在组织上和功能上相对独立。模块的命名要有含义，各个模块的名称统一采用小写英文字母命名，如：
表 4 模块命名举例
第五节配置文件位置及规范
java项目的配置文件主要涉及SSM框架配置、日志组件配置文件及其他配置文件。配置文件位置及命名规范，定义了各类配置文件存放的位置及这些文件如何命名：
1)Spring配置文件位置及命名规范：Spring配置文件统一存储在src/main/
resources目录位置，命名为：applicationContext.xml，spring-servlet.xml，系统默认公共的配置文件为applicationContext-common.xml。
2)日志组件配置文件：日志组件配置文件统一规定为log4j.properties，存放
在src/main/resources目录位置。
3)数据库配置文件：数据库组件配置文件统一规定为jdbc.properties，存放
在src/main/resources目录位置。
第四章公共组件的选用
Java平台是个开放的平台，java开发有很多成熟的开发组件，同一类组件不同的厂商有不同的实现方式。为了统一公司的开发技术，达到技术共享的目的，本章规定了公共组件的选用。公共组件在本文中是指第三方提供的、J2EE 开发通常使用的组件，如数据访问组件（或框架）、日志组件、文件上传组件等等。
第一节基础框架组件的选用
java项目基础框架组件选用当前流行的SSM框架，所以模块的开发需要按照SSM的开发模式进行。对于有特殊技术需要的项目在技术委员会评定确认以后可以不采用SSM作为基础开发框架，但如果需要引用其他在该框架下开发的模块，必须保留各框架组件的类库以保证系统能够正常运行。2015年版本的公司JA V A开发框架的SSM框架的各组件版本说明如下：
表 5 SSM框架组件
原则上基础框架组件能够完成的技术实现不得采用其他同类组件来实现。SSM应用还做了如下规范：
1)Spring的配置文件可以基于注解和配置文件两种方式。在同一个项目中，
注解和配置文件可以混合使用，但在同一模块中只允许使用其中一种方
式。
第二节日志组件的选用
日志组件使用log4j组件，选用版本为1.2.17。
第三节jquery的选用
一般情况下，避免使用ExtJs脚本组件。如果项目中需要使用jquery，统一使用jquery1.9.0版本。
第五章公司开发技术组件
相对于公共组件来说，公司开发的用于解决特定技术问题的组件，这些组件如果没有现成的（或合适的）第三方组件可以替代，开发完成以后可以应用到公司的多个项目中。
[编制中]
对于已经存在的组件，各项目组要充分利用已有组件资源，不得重新单独开发。
第六章公司开发模块
公司将逐渐开发和积累软件成果，软件成果以（业务或技术）模块的形式存在，软件模块的复用是公司提高软件开发效率、节约开发成本、提高软件开发质量的重要途径。公司开发模块的规范包括模块开发的规范以及模块应用的规范。
模块开发的规范是指开发各个模块应该遵循的规范，使开发完成的模块符合J2EE开发规范，并且可以应用到其他项目中。这里要遵循的规范主要是目录结构规范、使用技术规范、组件规范、版本规范等。
模块的应用规范给出公司开发项目应该使用的成熟模块以及模块的接口和应用条件等。模块的应用规范规定公司开发项目要使用的模块、选择合适的版本、按照正确的方式来使用。
第一节模块开发规范
[编制中]
第二节模块应用规范
公司启动新项目以后，一方面要使用本文所规定的软件框架和规范进行开发，还要充分利用已经成熟的模块，不得单独重新开发。
当碰到特殊业务需要时，如果公司已有模块不能满足需求，经过公司技术委员会评估确认以后可以为特定项目单独开发某一模块。
当开发过程碰到模块中不能满足系统需要的缺陷时，开发人员提交给软件技术研发一部，由软件技术研发一部根据缺陷的严重程度和紧迫性立即更新软件或者在模块的下一个版本中进行修复或改进。
目前公司规定统一使用的模块如下表所列：
表 6 公司规定统一使用的模块
第三节模块的使用
当开发项目需要使用到某个模块时，就需要从模块资源库中获取该模块的相关资源（请与技术支持联系），包括模块程序代码、模块配置文件、模块相关脚本等。一个模块的资源包括以下几个部分。
表7 模块包括的资源
注：各个模块并不包含上表中所列举出的所有文件或文件目录。
Java开发规范
Java开发规范
目录 第1章序言 (4) 第2章java一般性研发规范 (5) 2.1 代码格式 (5) 2.1.1包、类、方法的命名规范: (5) 2.1.2方法的命名应注意避免与java中具有特殊意义的名称例如equals， hashCode，clone，finalizer等冲突 (7) 2.1.3Java bean中取得boolean类型的属性值必须使用is****形式命名 (9) 2.1.4if,else,while,for等必须使用{} (9) 2.1.5类必须包含在包里，禁止出现无包的类 (10) 2.1.6类和方法必须拥有注释，注释量占总体代码25%以上，类头部，以及方法 头部的注释应符合javadoc标准。 (11) 2.2 基本语法 (12) 2.2.1不能随意捕捉异常，原则上谁捕捉谁处理 (12) 2.2.2if，while，try，finally，switch ，synchronized ，static instantiation 里面应有相应的逻辑处理，不能为空。 (13) 2.2.3在处理循环中，不能在程序中人为的改变步长。 (14) 2.2.4将简单类型int，short，float，double等转化成字符串时，需使用其对 应类的toString方法。 (14) 2.2.5javaBean中hashCode，以及equals方法必须同时override。 (15) 2.2.6懒式方式创建对象：不能采用双检查惯用法 (18) 2.2.7不能在finally中返回值。 (19) 2.2.8Boolean实例化时，应用使用Boolean.valueOf，Boolean.TRUE， Boolean.FALSE。 (19) 2.2.9Integer,Byte,Short,Long等实例化时，应用使用valueOf (20) 2.2.10对于多个if语句嵌套的情况下能够整合尽量整合。 (20) 2.2.11override function，不能只有super.function语句，否则视为无效代码 21 2.2.12Collection.toArray的注意事项。 (21) 2.2.13对于BigDecimal方法，应避免使用float值，double值进行创建，应使 用字符串形式创建。 (22) 2.2.14String,BigDecimal,BigInteger等值类型调用replace，add等方法的注 意事项。 (23) 2.2.15需要注意的引起NullException的语句。 (23) 2.2.16ResultSet使用next时，需要判断是否具有记录再进行一下步操作。 25 2.2.17字符串使用相应的规则。 (25) 2.2.18禁止直接调用 System.gc(),System.getRuntime().gc(),System.runFinalization()。 (27) 2.2.19finalize相应的规则。 (27) 2.2.20禁止在代码中使用System.out,ex.printStackTrace打印日志。 (28) 2.2.21系统资源释放（谁创建的，谁关闭） (29) 2.2.22使用Clone时相应的规则。 (32) 2.2.23java Bean类必须实现Serialize接口。 (33)
Java编程规范试题
姓名： ____________ 工号：_______________ 部门：____________ 成绩： 一. 判断题(共15题，每题2分，直接在括号内打“/或“X”) 1、任何时候都不要使接口可以序列化。x 2、相对独立的程序块之间、变量说明之后必须加空行。V 3、当程序需要释放对象的时候，应该手工调用fin alize 方法以释放对象。x 4、公司的规范要求注释率是20%以上，并且必须有助于对程序的阅读理解。x 5、为了程序更加简洁，我们应该尽量使用下面的方式来赋值： a = b = 1 。x 6、每个类都需要定义构建器。x 7、类名、方法名、属性名的命名，都应该使用意义完整的英文描述。V 8、main() 方法的定义是public static void main(String args[]) 。x 9、常量名应该使用全大写，英文单词之间用下划线或者-分隔开。并且，常量应该使用final static 修饰。x 10、公有方法参数名可以和属性名相同，但局部变量不能和属性名相同。V 11、一两行代码就能完成的功能没有必要编写方法实现。x 12、对于模块间接口方法的参数的合法性检查，调用者和被调用者都应该对参数进行合法性检查。 x 13、运行期异常使用RuntimeException的子类来表示，必须在方法声明上加throws子句。x非运行 期异常是从Exception继承而来的，不用在可能抛出异常的方法声明上加throws子句。x 14、使用Objectstream 的方法后，调用release()，释放对象。X 15、减小单个方法的复杂度，使用的if, while, for, switch 语句要在10个以内。V 二、单项选择题(共23题，每题2分) (c ) 1、排版时，代码缩进应该采用的方式是： (A)Tab缩进 (B)2个空格缩进
JAVA开发规范文档
Java 开发规范文档 一：目的 使本组织能以标准的，规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性，可读性，可修改性，可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。 二：代码组织与风格 1：长度：为便于阅读和理解，单个函数的有效代码长度当尽量在100行以内（不包括注释行），当功能模块过大时往往采用使用子函数将相应的功能抽取出来，这也有利于提高代码的重用度。 2：单个类不宜过大，当出现此类过大时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过1500行。尽量避免使用大类和长方法。3：间隔：类，方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。操作符两端应当各空一个字符以增加可读性。 三：注释 1：注释应该增加代码的清晰度。代码注释的目的时要使代码更易于被其他开发人员等理解。2：保持注释的简洁。 3：注释信息应该包括代码的功能。 4：除变量定义等较短语句的注释使用行尾注释外，其他注释当避免使用行尾注释。 5：JavaDoc规范 对类，方法，变量等注释需要符合javadoc规范，对每个类，方法都应详细说明其功能条件，参数等。类注释中应当包含版本和作者信息。 1）类，接口注释在类，接口定义之前当对其进行注释，包括类，接口的目的，作用，功能，继承于何种父类，实现的接口，实现的算法，使用方法，示例程序等。 2）方法注释以明确该方法功能，作者，各参数含义以及返回值等。
3）其他注释应对重要的变量及不易理解的分支条件表达式加以注释，以说明其含义等。四命名规范 1：对变量，类，接口及包的命名应该使用英文。严禁使用汉语拼音及不相关单词命名。更不可以使用汉字来进行命名。采用大小写混合，提高名字的可读性。一般应该采用小写字母，但时类和接口的名称的首字母，以及任何中间单词的首字母应该大写。包名全部小写。 2：尽量少用缩写，但如果一定要用，当使用公共缩写和习惯缩写等，如implement可缩写为impl，manager可缩写成mgr等。 3：包名一般以项目或模块名命名，少用缩写和长名，一律小写。 包名按照如下规定组成[基本包].[项目名].[模块名].[子模块名].…. 如：org.skyinn.skyhome.dao.hibernate。 不得将类直接定义在基本包下，所有项目中的类，接口等都当定义在各自的项目和模块包中。 4：类，接口所有单词首字母大写，最好能够见名知意。一般采用名词。接口可带I前缀。 或able，dao后缀。 5：字段常量采用完整的英文大写单词，单词之间用下划线连接，如DEFAULT_V ALUE. 6：变量和参数对不易识别出该变量类型的变量应使用类型缩写作其前缀，如字符串使用strXXX，boolean使用isXXX，hasXXX等等。除第一个单词外其余单词的首字母大写。7：集合采用复数名称来表示队列中存放的对象类型，名词采用完整的英文描述。 例如：Vector vProducts= new Vector(); Array aryUsers= new Array(); 8：方法方法的名称应采用完整的英文描述，大小写混合使用：所有中间单词的第一个字母大写。方法名称的第一个单词常常采用一个强烈动作色彩的动词。取值类使用get前缀，设置类使用set前缀。例如getName（），setSarry（）。 9：异常类名由表示该异常类型的单词和Exception组成，如ActionException。异常实例一般使用e，ex等。 10：数组的命名 数组应该总是用下面的方式来命名：byte[] buffer; 而不是：byte buffer[]; 五：类与接口 1：基本原则：一个类只做一件事情。另一个原则时根据每个类的职责进行划分，比如用User 来存放用户信息，而用UserDAO来对用户信息进行数据访问操作，用UserServer对用户信息的业务操作等等。多个类中使用相同方法时将其方法提到一个接口中或使用抽象类，尽量提高重用度。不希望被实例化的类的缺省构造方法声明为private。 2：一般而言，接口定义行为，而抽象类定义属性和共有行为，注意2者的取舍，在设计中可由接口定义公用的行为，由一个抽象类来实现其部分或全部方法，以给子类提供统一的行为为定义。 六：方法 一个方法只完成一项功能。方法参数类型和参数返回值尽量接口化，以屏蔽具体的实现细节，提高系统的可扩展性，例如：public void addUser（List userList）{} public List listAllUsers（）{} 七：Web 命名规范 一：jsp页面命名 对于某个功能块的增删改查页面定义，最好使用
华为JAVA编程规范
1 Java 编程规范 1.1 排版 1.1.1 规则 规则1程序块要采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。(1.42+) 说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。 规则2分界符（如大括号…{?和…}?）应各独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序 或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+) 示例: if (a>b) { doStart(); } 规则3较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐， 语句可读。(1.42+) 示例： if (logger.isDebugEnabled()) { logger.debug("Session destroyed,call-id" + event.getSession().getCallId()); } 规则4不允许把多个短语句写在一行中，即一行只写一条语句(1.42+) 说明：阅读代码更加清晰 示例：如下例子不符合规范。 Object o = new Object(); Object b = null; 规则5if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。 (1.42+) 说明：阅读代码更加清晰，减少错误产生 示例： if (a>b) { doStart(); }
JAVA开发规范
1.编程规范 (一)命名规范 1.【强制】所有编程相关的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束 反例：_name / name_ / $name / name$ 正例：name 2.【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。 反例：XingMing [姓名] /xingBie() [性别] 正例：name[姓名] sex[性别]等国际通用的名称，可视为英文。 3. 【强制】类名使用UpperCamelCase(第一个词的首字母，以及后面每个词的首字母都大写，叫做“大骆驼拼写法”) 风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / DTO / VO / DAO 等。正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
4. 【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase (第一个词的首字母小写，后面每个词的首字母大写，叫做“小骆驼拼写法”)风格，必须遵从驼峰形式。 正例： localValue / getHttpMessage() / inputUserId 5. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。 正例： MAX_STOCK_COUNT 反例： MAX_COUNT 6. 【强制】抽象类命名使用 Abstract或Base 开头；异常类命名使用 Exception结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。 7. 【强制】中括号是数组类型的一部分，数组定义如下：String[] args; 请勿使用String args[]的方式来定义 8. 【强制】POJO类中的任何布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。 反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是isSuccess()，RPC框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。
Java编程规范
Java编程规范本文引用阿里Java开发手册。GitHub阅读地址： 目录 编程规约 - 命名规约 - 常量定义 - 格式规范 - OOP规约 - 集合处理 - 并发处理 - 控制语句 - 注释规约 - 其他 - 异常处理 - 建表规约 - 索引规约 - SQL规约
- ORM规约 编程规约 命名规约 1、【强制】所有编程相关命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束 反例： _name / __name / $Object / name_ / name$ / Object$1 2、【强制】所有编程相关的命名严禁使用拼音与英语混合的方式，更不允许直接使用中的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即纯拼音的命名方式也要避免采用。 反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3; 正例： ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称，可视为英文。12345 3、【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名） DO / DTO / VO / DAO 等。 正例： MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例： macroPolo / UserDo / XMLService / TCPUDPDeal
/ TAPromotion123 4、【强制】方法名、参数名、成员变量、局部变量都统一只用 lowerCamelCase 风格，必须遵从驼峰形式。 正例： localValue / getHttpMessage() / inputUserId1 5、【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。 正例： MAX_STOCK_COUNT 反例： MAX_COUNT123 6、【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。 7、【强制】中括号是数组类型的一部分，数组定义如下：String[] args ; 反例：请勿使用 String args[] 的方式来定义1 8、【强制】 POJO 类中的任何布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。 反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是 isSuccess()， RPC框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。1 9、【强制】包名统一使用小写，点分隔符之间有且仅有一
java项目团队开发规范
项目团队开发规范
修订历史记录
目录 1引言 (6) 1.1 编写目的 (6) 1.2 预期读者 (6) 1.3 编写背景 (6) 2概述 (7) 2.1 目标 (7) 2.2 修改及完善 (7) 3详细规范 (7) 3.1 使用的工具 (7) 3.2 框架设计 (7) 3.3 包目录 (8) 3.4 编码规范 (10) 3.4.1 目的 (10) 3.4.2 依据 (10) 3.4.3 具体规范 (10) 3.4.3.1 编码风格 (10) 3.4.3.1.1 缩进 (10) 3.4.3.1.2 空格 (11) 3.4.3.1.3 对齐 (12) 3.4.3.1.4 空行 (12)
3.4.3.1.5 代码长度 (13) 3.4.3.1.6 行数 (13) 3.4.3.1.7 注释 (14) 3.4.3.2 代码效率 (17) 3.4.3.2.1 综述 (17) 3.4.3.2.2 具体实现 (17) 3.4.3.3 异常处理 (17) 3.4.3.3.1 处理CHECK 异常与UNCHECK异常 (17) 3.4.3.4 程序调试 (17) 3.4.4 日常交流 (18) 3.4.4.1 互相促进 (18)
1引言 1.1 编写目的 本文档作为项目团队开发规范的说明书，描述了项目开发过程中的使用的工具，框架，代码编写规范及注意问题，作为项目团队建设，开发及测试工作的依据。 1.2 预期读者 本文档的预期读者包括以下几类： ?项目组长 ?项目组全体成员 1.3 编写背景 根据公司现有的开发状况，决定组件稳定的项目开发团队，制定全体团队成员共识的开发规范，有助于提高项目开发的效率、项目团队整体水平的提升。
java开发文档
Java 开发规范 1．命名规范 1.包命名规范： 1.业务模块的包命名格式如下: src/业务模块名称 2.Service接口的包命名格式如下: com.greencloud.service 3.Service接口实现类的包命名格式如下:com.greencloud.service.impl 4.Dao 接口的包命名格式如下：com.greencloud.dao 5.Dao 接口的实现类的包命名格式如下：com.greencloud.dao.impl 6.Fa?ade接口的包命名格式如下: com.greencloud.service.facade 7.Fa?ade接口的实现类的包命名格式如下：com.greencloud.service.facade.impl 8.业务域对象的包命名格式如下:com.greencloud.entity 9.异常类的包命名格式如下：com.greencloud.exception 10.枚举类的包命名格式如下：com.greencloud.enum 11.常量类的包命名格式如下：com.greencloud.contant 12.帮助类的包命名格式如下：com.greencloud.util 2.类命名规范： 1.Service接口的命名格式如下: I+表名+service 2.Service接口实现类的命名格式如下: 表名+serviceImpl 3.Dao 接口的命名格式如下：I+表名+dao 4.Dao 接口的实现类的包命名格式如下：表名+daoImpl 5.Fa?ade接口的命名格式如下: I+包名+facadeService 6.Fa?ade接口的实现类的命名格式如下：包名+facadeServiceImpl 7.业务域对象的命名格式如下:表名 8.异常类的命名格式如下：描述异常情况+exception 9.枚举类的命名格式如下：描述枚举情况+enum 10.常量类的命名格式如下: 描述常量情况+contant 11.帮助类的命名格式如下: 描述帮助类型+util 3.方法命名规范： 1.查询单个实体对象的方法命名格式: 1.查询单个的实体对象：load+实体对象名+by+字段名 2.如果类中只存在一个加载实体对象的方法:load+实体对象名 3.如果加载一个实体对象需要多个字段组合查询:load+实体对象名+by+最核 心的查询字段或者load+实体对象名+by+ 核心字段1+And+核心字段2 4.失败抛出flex.messaging.service.ServiceException异常或者它的子类 5.成功返回实体对象 例如：通过code字段查询CodeBase实体对象 public CodeBase loadCodeBaseByCode(String code) throws ServiceException 2.查询多个实体对象的方法命名格式:
Java编程要求规范精彩试题
JAVA编程规范--试题 姓名：工号：部门：成绩： 一. 判断题（共15题，每题2分，直接在括号内打“√”或“×”） 1、任何时候都不要使接口可以序列化。x 2、相对独立的程序块之间、变量说明之后必须加空行。√ 3、当程序需要释放对象的时候，应该手工调用finalize方法以释放对象。x 4、公司的规范要求注释率是20％以上，并且必须有助于对程序的阅读理解。x 5、为了程序更加简洁，我们应该尽量使用下面的方式来赋值：a = b = 1 。x 6、每个类都需要定义构建器。x 7、类名、方法名、属性名的命名，都应该使用意义完整的英文描述。√ 8、main() 方法的定义是public static void main(String args[])。x 9、常量名应该使用全大写，英文单词之间用下划线或者-分隔开。并且，常量应该使用 final static修饰。x 10、公有方法参数名可以和属性名相同，但局部变量不能和属性名相同。√ 11、一两行代码就能完成的功能没有必要编写方法实现。x 12、对于模块间接口方法的参数的合法性检查，调用者和被调用者都应该对参数进行合 法性检查。x 13、运行期异常使用RuntimeException的子类来表示，必须在方法声明上加throws子句。 x非运行期异常是从Exception继承而来的，不用在可能抛出异常的方法声明上加throws 子句。x 14、使用ObjectStream 的方法后，调用release() ，释放对象。X 15、减小单个方法的复杂度，使用的 if, while, for, switch 语句要在10个以内。√ 二、单项选择题(共23题，每题2分) （ c ）1、排版时，代码缩进应该采用的方式是： （A）Tab缩进 （B）2个空格缩进 （C）4个空格缩进 （D）8个空格缩进
java开发规范文档
一千零一夜产品部系统开发规范V1.0 一千零一夜途遇科技有限公司 2015-11-03
修改记录 目录 1前言 (4) 2开发管理 (4) 3项目周期 (4) 4命名规范 (5) 4.1项目编号命名规范 (5) 4.2文档命名规范 (5) 4.3路径管理 (5) 4.4jsp/html命名规范 (6) 4.5数据库命名规范 (8) 4.5.1表名规范 (8) 4.5.2字段规范 (8) 5文档规范 (8) 6代码规范 (9) 6.1Java源代码规范 (9) 6.1.1命名 (9) 6.1.2代码格式 (11) 6.1.3注释 (12) 6.1.4其他 (13) 6.2jsp/html代码规范 (13) 6.3数据库开发规范 (15) 6.3.1主键 (15) 6.3.2日期类型 (16) 6.3.3固定字段 (16) 6.3.4取值规范 (16) 6.3.5数据库开发工具 (16)
6.3.6Sql书写规范 (17) 6.4其他规范 (17) 7实战代码规范 (18) 7.1Java源代码规范 (18) 7.1.1java代码命名与格式 (18) 7.2jsp/html代码规范 (26) 8FAQ (29) 8.1Logic类中新增数据方法怎么写 (29) 8.2Logic类中修改数据方法怎么写 (30) 8.3Logic类中删除数据方法怎么写 (31) 8.4怎样创建一个没有底部按钮的窗口 (32) 8.5怎样设置弹出窗口的标题 (32) 8.6怎样重写提交数据的方法 (33) 8.7怎样创建单grid的页面 (33) 8.8怎样多个页签的grid的页面 (34) 8.9怎样创建左边树右边grid的页面 (34) 9代码检查规定 (34) 10附录1：JPA使用指南javax.persistence的注解配置 (34)
javaweb开发规范
Java web开发规范 1、前言 为了使软件开发过程有章可循，保证软件质量，加强开发管理。 2、开发管理 项目进度周报表格如下： 项目编号汇报人汇报日期项目进度详细描述其他问题 3、命名规范 3.1项目编号命名规范 命名方式：项目英文/中午拼音名称_开发组编号_序列号 序列号由3为数字组成，不足的用’0’补齐。 3.2文档命名规范 命名方式：项目英文/中午拼音名称_文档名称_序列号_编写人名称/编号 3.3jsp/html命名规范 1、jsp与html文件名全部小写，并遵循如下的规范： a.数据/内容显示页: 名词，多个单词用下划线分隔，要求能说明显示内容的信息，为避免冲突，可加上“_list”。例如： new_message.html或my_file_list.jsp b.操作处理页 命名格式：名词_下划线_动词，例如：file_delete.jsp。 c.含frame页面