GitHub推出Scientist,帮助开发者重构关键路径代码
GitHub最近正式发布了 Scientist 1.0,这是一个能够帮助开发者更有信心地重构或重写代码的Ruby库, 作者 是GitHub的工程师Jesse Toth。在过去几年中,Scientist已经为GitHub上的大量项目所用。
按照Toth的看法,Scientist对于关键代码的重构尤为实用,在进行这种重构时,开发者对于新的实现的正确性要具备很强的信心。在此之前,一种常见的重构方法是采取 BranchByAbstraction 架构模式,这种模式本身虽然非常实用,但它只是保证了新的组件能够取代旧组件所出现的每一个场合而已。而Scientist的目标是提供更好的正确性保障。此外,Scientist还将尝试绕开测试过程的限制,因为测试过程往往无法做到涵盖所有可能的情况或输入数据的组合。
Scientist的基本思想是建立一种受控试验(experiment),在其中同时运行旧的代码路径与新的代码路径,随后对两者的输出进行比较,并对任何不匹配或异常进行记录。旧的代码路径将保证整个系统在重构的实验阶段仍能够正确地运行,而新的代码路径的正确性也同时得到了验证。
一个experiment是一种轻量级的抽象,它包含了两种行为。use行为表示执行旧的代码路径,而try行为则表示执行新的代码路径。
experiment = Scientist::Default.new "my-experiment" experiment.use { <call the old code here, the control> } experiment.try { <call the new code here, the candidate> } experiment.run #... def publish(result) #...
run方法将始终返回与use代码块相同的返回结果,而publish方法将在experiment的末尾进行调用,以发布所收集到的数据。除了对try与use代码块的结果进行比较之外,Scientist还会随机地调整他们的执行顺序,以回避两者之间可能产生的相互关联,它还将评估两种方法的执行时间、管理异常、并发布所收集到结果。
Scientist提供了大量的方法对它的默认行为进行自定义,举例来说,用户可以定义一个特定的比较方法,以覆盖默认的 == 操作符,这一方法将用于输出的对照比较。此外,用户还可以提供一个上下文对象,可在发布数据时使用。用户还可以控制启动任务、启动或关闭experiment的执行等等。Scientist还提供了一些更高级的控制选项,以允许用户忽略结果、运行多个try代码块、或只运行try代码块,以涵盖某些特殊的用例。
InfoQ与GitHub的首席工程师Jesse Toth进行了一次对话。
能否请你描述一下Scientist的诞生过程?
Scientist的诞生过程是这样的。当时我有一位前同事Rick Bradley正在尝试重构一个非常复杂的API终结点,该API将返回一个长长的repository列表。他不确信所改动的代码是否已经得到了足够的测试覆盖,并希望通过某种方式对真实的数据集进行测试。于是他快速地修改了一部分代码以调用重构后的方法,并且每当重构后的方法与原始方法产生不一致行为的时候,就在我们的指标栈中将数据记录下来。这种方法相当有效,于是我们为它编写了一个库,让任何人都可以利用它进行相同的实验。
为了让现有的代码能够通过Scientist进行一系列实验,所改动的代码会产生多大的开销?你在GitHub中又是怎样在使用Scientist时调整它的投入与产出比的呢?
这取决于你希望进行实验的那部分代码有多大开销,以及这部分代码的调用频率。如果候选的重构代码与对照的原始代码具有完全相同的效率,那么运行一个experiment就是2倍的开销。如果候选代码极大地提升了性能,那么开销就会大大地降低。
如果我们认为运行Scientist experiment的代价很高,那么我们就会缓慢地提高运行experiment的请求的比例。如果experiment的执行能够涵盖1%或5%的访问量,这就已足够为我们收集大量的性能与不匹配方面的数据了。
你是否希望在Scientist中引入更多的特性?
Scientist已经具备了我们目前所需的所有特性,当然,如果有用户发现了某种使用Scientist的其他方式,并希望为支持这一方式而添加相应的特性,我们将非常乐于看到这方面的贡献。
Scientist所需的运行环境是已安装了Ruby 1.9的Unix系统,可以从对应的 gem 中进行安装。
查看英文原文: GitHub's Scientist Aims to Help Refactoring Critical Paths
</div>来自: http://www.infoq.com/cn/news/2016/02/github-scientist-refactoring