WAFⅡ开发培训课程系列之开发规范介绍

1、内部公开 请勿外传P1版权所有1993-2012金蝶软件（中国）有限公司 内部公开 请勿外传WAF开发培训课程系列 WAF开发规范介绍BOS WebBOS Web平台系统部平台系统部 2012.10 2012.10内部公开 请勿外传P2WAF 课程导向WAF 开发规范介绍 培训内容：本章将对WAF的视图层(JSP),视图逻辑层(JS),视图层样式(CSS)以及前端逻辑层(WebController)层的开发规范进行详述. 我们相信: 期望目标： 开发人员在基于WAF进行开发时,能严格遵循WAF制订的开发规范,并在日常应用开发中形成良好的编码习惯.内部公开 请勿外传P3课程目录视图层(JSP)开

2、发规范视图层逻辑(JS)开发规范视图层样式(CSS)开发规范前端逻辑层(WebController)开发规范内部公开 请勿外传P4WAF 课程导向WAF WAF 视图层视图层JSPJSP的开发规范的开发规范内部公开 请勿外传P5WAF 视图层JSP的开发规范 WAF 的JSP页面最好由BIM生成,不建议手工维护,手工维护带来的问题如下:l 手工编排界面布局及组件会造成开发难度系数大,开发效率低下.l 手工编排界面布局及组件会造成与BIM的元数据不同步,造成其它开发人员不再敢使用BIM进行二次发布.内部公开 请勿外传P6WAF 视图层JSP的开发规范WAF JSP路径要求为:/webviews/

3、.List/EditPage.jspWAF JSP数据绑定的注意事项: 控件标签如果与模型属性进行了数据绑定,则须指定相关控件的name属性,并且value属性需要使用EL表达式进行描述.如: 内部公开 请勿外传P7WAF 视图层JSP的开发规范数据绑定的限定,实体属性名称的前两位必须为小写.该限定主要是由于某些服务器在解析JSP中的EL表达式时存在缺陷导致,为了兼容所有的应用服务器,所以作此限定.如:number,cbNumber,myDescription 合法NUMBER,CBNumber,MyDescription 非法内部公开 请勿外传P8WAF 课程导向WAF WAF 视图层视图层

4、JSJS的开发规范的开发规范内部公开 请勿外传P9WAF 视图层JS的开发规范JS路径要求为:/webviews/.List/EditPage.jsJS类的命名空间要求为:.List/EditPage.如:waf.defineClass(“custom.payment.PersonalListPage”,waf.template.GeneralDataBaseListPage,function().); Waf.defineClass(“custom.payment.PersonalEditPage”,waf.template.GeneralDataBaseEditPage,function(

5、);内部公开 请勿外传P10WAF 视图层JS的开发规范变量的命名规则,WAF不作强制,推荐使用匈牙利命名法则.规范格式：变量名=属性+类型+对象描述例如：String型:strName,strNumber,strDescriptionint型: nIndex,nAgefloat型:fltAmount,fltQuartydouble型:dblAmount,dblQuarty 文本控件: txtName,txtNumber,txtDescription标签控件:lblName,lblNumber,lblDescription Action的命名规范要以+Action命名. 前面以动词开头,固定以

6、Action结尾.如:审核: auditAction, 反审核:unAuditAction, 生效:validAction,反生效:unValidAction等.注: 在BIM工具中不用加Action后缀,发布时已经自动加上Action后缀.由于WAF用到Jquery作前端展示,并对Jquery作了进一步的扩展,大多网上资料会使用$作为Jquery的标识,在WAF中不允许直接使用$.xxx,必须使用waf.xxx.内部公开 请勿外传P11WAF 视图层JS的开发规范Ajax请求必须使用waf.doPost,waf.doGet或waf.doSubmit.不允许使用其它第三方类库的ajax或标准的

7、HttpXMLRequest等方式进行请求.如: waf.doPost(action:”audit”,async: true/false,success:function(responseData),error:function(response,textStatus,errorThrow). );内部公开 请勿外传P12WAF 视图层JS的开发规范以Get方式进行重定向或ajax请求时,如遇到包含特殊字符的参数,需要使用waf.encodeURIComponent(str)进行转换. Post方式不作限制.如: waf.redirect(“/custom/test.do?method=ini

8、tialize&billId=” + waf.encodeURIComponent(billID);或者:waf.doGet(action:”audit”,param:”billid=” + waf.encodeURIComponent(billID),success:function(responseData).,error:function(response,textStatus,errorThrow);内部公开 请勿外传P13WAF 视图层JS的开发规范在WAF的JS类中,由于BIM采用反向解析方式生成,目前还不支持see的解析,所以在JS类中的注释不要包括see标识符.内部公开

9、 请勿外传P14WAF 课程导向WAF WAF 视图层视图层CSSCSS的开发规范的开发规范内部公开 请勿外传P15WAF 视图层JS的开发规范业务自己开发的CSS请写到当前页面的CSS中，请不要单独在页面 jsp中加style.例如: 请不要设置inputfloat:left请做局部性的或者某个点的设置，不要做全局性的. 例如: #txtNumberborder-width:2px通过id来进行css的修改. 例如: 然后可以通过如下的方式来更改子控件的css： .new input.ui-f7color:red 更改其中显示的字体 .new .ui-f7-triggerbackground

10、-image:/xx.png 更改f7触发的图标设置专有的命名空间，然后再设置这个命名空间下的其他控件样式.内部公开 请勿外传P16WAF 课程导向WAF WAF 前端逻辑层前端逻辑层(WebController)(WebController)开发规范开发规范内部公开 请勿外传P17WAF 前端逻辑层开发规范类路径要求为:com.kingdee.eas.List/EditPageController如:package com.kingdee.eas.custom.payment.PersonalListPageController;package com.kingdee.eas.custom.

11、payment.PersonalEditPageController;变量的命名规则,WAF不作强制,推荐使用匈牙利命名法则.规范格式：变量名=属性+类型+对象描述例如：String型:strName,strNumber,strDescriptionint型: nIndex,nAgefloat型:fltAmount,fltQuartydouble型:dblAmount,dblQuarty 文本控件: txtName,txtNumber,txtDescription标签控件:lblName,lblNumber,lblDescription内部公开 请勿外传P18WAF 前端逻辑层开发规范Acti

12、on的命名规范要以+Action命名. 前面以动词开头,固定以Action结尾.如: 审核: auditAction, 反审核:unAuditAction, 生效:validAction,反生效:unValidAction等.注: 在BIM工具中不用加Action后缀,发布时已经自动加上Action后缀.在WAF的WebController类中,由于BIM采用反向解析方式生成,目前还不支持see的解析,所以在WebController类中的注释不要包括see标识符. 内部公开 请勿外传P19由于Spring提供的服务很多,为了未来架构能更好的治理与管控,在使用WAF开发业务应用时,应尽量避免使用框架提供以外的任何服务.例如:l不允许更改spring配置文件(applicationContext.xml)l 不允许更改web.xml配置文件l 不建议使用Spring的service