项目规范和基础配置文档格式.docx

项目规范和基础配置文档格式.docx

《项目规范和基础配置文档格式.docx》由会员分享，可在线阅读，更多相关《项目规范和基础配置文档格式.docx（16页珍藏版）》请在冰豆网上搜索。

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.5Bean包中JavaBean文件的名称

bean中的JavaBean文件需和数据库中的表一一对应起来，以数据库中的表来命名JavaBean文件，如TUser表对象bean包的TUser.java。

如有不与数据库表对应JavaBean可自行选择有意义的英文单词或组合来命名，但应首字母大写的驼峰命名法。

1.6Bean包中JavaBean对象的数据库操作文件名称

所有JavaBean与数据库的操作，一律命名为JavaBeanOP的形式。

如TUser对象的数据库操作命名为TUserOP.java，其中包括所有与数据库的操作。

同时每个OP文件必须含有函数insert（）、update（）和delete（）分别表示新建、修改和删除的含义。

具体代码可参照src.bean.tpersonop.java来写。

1.7Servlet包中文件的名称

servlet文件命名格式为JavaBean对象名+对JavaBean的操作（如新增Add，修改Modify，删除Delete，列表List,搜索Search等动词）+Servlet。

如对TUser表的操作TUserAddServlet为新建TUser对象的servlet、TUserModifyServlet为修改TUser对象的servlet、TUserDeleteServlet为删除TUser对象的servlet、TUserListServlet为显示TUser对象列表的servlet等等。

1.8Util包中文件的名称

首字母的大写的驼峰命名法，保证文件名有意义的英文单词。

目前系统中的公用java文件都在util包下，如图：

其中Const.java表示系统用到的通用常量。

DateFun.java为系统对Date类型的操作函数。

DBConnect.java为系统通过的数据库连接方法。

MD5.java为MD5加密算法，用于用户登录密码的加密处理。

Pagelist.java为通用的分页显示。

StrFun.java类为servlet文件去request对象中对象attribute属性时的转码方法。

1.9Java文件中函数的写法

java文件中函数命名最好以动词.名词的形式。

如想根据ID获得某个对象，可以命名为getXXByID，首字母小写，其余单词为大写。

函数中局部变量的命名为全部小写，常量为全部大写。

1.10JSP文件的写法

首页和登录页的JSP文件放在根目录下，其余文件按照英文含义放入响应的文件夹下，每个文件夹下包括了该模块的全部操作页面。

如图：

建议文件夹的命名为首字母大写的驼峰命名法。

1.11、EXT2的JS文件放置

与每个页面对应的JS文件放到/inc/编程人的拼音缩写（全部小写）文件夹下。

建议命名为有意义的英文单词或组合，首字母小写的驼峰命名法。

如有大家一起用到的通过JS函数，建议新建一个通过的JS文件，大家一起调用其中的函数。

1.12数据库的连接的写法

详细参照src下bean.tpersonop.java文件。

简单说明insert函数写法，代码如下：

/***

*作用：

向tperson表中添加新纪录

***/

publicvoidinsert（Objectbean）

{

Stringsql="

insertintotperson

（TPersonID,TPersonName,TPersonType,TPersonNum）values（?

?

）"

;

DBConnectdbc=null;

try

dbc=newDBConnect（sql）;

dbc.setString（1,（（tperson）bean）.getTPersonID（））;

dbc.setString（2,（（tperson）bean）.getTPersonName（））;

dbc.setString（3,（（tperson）bean）.getTPersonType（））;

dbc.setString（4,（（tperson）bean）.getTPersonNum（））;

dbc.executeUpdate（）;

}

catch（Exceptione）

System.out.println（e.getMessage（））;

finally{

dbc.close（）;

注意：

1、建议所有insert、update和delete函数参数都有Object对象；

2、连接数据库调用DBConnect中的newDBConnect（）方法，函数sql参数，调用对应的setXXX方法替换相应类型的?

，最后执行操作；

3、调用try-catch-finally的格式，finally用来关闭数据库的连接。

DBconnect初始化在try代码块之外。

1.13List的写法

详细参照scr下servlet.ListServlet.java文件。

分页显示时，传入totalsql和sql两个查询语句，total语句为查询所有的表中对象，sql为调用对应页面的sql语句，二者作为参数传入JavaBean的OP文件中，调用getresult（）方法返回List列表。

1.14代码注释

每一个函数的上方必须要写注释。

格式如下：

其中作用写明该函数的主要用于，同时可选择写下传入参数含义和返回参数的含义。

当存在自认为不容易理解的代码时，需及时写下该代码的含义。

通常应保证每5行代码含有一行注释。

1.15Session和forward

只有在一个对象变量需在多个页面共享时，才使用session的方式，其余都使用请求转发方式。

请求转发代码如下：

ServletContextsc=this.getServletContext（）;

RequestDispatcher

rd=sc.getRequestDispatcher（"

/sample/index.jsp"

）;

rd.forward（request,response）;

2.数据库汇总规

2.1首先每个人要做的是先记录下数据库中你负责哪些表。

2.2每天某个时间（商讨定），汇总人中询问每个人（QQ群中，注意关注）是否有数据库表的结构增删改，有的人员及时响应。

否则，等待下次询问！

（紧急修改问题可联系汇总人）

2.3如果你有数据表的增加，修改，删除操作（必须注意修改自己的EA文件，为了以后形成完整的开发数据字典），及时响应（最好在你项目相应文件更新服务器前）负责汇总人询问。

（以mysql为例，把库中你有变动的表选中，然后备份出来发给负责汇总人）

2.4负责汇总人接到几个变动表备份后，将原库中对应删去，然后还原变动表进库。

并向其他开发人员通知，表有改动，需要的提出申请！

！

2.5其他人员申请时，如果自己负责的众多表中有重要测试数据，可以把这些表备份，并附文字说明发给汇总人。

2.6负责汇总人，将申请者，备份的这些表从自己旧库中删除，并还原。

并把总体数据库备份给申请者。

2.7申请者，删除整个库（安全考虑最好也备份下），然后把汇总人员发的库备份还原。

附加说明：

1、申请人，这里特指汇总人员通知了有了哪些变动后，其他那些索取最新总库的人员。

2、第4步，第5步这里，汇总人员不需要等所有申请人反映，而是接受一个处理并发送一个。

3、为了减轻汇总人员负荷，申请人注意，你确定距离上次申请时间较短，你的最新测试数据很少，就不要因为这一点，再去备份变动的表给汇总人员索取最新！

（同样如果数据表结构增删改了，但项目文件提交后，其他人更新不会有问题，可暂时缓下，等待汇总人员询问）

4、和申请者一样，如果修改表结构人，负责围中的其他表虽然结构未变化，但有重要测试数据的可一同备份，并说明清楚。

5、之所以，这样做防止大家项目CVS同步了，但由于不知道谁自己改了表，没及时通知大家，导致大家项目都运行不起来，陷入瘫痪状态。

所以每个人必须严格按照流程做事。

也为了以后生成文档准确方便。

6、有良好建议请联系我，以后继续完善该手册！

7、参考操作见下图：

你修改什么表，备份时，就在哪几个表上打钩！

不要选其他表

有的mysql版本有这个问题可能！

所以备份后大家看下里面是不是就那几个选中的表。

不是的话，先删掉其表，然后再备份发给汇总人

3．623服务器连接方法（CVS）

3.1打开MyEclipse，在File菜单下选择Import。

如图2-1。

图2-1

3.2.在Import窗口中选择CVS下面的ProjectsfromCVS。

如图2-2。

图2-2

3.3点击Next，进入图2-3所示界面，选择Createanewrepositorylocation。

图2-3

3.4点击Next进入图2-4所示界面，填入相应的信息即可。

（如：

Host：

121.248.196.1，Repositorypath：

/project，User和Password中输入自己在服务上设置的用户名和密码即可）

现为：

121.248.196.1

图2-4

3．5点击Next进入图2-5界面，说明连接成功，选择相应项目，选择Finish即可。

图2-5

4.关于CVS源码同步及项目远程部署管理细则

4.1项目开发人员应遵循的规则

1、项目开发人员在每