如何优雅的使用接口

嗯,6.1刚过完,我们不在是宝宝了,来吧,撸一篇接口的文章(interface).

在编程的过程中我们应该学会如何使用接口来给变我们的生活,极大的提升自我能力。接口不是新特性,但是非常重要,下面我们来撸个接口的小例子。

虚构一个DocumentStore的类,这个类负责从不同的资源收集文本。可以从远程url读取html,也可以读取资源,也可以收集终端命令输出。

定义DocumentStore类

class DocumentStore{
    protected $data = [];

    public function addDocument(Documenttable $document){
        $key = $document->getId();
        $value = $document->getContent();
        $this->data[key] = $value;
    }

    public function getDocuments(){
        return $this->data;
    }

}

既然addDocument()方法的参数只能是Documenttable的类的实例,这样定义DocumentStore的类怎么行呢? 其实Documenttable不是类,是接口;

定义Documenttable

interface Documenttable{
    public function getId();
    public function getContent(); 

}

这个接口定义表名,实现Documenttable接口的任何对象都必须提供一个公开的getId()方法和一个公开的getContent()方法。

可是这么做有什么用呢?这么做的好处就是,我们可以分开定义获取稳定的类,而且能使用十分不同的方法。下面是一种实现方式,这种方式使用curl从远程url获取html。

定义HtmlDocument类

class HtmlDocument extends Documenttable{

    protected $url;

    public function __construct($url)
    {
        $this->url = $url;
    }

    public function getId(){
        return $this->url;
    }

    public function getContent(){
        $ch = curl_init();
        curl_setopt($ch,CURLOPT_URL,$this->url);
        curl_setopt($ch,CURLOPT_RETURNTRANSFER,1);
        curl_setopt($ch,CURLOPT_CONNECTTIMEOUT,3);
        curl_setopt($ch,CURLOPT_FOLLOWLOCATION,1);
        curl_setopt($ch,CURLOPT_MAXREDIRS,3);
        curl_close($ch);
        return $thml;
    }
}

下面一个方法是获取流资源。

class StreamDocument extends Documenttable{
    protected $resource;
    protected $buffer;

    public function __construct($resource,$buffer = 4096)
    {
        $this->resource=$resource;
        $this->buffer=$buffer;
    }

    public function getId(){

        return ‘resource-‘ .(int)$this->resource;
    }

    public function getContent(){
        $streamContent = ‘‘;
        rewind($this->resource);
        while (feof($this->resource) === false){
            $streamContent .= fread($this->resource,$this->buffer);
        }
        return $streamContent;
    }
}

下面一个类是获取终端命令行的执行结果。

class CommandOutDocument extends Documenttable{
    protected $command;
    public function __construct($command)
    {
        $this->command=$command;
    }

    public function getId(){
        return $this->command;
    }

    public function getContent(){
        return shell_exec($this->command);
    }

}

下面我们来演示一下借助上面的三个类来实现DocumentStore类。

$documentStore = new DocumentStore();

//添加html文档
$htmlDoc = new HtmlDocument(‘https:// www.i360.me‘);

$documentStore->addDocument($htmlDoc);

//添加流文档

$streamDOC = new StreamDocument(fopen(‘stream.txt‘,‘rb‘));

$documentStore->addDocument($streamDOC);

//添加终端命令文档

$cmdDoc = new CommandOutDocument(‘cat /etc/hosts‘);

$documentStore->addDocument($command);

print_r($documentStore->getDocuments());die;

这里HtmlDocument,StreamDocument,CommandOutDocument这三个类没有任何共同点,只是实现了同一个接口。

时间: 2024-10-13 03:26:29

如何优雅的使用接口的相关文章

使用Guava retryer优雅的实现接口重试机制

转载自: 使用Guava retrying优雅的实现接口重调机制 Guava retrying:基于 guava 的重试组件 实际项目中,为了考虑网络抖动,加锁并发冲突等场景,我们经常需要对异常操作进行重试.优雅的重试 其实就是将业务处理逻辑和重试逻辑分离. 下面是原文地址: API 接口调用异常和网络异常在我们日常开发中经常会遇到,这种情况下我们需要先重试几次才能将其标识为错误并在确认错误之后发送异常提醒. Guava retrying 可以灵活的实现这一功能.Guava retrying在支

优雅的实现接口转换——适配器模式详解.md

1.前言 插头转换器我们应该都用过.当我们要使用二插头的电器而身边只有3孔的插座时,一个插头转换器就能解决插头和插座不匹配的问题.如下图所示 插头转换器其实只做了一件事,就是把原本不能使用的三孔插座转换成了能使用的二孔插座.而这也正是我们接下来要讲的适配器模式的本质:把不能被客户端使用的接口转换成了能被客户端使用的接口. 2.适配器模式详解 2.1适配器模式的定义 将一个类的接口变换成客户端所期待的另一种接口,从而使原本因接口不匹配而无法在一起工作的两个类能够在一起工作. 2.2适配器模式的类结

Spring Boot 2.x (十):构建优雅的RESTful接口

RESTful 相信在座的各位对于RESTful都是略有耳闻,那么RESTful到底是什么呢? REST(Representational State Transfer)表述性状态转移是一组架构约束条件和原则.满足这些约束条件和原则的应用程序或设计就是RESTful.需要注意的是,REST是设计风格而不是标准.REST通常基于使用HTTP,URI,和XML(标准通用标记语言下的一个子集)以及HTML(标准通用标记语言下的一个应用)这些现有的广泛流行的协议和标准. 也许这段话有些晦涩难懂,换个角度

Netty优雅退出机制和原理

1.进程的优雅退出 1.1.Kill -9 PID带来的问题 在Linux上通常会通过kill -9 pid的方式强制将某个进程杀掉,这种方式简单高效,因此很多程序的停止脚本经常会选择使用kill -9 pid的方式. 无论是Linux的Kill -9 pid还是windows的taskkill /f /pid强制进程退出,都会带来一些副作用:对应用软件而言其效果等同于突然掉电,可能会导致如下一些问题: 缓存中的数据尚未持久化到磁盘中,导致数据丢失: 正在进行文件的write操作,没有更新完成,

springboot+redis+Interceptor+自定义annotation实现接口自动幂等

前言: 在实际的开发项目中,一个对外暴露的接口往往会面临很多次请求,我们来解释一下幂等的概念:任意多次执行所产生的影响均与一次执行的影响相同.按照这个含义,最终的含义就是 对数据库的影响只能是一次性的,不能重复处理.如何保证其幂等性,通常有以下手段: 1:数据库建立唯一性索引,可以保证最终插入数据库的只有一条数据 2:token机制,每次接口请求前先获取一个token,然后再下次请求的时候在请求的header体中加上这个token,后台进行验证,如果验证通过删除token,下次请求再次判断tok

优雅对API进行内部升级改造

优雅对API进行内部升级改造 背景 随着业务的快速发展老的系统将逐渐的无法快速支撑现有业务迭代重构一个必然的过程;然而在底层业务系统重构的过程中,对外提供的API也同时需要进行相应的升级替换;推动外部调用方替换新的API是十分艰难而漫长的过程,因此往往很多时候不得不需要在旧的API内部进行改造升级.旧API的内部改造...老代码接口无单测逻辑惨不忍睹!!! 如何能避免不改动老的代码优雅的完成接口的内部改造升级? 实现方案 利用自定义注解+aop不侵入旧代码进行切换 利用redis 对接口进行灰度

Netty系列之Netty可靠性分析

作者 李林锋 发布于 2014年6月19日 | 29 讨论 分享到:微博微信FacebookTwitter有道云笔记邮件分享 稍后阅读 我的阅读清单 1. 背景 1.1. 宕机的代价 1.1.1. 电信行业 毕马威国际(KPMG International)在对46个国家的74家运营商进行调查后发现,全球通信行业每年的收益流失约为400亿美元,占总收入的1%-3%.导致收益流失的因素有多种,主要原因就是计费BUG. 1.1.2. 互联网行业 美国太平洋时间8月16日下午3点50分到3点55分(北

转:自己动手写插件框架(3)

转自:http://www.devbean.net/2012/03/building-your-own-plugin-framework-3/ 编程语言的支持 在前面的章节中,我们已经了解到,如果你能够使用编译器令应用程序和插件的虚表匹配,那么就可以保持 C++ 虚表级别的兼容性:或者你可以使用 C 级别的兼容性,然后就能使用不用的编译器去构建系统,但其限制在于你只能编写纯 C 应用.这样的话,你就不能够使用前面我们在例子 IActor 中看到的那种优雅的 C++ 接口. 纯 C 实现 在纯 C

app 后端技术

app 后端技术 一直以来工作的方向是web server,对app server没有什么了解.虽然没有接触过移动app开发,但对app后端技术还是挺有探索欲望的,app应用和web应用在前端的用户习惯不同,相信后端也会有很多不太一样的地方.开此文记录一些网上收集到的app后端技术体系,以备了解. 下面就app server在业务设计上通常需要考虑的几个方面: 1.api风格 如何设计一套合理且优雅的api接口集,可以参考Restful分格: api采用http(s)协议与前端通信: 每个uri