项目规范和基础配置.doc
《项目规范和基础配置.doc》由会员分享,可在线阅读,更多相关《项目规范和基础配置.doc(22页珍藏版)》请在咨信网上搜索。
1、项目规范和基础配置1. 项目规范说明1.1名词解释(1)驼峰命名法:就是当变量名或函数名是由一个或多个单字连结在一起,而构成的唯一识别字时,第一个单字以小写字母开始;第二个单字的首字母大写或每一个单字的首字母都采用大写字母,例如 :myFirstName、myLastName,这样的变量名看上去就像骆驼峰一样此起彼伏,故得名。(2)首字母大写的驼峰命名法:在驼峰命名法基础上首字母大写。1.2数据库中表、视图、字段的命名a) 数据库表命名需以 T 开头,后接表的英文简写(首字母大写的驼峰命名法),如 TUser 表。视图命名需以 V 开头,后接表的英文简写或视图的目的(首字母大写驼峰命名法)。b
2、) 字段的命名需以有意义的英文单词组合(首字母大写的驼峰命名法)。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。如有不与数据库表对应 JavaBean 可
4、自行选择有意义的英文单词或组合来命名,但应首字母大写的驼峰命名法。1.6 Bean 包中 JavaBean 对象的数据库操作文件名称所有 JavaBean 与数据库的操作,一律命名为 JavaBeanOP 的形式。如 TUser 对象的数据库操作命名为TUserOP.java,其中包括所有与数据库的操作。同时每个 OP 文件必须含有函数 insert()、update()和 delete()分别表示新建、修改和删除的含义。具体代码可参照 src.bean.tpersonop.java 来写。1.7 Servlet 包 中文件的名称servlet 文件命名格式为JavaBean 对象名 + 对J
5、avaBean 的操作(如新增 Add,修改 Modify,删除 Delete,列表 List, 搜索Search 等动词)+Servlet。如对TUser 表的操作 TUserAddServlet 为新建 TUser对象的servlet、TUserModifyServlet为修改TUser对象的servlet、TUserDeleteServlet 为删除 TUser 对象的 servlet、TUserListServlet 为显示 TUser 对象列表的servlet 等等。1.8 Util 包中文件的名称首字母的大写的驼峰命名法,保证文件名有意义的英文单词。目前系统中的公用 java 文件
6、都在 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 下 bean.tperson
8、op.java 文件。简单说明insert 函数写法,代码如下:/*作用:向tperson表中添加新纪录*/publicvoid 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.setString(2,(tperson)
9、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 DBConnect()方法,函数sql参数
10、,调用对应的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.getRequestDispatcher(/sample/index.jsp);rd.fo
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 项目 规范 基础 配置
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,个别因单元格分列造成显示页码不一将协商解决,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【天****】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【天****】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。