인터페이스의 의미와 인터페이스를 사용하여 고품질 PHP 코드를 작성하는 방법을 설명하는 기사

                                                                                                                编 개요 码 코딩에는 코드가 읽기 쉽고, 유지 관리되고, 확장 가능하고, 테스트하기 쉬운지 확인하는 것이 중요합니다. 이러한 문제를 개선할 수 있는 한 가지 방법은 인터페이스를 사용하는 것입니다.

대상

이 글은 PHP의 OOP(객체 지향 프로그래밍) 개념과 상속에 대한 기본적인 이해가 있는 개발자를 대상으로 합니다. PHP에서 상속을 사용하는 방법을 알고 있다면 이 글을 더 쉽게 이해할 수 있습니다.

인터페이스란 무엇인가요?

기본적으로 인터페이스는 "클래스가 수행해야 하는 작업"을 설명합니다. 인터페이스는 인터페이스를 구현하는 모든 클래스에 인터페이스에서 지정한 공용 메서드가 포함되어 있는지 확인하는 데 사용됩니다.

인터페이스

는

:

클래스에서 공개 메소드를 정의하는 데 사용될 수 있습니다.

클래스에서 상수를 정의하는 데 사용됩니다.

• 인터페이스
• 는
할 수 없습니다:

개별적으로 인스턴스화할 수 있습니다.

클래스에서 비공개 또는 보호 메서드를 정의하는 데 사용됩니다.

• 클래스에서 속성을 정의하는 데 사용됩니다.
• 인터페이스는 클래스에 포함되어야 하는 공용 메서드를 정의하는 데 사용됩니다. 기억해야 할 점은 인터페이스가 메소드 이름, 매개변수 및 반환 값만 정의할 뿐 메소드 본문은 포함하지 않는다는 것입니다. 인터페이스는 클래스 간 통신의 특정 동작을 정의하는 것이 아니라 객체 간 통신을 정의하는 데만 사용되기 때문입니다. 약간의 맥락을 제공하기 위해 이 예제에서는 여러 공용 메소드를 정의하는 예제 인터페이스를 보여줍니다.

• interface DownloadableReport
  {
      public function getName(): string;
  
      public function getHeaders(): array;
  
      public function getData(): array;
  }

php.net에 따르면 인터페이스에는 두 가지 주요 목적이 있습니다.

개발자가 사용할 수 있는 다양한 클래스의 객체를 만들 수 있도록 허용합니다. 동일한 인터페이스를 구현하기 때문에 서로 바꿔서 사용할 수 있습니다. 일반적인 예로는 여러 데이터베이스 액세스 서비스, 여러 결제 게이트웨이 또는 다양한 캐싱 전략이 있습니다. 이를 사용하는 코드를 변경하지 않고도 다양한 구현을 대체할 수 있습니다.

함수나 메서드가 인터페이스에 맞는 매개변수를 받아들이고 개체가 수행할 수 있는 다른 작업이나 구현 방법에 신경 쓰지 않고 해당 매개변수에 대해 작업할 수 있도록 허용합니다. 이러한 인터페이스는 동작의 의미를 설명하기 위해 종종 Iterable, Cacheable, Renderable 등으로 명명됩니다. [추천 학습: "

PHP 비디오 튜토리얼
1. "]
2. PHP에서 인터페이스 사용하기
인터페이스는 OOP(객체 지향 프로그래밍) 코드에서 매우 중요한 부분입니다. 이를 통해 코드를 분리하고 확장성을 향상할 수 있습니다. 예를 들어 다음 클래스를 살펴보겠습니다.

class BlogReport
{
    public function getName(): string
    {
        return 'Blog report';
    }
}

보시다시피 문자열을 반환하는 메서드가 포함된 클래스를 정의했습니다. 이를 통해 메소드의 동작을 결정했으므로 getName()이 반환된 문자열을 어떻게 작성하는지 확인할 수 있습니다. 그러나 다른 클래스의 코드에서 이 메서드를 호출한다고 가정해 보겠습니다. 다른 클래스는 문자열이 어떻게 구성되는지 신경 쓰지 않고 문자열이 반환되는지 여부에만 관심이 있습니다. 예를 들어, 다른 클래스에서 이 메서드를 호출하는 방법을 살펴보겠습니다.

class ReportDownloadService
{
    public function downloadPDF(BlogReport $report)
    {
        $name = $report->getName();

        // 在这里下载文件...
    }
}

위 코드는 이미 작동하지만, 이제 사용자 보고서를 다운로드하기 위해 A 메서드를 추가하려는 경우를 상상해 보겠습니다. 물론 하나의 BlogReport 클래스만 전달해야 했기 때문에 ReportDownloadService의 기존 메소드를 사용할 수 없습니다. 따라서 기존 메소드의 이름을 바꾸고 새로운 메소드를 추가해야 합니다.

class ReportDownloadService
{
    public function downloadBlogReportPDF(BlogReport $report)
    {
        $name = $report->getName();

        // 在这下载文件...
    }

    public function downloadUsersReportPDF(UsersReport $report)
    {
        $name = $report->getName();

        // 在这下载文件...
    }
}

실제로 볼 수는 없지만 위 클래스의 나머지 메소드는 동일한 코드를 사용하여 다운로드를 빌드한다고 가정합니다. 공개 코드를 메소드로 승격할 수 있지만 여전히 일부 공개 코드가 있습니다. 이 외에도 거의 동일한 코드를 사용하여 이 클래스에 여러 항목이 있습니다. 이로 인해 나중에 코드를 확장하거나 테스트 기능을 추가하려고 할 때 추가 작업이 발생할 수 있습니다. getName()是如何构建返回的字符串的。但是，假设我们在另一个类中的代码中调用此方法。另一个类并不会关心字符串是如何构建的，它只关心它是否被返回。例如，让我们看看如何在另一个类中调用此方法：

interface DownloadableReport
{
    public function getName(): string;

    public function getHeaders(): array;

    public function getData(): array;
}

尽管上面的代码已经可以用了，让我们设想一下，若是我们现在想要在 UserReport 类中增加一个下载用户报告的方法。当然，我们不能使用 ReportDownloadService 中已经存在的方法，因为我们已经强制只能传入一个 BlogReport 类。因此，我们必须重命名现有方法，再添加一个新的方法。像这样：

class BlogReport implements DownloadableReport
{
    public function getName(): string
    {
        return '博客报告';
    }

    public function getHeaders(): array
    {
        return ['头在这'];
    }

    public function getData(): array
    {
        return ['报告的数据在这里'];
    }
}

虽然你实际看不到，但我们假设上述的类中，其余的方法都使用相同的代码来构建下载。我们可以将公共的代码提升为方法，但我们仍然会有一些公共的代码。除此之外，我们还有多个进入这个类的几乎是相同代码的入口。这可能会在未来尝试扩展代码或添加测试功能时导致额外的工作量。

举个例子，我们创建一个新的 AnalyticsReport；我们现在需要为这个类增加一个新的 downloadAnalyticsReportPDF() 方法。这时你可能会观察到这个文件正在快速增长。这时就是使用接口的绝佳时机。

我们从创建一个接口开始。我们要创建一个叫做 DownloadableReport 的接口，并这样定义：

class UsersReport implements DownloadableReport
{
    public function getName()
    {
        return ['用户报告'];
    }

    public function getData(): string
    {
        return '报告的数据在这里';
    }
}

我们现在要更改 BlogReport 和 UsersReport 来实现 DownloadableReport 接口，如下所示。我故意写错了 UsersReport

예를 들어, 새로운 AnalyticsReport를 생성했습니다. 이제 이 클래스에 새로운 downloadAnalyticsReportPDF() 메서드를 추가해야 합니다. 이 시점에서 파일이 빠르게 증가하는 것을 볼 수 있습니다. 지금은 인터페이스를 사용하기에 좋은 시기입니다.

인터페이스를 만드는 것부터 시작합니다. DownloadableReport라는 인터페이스를 만들고 다음과 같이 정의하겠습니다. 🎜

class UsersReport implements DownloadableReport
{
    public function getName(): string
    {
        return '用户报告';
    }

    public function getHeaders(): array
    {
       return [];
    }

    public function getData(): array
    {
        return ['报告的数据在这里'];
    }
}

🎜이제 BlogReport 및 UsersReport를 변경하여 구현하겠습니다. DownloadableReport 인터페이스는 아래와 같습니다. 무언가를 보여주기 위해 의도적으로 UsersReport에 잘못된 코드를 작성했습니다. 🎜

class ReportDownloadService
{
    public function downloadReportPDF(DownloadableReport $report)
    {
        $name = $report->getName();

        // 在这下载文件
    }

}

rrreee🎜이 코드를 실행하려고 하면 다음과 같은 이유로 오류가 발생합니다. 🎜

1. 找不到 getHeaders() 方法。
2. getName() 方法返回类型在接口中定义的方法返回值类型中。
3. getData() 方法定义了返回类型，但和接口中定义的返回类型不同。

因此，要让 UsersReport 正确地实现 DownloadableReport 接口，我们需要作如下变动：

class UsersReport implements DownloadableReport
{
    public function getName(): string
    {
        return '用户报告';
    }

    public function getHeaders(): array
    {
       return [];
    }

    public function getData(): array
    {
        return ['报告的数据在这里'];
    }
}

现在我们两个报告类都实现了相同的接口，我们可以像这样更新我们的 ReportDownloadService：

class ReportDownloadService
{
    public function downloadReportPDF(DownloadableReport $report)
    {
        $name = $report->getName();

        // 在这下载文件
    }

}

现在我们向 downloadReportPDF() 方法传入了 UsersReport 或 BlogReport 对象，没有任何错误出现。这是因为我们现在知道了报告类所需要的必要方法，并且报告类会按照我们预期的类型返回数据。

向方法传入接口，而不是向类传入接口，这样的结果使得 ReportDownloadService 和报告类产生松散耦合，这根据的是方法做什么，而不是如何做。

如果我们想要创建一个新的 AnalyticsReport，我们需要让它实现相同的接口，然后它就会允许我们将报告类实例传入相同的 downloadReportPDF() 方法中，而不用添加其他新的方法。如果你正在构建自己的应用或框架，想要让其他开发人员有创建给他们自己的类的功能，这将非常有用。举个例子，在 Laravel 中，你可以通过实现 Illuminate\Contracts\Cache\Store 接口来创建自定义的缓存类。

除了使用接口来改进代码外，我更倾向于喜欢接口的「代码即文档」特性。举个例子，如果我想要知道一个类能做什么和不能做什么，我更喜欢在查看类之前先查看接口。它会告诉我所有可调用的方法，而不需要关心这些方法具体是怎么运行的。

对于像我这样的 Laravel 开发者来说，值得注意的一件事是，你会经常看到 接口 interface 和 契约 contract 交替使用。根据 Laravel 文档，「Laravel 的契约是一组定义了框架提供的核心服务的接口」。因此，契约是一个接口，但接口不一定是契约。通常来说，契约只是框架提供的一个接口。有关契约的更多内容，我建议阅读一下 文档，因为我认为它在契约的理解和使用途径上有很好的见解。

结论

阅读本文后，我们希望你能简要地了解到了什么是接口，如何在 PHP 中使用接口，以及使用接口的好处。

对于我的 Laravel 开发者读者们，我下周会更新一篇新的博文，讲解如何在 Laravel 中使用接口实现桥接模式。如果你感兴趣，可以订阅我的网站更新通知，这样当我更新时，你就会收到通知。

如果这篇文章有助于你理解 PHP 接口，我期待在评论区听到你的声音。继续去创造令人惊叹的作品吧！

非常感谢  Aditya Kadam 、 Jae Toole 和 Hannah Tinkler 帮助我校对和改进这篇文章。

原文地址：https://dev.to/ashallendesign/using-interfaces-to-write-better-php-code-391f

译文地址：https://learnku.com/php/t/62228

위 내용은 인터페이스의 의미와 인터페이스를 사용하여 고품질 PHP 코드를 작성하는 방법을 설명하는 기사의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!