PHP 关于抽象类和接口的命名约定

Question

抽象类是否应该总是以Abstract为前缀并以Interface后缀（当它是接口时）？ 是否有任何标准命名约定，类似于文件夹结构/命名空间的 PSR-0，但对于类？

这似乎是多余的，因为该语言为此具有文字关键字。

abstract class AbstractFoo {}

interface InterfaceFoo {}

trait TraitFoo {}

Answer 1

虽然没有任何约定，但我认为对各个组件使用Abstract前缀和Interface后缀是一个很好的做法。 它有助于一目了然地更好地理解代码，IMO。

Answer 2

PHP-FIG 项目确实通过 PSR 命名约定“ByLaw” https://www.php-fig.org/bylaws/psr-naming-conventions/提出了命名约定

它指出：

• 接口必须以接口为后缀：例如Psr\\Foo\\BarInterface

• 抽象类必须以 Abstract 为前缀：例如Psr\\Foo\\AbstractBar

• Traits 必须以 Trait 为后缀：例如Psr\\Foo\\BarTrait

这些约定通常在包中遵循

Answer 3

对此没有约定； 尤其是在 PHP 中。 这一切都可以按照您的意愿进行组织。

随着 PHP 5.3 中命名空间的添加，我认为不需要向实际类名添加Abstract或Interface前缀/后缀。

只需按原样命名即可！

Answer 4

使用以下方法命名抽象类和接口：

• 抽象的*
• *界面

将使您的代码库保持干净、美观且对您的团队一目了然，什么是原型，什么是契约，什么是具体实现。

在任何情况下，命名约定都可以提高我们的生产力，因此“随心所欲地命名”远不是一个好主意。

即使FIG 组没有提出抽象类和接口的命名约定——如果你检查主要的开源PHP 项目，你会发现几乎所有项目都使用这个约定。

Answer 5

与大多数其他答案相反，我建议最好不要在类中添加前缀或后缀。 为此abstract, interface, class, final该语言具有文字关键字，例如abstract, interface, class, final 。

以下实际上打破了干净的代码原则：

abstract class AbstractPerson 
{

   // ...
}

类似于“评论通常很糟糕，因为它表明代码不容易阅读”的想法。 如果你的类、继承和它们的契约是以清晰易读的方式设计的，那么就不需要前缀。

行为设计

通常可以以反映事物行为的方式命名事物。 例如在日志子系统中：

interface Loggable
{
    public function getLog(): string;
}

trait WritesLogs
{
    public function writeLog(): void
    {
        file_put_contents("logs.txt", $this->getLog());
    }
}

abstract class Event implements Loggable
{
    use WritesLogs;

    public function asLog(): string
    {
        return "{$this->getName()} at {$this->created_at}";
    }

    abstract public function getName(): string;
}

class FooCreated extends Event
{
    public function getName(): string
    {
        return 'Foo was created';
    }
}

Answer 6

约定就是你看到的样子：语言本身不强制任何约定，除了那些使解析器能够读取你的代码的约定。 基本上，您应该为特定项目或更好地为所有项目设置自己的约定。 但是，在不同人的团队中工作可能会导致不遵守约定，这实际上取决于程序员。

根据我的经验，我建议遵循“按合同设计”之类的方法。 像命名实现类一样命名你的合约（接口），然后给你的实现一个更具体的名称（或者回退到 MyContractNameImpl，我猜主要来自 Java）。 此外，许多现代 IDE 知道您的类是接口还是抽象类，因此实际上没有必要将其放在名称中。 出于同样的原因，我还发现像“IMyContract”这样的合同并不是很好。

Answer 7

接口：

接口必须以接口为后缀： eg Psr\\Foo\\BarInterface 。

---

抽象类：

抽象类必须以 Abstract 为前缀： eg Psr\\Foo\\AbstractBar 。

---

性状

Traits 必须以 Trait 为后缀： eg Psr\\Foo\\BarTrait 。

---

来源： https : //www.php-fig.org/bylaws/psr-naming-conventions/