项目规范和基本配置.docVIP

项目规范和基础配置 项目规范说明 1.1名词解释驼峰命名法：就是当变量名或函数名是由一个或多个单字连结在一起，而构成的唯一识别字时，第一个单字以小写字母开始；第二个单字的首字母大写或每一个单字的首字母都采用大写字母，例如 ：myFirstName、myLastName，这样的变量名看上去就像骆驼峰一样此起彼伏，故得名。 首字母大写的驼峰命名法：在驼峰命名法基础上首字母大写。数据库中表、视图、字段的命名 a) 数据库表命名需以 T 开头，后接表的英文简写（首字母大写的驼峰命名法），如 TUser 表。视图命名需以 V 开头，后接表的英文简写或视图的目的（首字母大写驼峰命名法）。 b) 字段的命名需以有意义的英文单词组合（首字母大写的驼峰命名法）。 项目 java 代码包含义：严格遵照 MVC 模式M 模型层包括 JavaBean 和其他数据操作， C 控制器层即通过 Servlet 负责页面的跳转。 所以 src 文件夹分为如下三部分： bean 包——内含与数据库表相对应的 JavaBean 对象， JavaBeanOP——还有对应 JavaBean 与数据库的操作。 servlet 包——包括所有与页面交互的 Servlet 操作； util 包——包括公用的或特殊用途的函数。 具体如下图： 1.4项目中 java 包的命名规则： a)bean 包的名称命名规则为 bean.编程人的拼音缩写.编写模块的英文单词； b)servlet 包的名称命名规则为 servlet.编程人的拼音缩写.编写模块的英文单词； c) util 包的名称命名规则为 util.编程人的拼音缩写。 d)注意：命名规则的前两项应为小写（即 XX 包.编程人的拼音缩写），最后一项（即编写模块的英文单词或是 util 包的第二项）应为大写。具体格式如图： 1.5 Bean 包中 JavaBean 文件的名称bean 中的 JavaBean 文件需和数据库中的表一一对应起来 ，以数据库中的表来 命名 JavaBean 文件，如 TUser 表对象bean 包的 TUser.java。如有不与数据库表对应 JavaBean 可自行选择有意义的英文单词或组合来命名，但应首字母大写的驼峰命名法。 6 Bean 包中 JavaBean 对象的数据库操作文件名称所有 JavaBean 与数据库的操作，一律命名为 JavaBeanOP 的形式。如 TUser 对象的数据库操作命名为TUserOP.java，其中包括所有与数据库的操作。同时每个 OP 文件必须含有函数 insert（）、update（）和 delete（）分别表示新建、修改和删除的含义。具体代码可参照 src.bean.tpersonop.java 来写。 7 Servlet 包 中文件的名称servlet 文件命名格式为JavaBean 对象名 + 对JavaBean 的操作（如新增 Add，修改 Modify，删除 Delete，列表 List, 搜索Search 等动词）+Servlet。如对TUser 表的操作 TUserAddServlet 为新建 TUser对 象 的 servlet 、 TUserModifyServlet 为修改TUser对象的servlet、TUserDeleteServlet 为删除 TUser 对象的 servlet、TUserListServlet 为显示 TUser 对象列表的servlet 等等。8 Util 包中文件的名称首字母的大写的驼峰命名法，保证文件名有意义的英文单词。目前系统中的公用 java 文件都在 util 包下，如图其中 Const.java 表示系统用到的通用常量。DateFun.java 为系统对 Date 类型的操作函数。 DBConnect.java 为系统通过的数据库连接方法。 MD5.java 为 MD5 加密算法，用于用户登录密码的加密处理。 Pagelist.java 为通用的分页显示。 StrFun.java 类为 servlet 文件去 request 对象中对象 attribute 属性时的转码方法。9 Java 文件中函数的写法java 文件中函数命名最好以动词.名词的形式。如想根据 ID 获得某个对象，可以命名为 getXXByID，首字母小写，其余单词为大写。函数中局部变量的命名为全部小写，常量为全部大写。 10 JSP 文件的写法首页和登录页的 JSP 文件放在根目录下，其余文件按照英文含义放入响应的文件夹下，每个文件夹下包括了该模块的全部操作页面。如图： 建议文件夹的命名为首字母大写的驼峰命名法。 11、EXT2 的 JS 文件放置与每个页面对应的 JS 文件放到/inc/编程人的拼音缩写（全部小写）文件夹下