《项目规范和基础配置》由会员分享，可在线阅读，更多相关《项目规范和基础配置（17页珍藏版）》请在金锄头文库上搜索。
1、项目规范和基础配置1. 项目规范说明1.1 名词解释（1）驼峰命名法：就是当变量名或函数名是由一个或多个单字连结在一起，而构成的唯一识别字时，第一个单字以小写字母开始；第二个单字的首字母大写或每一个单字的首字母都采用大写字母，例如 ：myFirstName、myLastName，这样的变量名看上去就像骆驼峰一样此起彼伏，故得名。（2）首字母大写的驼峰命名法：在驼峰命名法基础上首字母大写。1.2 数据库中表、视图、字段的命名a) 数据库表命名需以 T 开头，后接表的英文简写（首字母大写的驼峰命名法），如 TUser 表。视图命名需以 V 开头，后接表的英文简写或视图的目的（首字母大写驼峰命名法）
2、。b) 字段的命名需以有意义的英文单词组合（首字母大写的驼峰命名法）。1.3 项目 java 代码包含义：严格遵照 MVC 模式M 模型层包括 JavaBean 和其他数据操作，C 控制器层即通过 Servlet 负责页面的跳转。所以 src 文件夹分为如下三部分：bean 包内含与数据库表相对应的 JavaBean 对象，JavaBeanOP还有对应 JavaBean 与数据库的操作。servlet 包包括所有与页面交互的 Servlet 操作；util 包包括公用的或特殊用途的函数。具体如下图：1.4 项目中 java 包的命名规则：a)bean 包的名称命名规则为 bean.编程人的拼音
3、缩写.编写模块的英文单词；b)servlet 包的名称命名规则为 servlet.编程人的拼音缩写.编写模块的英文单词；c) util 包的名称命名规则为 util.编程人的拼音缩写。d)注意：命名规则的前两项应为小写（即 XX 包.编程人的拼音缩写），最后一项（即编写模块的英文单词或是 util 包的第二项）应为大写。具体格式如图：1.5 Bean 包中 JavaBean 文件的名称bean 中的 JavaBean 文件需和数据库中的表一一对应起来 ，以数据库中的表来 命名 JavaBean 文件，如 TUser 表对象bean 包的 TUser.java。如有不与数据库表对应 JavaBe
4、an 可自行选择有意义的英文单词或组合来命名，但应首字母大写的驼峰命名法。1.6 Bean 包中 JavaBean 对象的数据库操作文件名称所有 JavaBean 与数据库的操作，一律命名为 JavaBeanOP 的形式。如 TUser 对象的数据库操作命名为TUserOP.java，其中包括所有与数据库的操作。同时每个 OP 文件必须含有函数 insert（）、update（）和 delete（）分别表示新建、修改和删除的含义。具体代码可参照 src.bean.tpersonop.java 来写。1.7 Servlet 包 中文件的名称servlet 文件命名格式为JavaBean 对象名
5、+ 对JavaBean 的操作（如新增 Add，修改 Modify，删除 Delete，列表 List, 搜索Search 等动词）+Servlet。如对TUser 表的操作 TUserAddServlet 为新建 TUser对 象 的servlet 、 TUserModifyServlet 为修改TUser对象的servlet、TUserDeleteServlet 为删除 TUser 对象的 servlet、TUserListServlet 为显示 TUser 对象列表的servlet 等等。1.8 Util 包中文件的名称首字母的大写的驼峰命名法，保证文件名有意义的英文单词。目前系统中的公
6、用 java 文件都在 util 包下，如图：其中 Const.java 表示系统用到的通用常量。DateFun.java 为系统对 Date 类型的操作函数。DBConnect.java 为系统通过的数据库连接方法。MD5.java 为 MD5 加密算法，用于用户登录密码的加密处理。Pagelist.java 为通用的分页显示。StrFun.java 类为 servlet 文件去 request 对象中对象 attribute 属性时的转码方法。1.9 Java 文件中函数的写法java 文件中函数命名最好以动词.名词的形式。如想根据 ID 获得某个对象，可以命名为 getXXByID，首字
7、母小写，其余单词为大写。函数中局部变量的命名为全部小写，常量为全部大写。1.10 JSP 文件的写法首页和登录页的 JSP 文件放在根目录下，其余文件按照英文含义放入响应的文件夹下，每个文件夹下包括了该模块的全部操作页面。如图：建议文件夹的命名为首字母大写的驼峰命名法。1.11、EXT2 的 JS 文件放置与每个页面对应的 JS 文件放到/inc/编程人的拼音缩写（全部小写）文件夹下。如图：建议命名为有意义的英文单词或组合，首字母小写的驼峰命名法。如有大家一起用到的通过 JS 函数，建议新建一个通过的 JS 文件，大家一起调用其中 的函数。1.12 数据库的连接的写法详细参照 src 下 be
8、an.tpersonop.java 文件。简单说明insert 函数写法，代码如下：/* 作用：向tperson表中添加新纪录* */public void insert(Object bean)String sql = insert into tperson (TPersonID,TPersonName,TPersonType,TPersonNum) values (?,?,?,?);DBConnect dbc = null;trydbc = new DBConnect(sql);dbc.setString(1,(tperson) bean).getTPersonID();dbc.setSt
9、ring(2,(tperson) bean).getTPersonName();dbc.setString(3,(tperson) bean).getTPersonType();dbc.setString(4,(tperson) bean).getTPersonNum();dbc.executeUpdate();catch(Exception e)System.out.println(e.getMessage();finallydbc.close();注意：1、建议所有insert、update和delete 函数参数都有Object对象；2、连接数据库调用DBConnect中的new DBC
10、onnect（）方法，函数sql参数，调用对应的setXXX方法替换相应类型的?，最后执行操作；3、调用 try-catch -finally 的格式，finally 用来关闭数据库的连接。DBconnect 初始化在 try 代码块之外。1.13 List 的写法详细参照 scr 下 servlet.ListServlet.java 文件。分页显示时，传入totalsql 和 sql 两个查询语句，total 语句为查询所有的表中对象，sql 为调用对应 页 面 的 sql 语 句 ， 二者作为参数传入JavaBean的OP文件中，调用getresult（）方法返回 List 列表。1.14
11、 代码注释每一个函数的上方必须要写注释。格式如下：/* 作用：向tperson表中添加新纪录* */其中作用内写明该函数的主要用于，同时可选择写下传入参数含义和返回参数的含义。当存在自认为不容易理解的代码时，需及时写下该代码的含义。通常应保证每 5 行代码内含有一行注释。1.15 Session 和 forward只有 在一个对象 变量需在多个页面共享时， 才使用session 的方式，其余都使用请求转发方式。请求转发代码如下：ServletContext sc=this.getServletContext();RequestDispatcherrd=sc.getRequestDispatch
12、er(/sample/index.jsp);rd.forward(request, response);2. 数据库汇总规范2. 1 首先每个人要做的是先记录下数据库中你负责哪些表。2.2 每天某个时间（商讨定） ，汇总人中询问每个人（QQ 群中，注意关注）是否有数据库表的结构增删改，有的人员及时响应。否则，等待下次询问！（紧急修改问题可联系 汇总人）2.3 如果你有数据表的增加，修改，删除操作（必须注意修改自己的 EA 文件，为了以后形成完整的开发数据字典） ，及时响应（最好在你项目相应文件更新服务器前）负责汇总人询问。 （以 mysql 为例，把库中你有变动的表选中，然后备份出来发给负责汇
13、总人）2.4 负责汇总人接到几个变动表备份后，将原库中对应删去，然后还原变动表进库。并向其他开发人员通知，表有改动，需要的提出申请！2.5 其他人员申请时，如果自己负责的众多表中有重要测试数据，可以把这些表备份，并附文字说明发给汇总人。2.6 负责汇总人，将申请者，备份的这些表从自己旧库中删除，并还原。并把总体数据库备份给申请者。2.7 申请者，删除整个库（安全考虑最好也备份下） ，然后把 汇总人员发的库备份 还原。附加说明：1、 申请人，这里特指 汇总人员通知了有了哪些变动后，其他那些索取最新总库的人员。2、 第 4 步，第 5 步这里，汇总人员不需要等所有申请人反映，而是接受一个处理并发送
14、一个。3、 为了减轻汇总人员负荷，申请人注意，你确定距离上次申请时间较短，你的最新测试数据很少，就不要因为这一点，再去备份变动的表给 汇总人员 索取最新！（同样如果数据表结构增删改了，但项目文件提交后，其他人更新不会有问题，可暂时缓下，等待汇总人员询问）4、 和申请者一样，如果修改表结构人，负责范围中的其他表虽然结构未变化，但有重要测试数据的可一同备份，并说明清楚。5、 之所以，这样做防止大家项目 CVS 同步了，但由于不知道谁自己改了表，没及时通知大家，导致大家项目都运行不起来，陷入瘫痪状态。 所以每个人必须严格按照流程做事。也为了以后生成文档准确方便。6、 有良好建议请联系我，以后继续完善
15、该手册！7、 参考操作见下图：你修改什么表，备份时，就在哪几个表上打钩！ 不要选其他表 有的 mysql 版本有这个问题可能！所以备份后大家看下里面是不是 就那几个选中的表。不是的话， 先删掉其表，然后再备份发给汇总人3 623 服务器连接方法（CVS）3.1 打开 MyEclipse，在 File菜单下选择 Import。如图 2-1。图 2-13.2.在 Import窗口中选择 CVS下面的 Projects from CVS。如图 2-2。图 2-23.3点击 Next，进入图 2-3所示界面，选择 Create a new repository location。图 2-33.4点击
16、Next进入图 2-4所示界面，填入相应的信息即可。 （如：Host：121.248.196.1，Repository path：/project，User 和 Password中输入自己在服务上设置的用户名和密码即可）图 2-435 点击 Next进入图 2-5界面，说明连接成功，选择相应项目，选择 Finish即可。现为：121.248.196.1图 2-54. 关于 CVS 源码同步及项目远程部署管理细则4.1 项目开发人员应遵循的规则1、项目开发人员在每次修改程序之前，必须先连接 623 的 CVS 服务器将整个项目的源码进行同步；2、 项目开发人员在修改完程序的当天必须与 623 的 CVS 服务器进行同步；3、 项目开发人员修改完并与 623 的 CVS 服务器同步以后，必须再次对本次修改的内容进行测试。4、 原则上项目开发人员不允许直接
