[项目管理]项目规范和基础配置
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
(项目管理)项目规范和
基础配置
项目规范和基础配置
1.项目规范说明
1.1名词解释
(1)驼峰命名法:就是当变量名或函数名是由一个或多个单字连结在一
起,而构成的唯一识别字时,第一个单字以小写字母开始;第二个单字的首字母大写或每一个单字的首字母都采用大写字母,例如:myFirstName、myLastName,这样的变量名看上去就像骆驼峰一样此起彼伏,故得名。
(2)首字母大写的驼峰命名法:在驼峰命名法基础上首字母大写。
1.2数据库中表、视图、字段的命名
a)数据库表命名需以T开头,后接表的英文简写(首字母大写的驼峰命名法),如TUser表。
视图命名需以V开头,后接表的英文简写或视图的目的(首字母大写驼峰命名法)。
b)字段的命名需以有意义的英文单词组合(首字母大写的驼峰命名法)。
1.3项目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.5Bean包中JavaBean文件的名称
bean中的JavaBean文件需和数据库中的表一一对应起来,以数据库中的表来命名JavaBean文件,如TUser表对象bean包的。如有不与数据库表对应JavaBean可自行选择有意义的英文单词或组合来命名,但应首字母大写的驼峰命名法。
1.6Bean包中JavaBean对象的数据库操作文件名称
所有JavaBean与数据库的操作,一律命名为JavaBeanOP的形式。如TUser 对象的数据库操作命名为,其中包括所有与数据库的操作。同时每个OP文件必
须含有函数insert()、update()和delete()分别表示新建、修改和删除的含义。具体代码可参照.来写。
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包下,如图:
其中表示系统用到的通用常量。
为系统对Date类型的操作函数。
为系统通过的数据库连接方法。
MD5.java为MD5加密算法,用于用户登录密码的加密处理。
为通用的分页显示。
类为servlet文件去request对象中对象attribute属性时的转码方法。1.9Java文件中函数的写法
java文件中函数命名最好以动词.名词的形式。如想根据ID获得某个对象,可
以命名为getXXByID,首字母小写,其余单词为大写。函数中局部变量的命名为全部小写,常量为全部大写。
1.10JSP文件的写法
首页和登录页的JSP文件放在根目录下,其余文件按照英文含义放入响应的文件夹下,每个文件夹下包括了该模块的全部操作页面。
如图:
建议文件夹的命名为首字母大写的驼峰命名法。
1.11、EXT2的JS文件放置
与每个页面对应的JS文件放到编程人的拼音缩写(全部小写)文件夹下。如图:
建议命名为有意义的英文单词或组合,首字母小写的驼峰命名法。如有大家一起用到的通过JS函数,建议新建一个通过的JS文件,大家一起调用其中的函数。
1.12数据库的连接的写法
详细参照src下.java文件。简单说明insert函数写法,代码如下:
/***
*作用:向tperson表中添加新纪录
***/
publicvoid insert(Objectbean)
{
Stringsql="insertintotperson
(TPersonID,TPersonName,TPersonType,TPersonNum)values(?,?,?,?)";
DBConnectdbc=null;
try
{
dbc=new DBConnect(sql);
(1,((tperson)bean).getTPersonID());
(2,((tperson)bean).getTPersonName());
(3,((tperson)bean).getTPersonType());
(4,((tperson)bean).getTPersonNum());
();
}
catch(Exceptione)
{
.println(e.getMessage());
}
finally{
();
}
}
注意:
1、建议所有insert、update和delete函数参数都有Object对象;