代码质量与评审

1、北美专业培训机构艾威（中国）培训学院AVTECH简介AVTECH总部设在美国国NEWJERSEY,是北美排行行第一的的专业培培训机构构，设有有4大分校，数十个个培训点点遍布北北美、西西欧和东东亚;；2000年进入中中国，以以培养国国际化的的中高端端信息人人才为己己任,专注于国国际前沿沿的新技技术研发发与信息息科技新新兴行业业的开拓拓教育。AVTECH进入中国国13年，属同同行中历历史最久久。AVTECH是国内最最大的国国际认证证考试中中心，提提供上千千门国际际认证考考试。AVTECH的师资来来自全球球，在国国内培训训机构中中独一无无二的。学院开设课程程超过500门，学习习培训内内容涵盖IT技术

2、及使用IT技术的医医学、生生物、财财会、管管理等相相关行业业所有高高、中、低级知知识和技技能。其其中一些些技术课课程来自自于如下下厂家:微软、IBM、Oracle、Cisco、SAS、ISTQB、SAP、PMI、EXIN、IIBA、Open Group、APMG、ISACA、Vmware、EXIN、Peoplecart、EPI、BRMI、IAOP、ScrumAlliance等艾威最新推推荐：ITIL、ITIL Expert、CISSP、PMP、CISA、COBIT、Prince2、MSP、SCM、CSD、CBAP、TOGAF、CRISC、CGEIT、CISM、PGMP、PFMP、BRMP、CD

3、CP、SGF、NPDP等认证培培训代码质量量与评审审内容质量管理理的必要要性质量管理理实践看得见的的改进总结互联网开开发特点点市场竞争争激烈，需求变变化快开发周期期长隐性成本本时间/迭代代码质量量的影响响成本生产率质量管理理实践代码质量量封装内聚耦合冗余可读性可测试性质量角度：演演化、维维护高内聚、低耦合合是有限限度的目标群体体：开发发人员代码质量量保障步步骤代码评审审持续集成成对待变化化的态度度不只是拥拥抱变化化，更要要利用变变化时间/迭代质量拒绝退化化重构的时时机某周一早早上，你你的老板板要求编编写一个个小程序序，从键键盘读入入字符，然后输输出到打打印机上上void Copy()intc;

4、while(c=Rdkbd()!=EOF)wrtPrt(c);CopyCharWriterPrtCharReadKbd重构的时时机boolean ptFlag=false;boolean punchFlag=false;void copy()intc;while(c=(ptFlag?Rdpt():Rdkbd()!=EOF)punchFlag?wrtPunch():wrtPrt(c);几个月后后，老板板来找你你，说有有时希望望Copy程序能从从手写板板读入信信息几个个月后，老板又又来找你你，有时时希望Copy程序可以以输出到到U盘上ReadWriterCopyKbdPtCharCharPrtPu

5、h质量管理理平台SonarMavenJenkins插件体系系结构看得见的的度量指指标A&D重复代码单元测试复杂度潜在Bug编码规则注释代码重复代码码单元测试试复杂度圈复杂度度度量代码码分支情情况Iffor while casecatchthrowreturn & | ?复杂性越越高，测测试成本本越高复杂度编码规则则检查注释架构依赖结构构矩阵（DSM）设计度量量指标NOC派生类的数目DIT继承树的深度RFC类的外部响应LCOM4方法的内聚LCOM4Lack of cohesion of methods说明类内内部方法法和变量量之间的的关系指标LCOM4=0/BadLCOM4=1 /高LCOM4=

6、2/低SRP原则RFCResponseForClass通过检查查方法被被调用的的情况来来反映一一个类的的复杂程程度可以简单单的理解解为一个个类所包包含的方方法多寡寡复杂度从从类的内内部描述述，RFC从类的外外部来描描述RFC=M +RRFC =M+ RM =number of methodsinthe classR =number of remotemethods directly calledbymethods of theclassR= numberofremotemethodscalled, recursively throughthe entirecall tree设计设计高级度量量S

7、onar插件附加维度治理可视化集成IDE本地化多语言http:/display/SONAR/Sonar+Plugin+Library/插件改进效果果改进架构-模块划分分原则采用Maven多Project结构，先先根据职职能分Project，再根据据功能模模块分PackageREP(重用发布布等价原原则)重用的粒粒度就是是发布的的粒度CCP(共同封闭闭原则)包中所有有类对于于同一类类性质的的变化应应该是共共同封闭闭的ADP(无环依赖赖原则)在包的依依赖关系系图中不不允许存存在环设计-变化应对对之道视角描述关注点概念对象是一组责任软件要负责什么？规约对象是一组可以被其他对象或对象自己调用的方法（也

8、称行为）怎么使用软件？实现对象是代码和数据，以及它们之间的计算交互软件怎样履行自己的责任？MartinFowler的建议:对象的三三个视角角设计-变化应对对之道在概念上层层次上交交流，在实现层次次上执行行，客户端端无需准准确知道道具体操操作细节节，只需需一般性性（概念念性）知知道即可可只要概念念不变，客户端端就可以以与实现现细节的的变化隔离离开来案例：下下一节分分享去哪哪里听设计-变化应对对之道ProgrammingtoanInterface, notanImplementation客户对象象和服务务对象之之间的职责分配配使用抽象象类隐藏具体的实实现创建和使使用分离案例：评评价、资资料设计-变

9、化应对对之道Favorobjectcompositionoverclassinheritance但是设计计模式中中为什么么继承无无处不在在？不要按照照传统的方方式来使用继继承用新的行为为来特化现现有的具具体对象象案例：讲讲师分类类讲师男女主题A男主题B男主题A女主题B女性别讲师主题女男主题A主题B设计-变化应对对之道Designingfor Change在设计中中思考什什么应该该变化，并封装会发生变化的概念封装不只只是隐藏藏数据，也可以以是封装类型型变化不只只是算法法和行为为，可以以是任何何事情案例：委委托评价价讲师听众公司A公司B主办方usesusescreatecreate公司C设计-变化

10、应对对之道SingleResponsibilityPrincipleOpenClosed PrincipleLiskovSubstitutionPrincipleInterfaceSegregationPrincipleDependencyInversion Principle注释能用代码码来阐述述的，尽尽量不用用注释好的注释释应该解解释意图图，而不不是解释释操作什么也比比不上放放置良好好的注释释来得有有用什么也不不会比陈陈旧、提提供错误误信息的的注释更更有破坏坏性目录（一一）除了编码码，开发发还可以以做什么么编码规范范单元测试试 代码评审审静态检查查 持续集成成目录（二二） 补充动态检查查缺

11、陷管理理 性能测试试WEB前端分析析 自动化测测试除了编码码，开发发还可以以做什么么现状项目开发发过程中中，由于于开发人人员的经经验、代代码风格格各不相相同，以以及缺乏乏统一的的标准和和管理流流程，往往往导致致整个项项目的代代码质量量较差，难于维维护，需需要较大大的测试试投入和和周期等等问题。 措施可以采用用以下五五个步骤骤来保证证和提高高整个项项目的代代码质量量：统一一编码规规范、代代码样式式；静态态代码分分析（staticcodereview）；单元元测试；持续集集成；代代码评审审和重构构（Review&Refactor）。下面面将针对对每个步步骤和其其所使用用的工具具、方法法进行详详细描

12、述述。编码规范范规范统一一的编码码能提高高项目代代码的可可读性和和可维护护性，编编码规范范主要应包含含以下几几个方面面：一般规则则和格式式规范。例如代代码缩进进、程序序块规范范、每行行最大代代码长度度等。命名规则则。例如如包名、类名、变量、方法、接口、参数等等命名规规范文档规范范。例如如类文件件头声明明、类注注释、成成员变量量和方法法注释等等规范。编程规范范。例如如异常、并发、多线程程等方面面的处理理方式。其他规范范。例如如日志格格式、属属性文件件格式，返回值值和消息息格式。用eclipse控制代码码样式（一）一旦编码码规范确确定，就就可以利利用Eclipse来控制代代码样式式和格式式。点击E

13、clipse的Windows - Preference菜单项，在打开开的Preferences对话框的的左侧栏栏中找到到Java节点下的的子项Code Style，该项和它它的子项项允许您您对Java代码的样样式进行行控制：用eclipse控制代码码样式（二）可以在Eclipse提供的默默认代码码格式配配置的基基础上建建立自定定义的格格式。在Formatter面板中，点击New，输入新新的名字字并选择择一个默默认的配置作为为初始化化格式，如图所所示：用eclipse控制代码码样式（三）设置风格格如图所所示：代码静态态检查_CheckStyleCheckStyle用来检查查代码格格式、规规范、风

14、风格。检查并强强制执行行统一的的代码风风格；检查Javadoc；检查类、变量、方法的的命名；检查类和和方法的的大小；检查编码码错误，例如magicnumber；代码常见见问题举举例：代码中的的magic-number和magic-string：Strings=“0000”+ Integer.toString(ch, 16);0000、16的含义，作者几几周后就就忘记了了。CheckStyle的安装配配置（一一）CheckStyle插件地址址。自动安装装地址：http:/update下载地址址：http:/ CodeQualityTool 代码静态态检查_FindBugsFindBugs是一个j

15、ava代码的静静态代码码分析工工具，用用来发现现那些潜潜在的、常见的的、很难难被发现现的bug。与其他他静态分分析工具具不同，FindBugs不注重样样式或者者格式，它试图图只寻找找真正的的缺陷或或者潜在在的性能能问题。如NullPoint空指针检检查、没没有合理理管理资资源等。Findbugs插件地址址。自动安装装地址：http:/findbugs.cs./eclipse下载地址址：http:/ Bugs”操作：检查结果果： 单元测试试单元测试试单元测试试是最小小粒度的的测试，以测试试某个功功能或代代码块，一般由由程序员员来做。用例设计计和评审审设计阶段段需要具具体考虑虑要对哪哪些代码码单元

16、进进行测试试，被测测单元之之间的关关系，测测试策略略，以及及单元测测试用例例设计等等，并最最终输出出单元测试试用例设设计文档，用用来指导导具体的的单元测测试执行行。在用例设设计完成成之后，下一步步的工作作就是进进行测试试用例的的评审。个人的的理解和和经验始始终是有有限的，用例评评审可以以借集体体之力，对用例例设计进进入查漏漏补缺，进一步步保证测测试用例例的有效效性。单元测试试_JUnitJUnitJUnit是一个开开发源代代码的Java测试框架架，用于于编写和和运行可可重复的的测试。它是用用于单元元测试框框架体系系xUnit的一个实实例（用用于java语言）。主要用用于白盒盒测试，回归测测试。

17、下载地址址eclipse自带了JUnit，完整安安装包的的下载地地址：http:/ TestCase，如图：在Eclipse上执行Junit（三）新建测试试类：在Eclipse上执行Junit（四）下一步选选择要测测试的方方法：在Eclipse上执行Junit（五）完成HelloTest的Abs方法：在Eclipse上执行Junit（六）执行测试试程序，右键，RunAs-JUnit Test，就可以以看到JUnit测试结果果：绿色表示示测试通通过，只只要有1个测试未未通过，就会显显示红色色并列出出未通过过测试的的方法。单元测试试_EasyMock模拟对象象技术在实际项项目中，开发人人员自己己的

18、代码码往往需需要和其其他的代代码模块块或系统统进行交交互，但但在测试试的过程程中，这这些需要要被调用用的真实实对象常常常很难难被实例例化，利利用一个个模拟对对象来模模拟我们们的代码码所依赖赖的真实实对象，来帮助助完成测测试，提提高测试试覆盖率率。常见的模模拟技术术模拟技术术有很多多种，如如jMock，EasyMock，Mockito，PowerMock等等，下下面用EasyMock举例说明明如何模模拟对象象。EasyMock（一）EasyMock（二）/校验用户户名和密密码if(admin.equals(username)&123456.equals(password)ServletConte

19、xtcontext =getServletContext();RequestDispatcherdispatcher =context.getNamedDispatcher(dispatcher);dispatcher.forward(request,response);elsethrownewRuntimeException(Loginfailed.);EasyMock（三）为测试doPost()方法，需需要模拟拟HttpServletRequest等对象，以便脱脱离J2EE容器来测测试这个个Servlet。建立TestCase，名为LoginServletTest：publicclassL

20、oginServletTestextends TestCase 测试当用用户名和和口令验验证失败败的情形形：publicvoidtestLoginFailed()throwsException /创建mock对象MockControlmc=MockControl.createControl(HttpServletRequest.class);HttpServletRequestrequest=(HttpServletRequest)mc.getMock();EasyMock（四）/设置mock参数request.getParameter(username);/期望下面面的测试试将调用用此方法，

21、参参数为usernamemc.setReturnValue(admin,1);/期望返回回值为admin，仅调用用1次request.getParameter(password);/期望下面面的测试试将调用用此方法，参数数为 passwordmc.setReturnValue(1234, 1);/期望返回回值为1234，仅调用用1次/表示录制制完毕mc.replay();EasyMock（五）tryservlet.doPost(request,null);fail(Notcaught exception!);catch(RuntimeExceptionre)assertEquals(Login

22、 failed.,re.getMessage();/verify:mc.verify();运行JUnit，测试通通过！表表示我们们的Mock对象正确确工作了了！单元测试试_测试覆盖盖率分析析为了衡量量单元测测试的质质量和覆覆盖的范范围，需需要对单单元测试试的代码码进行测测试覆盖盖分析。具体采用用哪些指指标可以以根据项项目的实实际情况况来定，以避免免因过高高的指标标增加了了代码开开发人员员的工作作量而影影响了项项目整体体的进度度。业内比较较常用的的工具有有：1、Cobertura，对应的的eclipse插件：eCobertura。2、EclEmma是一款基基于EMMA的Eclipse插件，方方便

23、在Eclipse IDE中进行测测试覆盖盖率分析析。插件下载载地址：/Eclipse测试覆盖盖率分析析（一）下面说怎怎样在eclipse上执行测测试覆盖盖率分析析：先安装插插件EclEmma,然后在测测试用例例写好后后，可以以在右键键点击测试类，选择CoverageAs-JUnitTest.Eclipse测试覆盖盖率分析析（二）单元测试试执行完完后，Coverage视图中会会显示所所选择的的测试的的覆盖率率。双击击打开某某一具体体的类后后，可以以看到高高亮显示示的覆盖盖分析结结果，如如图所所示。红红色代表表测试没没有覆盖盖到该行行，黄色色表示部部

24、分覆盖盖，绿色色的行表表示该行行在本次次测试中中被覆盖盖到。Eclipse测试覆盖盖率分析析（三）在Coverage视图中可可以通过过点击鼠鼠标右键键将测试试覆盖分分析的结结果导出出成需要要的格式式，例如如HTML。单元测试试-FIRST原则Fast（快速）Independent（独立）Repeatable（可重复复）Self-Validating（自足验验证）Timely（及时）持续集成成持续集成成（Continuous Integration）是利用用一系列列的工具具、方法法和规则则，做到到快速的的构建开开发代码码，自动动的测试试化，来来提高开开发代码码的效率率和质量量 。持续集成成的提出

25、出如果项目目开发的的规模比比较小，比如一一个人的的项目，如果它它对外部部系统的依依赖很小小，那么么软件集集成不是是问题，但是随随着软件件项目复复杂度的增加加（即使使增加一一个人），就会会对集成成和确保保软件组组件能够够在一起工作提提出了更更多的要要求-要早集成成，常集集成。早早集成，频繁的的集成帮助项目目在早期期发现项项目风险险和质量量问题，如果到到后期才才发现这这些问题，解决问问题代价价很大，很有可可能导致致项目延延期或者者项目失失败。持续集成成持续集成成的常见见做法是是：持续续集成框框架+版本管理理器+构建工具具。1、持续集集成框架架常用的的有：Jenkins、Continuum、Crui

26、seControl等。2、版本管管理器常常用的有有：ClearCase、Wincvs、SVN等。3、构建工工具常用用的有：Ant、Maven。后面主要要以SVN+Jenkins +Ant实现方式式举例说说明。 持续集成成_版本管理理器持续集成成_自动构建建Ant在构建过过程方面面十分优优秀，它它是一个个基于任任务和依依赖的构构建工具具。下载载地址：http:/bindownload.cgiMaven不单是构构建工具具，也是是个项目目管理平平台。下下载地址址：http:/maven./download.htmlMaven与Ant对比，一一些使用用上的区区别：1、Maven是基于中中央仓库库的编译

27、译，即把把编译所所需要的的资源放放在一个个中央仓仓库里，如jar，tld等。当编编译的时时候，maven会自动在在仓库中中找到相相应的包包,而ant需要自己己定义了了。用maven编译的项项目在发发布的时时候只需需要发布布源码，小得很很，而反反之，ant的发布则则要把所所有的包包一起发发布。2、Maven有大量的的重用脚脚本可以以利用，如生成成网站，生成javadoc，sourcecode reference，等。而而ant都需要自自己去写写。3、Maven目前不足足的地方方就是没没有象ant那样成熟熟的GUI界面。 持续集成成_持续集成成框架有了自动动构建后后，我们们就可以以通过Jenkin

28、s每天定时时用Ant脚本或Maven，加上JUnit、Cobertura/EMMA等的ANT脚本调用用，每一一次的构建都都可以把把这些检检查工作作自动的的进行一一遍测试试。然后后生成测测试报告进行查查阅。Jenkins（Jenkins的前身）可以说说在安装装和配置置上最简简单的CI产品。Jenkins是基于java开发的，但它不不仅限于于构建基基于Java的软件，还能构构建.net、Python、Ruby等。Jenkins提供了一一组很明明确和可可扩展API的Jenkins组件。这这批组成成一个大大的类库库的Jenkins组件反过过来又丰丰富了Jenkins的功能；它们都都是开源源的，而而且它

29、们们可以直直接通过过Jenkins的控制台台来进行行安装。安装软件件下载地地址：http:/ Jenkins安装要点点将jenkins.war拷贝到tomcat的webapps目录下；修改Tomcat-7.0.8confserver.xml文件，设设置UTF-8编码：通过以下下方式修修改Jenkins_HOME的位置：在Jenkins的web.xml中找到Jenkins_HOME，默认value为空值，将其设设置为你希望望的路径径，然后后重启。 Jenkins首页Jenkins管理界面面Jenkins插件安装装（一）Jenkins插件安装装（二）JenkinsJob（一）JenkinsJob（

30、二）JenkinsJob（三）JenkinsJob（四）Jenkins质量度量量（一）Jenkins质量度量量（二）openEAP应用的实实践（一一）以下演示示在实际际的openEAP项目中，怎样自自动化完完成以上上活动。演示的是是一个web项目，目目录结构构如下图图所示： openEAP应用的实实践（二二）因为相关关依赖资资源都已已经在quality目录下了了（运行行只依赖赖数据库库环境，没有对对数据库库操作进进行模拟拟），所所以可以以直接通通过ant执行quality目录下的的build.xml，脚本执执行完毕毕后，生生成的报报告在quality目录下，如下图图所示： openEAP应用的

31、实实践（三三）也可以发发布到Jenkins上执行构构建： openEAP应用的实实践（四四）在Jenkins上查看报报告： 代码评审审代码评审审（Code Review）是Java项目开发发过程中中的一个个重要步步骤，代代码评审审可以帮帮助发现现静态代代码分析析过程中中无法发发现的一一些问题题，例如如代码在在逻辑上上或者功功能上是是否存在在错误，代码在在执行效效率和性性能上是是否有需需要改进进的地方方等。代代码评审审还可以以帮助新新进入项项目组的的成员快快速学习习和了解解项目，促进经经验分享享。代码码评审主主要包括括两种形形式，同同级评审审（Peer Review）和小组组评审（GroupRe

32、view）。同级级评审主主要指项项目成员员间的互互相评审审，小组组评审是是指通过过召开评评审会议议，项目目成员一一起对项项目代码码进行评评审。为了提高高代码评评审的有有效性和和效率，可以借借助一些些外部工工具，比比较常用用的代码码评审工工具有Jupiter和Code Striker。Jupiter是一款开开源的Eclipse插件，允允许成员员将评审审意见定定位到真真实代码码的具体体行，由由于代码码评审的的结果以以XML文件的形形式保存存。Jupiter使用Eclipse插件下载载地址：http:/ 动态检查查_JConsole（一）JConsole是一个基基于JMX的GUI工具，用用于监控控正

33、在运运行的JVM。JConsole是jdk5.0自带的工工具，所所以如果果安装的的的jdk5以上版本本，那么么就不用用去另外外安装。JConsole毕竟是JDK自带的东东西，功功能虽然然没有一一些商业业软件那那么强大大，但是是稳定性性好，在在大压力力情况下下也不会会发生什什么问题题。而且且，提供供了相对对全面的的系统监监控功能能。在待监控控的JVM启动命令令上增加加以下参参数，JConsole就可以远远程连接接并监控控了。-Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=fa

34、lse-Dcom.sun.management.jmxremote.port=7080其中7080是Jconsole连接的端端口。 动态检查查_JConsole（二）在本机运运行jdkbinjconsole.exe，输入远远端机器器的IP、JMX端口就可可以连接接上去了了。如下下图所示示： 动态检查查_JConsole（三）在本机运运行jdkbinjconsole.exe，输入远远端机器器的IP、JMX端口就可可以连接接上去了了。如下下图所示示：动态检查查_JMX（一）JMX（Java ManagementExtensions，即Java管理扩展展）是一一个为应应用程序序、设备备、系统统等植入

35、入管理功功能的框框架。通通常使用用JMX来监控系系统的运运行状态态或管理理系统的的某些方方面，比比如清空空缓存、重新加加载配置置文件等等 。下面举例例说明怎怎样通过过JMX监控自己己的程序序：1、Hello是一个需需要被管管理的类类： 动态检查查_JMX（二）2、要管理理Hello则必须创创建一个个相应Mbean：说明：包包含在MBean中方法都都将是可可以被管管理的。MBean起名是有有规范的，就是原原类名后后加上MBean字样。 动态检查查_JMX（三）3、创建Agent类注册服服务MBean： 动态检查查_JMX（四）4、运行后后通过JConsole监控的情情况如下下图： WEB前端分析

36、析（一）为什么关关注前端端性能分分析？“系统响响应时间间”指应应用系统统从请求求发出开开始到客客户端接接收到所所有数据所消消耗的时时间。这这样，“系统响响应时间间”加上上“呈现现时间”，才是完整的的用户感感受到的的响应时时间。 响应时间间=网络响应应时间+应用程序序响应时时间+浏览器处处理时间间响应时间间=（N1+N2+N3+N4）+ (A1+A2+A3)+TbWEB前端分析析（二）为什么关关注前端端性能分分析？ WEB前端分析析（三）Yahoo!的ExceptionalPerformance团队为改改善Web性能带来来最佳实实践。他他们为此此进行了了一系列列的实验验、开发发了各种种工具、写了

37、大大量的文文章和博博客并在在各种会会议上参参与探讨讨。最佳佳实践的的核心就就是旨在在提高网网站性能能。Excetional Performance团队总结结出了一一系列可可以提高高网站速速度的方方法。可可以分为为7大类34条。包括括内容、服务器器、cookie、CSS、JavaScript、图片、移动应应用等七七部分。详情请参参考附件件：雅虎团队队经验-网站页面面性能优优化的34条黄金守守则.pdf WEB前端分析析（四）Yahoo!的ExceptionalPerformance团队为改改善Web性能带来来最佳实实践。他他们为此此进行了了一系列列的实验验、开发发了各种种工具、写了大大量的文文章

38、和博博客并在在各种会会议上参参与探讨讨。最佳佳实践的的核心就就是旨在在提高网网站性能能。Excetional Performance团队总结结出了一一系列可可以提高高网站速速度的方方法。可可以分为为7大类34条。包括括内容、服务器器、cookie、CSS、JavaScript、图片、移动应应用等七七部分。详情请参参考附件件：雅虎团队队经验-网站页面面性能优优化的34条黄金守守则.pdf WEB前端分析析（五）常用的前前端性能能分析工工具有：FiddlerIBMPageDetailer（商用）FireBugYahooYSlowHTTP Analyzer（商用）AOLPageTest建议采用用IBMPageDetailer、YahooYSlow。 缺陷管理理缺陷管理理/软件缺陷陷管理（DefectManagement）是在软软件生命命周期中中获取、