Fractal 文档(看完看dingo的transformer)

什么是Fractal

Fractal为复杂的数据输出提供了样式和转化层。

通常做API 的时候都是从数据库拿出数据,然后转成json给客户端,对于不重要的api,可以这么做,但是如果是给公共的,或者是手机程序,就会出现多余的数据或者格式不一样的数据输出。

目标

  • 在原始数据和输出数据中间搞一个墙('barrier'), 这样的话即使内部结构改变了也不会影响到用户.
  • 有条理的数据格式转化
  • 包含了数据的嵌套依赖
  • 采用标准的HAL和JSON-API格式,并且允许自定义的连载
  • 支持数据分页
  • 将复杂的数据巧妙的输出给正规的API

一个简单的例子

这个列子是把下面的东西放在一起,现实开发中,我们会将Manage初始化,数据集合,json转化分开放到项目中.

class UsersController extends BaseController
{
    public function index()
    {
        $fractal = new FractalManager();

        $books = [
            [
                'id' => '1',
                'title' => 'Hogfather',
                'yr' => '1998',
                'author_name' => 'Philip K Dick',
                'author_email' => 'philip@example.org',
            ],
            [
                'id' => '2',
                'title' => 'Game Of Kill Everyone',
                'yr' => '2014',
                'author_name' => 'George R. R. Satan',
                'author_email' => 'george@example.org',
            ]
        ];

        $resource = new FractalCollection($books, function(array $book) {
            return [
                'id'      => (int) $book['id'],
                'title'   => $book['title'],
                'year'    => (int) $book['yr'],
                'author'  => [
                    'name'  => $book['author_name'],
                    'email' => $book['author_email'],
                ],
                'links'   => [
                    [
                        'rel' => 'self',
                        'uri' => '/books/'.$book['id'],
                    ]
                ]
            ];
        });

        $array = $fractal->createData($resource)->toArray();
        
        dd($array);

cursor: 分页中用的,不会去计算数据库中有多少条数据,通过请求一直在查看下一页有没有,通过cursor来做这个标记,如果没有了,那就返回404,代表分页结束了。

Include: 数据之前通常是有关联的,如用户有帖子,帖子有评论,评论属于帖子等,在restful apis中数据关联都是嵌套的,比如用户的帖子,通过用户include post()函数,就可以在返回用户的时候包含该用户相关联的帖子。

Manager Fractal有一个类叫做Manager,主要管理要将数据格式化为哪一种格式,json,Yaml 等等

Pagination Pagination
Pagination is the process of dividing content into pages, which in relation to Fractal is done in two alternative ways: Cursors and Paginators.

Paginator 一个很屌的用来处理分页的,会先计算数据库中有多少条数据,会添加一个'paginator'在meta中,并且在合适的时候会包含next/previous

resource 是对象,包含哪些基础的数据,会附上transformer,最终会被序列化和输出

Serializer 将Transformer的类 按规定的格式进行序列化,通常最常用的格式是json和HAL,像Twitter, FaceBook, Google都有自定义的一套关于数据传输的格式。

transformer 可以是一个类,也是可以是一个匿名函数,用来处理数据成为你想要的数据,然后可以被序列化。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,951评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,606评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,601评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,478评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,565评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,587评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,590评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,337评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,785评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,096评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,273评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,935评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,578评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,199评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,440评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,163评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,133评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,087评论 4 62
  • 在《<边城>题记》中沈从文说:“但本书作者,却早已存心把这个‘多数’放弃了。”费孝通在《乡土中国》正文首句就说:“...
    宜梦阅读 527评论 0 2
  • 又是一年团圆时,怎奈归途坎坷路。有多少人加入了十几亿人回家的艰难大军中,买火车票,机票,汽车票,骑摩托车回家的都有...
    韩小冰阅读 421评论 0 5
  • “你是一个焦虑症患者” 也许见医生的话 医生会给我这样的症断书 我没病 一点也没有 我也没有世界给我的压力 我不悲...
    7evenyears阅读 195评论 0 0