您的位置：360文档中心› java项目接口实现规范

java项目接口实现规范

java项目接口实现规范
java项目接口实现规范

项目接口实现规范

1：作用

项目开发过程中为了增加程序的可读性和程序的健壮性，方便后期程序的调试和维护，所以需要在开发过程中统一技术规范

二:目录

1.系统框架中模块功能，文件目录和文件名的规范

2.程序代码中文件名类名变量名接口名等规范

3.代码的书写的规范

4.数据库中表名字段名数据类型等规范

三:详细内容

说明

常用的命名风格如下。

(1)Pascal风格：包含一到多个单词，每一个单词第一

个字母大写，其他字母小写，其余字母均小写。例如：CollegeStudent、HelloWorld等。

(2)Camel风格：包含一到多个单词，第一个单词首字

母小写，其余单词首字母大写，其他字母均小写。例

如：name、gender、somePara等。

1.系统框架功能模块、文件目录和文件名的规范

(1)功能模块命名规范

数据访问层(DAO)——BaseDao，与数据库打交道的唯一方式；位于最底层；

业务逻辑层(SERVICES)——与业务有关的操作，以上三层多不与业务逻辑有关;

通用工具层(COMME)——与项目无关、可独立的类库。

系统管理层（SYSCONTROLLER）系统管理常用接口比如系统日志系统版本系统信息等

控制管理层(CONTROLLER)—对业务进行控制

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.编程规范 (一)命名规范 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项目团队开发规范

项目团队开发规范

修订历史记录

目录 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编程规范--试题 姓名：工号：部门：成绩： 一. 判断题（共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)

Java安全开发规范

Java安全开发规范

第1章前言 为提高应用安全水平，特制定本规范对代码编制进行规范。 规范中的安全要求按照严格程度分为三级： Policy 必须遵循的策略，实现方法可以自定义，但不能外翻策略的规定。 Discipline 必须遵守的纪律，必须按照规定中的描述实施，绝对不能违反。 Guideline 建议性的指南和规范，将逐步要求遵循实施。 第2章Java安全性开发规范 2.1跨站脚本XSS ?风险及危害性： 跨站脚本XSS指利用网站漏洞从用户那里恶意盗取信息。用户在浏览网站、使用即时通讯软件、甚至在阅读电子邮件时，通常会点击其中的链接。攻击者通过在链接中插入恶意代码，就能够盗取用户信息。攻击者通常会用十六进制（或其他编码方式）将链接编码，以免用户怀疑它的合法性。网站在接收到包含恶意代码的请求之后会产成一个包含恶意代码的页面，而这个页面看起来就像是那个网站应当生成的合法页面一样。许多流行的留言本和论坛程序允许用户发表包含HTML和javascript的帖子。假设用户甲发表了一篇包含恶意脚本的帖子，那么用户乙在浏览这篇帖子时，恶意脚本就会执行，盗取用户乙的session信息。 如何导致XSS攻击，一般来说来自http的post，或者get方式取得参数值很可能为恶意代码，如果开发者直接用这些参数组合成http链接，用户点击该

连接，就会造成XSS攻击风险。 ?应对措施 开发者要保证代码的安全性，使其免受XSS攻击，可采取以下措施： 1．过滤或转换用户提交数据中的HTML代码。 2．限制用户提交数据的长度 ?非安全代码示例 <% String mofWindowId =request.getParameter("mofWindowId"); %>

?安全代码示例 <% String mofWindowId=XSSCheck.getParameter(request,”mofWindowId”); %> 注：XSSCheck为公用工具类，用于XSS检查，其getParameter实现逻辑如下： 1、通过参数名称，从请求中取得参数值。 2、将&,<,>,’,”转义: & -> & < -> ⁢ > -> > “ -> " ‘ -> ´ 3、返回安全的字符串。 2.2违反信任边界规则（Trust Boundary Violation） ?风险及危害 一个受信任的边界可以被认为是由系统划出的边境，例如session,attribute，aplication,数据库，文件等在服务端存储边界都认为是受信任的。反之来来自http的post，或者get方式取得参数值是不受信任的。凡

JAVA编程规范

1 Java 编程规范 1.1 排版 1.1.1 规则 规则1程序块要采用缩进风格编写，使用TAB缩进，而不是替换为空格。(1.42+) 规则2分界符（如大括号‘{’和‘}’）左大括号“｛”与函数名或上文语句在同一行，而不是独占一行。(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(); } case x: { int i = 9; } 规则6相对独立的程序块之间、变量说明之后必须加空行。(1.42+)

Java编程规范(DOC)

Java编程规范 目录 Java编程规范 (1) 1编码规则 (1) 2命名规范 (7) 2.1类名、变量名（非final）、方法名 (7) 2.2驼峰式命名 (7) 2.3不能使用没有任何含义的英文字母进行命名 (7) 2.4不能使用拼音进行命名，统一使用准确的英文进行命名 (8) 2.5包名 (8) 2.6接口与类的命名 (8) 2.7抽象类命名 (8) 2.8实现类命名 (8) 2.9工具类命名 (8) 2.10变量命名 (8) 2.115、方法命名 (9) 2.12系统的命名约定 (9) 1编码规则 1、数据库操作、IO操作等需要使用结束close()的对象必须在try -catch-finally 的finally中close()，如果有多个IO对象需要close()，需要分别对每个对象的close()方法进行try-catch,防止一个IO对象关闭失败其他IO对象都未关闭。 手动控制事务提交也要进行关闭，对大对象进行关闭操作 示例： try { // ... ... } catch(IOException ioe) { //... ... } finally { try { out.close();

} catch(IOException ioe) { //... ... } try { in.close(); } catch(IOException ioe) { //... ... } } 2、系统非正常运行产生的异常捕获后，如果不对该异常进行处理，则应该记录日志。 说明：此规则指通常的系统非正常运行产生的异常，不包括一些基于异常的设计。若有特殊原因必须用注释加以说明。 logger.error(ioe，“[类.方法]描述”,参数); 示例： try { //.... ... } catch(IOException ioe) { logger.error(ioe); } 3、自己抛出的异常必须要填写详细的描述信息。 说明：便于问题定位。 示例： throw new IOException("Writing data error! Data: "+ data.toString()); 4(删除)、在程序中使用异常处理还是使用错误返回码处理，根据是否有利于程序结构来确定，并且异常和错误码不应该混合使用，推荐使用异常。 说明： 一个系统或者模块应该统一规划异常类型和返回码的含义。 但是不能用异常来做一般流程处理的方式，不要过多地使用异常，异常的处理效率比条件分支低，而且异常的跳转流程难以预测。

Java项目组开发规范

目录

第一章概述 1.1 编写目的 为规范FSOP项目的开发实施工作，特制定本规范。 为了提高软件开发质量，降低开发周期，增强代码的可重用性和易读性，使软件便于维护，开发人员间便于交流和协作，特总结出开发规范，以为参考。 1.2面向读者 从事FSOP项目的开发、实施工作的相关人员。 1.3名词解释 本节对手册中涉及到的术语进行简单描述。

第二章程序结构 2.1包结构 项目中的所有代码，必须符合如下的结构： 1、各子系统的模块： 其中subsys是子系统的名称，module是模块的名称，xxServlet和xxHandler是模块下面的Servlet 和Handler，允许有多个Servlet和Handler同时存在，建议同一个模块下，用多套Servlet和Handler处理不同的业务对象；util存放该模块专用的类；package/class可以任意级别的包或者类； 2、子系统之外的模块： sm.{module}.servlet.[xxServlet] https://www.360docs.net/doc/503858815.html,mon.util.[xxUtil] https://www.360docs.net/doc/503858815.html,mon.hander.[xxHander] https://www.360docs.net/doc/503858815.html,mon.sql.[xxSql] https://www.360docs.net/doc/503858815.html,mon.entity.[xxxx] 其中sm是system manage的简写，其他同上； 3、公共的类： 含义同上。 2.2相关类 1、对于Servlet，必须继承ServletBase，必须在Servlet中处理与request和response相关的操作，一般是取参数和设置属性等操作； 2、对于Handler，必须继承HandlerBase，该类的方法中，不能用request和response作为参数，更不能用Servlet作为参数； 3、程序中使用到的SQL，一律在XXXSQLBuilder中进行拼写，该类属于util包，需要继承SQLBuilderBase，其构造函数为私有类型，并且要实现静态方法getSQLBuilder(conn)，根据不用的数据库类型，返回不同的实例。

java开发详细设计文档模板

一卡通管理程序说明 详细设计说明书 作者：唐庆龙 完成日期：2009/10/7 签收人：老师 签收日期：2009/10/10 修改情况记录：

目录 1 引言 (1) 1.1 编写目的 (1) 1.2 背景 (1) 1.3 定义 (1) 1.4 参考资料 (1) 2 程序系统的结构 (1) 3 程序1（标识符）设计说明 (2) 3.1 程序描述 (2) 3.2 功能 (2) 3.3 性能 (2) 3.4 输入项 (2) 3.5 输出项 (2) 3.6 算法 (3) 3.7 流程逻辑 (3) 3.8 接口 (3) 3.9 存储分配 (3) 3.10 注释设计 (3) 3.11 限制条件 (3) 3.12 测试计划 (3) 3.13 尚未解决的问题 (4) 4 程序2（标识符）设计说明 (4)

1 引言 1.1 编写目的 说明编写这份详细设计说明书的目的，指出预期的读者范围。 1.2 背景 说明： a．待开发的软件系统的名称； b．列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 程序系统的结构 用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。

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开发工作规范

Java开发工作规范

目录 1文档介绍 (4) 1.1文档目的与背景 (4) 1.2文档范围 (4) 1.3参考文献 (4) 1.4术语与缩写解释 (4) 2命名及通用约定规范 (4) 2.1源文件结构规范 (4) 2.1.1Web项目主要目录结构 (4) 2.2J AV A包命名规范 (5) 2.2.1web层 (5) 2.2.2manager层 (6) 2.2.3dao层 (6) 2.2.4单元测试包 (7) 2.3J AV A类及接口命名规范 (7) 2.3.1web层 (7) 2.3.2manager层 (7) 2.3.3dao层 (8) 2.3.4单元测试类 (8) 2.4J AV A方法命名规范 (8) 2.4.1web层 (8) 2.4.2manager层 (9) 2.4.3dao层 (11) 2.4.4单元测试 (11) 2.5J AV A方法返回值规范 (11) 2.6J AV A变量命名规范 (12)

2.7J AV A常量命名规范 (12) 2.8URL映射注解规范 (12) 2.9JSP文件命名规范 (13) 2.9.1JSP文件夹 (13) 2.9.2JSP文件 (14) 3JAVA代码风格规范 (14) 3.1代码格式 (14) 3.2注释 (15) 3.2.1注释类型 (15) 3.2.2注释的格式 (17) 3.2.3注释的内容 (18) 3.3变量声明及初始化 (19) 3.3.1每行声明变量的数量 (19) 3.3.2初始化 (20) 3.4语句 (20) 3.4.1简单语句 (20) 3.4.2复合语句 (20) 3.4.3返回语句 (21) 3.4.4if，if-else，if else-if else语句 (21) 3.4.5for语句 (22) 3.4.6while语句 (22) 3.4.7do-while语句 (23) 3.4.8switch语句 (23) 3.4.9try-catch语句 (24) 3.5空白 (24) 3.5.1空行 (25) 3.5.2空格 (25) 4单元测试规范 (26)

软件编程规范JAVA

1 范围 本标准规定了Java 语言的编程规范，主要包括基本原则、文件结构、注释、命名规则、声明、表达式与语句、类和接口等。 本标准适用于使用Java 语言编码的所有软件。 2 术语和定义 下列术语和定义适用于本标准。 2.1 原则 编程时应该坚持的指导思想。 2.2 规则 编程时必须遵守的约定。 2.3 建议 编程时必须加以考虑的约定。 2.4 说明 对此规则或建议的必要的解释。 2.5 正例 对此规则或建议给出的正确例子。 2.6 反例 对此规则或建议给出的反面例子。 3 基本原则 说明：简单 是最美。保持代码的简单化是软件工程化的基本要求。不要过分追求技巧，否则会降低程序的可读性。 说明：编程 首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，其次考虑程序的效率和资源占用。 说明：尽量选择可借 用的代码，对其修改优化以达到自身要求。 说明：事实

上，我们无法做到完全消除错误，但通过不懈的努力，可以减少同样的错误出现的次数。 4文件结构 程序布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、可维护性。更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量，提高开发效率，降低开发成本。同时，对于普通程序员来说，养成良好的编程习惯有助于提高自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题，而且涉及到产品质量，涉及到个人编程能力的提高，必须引起大家重视。 4.1基本格式 正例: package .**; （ati是自动化技术研究所的简写，不一定恰当） import .*; /** * 文件名称: 题目名称 * 文件描述: 本类描述 * 版权所有: 版权所有(C)2001-2004 * 公司: 大连理工大学自动化研究所 * 内容摘要: 4.2

Java安全开发规范

Java安全开发规范 第1章 前言 为提高应用安全水平，特制定本规范对代码编制进行规范。 规范中的安全要求按照严格程度分为三级： > Policy 必须遵循的策略，实现方法可以自定义，但不能外翻策略的规定。 > Discipline 必须遵守的纪律，必须按照规定中的描述实施，绝对不能违反。 > Guideline 建议性的指南和规范，将逐步要求遵循实施。 第2章Java安全性开发规范 2.1 跨站脚本XSS * 风险及危害性： 跨站脚本XSS指利用网站漏洞从用户那里恶意盗取信息。用户在浏览网站、使用即时通讯软件、甚至在阅读电子邮件时，通常会点击其中的链接。攻击者通过在链接中插入恶意代码，就能够盗取用户信息。攻击者通常会用十六进制（或其他编码方式）将链接编码，以免用户怀疑它的合法性。网站在接收到包含恶意代码的请求之后会产成一个包含恶意代码的页面，而这个页面看起来就像是那个网站应当生成的合法页面一样。许多流行的留言本和论坛程序允许用户发表包含HTML和javascript的帖子。假设用户甲发表了一篇包含恶意脚本的帖子，那么用户乙在浏览这篇帖子时，恶意脚本就会执行，盗取用户乙的session信息。 如何导致XSS攻击，一般来说来自http的post，或者get方式取得参数值很可能为恶意代码，如果开发者直接用这些参数组合成http链接，用户点击该连接，就会造成XSS攻击风险。 * 应对措施 开发者要保证代码的安全性，使其免受XSS攻击，可采取以下措施： 1．过滤或转换用户提交数据中的HTML代码。 2．限制用户提交数据的长度 * 非安全代码示例 <% String mofWindowId = request.getParameter("mofWindowId"); %> * 安全代码示例 <% String mofWindowId=XSSCheck.getParameter(request,"mofWindowId"); %>

Java开发规范(公司规范)

Java开发规范 第1章序言 本规范的目的在于：建立一个可行可操作的编程标准、约定和指南，以规范公司java代码研发工作。 2013年为公司的质量年，为了提高公司研发能力，该规范的制定是为了规范java代码开发，提高java开发质量，从代码的层面规范并提高java项目的研发水平。该规范由运营中心技术小组制定，运营中心技术小组将结合PMD检查工具以及相应的检查工具，组织技术监控人员对重点项目以及新的java项目定期检查，对代码质量进行评估，对代码质量较差限期整改，并报运营中心备案作为项目考核依据。 本规范适用于2013年公司java代码研发规范。本规范的内容包括两个方面：java开发一般规范，以及java代码开发安全性规范。Java代码开发一般规范主要从java基本语法，代码格式，耦合性以及设计方面，以及代码质量因子等进行描述；java代码开发安全性规范主要从sql注入，资源注入，跨站脚步，安全边界违例，系统信息泄露进行描述。 为了方便并配合PMD检查工具等相应检查工具，方便开发者针对违规代码进行调整，本规范中java一般开发规范描述形式将结合PMD，并提供示例代码，其形式如下： ?规范描述： ?PMD规则名称： ?PMD级别（注1）： ?违规示例代码：

?合法示例代码： 本规范中java安全开发规范部分将结合具体项目，对出现安全隐患的代码进行分析，以及相应的解决办法和思路上进行分析,其具体格式如下： ?风险及危害： ?应对措施： ?非安全代码示例 ?安全代码示例 本规范解释权归运营中心技术小组，属于运营中心为了提供公司研发水平以及质量的一系列措施中的一部分，在后续的版本中将根据具体需要进行修改以及调整。 技术小组审核后给出相应的整改意见，对于有争议的问题，可直接与运营中心技术小组领导成员沟通。 第2章要求 气象局项目组的所有java开发人员，编写的代码必须满足第三章的所有规范（每个标题为一个规范）。项目组成员之间每周或每月互相检查对方编写的代码，若发现问题，要求对方及时更正。项目经理应该随时抽查、并最终审查代码，保证代码的规范性。

java-web开发规范文档

Java web开发规范 1、前言 为了使软件开发过程有章可循，保证软件质量，加强开发管理。 2、开发管理 3、命名规范 3.1 项目编号命名规范 命名方式：项目英文/中午拼音名称_开发组编号_序列号 序列号由3为数字组成，不足的用’0’补齐。 3.2 文档命名规范 命名方式：项目英文/中午拼音名称_文档名称_序列号_编写人名称/编号 3.3 jsp/html命名规范 1、jsp与html文件名全部小写，并遵循如下的规范： a.数据/内容显示页: 名词，多个单词用下划线分隔，要求能说明显示内容的信息，为避免冲突，可加上“_list”。例如： new_message.html 或my_file_list.jsp b.操作处理页 命名格式：名词_下划线_动词，例如：file_delete.jsp。 c.含frame页面

中的name属性命名的格式是①xxx_②xxx_③xxx ①xxx部分用来标识当前页面隶属于整个系统中的哪一功能模块。 如：属于ebwebmail模块则写ebwebmail，其它情况依次类推。 ②xxx部分标识当前页面所要完成的功能。 如：完成用户登录的功能则被标识为login，其它情况依次类推。 ③xxx部分用来用来表示页面在浏览器窗口所处的位置。 处于浏览器窗口的顶部则标识为top，其它情况依次类推。 例如：ebwebmail_inbox_top.jsp src属性相应的文件名根据情况建议在原命名规范上用下划线加上所处窗口的位置。 2、javascript脚本文件命名方式： 脚本函数都以①xxx_②xxx的方式命名。 ①xxx对应页面隶属的模块。 ②xxx表示函数所要实现的功能(动宾结构)，多个单词用下划线连接。 例如：ebwebmail_send_mail() 模块通用的脚本函数必须集合于一个js文件中，在页面上通过形式导入。js文件名命名使用模块名，例如：ebwebmail.js。 如果项目已经提供了公共js脚本，则优先使用公共js脚本中提供的函数。 所有定义方法的