《(AOS、JAVA)开发规范》由会员分享，可在线阅读，更多相关《(AOS、JAVA)开发规范（18页珍藏版）》请在金锄头文库上搜索。
1、软件产品开发规范（Java）1 .AOS开发规范1.1包命名1、包结构规定 包主要分为两类：第一类为系统公共包com.gxhtjs. tools 该包主要存放对数据库操作的增删查改的基本通用类。第二类为系统功能模块业务处理包，每个包都为一个独立的功能模块第三类为数据库操作包。2、包命名格式如：命名：以com.gxhtjs开头，最后个为英文单词不能用拼音缩写。3、包结构说明tools 工具包，该包的类都是具有通用性的包(包括通用算法类，数据库操作同类)。biz 业务处理包，将用来处理相关业务的类放入此包。如果相关的类是提供给页面调用时类在命名如：UserBizPlugin 表示用户信息业务处理插
2、件。dao 数据库操作包，即对数据库表进行操作时，一般会以表名建立对应类用来操作对应的表。dao包中的所有具体操作类都将集成数据通用类。1.2表单命名规范 1、表单目录机构 如下图按系统大的功能模块，每个模块都是一个独立的包，包的命名必须符合英文帕斯卡命名规范。2、AOS项目文件名命名规范：所有的文件命名必须以gxhtjs_项目名_大模块名_小模块名.xml进行命名。例如: gxhx_gxncpsg_xxcj_yhdddjc_sbwsjy.xml 销售统计-银行对账单稽查-上报无实际有form的命名规则同文件名命名方式：如：gxhx_gxncpsg_xxcj_yhdddjc_sbwsjy 企业
3、无系统有3、SQL语句编写SQL可以通过建立对应表的SQL xml，也可以在form上直接编写SQL尽量使用预编译的形式编写SQL特别是查询SQL。插件的开发规必须符合JAVA编程规范。1.3页面控件命名组件命名规范Button 按钮控件如：btnSubmitCheckBox 勾选框控件如：ckbGoodsCombox 下拉列表控件如：cbxFootboorDateChooser 日期选择控件如：dceTimesEdit 输入框控件如：edtNameIn 整数输入控件如：inMcountFloat小数输入框如：fltSellPriceHidden 隐藏值控件如：hidOrgidFlatButt
4、on 平按钮控件如：fbtnSubmitHSeperator 水平分隔线如：hprLineInSession session值控件如：isnOrgNameLabel 标签控件 如：lblNameListBox 列表控件如：lbxGoodsInfoPassword 密码控件如：pwdUserPasswordPrint 打印控件如：prtFpInfoReferEdit 参照控件如：retNsrsbhSeperator 垂直分隔线如：sprDownLineSpace 空方块控件 如：spePlanText 文本输入控件如：txtUserNameTextSeperator 带标题的水平分隔线如：tst
5、LineTitle 标题控件如：titHeadInfoTrueFalseBox 双值控件如：tfbNumbersFileDownloader 文件下载控件如：fdlFileNameFileUploader 文件上传控件如：fupFileNameSTreeWidget 勾选框树控件如：stwOrgTreeTreeWidget 树控件如：twdOrgTreeDatagrid表格组件如：dtgUserListToolbar工具条组件如：tlbMyToolBar2JAVA编程规范2.1命名规则2.1.1.1包结构与类名前缀为了便于管理Java开发的应用，Java开发的应用包命名要求带有前缀com，采用
6、“”的形式，如com.bcl表示基础工具包。在日常项目应用中积累的公共的内容希望能够形成通用的工具包，供项目组使用，工具包与应用包同级，采用“”的形式来组织项目开发的程序代码。包名和子功能包名要求具有实际的意义，从单词或缩写上能够看出包的意义，如 “com.bcl”表示基础工具组件的包，纳入公司的基础构件库进行管理，应用的包由项目组自己命名，命名的意义与具体的项目应用的意义相符。2.1.1.2类命名(1) 类名首字母应该大写，字段、方法以及对象（句柄）的首字母应小写。对于所有标识符，其中包含的所有单词都应紧靠在一起，而且将中间单词的首字母大写。例如：ThisIsAClassNamethisIs
7、MethodOrFieldName若在定义中出现了常数初始化字符，则大写static final基本类型标识符中的所有字母。这样便可标志出它们属于编译期的常数。Java包（Package）属于一种特殊情况：它们全都是小写字母，即便中间的单词亦是如此。对于域名扩展名称，如com，org，net或者edu等，全部都应小写（这也是Java 1.1和Java 1.2的区别之一）。(2) 一行不要超过80个字符，并要注意折行时的写法。下面是例子：someMethod(longExpression1, longExpression2, longExpression3, longExpression4, l
8、ongExpression5);var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3); 变量命名（Attributes/Properties）在本规则中，变量表示一个类属性（Attribute/Property）或一个类方法中的变量。变量可以是简单数据类型，如整数或浮点数，也可以是一个对象，如客户帐户、操作员等。本变量命名规则还包括一类特殊的变量：枚举数据常量2.1.2.1简单数据类型循环计数器在不影响程序可读性的前提下，可以使用传统的变量命名方式，如i、m、n等。除计数器以外的简单数据
9、类型的变量由小写字母前缀+大写字母起头的英文单词（或单词缩写）组成。当然，循环计数器也可以使用这种命名方式，如nLoopCounter。数组在变量名前缀后加数组前缀“a”。简单数据类型前缀表：数据类型变量名前缀例子booleanbbCustomExist, baCustomExistcharccSymbol, caSymbolsbyteyyByte, yaBytesshortssHour, saHoursintnnLen, nLoopCounter, naLengthlongllMemory, laTimesfloatffLength, faLengthdoubleddMile, daMile
10、s注：byte与int类型的前缀较特殊，使用时应注意2.1.2.2类实例命名类实例采用以下两种命名方法：1对于可以使用单个单词表示并且该单词与类名一致（不含类名的前缀）的类实例，可以使用全部是小写字母的实例名。例如operator（类WFOperator的实例）、task（类WFTask的实例）、date（类Date的实例）。2其它情况下使用以小写字母表示的类名（也可以是类名的缩写）和以大写字母起始的名称组成的标识名。例如strOperatorName、dateStart、customerList。常用的类名缩写如下表：类类名缩写例子Exceptionee, eAllExceptionSSBu
11、siExceptionbebe, beLowBalanceSSDbAccessdbadba, dbaManagement, dbaCIFSSLogiExceptionlele, leInvalidValueStringstrstrOperatorName, strAddressWFOperatoropopCustomerManager, opDepartmentManager3类实例数组或集合的命名，可以在前两种情况的基础上用单词的复数形式表示，如tasks、opDepartmentManagers，也可以在变量前面加前缀“some”表示，如someTask、someOperator。2.1.
12、2.3枚举数据常量枚举数据常量由表示枚举类型的前缀和常量名称组成。前缀全部由小写字母组成，名称使用大写字母起头的英文单词。例如交易类型的枚举常量命名如下：不明交易类型requestUnknown菜单请求requestMenuPrepare任务准备requestTaskPrepare任务提交requestTaskProcess提交requestReverseProcess登录requestLogin系统应用准备requestSysAppPrepare系统应用提交requestSysAppProcess2.1.3.1存取类型的类方法命名对于直接操作类属性的方法，命名使用前缀“get”、“is”和“
13、set”表示存或取类属性，后跟大写字母起头的英文单词。示例如下：FieldTypeGetternameSetternamefirstNameStringgetFirstName()setFirstName()addressSurfaceAddress objectgetAddress()setAddress()persistentBooleanisPersistent()setPersistent()customerIdIntgetCustomerId()setCustomerId()orderItemsArray of OrderItem objectsgetOrderItems()setO
14、rderItems()2.1.3.2一般类型的类方法命名使用“动词”+“名词短语”的命名格式，其中动词使用小写字母。例如invokeProduct()、analyseRiskItem()、openAccount()、refreshOutPutStream()2.2源程序结构源程序按以下结构进行组织：程序区说明Package区使用关键字“package”定义当前类的包系统import区用户import区类说明类成员属性定义类方法定义注意：为了便于使用文档工具自动生成程序文档，程序员必须严格遵守格式说明。2.3 Package区定义类所属的包，例如：package Main;2.4 Package区定义需要引入的系统资源，例如：2.5用户import区定义需要引入的本系统内部的包，例如：import SS.*;import App.*;2.6类说明类说明使用如
