一文讲解接口含义及如何用接口写高质量PHP代码

概述 在编码中,有一个重要的事情是确保你的代码是可读的、可维护的、可扩展的、易于测试的。我们可以改善这些问题的方法之一就是使用接口(interface)。

概述

在编码中,有一个重要的事情是确保你的代码是可读的、可维护的、可扩展的、易于测试的。我们可以改善这些问题的方法之一就是使用接口(interface)。

目标受众

本文针对对 OOP(object oriented programming)概念和 PHP 中的继承有基本理解的开发者,如果你知道如何在 PHP 中使用继承,那么这篇文章会更容易理解一些。

什么是接口?

基本上,接口描述了一个类「该做什么」。接口被用于确保实现接口的任何类中都包含接口规定的公共方法。

接口可以:

  • 用于定义类中的公共方法。
  • 用于定义类中的常量。

接口不可以:

  • 单独实例化。
  • 用于定义类中的私有(private)或保护(protected)方法。
  • 用于定义类中的属性。

接口口用于定义一个类中应该包括的公共方法。需要记住的是,接口只定义了方法名和参数以及返回值,但不包含方法体。这是因为接口仅用于定义对象间的通信,而不是定义类之间通信的具体行为。为了给出一点上下文,这个实例展示了一个定义了几个公共方法的示例接口:

interface DownloadableReport
{
public function getName(): string;

public function getHeaders(): array;

public function getData(): array;
}登录后复制

根据 php.net 介绍,接口有两个主要用途:

  • 允许开发人员创建不同类的对象,这些对象可以互换使用,因为它们实现相同的接口。一个常见的例子是多个数据库访问服务,多个支付网关或不同的缓存策略。可以更换不同的实现,而无需对使用它们的代码进行任何更改。
  • 允许函数或方法接受符合接口的参数并对其进行操作,而不关心对象还可以做什么或它是如何实现的。这些接口通常被命名为 Iterable,Cacheable,Renderable 等等来描述行为的含义。【推荐学习:《PHP视频教程》】
  • 在 PHP 中使用接口

    接口是 OOP (面向对象编程) 代码中非常重要的一部分。它们允许我们将代码解耦并提高可扩展性。举一个例子,让我们看看下面这个类:

    class BlogReport
    {
    public function getName(): string
    {
    return ;Blog report;;
    }
    }登录后复制

    如您所见,我们已经定义了一个带有返回字符串的方法的类。通过这样做,我们已经确定了方法的行为,因此我们可以看到getName()是如何构建返回的字符串的。但是,假设我们在另一个类中的代码中调用此方法。另一个类并不会关心字符串是如何构建的,它只关心它是否被返回。例如,让我们看看如何在另一个类中调用此方法:

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

    // 在这里下载文件…
    }
    }登录后复制

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

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

    // 在这下载文件…
    }

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

    // 在这下载文件…
    }
    }登录后复制

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

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

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

    interface DownloadableReport
    {
    public function getName(): string;

    public function getHeaders(): array;

    public function getData(): array;
    }登录后复制

    我们现在要更改 BlogReport 和 UsersReport 来实现 DownloadableReport 接口,如下所示。我故意写错了 UsersReport 的代码来演示一些东西。

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

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

    public function getData(): array
    {
    return [;报告的数据在这里;];
    }
    }登录后复制class UsersReport implements DownloadableReport
    {
    public function getName()
    {
    return [;用户报告;];
    }

    public function getData(): string
    {
    return ;报告的数据在这里;;
    }
    }登录后复制

    如果我们尝试运行这段代码,我们会得到报错,原因是:

  • 找不到 getHeaders() 方法。
  • getName() 方法返回类型在接口中定义的方法返回值类型中。
  • 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入门到就业线上直播课:立即学习全程直播 + 实战授课 + 边学 + 边练 + 边辅导

    如何写好一篇高质量的SEO软文

    原创2019-05-25 16:19:371758 + php学习QQ群(点击入群)
    一文讲解接口含义及如何用接口写高质量PHP代码

    php入门到就业线上直播课:进入学习API 文档、设计、调试、自动化测试一体化协作工具:点击使用

    如何写好一篇高质量的SEO软文?

    在《SEO中发布什么样的软文才能不被删除?》一文中,我们知道了软文的重要性及意义价值之所在,那么,我们究竟应该怎么去写一篇高质量的软文让网站的管理人员不会轻易去删除它呢?

    写好一篇软文首先最重要的便是感情与文笔,一篇好的具有强烈感情意愿最好能带上上佳的文笔的软文能让阅读者觉得赏心悦目,读者就会认可这篇文章,从而在内心深处不把它认同为广告,如果编辑的文笔实在不怎么样,那么请至少让他带上一点感情,或者说个人风格。再次,在写软文的时候,尽量带入SEO思维去写作,例如关键词的分布、相关内容的提取等等,这些都是要考虑到的,带入了SEO的思维好处就是面对搜索引擎的时候,蜘蛛会非常喜欢这样的页面,同时由于软文的质量过硬,读者也喜欢,那么搜索引擎会十分认可这篇文章,然后拿这样的文章页面去做某个长尾词的排名,岂不是占尽先机?

    最后我们在写软文的时候,遇到的问题还有一大部分是来自于写作的素材,到底我这篇软文应该写什么、怎么写,这想必是困扰各位SEO的一个难题,其实这个问题非常好解决——多读书,多看报,意思就是,做SEO不能太宅,要与时事接轨,尽量去多看看热点新闻、争议微博、互动博客等,这样的具有爆炸性信息传递的地方能带来的素材的数量是非常恐怖的,还有就是一些问题的提问上,您也可以针对某个问题进行回答从而写出一篇高质量的软文,例如,某位在爱站实战SEO培训的学员论坛上提问:关于www域名跳转入二级域名用301还是302的请教讨论,那么针对这个问题我们就可以去写一篇软文,这样的软文能帮用户解决实际的需要,这样的软文才是有价值的软文。

    以上就是如何写好一篇高质量的SEO软文的详细内容,更多请关注钦钦技术栈其它相关文章!

    转载至:php中文网【www.php.cn】

    版权声明:本文(即:原文链接:https://www.qin1qin.com/catagory/26675/)内容由互联网用户自发投稿贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 630367839@qq.com 举报,一经查实,本站将立刻删除。

    (0)
    上一篇 2022-09-27 8:49:01
    下一篇 2022-09-27 8:49:52

    软件定制开发公司

    相关阅读

    发表回复

    登录后才能评论
    通知:禁止投稿所有关于虚拟货币,币圈类相关文章,发现立即永久封锁账户ID!