JAVA编码规范和指南培训(新改).ppt

1、税友软件集团Java编码规范和指南培训,纳税事业部/王伟,20091125,WWW.JDLSSOFT.COM.CN,A,2,课程目标,使开发人员认识到编码规范和指南存在的意义 对公司的开发编码规范(JAVA)、JAVA编码指南、JavaScript编码规范和J2EE项目开发命名标准等文档做一简介，使开发人员对此有个总体印象，知道在以后的工作中需要遵守这些规范 通过对公司编码规范和编码指南的介绍，使得开发人员了解到其侧重点,WWW.JDLSSOFT.COM.CN,A,3,PPT概要,WWW.JDLSSOFT.COM.CN,A,4,一、编码规范的目的,宗旨：为了开发小组能够在编码过程中遵循一致的风

2、格，使得代码阅读者能够非常清晰的各个成员编写的代码，使得维护人员能够很好的继承前辈的代码，制定编码规范； 编码工程师：负责按编码规范实施编码工作 。 代码审核人：负责按编码规范审核代码 。,WWW.JDLSSOFT.COM.CN,A,5,二、编码指南的目的,宗旨： 为了提高团队编程的质量、协同性、规范性，需要对项目的编码过程作出指导和约束；同时也作为概要设计、详细设计的补充，及测试的依据。 每个项目都需要结合项目实际情况制定相应的编码指南 项目组织者：在编码开始前根据公司编码指南模板，对其进行裁剪和细化，于项目编码前公布，并组织对全体编码人员、测试人员进行培训，作为项目级规范必须遵守，同时指定

3、本项目各种规定的负责人、检查人。 编码人员：深入理解本项目编码指南中所要求的一些约束、规定，如是编码指南中某个方面的负责人，则还需要切实检查并督促其他编码人员遵循这些规定。,WWW.JDLSSOFT.COM.CN,A,6,三、编码规范与编码指南,编码规范是一组相对静态的规范，而项目指南是项目组内相对动态的； 编码规范是针对编码的成果，而编码指南是针对项目编码的过程； 编码指南是贯彻编码规范的一种较好的方法，项目组内没有制定或没有很好的执行编码指南，通常会造成代码成果没有什么规范性 编码指南除了对项目内编码规范作出指南之外，还要关注很多方面，比如开发框架、命名约定等内容,WWW.JDLSSOFT

4、.COM.CN,A,7,PPT概要,WWW.JDLSSOFT.COM.CN,A,8,JAVA编码规范包括的几个方面,源代码格式和文件样式 版权信息、类注释、javadoc、缩进、页宽等 命名规范 包名、类名、方法名、变量名等的通用规范 程序编写规范 clone、final、垃圾收集等 一些编程约束和技巧 一些经验和建议，时至今日，依然有价值,WWW.JDLSSOFT.COM.CN,A,9,PPT概要,WWW.JDLSSOFT.COM.CN,A,10,JAVA编码指南包括的几个方面,开发环境、技术框架、工程结构及命名规定 开发方面规范和约束的关键要素 编码过程负责人分工,WWW.JDLSSOFT

5、.COM.CN,A,11,一、开发环境、工程结构及命名规定,项目开发架构 开发架构、使用框架（交大龙山架构、扩展包、Struts等等）、开发流程等 项目开发环境 WEB层目录结构、代码包结构目录、配置文件命名等 例global、images、scripts、pages/模块名等 .jdlssoft.系统名.web.模块名.actions WEB-INF/config/目录 EJB层代码包结构目录、配置文件目录 编译和打包结构、打包脚本,WWW.JDLSSOFT.COM.CN,A,12,JAVA编码指南包括的几个方面,开发环境、技术框架、工程结构及命名规定 开发方面规范和约束的关键要素 编码过程

6、负责人分工,WWW.JDLSSOFT.COM.CN,A,13,二、开发方面规范和约束的关键要素,界面约束 公共方法与函数 常量类 提示信息 日志 注释,WWW.JDLSSOFT.COM.CN,A,14,2.1、界面编码约束,页面元素使用规则 文本输入框、日期输入框、金额、小数、身份证 页面操作约定 新增、删除、修改、查询、进度条、返回、退出 页面特殊字符处理 URLEncoder.encode ConvertType.filter,WWW.JDLSSOFT.COM.CN,A,15,2.2、公共方法与函数,架构级的工具类 SysUtil、StringUtil、FileUtil等 扩展包中Base

7、Code 页面上进行代码/名称转换、下拉框选择 项目自定义的公共方法 项目级、模块级 JS公共函数及工具组件,WWW.JDLSSOFT.COM.CN,A,16,2.3、常量类,*Constants 类中自定义的常量对象 公共的常量类 模块级的常量类 模块目录下 层次级的常量类 层次目录下 项目级的常量类 common目录下,WWW.JDLSSOFT.COM.CN,A,17,2.4、提示信息,页面方式提示 提示信息页面/global/info.jsp 错误信息页面/global/error.jsp 警告信息页面/global/warn.jsp 错误、提示信息号码段 Messages.getIns

8、tance().getMessage(8100, param) 异常处理的机制与提示信息的结合 底层业务处理出错时，设置好相应的MsgCode，逐级向上抛出异常直到页面层，页面层根据相关开发框架，跳转到相应的提示信息页面,WWW.JDLSSOFT.COM.CN,A,18,2.5、日志、注释规范,日志配置文件 日志级别要求 异常、错误、警告、提示、调试 Log的记载格式为: 错误编码-业务处理名称：错误信息； 注释规范 注释应该采用标准的JavaDoc注释方法 类文件、函数、数据结构、处理逻辑、全局变量和常量都要注释,WWW.JDLSSOFT.COM.CN,A,19,2.5、日志、注释规范,pa

9、ckage .servyou.sszsk.web import java.util.ArrayList; /* * Title: 税收知识库系统action基类 * * Description: 税收知识库系统action基类，所有的action都要继承本类 * 由本来通过command调用具体的receiver类，有如下一些可以被公用的方法 * * * Copyright: Copyright(c) 2009-2018 税友集团 * * Company: 税友集团 * * author servyou * * version 1.0 */ public class ProjectBaseSe

10、archAction extends BaseSearchAction ,WWW.JDLSSOFT.COM.CN,A,20,JAVA编码指南包括的几个方面,开发环境、技术框架、工程结构及命名规定 开发方面规范和约束的关键要素 编码过程负责人分工,WWW.JDLSSOFT.COM.CN,A,21,三、编码过程负责人分工,集成打包负责人 ant脚本：包结构、页面目录、代码目录、配置目录 公共JS负责人 公共JS的统一维护；同时负责检查页面元素使用规则，输入框、下拉框等等；以及前台提示信息对话框规范性的检查 公共方法与函数、常量类负责人 工具类、baseCode、常量类统一维护，公共方法要及时提取；

11、同时负责代码中公共方法使用情况的检查 配置文件管理负责人 配置文件的管理：命名规范性、模块划分规范性；公共配置文件的统一维护：poolconfig等 提示信息、日志、注释负责人 代码中规范的检查：日志的级别、规范性、注释的遗漏、规范性等等；提示信息号码的分配，代码中号码使用正确性的检查；,WWW.JDLSSOFT.COM.CN,A,22,PPT概要,WWW.JDLSSOFT.COM.CN,A,23,JAVA编码规范相关文档,开发编码规范(JAVA) JAVA编码指南 JavaScript编码规范 J2EE项目开发命名标准,WWW.JDLSSOFT.COM.CN,A,24,JavaScript编

12、码规范,目的：为了重视页面层的开发，为了规范公司J2EE项目开发中对JS的使用,增强项目的可读性，降低交流成本，以公司目前项目开发的实际情况为基础，制定出公司JS开发规范 总则： 在J2EE项目开发中，页面开发不是二等公民； JavaScript代码也是代码，需要象对待Java一样来对待； 使用第三方框架如prototype、dwr时，应该使用原版的而不用压缩、混淆版的； 应该考虑发布版与开发版的区别对待，对于重要的、自主研发的js文件，发布版中应该混淆、压缩； 应该采用面向对象的思想对js代码进行管理、书写；,WWW.JDLSSOFT.COM.CN,A,25,JavaScript编码规范,J

13、S目录结构 JS源代码格式规范 JS文件样式约定 JS编程约束和技巧,WWW.JDLSSOFT.COM.CN,A,26,JS目录结构,公司级公用的JavaScript文件放在scripts目录的servyou下； 项目级公用的JavaScript文件放在scripts目录的XX项目下； 第三方的JavaScript文件（可能还包含一些页面，CSS，images等）放在scripts下，新建一个目录； 与页面相关的JavaScript文件和页面放在同一个目录下，命名同页面名称（如果同一模块的多个页面使用同一个js文件，该文件的命名应该与该模块名相关，如fxxa_manage.js。）,WWW.JDLSSOFT.COM.CN,A,27,JS源代码格式规范,应该采用面向对象的方式去管理、书写函数和变量 ； 每行长度 缩进 关于空格,WWW.JDLSSOFT.COM.CN,A,28,JS一些编程约束和技巧,JS的压缩与混淆 怎样刷新JS脚本由于浏览器缓存引起的错误 Ctrl+F5刷新，或者 引入太大的JS文件，影响浏览器的速度，要做到按需加载和拆分 JS代码段在页面中的位置，对页面解析效率的影响,WWW.JDLSSOFT.COM.CN,A,29,PPT概要,WWW.JDLSSOFT.COM.CN,A,30,代码检查工具及使用