编程最佳实践

您应该遵循常见的编程最佳实践来减少错误并提高扩展的质量和可维护性。

以下最佳实践列表解决了第三方扩展中常见的问题。

遵循一套编码标准

编码标准是一套指导方针，描述了应该如何编写代码。这些标准定义了决定代码风格的编码实践。无论您是单独的开发人员还是团队的一员，遵循一组编码标准都将有助于使您的代码保持一致和可维护。

Magento 的编码标准基于以下内容：

• Zend 编码标准
• PSR2
• PSR4

为了帮助您遵守编码标准，我们建议您使用PHP_CodeSniffer 工具。

编写和使用可重用代码

避免使用难以维护的冗余或重复代码。不要在整个扩展中复制和粘贴相同的代码，而是创建单个类或方法并在需要时引用它。

作为一般规则，尽可能多地重用代码以防止代码重复。

您编写的代码应该小而集中，并提供通用的解决方案。这将帮助您在未来的开发中重用代码。

设计可替换的代码

设计和编写可替换的代码与使其可重用同样重要。具有可替换的设计意味着您的代码是模块化且松散耦合的，这使得更新和改进更容易。

当发现错误或更新策略可用时，用更新更好的部分替换部分代码库是常见的做法。在您的代码库中编写可替换的代码使这种做法更容易、更有效。

避免创建辅助类

帮助程序或实用程序类是充满静态方法的类，这些方法不太适合其他任何地方。这些类被认为是一种反模式并且违反了面向对象编程的原则。

如果您有ClassA和 可以ClassAHelper使用静态函数，ClassA则应考虑将这些函数重构为ClassA.

作为随机方法的包罗万象的辅助类违反了单一职责原则，因为它试图在单个类中解决多个问题。您应该重构您的代码并将这些函数移到适当的类中。

与大小写和命名约定保持一致

您的文件、文件夹名称、类和方法的命名约定应该保持一致。遵循标准约定使您的代码更易于阅读并看起来更专业。

不遵循这种做法是违反代码标准的，并会影响您的扩展的可读性和可维护性。

组合优于继承

类继承是面向对象的编程概念，处理代码重用和扩展基类的行为，这是 Magento 1 开发的首选。

对象组合是组合类对象和数据类型以创建更复杂的类的编程概念。类和数据类型一起使用以产生所需的功能。

对于 Magento 2扩展开发，我们鼓励使用对象组合而不是类继承。使用组合而不是继承使您的扩展在发生类更改时更易于维护，并在需要实现新功能时进行更新。

使用周围插件

避免在不需要时使用around 方法插件，因为它们会增加堆栈跟踪并影响性能。环绕方法插件的唯一用例是当您需要终止所有其他插件和原始方法的执行时。

访问方法参数是使用around方法插件而不是after方法插件的主要理由。

从 2.2 开始，方法插件允许您访问方法参数。如果您需要使用参数替换或修改函数结果，请使用after方法插件。

测试你的代码

编写可测试的代码并按照Magento 测试指南为您的代码创建测试。

测试有助于描述您的代码在不同条件下的作用并定义其功能。确保您的测试涵盖各种条件，以防止在添加新代码时引入错误。