编写 Linux 实用程序的艺术(一)

摘要

Linux 因附带大量的工具和集成这些工具的优秀方法而著名。Peter Seebach 将讨论新工具是如何开发的，以及如何把一个一次性的程序转变为您将在未来几年中使用的实用程序。

Linux 和其他类 UNIX 系统总是附带了大量的工具，它们执行从显而易见的到不可思议的广泛功能。类 UNIX 编程环境的成功很大程度上归功于工具的高品质和选择，以及这些工具之间相互衔接的简易性。

作为开发人员，您可能会发现现有实用程序并不总是能够解决问题。虽然能够通过结合使用现有实用程序来容易地解决许多问题，然而解决其他问题却至少需要一些实际的编程工作。这些后面的任务通常是创建新实用程序的候选任务，结合现有实用程序来创建新实用程序可以通过做最少的工作来解决问题。本文考察优秀实用程序所具有的品质，以及设计这种实用程序所经历的过程。

优秀的实用程序具有哪些品质？

Kernighan & Pike 所著的 The UNIX Programming Environment 一书中包含了对此问题的精彩讨论。优秀的实用程序是把自己的工作做得尽可能好的实用程序。它必须与其他实用程序配合融洽；必须能够容易地与其他实用程序结合使用。无法与其他实用程序结合使用的程序不是实用程序，而是应用程序。

实用程序应该允许您根据手边的材料廉价而容易地构建一次性的应用程序。许多人认为实用程序就像是工具箱中的工具。设计实用程序的目标不是为了让单个工具来做所有事情，而是为了拥有一组工具，其中每个工具都尽可能好地做一件事情。

有些实用程序自身就是相当有用的，而其他实用程序则必须与一系列实用程序配合使用。前者的例子包括 sort 和 grep。另一方面，xargs 除了与其他实用程序（最常见的是 find）配合使用外，很少单独使用。

使用什么语言来编写实用程序？

大多数 UNIX 系统实用程序都是用 C 语言来编写的。本文中的例子使用 Perl 和 sh。应该使用恰当的工具来做恰当的事情。如果您对某个实用程序使用得足够频繁，那么用编译型语言来编写它的成本也许能通过性能提升来获得回报。另一方面，对于程序的工作负荷很轻这种相当普遍的情况，使用脚本语言也许会提供更快的开发速度。

如果无法肯定，您应该使用自己最了解的语言。至少当您在对某个实用程序进行原型化，或在弄清它是如何有用时，程序员效率将优先于性能调整。大多数 UNIX 系统实用程序都是用 C 编写的，这只是因为这些实用程序使用得足够频繁，以致考虑效率比考虑开发成本更加重要。Perl 和 sh（或 ksh）可能是用于快速原型化的很好语言。对于与其他程序配合实用的实用程序，使用 shell 来编写它们或许要比使用更传统的编程语言来编写它们要容易一些。另一方面，当您希望与原始的字节交互时，C 或许就是最好的选择。

设计实用程序

一个不错的经验法则就是当您第二次必须解决某个问题时，首先考虑实用程序的设计。不要对第一次编写的一次性作品感到遗憾；您可以将它看作是一个原型。第二次，请把您所需的功能与第一次所需的功能作比较。在第三次前后，您应该开始考虑花时间来编写一个通用实用程序。即使纯粹的重复性任务也可能会给实用程序的开发带来好处；例如，由于人们对尝试以通用的方式重命名文件感到失望，于是开发了许多通用文件重命名程序。

下面是一些实用程序设计目标；每个目标将在下面单独的小节中介绍。 　　

做好一件事情。 　　

成为一个过滤器。 　　

通用化。　　

健壮。 　　

新颖。

做好一件事情

做好一件事情；不要糟糕地做多件事情。关于做好一件事情的最佳例子或许是 sort。除了 sort 外，没有其他 哪个实用程序具有排序功能。基本的思想很简单：如果一次仅解决一个问题，您就能花时间把它解决好。

设想一下，如果大多数程序都具有排序功能，但是有些仅支持按词法排序，而其他一些仅支持按数字排序，另外一些甚至支持关键字选择而不是对整行排序，那将是一件多么令人沮丧的事情。起码，这也是恼人的。

当您发现某个问题需要解决时，应尝试将问题分解为多个部分，不要重复那些其他实用程序中已经存在的部分。您对允许配合现有工具使用的工具关注得越多，您的实用程序就越有可能保持有用。

也许您需要编写多个程序。完成专门任务的最佳途径通常是编写一两个实用程序，再用一些线索将它们联系起来，而不是编写单个程序来解决整件事情。使用 20 行的 shell 脚本来将新的实用程序与现有工具结合起来是很理想的。如果尝试一次解决整个问题，随之而来的第一个变更就可能要求您全盘重新考虑。

我偶尔需要从数据库生成两列或三列的输出。编写一个程序在单个列中生成输出，然后结合使用一个对输出进行分列的程序，这样通常会更有效率。组合这两个实用程序的 shell 脚本本身是临时性的，单独的实用程序比这个脚本的使用寿命更长。

有些实用程序服务于非常专一的需要。针对一个包含大量内容的目录，如果 ls 的输出非常快地滚出屏幕，这可能是因为其中有一个文件具有非常长的文件名，从而迫使 ls 仅对输出使用单个列。使用 more 来对输出分页会花一些时间。为什么不像下面这样就按长度对行排序，然后通过 tail 来管道输出结果呢？

　　 清单 1. 世间能找到的最小实用程序 sl

#/usr/bin/perl -w
print sort { length $a <=> length $b } <>;

清单 1 中的脚本确切地就做一件事情。它不接受任何选项，因为它不需要选项；它仅关心行的长度。归功于 Perl 便利的 <> 表达方式，这个小实用程序既适用于标准输入，也适用于命令行指定的文件。

成为一个过滤器

几乎所有实用程序都最适合想像为过滤器，尽管有一些非常有用的实用程序不符合这个模型。（例如，某个程序在执行计数时可能非常有用，尽管它作为过滤器工作得并不好。仅接受命令行参数作为输入并潜在地产生复杂输出的程序可能非常有用。）然而，大多数实用程序都应该作为过滤器来工作。根据惯例，过滤器对文本的行起作用。大多数过滤器都应该支持多个输入文件。

记住实用程序需要在命令行和脚本中运行。有时，理想的行为会稍有不同。例如，大多数版本的 ls 都会在向终端写出时自动将输入排序到多个列中。grep 的默认行为是在指定多个文件的情况下打印从其中找到匹配项的那个文件名称。这样的差别应该与用户希望的实用程序工作方式有关，而不是与其他事项有关。例如，旧版本的 GNU bc 在启动时显示强迫性的版权标记。请不要那样做。让您的实用程序仅做它应该做的事情。

实用程序喜欢生活在管道中。管道允许实用程序专注于自己的工作，而不是去关注旁枝末节。为了生活在管道中，实用程序需要从标准输入读取数据，然后向标准输出写出数据。如果您希望处理记录，那么您最好能够使每一行成为一个“记录”。诸如 sort 和 join 之类的现有程序已经在那样考虑了。它们将会因为您这样做而感谢您。

我偶尔使用这样一个实用程序，它针对一个文件树反复调用其他程序。这充分利用了标准的 UNIX 实用程序过滤器模型，但是该模型仅适用于读取输入然后写出输出的实用程序；不能将它用于就地操作或接受输入输出文件名的实用程序。

可以使用标准输入来运行的大多数程序也完全可以针对单个文件或一组文件运行。注意，可以证明这样违背了反对重复工作的规则；显而易见，这可以通过将 cat 的输出馈送给该系列中的下一个程序来解决。然而这在实践中似乎是合理的。

有些程序可能合法地读取一种格式的记录，但是却产生完全不同的输出。这样的一个例子就是将输入材料划分为列的实用程序。这样一个实用程序可能将输入中的行视为记录，但是却在输出中的每行上产生多个记录。

并非每个实用程序都完全符合这个模型。例如，xargs 不是接受记录而是接受文件名作为输入，并且所有的实际处理都是由其他程序完成的。