FastD最佳实践一:构建API

FastD 是一个专门针对 API 应用层而生的一个 PHP 应用框架&＃xff0c;提供良好的中间件&＃xff0c;路由以及支持 swoole 扩展运行&＃xff0c;从而具体良好的性能条件。

创建项目

composer create-project fastd/dobee api -vvv

创建一个为 API 的项目。

运行第一个程序

进入命令行模式

php -S localhost:9876 -t web

访问 localhost:9876

{"msg":"hello dobee"
}

执行流程

点击: FastD设计详解

实现第一个路由

1. 创建"控制器"

通过命令行

php bin/console controller:create {name}

命令行会自动创建 CURD 多个操作方法&＃xff0c;由开发者手动添加操作逻辑。

手动创建

MeController.php

{public function me(ServerRequest $request){return json([&＃39;name&＃39; &＃61;> &＃39;janhuang&＃39;]);}
}

2. 添加路由地址

get(&＃39;/&＃39;, &＃39;WelcomeController&＃64;welcome&＃39;);
route()->get(&＃39;/hello/{name}&＃39;, &＃39;WelcomeController&＃64;sayHello&＃39;);
route()->get(&＃39;/who&＃39;, &＃39;MeController&＃64;me&＃39;);

3. 调用

curl -i http://127.0.0.1:9876/who

response

{"name": "janhuang"
}

完成最第一个路由。

给应用添加单元测试

我仍热认为测试是一个非常重要的环节&＃xff0c;也是一个优秀开发者一个重要品质之一。

如果其中涉及数据库测试&＃xff0c;可以参考: 数据库测试

{public function testSayHello(){$request &＃61; $this->request(&＃39;GET&＃39;, &＃39;/&＃39;);$response &＃61; $this->app->handleRequest($request);$this->isSuccessful($response);}
}

可以给你的应用API添加格式各样的测试&＃xff0c;来验证程序的有效性。

给 API 添加公共缓存

何为公共缓存&＃xff1f;

公共缓存的灵感来自于 varnish&＃xff0c;当用户发起非 GET 请求的时候&＃xff0c;进行缓存处理并返回(如果有的话)&＃xff0c;其他请求一律穿透&＃xff0c;交给底层处理。

缓存也是一个前置中间件&＃xff0c;使用方式与日常操作保持一致。

文档: 中间件

config/app.php

[// code&＃39;common.cache&＃39; &＃61;> [\FastD\Middleware\CacheMiddleware::class]],
];

config/routes.php

get(&＃39;/&＃39;, &＃39;WelcomeController&＃64;welcome&＃39;);
route()->get(&＃39;/hello/{name}&＃39;, &＃39;WelcomeController&＃64;sayHello&＃39;);
route()->get(&＃39;/who&＃39;, &＃39;MeController&＃64;me&＃39;)->withMiddleware(&＃39;common.cache&＃39;);

完成配置后&＃xff0c;请求路由地址

curl -i http://localhost:9876/whoHTTP/1.1 200
Host: localhost:9876
Connection: close
X-Powered-By: PHP/7.0.0
Content-Type: application/json; charset&＃61;UTF-8
X-Cache: ee4d94f352cb03116b61ce9158720ebf
Expires: Tue, 08 Aug 2017 10:58:21 GMT

会产生 X-Cache 新的响应头&＃xff0c;用于代表缓存生效。

Basic Auth

大部分 API 中&＃xff0c;都需要对请求来源进行一定的鉴权处理&＃xff0c;由于框架已经集成了简单的 Basic auth&＃xff0c;使用方法与上述保持一致。

get(&＃39;/&＃39;, &＃39;WelcomeController&＃64;welcome&＃39;);
route()->get(&＃39;/hello/{name}&＃39;, &＃39;WelcomeController&＃64;sayHello&＃39;);
route()->get(&＃39;/who&＃39;, &＃39;MeController&＃64;me&＃39;)->withMiddleware([&＃39;basic.auth&＃39;, &＃39;common.cache&＃39;]);

为 API Server 加速

众所周知&＃xff0c;swoole 为 PHP 提供了良好的性能体验和网络通信体验&＃xff0c;而框架中也无缝整合 swoole&＃xff0c;为框架、服务提供良好体验做了一个铺垫&＃xff0c;现在&＃xff0c;你只需要配置IP、端口、swoole常用配置&＃xff0c;即可无痕启动以 swoole 服务器&＃xff0c;为你的 API Server 进行加速处理。

config/server.php

/*** &＃64;author jan huang * &＃64;copyright 2016** &＃64;link https://www.github.com/janhuang* &＃64;link http://www.fast-d.cn/*/return [&＃39;host&＃39; &＃61;> &＃39;http://&＃39;.get_local_ip().&＃39;:9527&＃39;,&＃39;class&＃39; &＃61;> \FastD\Servitization\Server\HTTPServer::class,&＃39;options&＃39; &＃61;> [&＃39;user&＃39; &＃61;> &＃39;nobody&＃39;,&＃39;group&＃39; &＃61;> &＃39;nogroup&＃39;,&＃39;pid_file&＃39; &＃61;> __DIR__ . &＃39;/../runtime/pid/&＃39; . app()->getName() . &＃39;.pid&＃39;,&＃39;log_file&＃39; &＃61;> __DIR__ . &＃39;/../runtime/logs/&＃39; . app()->getName() . &＃39;.pid&＃39;,&＃39;log_level&＃39; &＃61;> 5,&＃39;worker_num&＃39; &＃61;> 10,&＃39;task_worker_num&＃39; &＃61;> 20,],&＃39;processes&＃39; &＃61;> [],&＃39;listeners&＃39; &＃61;> [],
];

get_local_ip 函数为了默认或者本地内网ip&＃xff0c;如果你的API是对外开放的&＃xff0c;请修改为您的外网ip或者 0.0.0.0。

options 参数为 swoole 扩展配置参数。请参考: swoole配置

启动

php bin/server start

守护进程

php bin/server start -d

停止

php bin/server stop