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

税友软件集团

Java编码标准和指南培训纳税事业部/王伟20211125课程目标使开发人员认识到编码标准和指南存在的意义对公司的?开发编码标准(JAVA)?、?JAVA编码指南?、?JavaScript编码标准?和?J2EE工程开发命名标准?等文档做一简介，使开发人员对此有个总体印象，知道在以后的工作中需要遵守这些标准通过对公司编码标准和编码指南的介绍，使得开发人员了解到其侧重点WWW.JDLSSOFT.COM.CN整理pptPPT概要制定编码规范和指南的意义JAVA编码规范包括的几个方面JAVA编码指南包括的几个方面JAVA编码规范相关文档代码检查工具介绍及使用WWW.JDLSSOFT.COM.CN整理ppt一、编码标准的目的宗旨：为了开发小组能够在编码过程中遵循一致的风格，使得代码阅读者能够非常清晰的各个成员编写的代码，使得维护人员能够很好的继承前辈的代码，制定编码标准；编码工程师：负责按编码标准实施编码工作。代码审核人：负责按编码标准审核代码。WWW.JDLSSOFT.COM.CN整理ppt二、编码指南的目的宗旨：为了提高团队编程的质量、协同性、标准性，需要对工程的编码过程作出指导和约束；同时也作为概要设计、详细设计的补充，及测试的依据。每个工程都需要结合工程实际情况制定相应的编码指南工程组织者：在编码开始前根据公司编码指南模板，对其进行裁剪和细化，于工程编码前公布，并组织对全体编码人员、测试人员进行培训，作为工程级标准必须遵守，同时指定本工程各种规定的负责人、检查人。编码人员：深入理解本工程编码指南中所要求的一些约束、规定，如是编码指南中某个方面的负责人，那么还需要切实检查并催促其他编码人员遵循这些规定。WWW.JDLSSOFT.COM.CN整理ppt三、编码标准与编码指南编码标准是一组相对静态的标准，而工程指南是工程组内相对动态的；编码标准是针对编码的成果，而编码指南是针对工程编码的过程；编码指南是贯彻编码标准的一种较好的方法，工程组内没有制定或没有很好的执行编码指南，通常会造成代码成果没有什么标准性编码指南除了对工程内编码标准作出指南之外，还要关注很多方面，比方开发框架、命名约定等内容WWW.JDLSSOFT.COM.CN整理pptPPT概要制定编码规范和指南的意义JAVA编码规范包括的几个方面JAVA编码指南包括的几个方面JAVA编码规范相关文档代码检查工具介绍及使用WWW.JDLSSOFT.COM.CN整理pptJAVA编码标准包括的几个方面源代码格式和文件样式版权信息、类注释、javadoc、缩进、页宽等命名标准包名、类名、方法名、变量名等的通用标准程序编写标准clone、final、垃圾收集等一些编程约束和技巧一些经验和建议，时至今日，依然有价值WWW.JDLSSOFT.COM.CN整理pptPPT概要制定编码规范和指南的意义JAVA编码规范包括的几个方面JAVA编码指南包括的几个方面JAVA编码规范相关文档代码检查工具介绍及使用WWW.JDLSSOFT.COM.CN整理pptJAVA编码指南包括的几个方面开发环境、技术框架、工程结构及命名规定开发方面标准和约束的关键要素编码过程负责人分工WWW.JDLSSOFT.COM.CN整理ppt一、开发环境、工程结构及命名规定工程开发架构开发架构、使用框架〔交大龙山架构、扩展包、Struts等等〕、开发流程等工程开发环境WEB层目录结构、代码包结构目录、配置文件命名等例global、images、scripts、pages/模块名等cn.jdlssoft.系统名.web.模块名.actionsWEB-INF/config/目录EJB层代码包结构目录、配置文件目录编译和打包结构、打包脚本WWW.JDLSSOFT.COM.CN整理pptJAVA编码指南包括的几个方面开发环境、技术框架、工程结构及命名规定开发方面标准和约束的关键要素编码过程负责人分工WWW.JDLSSOFT.COM.CN整理ppt二、开发方面标准和约束的关键要素界面约束公共方法与函数常量类提示信息日志注释WWW.JDLSSOFT.COM.CN整理ppt2.1、界面编码约束页面元素使用规那么文本输入框、日期输入框、金额、小数、身份证页面操作约定新增、删除、修改、查询、进度条、返回、退出页面特殊字符处理URLEncoder.encodeConvertType.filterWWW.JDLSSOFT.COM.CN整理ppt2.2、公共方法与函数架构级的工具类SysUtil、StringUtil、FileUtil等扩展包中BaseCode页面上进行代码/名称转换、下拉框选择工程自定义的公共方法工程级、模块级JS公共函数及工具组件

WWW.JDLSSOFT.COM.CN整理ppt2.3、常量类***Constants类中自定义的常量对象

公共的常量类模块级的常量类模块目录下层次级的常量类层次目录下工程级的常量类common目录下WWW.JDLSSOFT.COM.CN整理ppt2.4、提示信息页面方式提示提示信息页面/global/info.jsp错误信息页面/global/error.jsp

警告信息页面/global/warn.jsp错误、提示信息号码段

Messages.getInstance().getMessage("8100",param)异常处理的机制与提示信息的结合底层业务处理出错时，设置好相应的MsgCode，逐级向上抛出异常直到页面层，页面层根据相关开发框架，跳转到相应的提示信息页面WWW.JDLSSOFT.COM.CN整理ppt2.5、日志、注释标准日志配置文件日志级别要求异常、错误、警告、提示、调试Log的记载格式为:错误编码-<模块名>业务处理名称：错误信息；注释标准注释应该采用标准的JavaDoc注释方法类文件、函数、数据结构、处理逻辑、全局变量和常量都要注释WWW.JDLSSOFT.COM.CN整理ppt2.5、日志、注释标准packagecn.servyou.sszsk.webimportjava.util.ArrayList;/***<p>Title:税收知识库系统action基类</p>**<p>Description:税收知识库系统action基类，所有的action都要继承本类*由本来通过command调用具体的receiver类，有如下一些可以被公用的方法*</p>**<p>Copyright:Copyright(c)2021-2021税友集团</p>**<p>Company:税友集团</p>**@authorservyou**@version1.0*/publicclassProjectBaseSearchActionextendsBaseSearchAction{WWW.JDLSSOFT.COM.CN整理pptJAVA编码指南包括的几个方面开发环境、技术框架、工程结构及命名规定开发方面标准和约束的关键要素编码过程负责人分工WWW.JDLSSOFT.COM.CN整理ppt三、编码过程负责人分工集成打包负责人ant脚本：包结构、页面目录、代码目录、配置目录公共JS负责人公共JS的统一维护；同时负责检查页面元素使用规那么，输入框、下拉框等等；以及前台提示信息对话框标准性的检查公共方法与函数、常量类负责人工具类、baseCode、常量类统一维护，公共方法要及时提取；同时负责代码中公共方法使用情况的检查配置文件管理负责人配置文件的管理：命名标准性、模块划分标准性；公共配置文件的统一维护：poolconfig等提示信息、日志、注释负责人代码中标准的检查：日志的级别、标准性、注释的遗漏、标准性等等；提示信息号码的分配，代码中号码使用正确性的检查；WWW.JDLSSOFT.COM.CN整理pptPPT概要制定编码规范和指南的意义JAVA编码规范包括的几个方面JAVA编码指南包括的几个方面JAVA编码规范相关文档代码检查工具介绍及使用WWW.JDLSSOFT.COM.CN整理pptJAVA编码标准相关文档开发编码标准(JAVA)

JAVA编码指南

JavaScript编码标准

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

JS源代码格式标准

JS文件样式约定

JS编程约束和技巧WWW.JDLSSOFT.COM.CN整理pptJS目录结构公司级公用的JavaScript文件放在scripts目录的servyou下；工程级公用的JavaScript文件放在scripts目录的XX工程下；第三方的JavaScript文件〔可能还包含一些页面，CSS，images等〕放在scripts下，新建一个目录；与页面相关的JavaScript文件和页面放在同一个目录下，命名同页面名称〔如果同一模块的多个页面使用同一个js文件，该文件的命名应该与该模块名相关，如fxxa_manage.js。〕WWW.JDLSSOFT.COM.CN整理pptJS源代码格式标准应该采用面向对象的方式去管理、书写函数和变量

；每行长度缩进关于空格

WWW.JDLSSOFT.COM.CN整理pptJS一些编程约束和技巧JS的压缩与混淆怎样刷新JS脚本由于浏览器缓存引起的错误Ctrl+F5刷新，或者<scriptlanguage="JavaScript"src="./scripts/common.js?v=1.0.002"></script>

引入太大的JS文件，影响浏览器的速度，要做到按需加载和拆分JS代码段在页面中的位置，对页面解析效率的影响WWW.JDLSSOFT.COM.CN整理pptPPT概要制定编码规范和指南的意义JAVA编码规范包括的几个方面JAVA编码指南包括的几个方面JAVA编码规范相关文档代码检查工具介绍及使用WWW.JDLSSOFT.COM.CN整理ppt代码检查工具