Xcode执行静态代码分析
在项目的开发之中,每个开发者最激动最高兴看到的是自己编写的代码,不用太多的调试就可以畅通无阻的运行,无任何bug侵袭。但这只是个理想的状态,看起 来运行良好的代码往往都会存在潜在位置的bug,这是每位开发者最头痛的事,也是每位开发者都想极力避免的事情。所以如果手头用到的IDE能够比较给力的 话,那么我们就可以避免程序中许多的bug。Xcode作为一款强大的Objective-C的IDE,其内置提供了很多开发工具来辅助开发者的日常开发 工作,最大限度的降低开发难度,本篇简单介绍下Xcode中的静态代码分析功能。
静态分析的主要目的:
代码中的bug往往是由于开发者忽略一些代码缺陷而造成的,这些代码缺陷可能是极其微小的错误,以至于在程序的编译期并未给出很好的错误, 从而导致这些代码缺陷在程序的运行期以某种非正常形式呈现出来。那么对于开发这开说,这些微小的代码缺陷,往往是很难跟踪调试的,因此也为修复代码带来了 很大困难。Xcode静态代码分析的作用即发现项目源代码中的某些代码缺陷,并分类进行提示,以方便开发者及时关注并加以修改,从而把代码缺陷(潜在的 bug)及时清除。
静态分析错误提示分类:
Xocde的静态代码分析工具会接卸项目的源代码,并以以下集中错误类型加以标识:
- 逻辑缺陷,例如访问未初始化的变量或空指针的解引用
- 内存管理缺陷,如内存泄露
- 无用存储缺陷(永不会被访问的变量)
- 因未遵从项目用到的框架(frameworks)或类库(libraries)所规范而导致的API使用缺陷
第一次在项目中执行静态分析时,可能会发现许多错误。但经常性的执行静态分析并修复发现的代码缺陷,之后的遇到的错误会越来越少。这对于编写强壮的代码是很有帮助的。
但要注意的是,静态分析未报告错误,并不意味者程序没有错误。静态分析工具并不是万能的,不会检测到源代码中的所有错误。
静态代码分析的使用举例:
以新建StaticCodeAnalysisDemo功能为例。新建MJIssueViewController测试文件,并编写两个会提示静态分析错误的测试方法,代码如下:
// Dead store - (void)issueCodeBlockA { CGRect frame = CGRectMake(0.0, 0.0, 100, 100); } // Memory , Potential leak of an object - (CGGradientRef)issueCodeBlockB { CGGradientRef gradient ; CGColorSpaceRef colorSapce = CGColorSpaceCreateDeviceRGB() ; CGFloat components[16] = { 211/255.0 , 101/255.0 , 98/255.0 , 1.0 , 215/255.0 , 54/255.0 , 45/255.0 , 1.0 , 193/255.0 , 19/255.0 , 0 , 1.0 } ; CGFloat locations[] = {0.0 , 0.5 , 1.0 } ; int locationNum = 3 ; gradient = CGGradientCreateWithColorComponents(colorSapce, components, locations, locationNum); return gradient ; }
长按Xcode左上角的Run按钮中,在弹出的下拉列表选择Analyze,之后工程会进行自动进行build,
在成功后,在左侧栏的Issue Navigation一栏中,我们可以看到Xcode静态分析工具为我们展示的一些错误提示。如下图:
此处包含了Dead Store和Memory错误提示,Dead Store提示了在方法中不会被使用的变量frame ;Memory提示了潜在内存泄露错误(gradient变量未调用CGGradientRelease函数进行释放)。
接着,点击左侧错误导航中的提示之一,我们看到Xcode以一种图形化的导向方式为我们指定错误发生的流转方式,第一次看觉得还是比较炫的。
这样,按照静态分析工具的错误提示指引,我们可以预先发现那些代码缺陷,及时进行修复,这样代码发生错误的概率将明显减少。
设置工程自动进行静态分析
选中工程文件,在TARGETS的Build Settings选项中的搜索栏中搜索关键字,Run Static Analyzer,在结果中,Build Options下会显示Run Static Analyzer选项设置,双击该选项并在弹出窗口中将NO改为YES,