博客地址:http://blog.csdn.net/FoxDave
确保代码一致性和质量
软件开发团队常常同项目的一致性和高质量做斗争。不同的开发者有不同的编码风格和偏好。在每个团队都有技术优秀的独立开发者和相对经验较少的开发者。并且,许多组织都有特定的软件开发必须遵守的条例。所有的挑战都使得开发者难以一直关注,特别是当项目结束日期近在咫尺时,开发者往往通过牺牲质量而把任务尽快完成,长久来看这种做法危害更大。
选择JavaScript库并使用代码规范
如果你的团队以前构建过SharePoint定制化项目,你很可能已经有了编码规范来描述你如何构建定制化和项目中使用的工具和库。使用代码规范可以使你消除个体开发者的偏好,使整个代码更容易维护。同时编码规范也反映了过去几年你的团队积累下来的经验,使你在做定制化时更高效和高质量。
SharePoint Framework专注于客户端开发,推荐使用TypeScript来帮助开发者编写更好的代码并在编译过程中捕获不一致的地方。完成同一个任务也有成百上千的客户端库。如果你的团队以前做过客户端开发,你可能已经对某个特定库有所偏好。如果没有的话,推荐你去找一些在你的团队乃至全公司进行应用。
通过使用公共库你可以使新团队成员更容易地融入团队,也可以使团队间的成员交换变得更加容易。当你从客户端开发方面得到更多经验时,你的组织中所有的项目都可以从中受益。在全公司的层面标准化你的项目也可以缩短周期,降低维护项目的成本。互联网上的库每天都会更新,如果你一直在持续地更换最新版本,你会发现工作得很低效。
这种做法也帮助你提升了绩效。因为全公司使用的都是相同的库,开发者只需要下载一次就可以了。
从最受欢迎的库中选择一个可以使你复用很多知识和经验,比如某个开发者对它有相当长时间的应用和了解,并且这样的库已经修复了很多问题。并且这样的库也有自己的编码规范,你可以拿来采用。通过这样的手段可以让员工提高产出。
例如,构建SPFx解决方案,微软选择React。同时微软的其他团队如OneDrive、Delve也使用React。这不是说你要使用React,而是要证明选择客户端库的重要性。如果你的团队对Angular或Knockout有经验,就应该愉快地使用它们。
在解决方案的整个生命周期强制编码规范和策略
使用代码规范给你带来了好处,但是只有编码规范并不意味着它们在你的整个开发和测试过程中使用了。时间越长就越难验证你的团队是否很好地执行了编码规范和组织策略,发现问题整改的成本也就越高。下面是一些建议的方法。
Linting
Linting是这样一个过程,它验证代码是否符合特定的规则。默认情况下SPFx项目采用TypeScript构建。在每个构建的TSLint(TypeScript的linter)上会根据预定义的规则集合进行分析并报告矛盾的地方。开发者可以选择启用哪个规则,也可以根据团队的规范和指引定义自己的规则。
开发者不仅可以使用linting来验证TypeScript文件的内容,还有CSS、JavaScript或Markdown。
自动化测试
使用自动化测试开发者可以很容易地验证应用最新更改后工程的正确性。自动化测试使开发者能够验证解决方案是否正确工作,尽早发现可能发生的问题。
SPFx提供了对Karma测试标准的支持,可以使用Mocha编写测试。如果有需要,开发者还可以使用SPFx额外提供的PhantomJS来扩展测试的范围。所有SPFx项目的测试都可以使用标准的gulp test任务执行。
代码分析
除了上述的内容,开发者常常还需要更多的支持来验证项目的正确性。通常来说linter关注于代码本身,但是没有特定代码文件用来做什么的部分。例如在SPFx项目中,一个web部件需要有唯一的ID。再就是来自公司的其他需求如不能从CDN引用脚本或引用特定版本的库。
SharePoint Code Analysis Framework(SPCAF)是一个第三方的解决方案,常被SharePoint开发者、管理员、QA和安全员使用,用来验证SharePoint自定制满足需求。SPCAF跟应用的整个生命周期进程集成,帮助降低成本。SPCAF提供了一系列专门针对SPFx项目的规则。