开发前约定.doc

开发前约定在开发项目前，要求每位开发小组成员都必须先阅读以下约定，严格按以下约定来进行开发。系统框架系统总框架采用SUN J2EE框架，使用JAVA技术和组件技术， 基于Web server。 开发环境开发环境Web server采用JDK1.4tomcat4.1.18，配置于windows2000下；数据库服务器IP为，数据库采用SQL Server2000。登录数据库用户名为：XXXXXX，口令为：XXXXXX数据库使用规范1.1服务器上有关数据库的一切操作只能由服务器管理人员进行。1.2程序中访问数据库时使用统一的用户、统一的连接文件访问数据库。1.3原则上只能建一个库，库中再包含若干表。1.4命名规则：（1） 数据库、表、字段、索引、视图等一系列与数据库相关的名称必须全部使用与内容相关的英文或汉语拼音缩写，可以考虑加下划线（_）连接，对照表的表名要求以cd_ 开头。 （2） 所有的名称必须统一使用英文小写字母。 （3） 所有的名称起始和结尾不能使用下划线（_）。 （4） 所有的名称不能包含26个英文小写字母、数字和下划线（_）以外的其他字符。 （5） 表结构中标志位含义统一用0和1表示，0为假，1为真。1.5不再使用的数据库、表应删除，在删除之前必须备份（包括结构和内容）。1.6数据应尽量符合sql92标准，sql句尽量避免出现“”或者substring等特定数据库相关函数。源代码目录规范每位开发小组成员一定要遵守以下创建源代码目录的规范1、目录的命名规则及结构目录的命名以模块名称的英文缩写或汉语拼音首字母缩写命名，如模块名称为工具，则目录名称为tools或gj（同一工程中只可采用一种命名规则）。项目开发目录结构（JSP文件目录结构）： (说明：根目录ROOT,此目录下放模块目录及代码)|-ModuleName（说明：此目录下放子模块目录和程序代码）项目开发目录结构（类文件目录结构）： (说明：根目录WEBINF)|-classes |-com |-sx |-xxxx (说明：此目录下放项目class文件) -doc(说明：文档目录) -src(说明：java类源文件) -bak(说明：备份文件) 2、文件命名规则及结构文件名以简要描述文件处理内容的英文缩写或汉语拼音首字母缩写命名，如调试，则文件名为debug.jsp或ts.jsp（同一工程中只可采用一种命名规则）。在每个文件（java源文件和jsp文件）头部需要说明如下内容：版本、版权所有、制作人、文件名称、文件功能。例如：文件名: xxxxxxxxxxxxxxxxxxxx说明: xxxxxxxxxxxxxxxxxx作者： xxxxxx版本号：xx.xx更新时间：200x-xx-xx编码规范：项目中jsp源文件字符集统一采用GBK字符集。需要注意的有：1) 使用自定义变量（包括全局变量、局部变量）之前必须先声明变量，并用注释语句标明变量的类型、用途、含义。 2) 自定义函数必须用注释语句标明函数的用途、参数的数据类型、意义，返回值的类型。3) 程序中重要的过程或代码较长的过程应使用注释语句标明该过程的起始行和结束行，并注明该过程的功能。4) 数据库操作统一使用DBA数据库组件，数据库操作中应用try / cache / finally的写法，尽量捕捉所有可能出现的异常错误，尽量避免一个try囊括所有程序代码，以便调试时方便排错。每位开发小组成员一定要绝对遵守这个规范。当实际应用与上面的规范相抵触时，必须经过项目负责人批准，并记录下原因、潜在后果，以及符合规范需要的条件，同时要求程序必须具有良好的可读性。异常处理和日志程序中所有的异常处理和应用日志记载使用统一处理异常处理bean的名称为com.sx.xxoa.controller.util.ApplicationException。日志记载bean的名称为com.sx.xxoa.controller.util.LogMsg。Session的管理和调用当前系统中已知的session变量名有rbs，rbs为16位用户标识。页面管理JSP页面中的通用图片、CSS、JS和一些通用工具文件都应放在统一目录，目录为/xxoa/common，图片放在xxoa/common/images/目录里，CSS文件放在xxoa/common/css目录里，脚本放在xxoa/common/