Shell 脚本和自动化指南

Question

我目前正在开发一些脚本，这些脚本可以自动化很多东西并且相当中等大小。我已经开始遵循某些事情来使我的脚本通用和可移植，例如：

• 管理员登录用于调度脚本
• 使用绝对路径
• 使用配置文件
• 在开发时使用写入主机并在部署（调试）时切换到日志记录

我最感兴趣了解是否有任何标准脚本技术和指南旨在使脚本开发人员的生活变得简单。我同时使用 perl 和 powershell，因此非常欢迎和赞赏更通用的建议。

感谢您提前提供的任何帮助。
钢铁用户

Answer 1

这有点宽泛，我确信这是主观的。不过，我已经完成了一些脚本工作，并且可以提供一些我从经验中学到的东西。

1. 让您的脚本数据驱动。硬编码尽可能少的东西。所有诸如路径、资源位置等的内容都应该可以从配置文件中更改，而不是通过编辑主脚本来更改。这与您关于绝对路径的观点相关。对所有路径进行硬编码是不行的。让一切变得相对会带来太多的限制。最好有一个名为 DATA_ROOT 的变量，您可以修改该变量，然后让所有例程引用诸如 ${DATA_ROOT}/resources/images 之类的内容> 等等。 ${PROGRAM_ROOT} 也很有用，这样您就可以安装多个套件来测试等。
2. 错误检查。脚本语言通常是动态类型的，因此请确保检查所做的每件事的返回值。创建一个库，您可以使用它执行诸如 call_safely(fn, arg0, arg1,.. ) 和 call_and_abort_on_failure(fn, arg0, arg1,...) 之类的事情甚至可能是有意义的。
3. 自由地评论和记录。脚本更容易修改已编译的程序，因此当人们想要扩展它们时，它们经常以错误的方式进行修补。确保您的 API 有完整的文档记录，以便当人们想要添加新的命令行选项时，他们知道如何操作，而不是在您的 API 之上编写包装脚本。
4. 让一个脚本做一件事，如果需要的话可以编写聚合器。具有 if(FLAG) {do_something} else {do_something_completely_other} 的脚本会杀死你。让您的脚本做一件事并做好它，如果您愿意，您可以根据需要编写委托给这些脚本的包装器（以获得更好的用户体验）。
5. 自由使用第三方工具，而不是发明自己的工具。命令行解析、文本处理等都是老领域，有很多库可以很好地完成这些任务。使用它们而不是重新实现。 最无错误的程序是从未编写过的程序。
6. 让您的日志记录和测试框架坚如磐石。当糟糕的事情发生时，您应该知道一切，而不必重新运行脚本。从第一天开始就使用一些标准的日志记录框架，并使其可通过可按需重新加载的文件进行配置。确保您的代码经过单元测试，以便在进行新更改时不会引入回归错误。另外，记录计时指标，以便您随着时间的推移了解脚本在哪里变慢。将来会有用的。
7. 让您的脚本尽可能免于修改。这很难描述，但我可以给你举个例子。我有一些脚本来跟踪各个分支的构建的各种指标并将它们放入一个目录中。我编写它的目的是，如果您想要跟踪分支 foo，您所要做的就是在某个位置创建一个名为 foo 的目录，它就会跟踪该目录。您不必修改很多东西，真正想要跟踪指标的经理可以根据需要创建目录。

这些是我从头到尾能想到的几点。

Answer 2

只是一些我认为好的做法：

• 只要您在运行时捕获它们，使用绝对路径就可以了。请参阅此问题。
• 对于配置文件，使用一些易于处理的格式，例如 xml 或 yaml。
• 不要使用 write-host，使用更好的 write-output 或 < code>write-log 或者，更好的是，实现一个自定义函数，该函数允许您根据配置文件上的设置在控制台/日志之间切换。有关更多详细信息，请参阅我对此问题的回答。

这些只是根据您的观点提出的一些建议。

---

编辑 关于采用 XML 配置文件的注意事项

使用 XML，因为您的配置文件将包含一些设置，并且您将仅通过脚本对其进行管理。

---

希望这有帮助

干杯