Slimをオススメしてみる ControllerとContainer

Transcript

1. Slimをオススメしてみる ControllerとContainer by がる
2. 自己紹介  古庄と申します  「がる(gallu)」というハンドルでふらついております  本職は技術者です。現役プログラマーやってます  バックエンド系なので、インフラとかDBとかも一通り  最近はPM業も多いですねぇ  あわせて、教育とか色々
3. Slimいいよ!!  https://www.slimframework.com/  Slim is a PHP micro framework that helps you quickly write simple yet powerful web applications and APIs.  Slim は、シンプルかつ強力な Web アプリケーションと API をすばやく作 成するのに役立つ PHP マイクロ フレームワークです。(Google)  Slimは、シンプルかつパワフルなWebアプリケーションやAPIを素早く作 成できるPHPマイクロフレームワークです。(DeepL)  Slimいいです!!  micro framework いいです!!  シンプルでいいです!!  っていう個人の感想と妄想を垂れ流してみます(笑
4. 前回のあらすじ  素install  ルーティングくらいは別ファイルに  ルーティングを追加  (過去のPPTの資料でここから先があるのは幻です忘れ てください(笑))
5. Controllerを切り出してみる  普通に考えて「routingん中に処理コードを書く」とか、常 軌を逸脱しているので  いわゆる「Controller」的なクラスを切り出してみましょう  まず「Controllerクラスを入れる」ディレクトリを作ります。 これもまぁどこでもよいのですが、慣習も考えてこんな風 にしてみましょう  mkdir -p app/Controller  autoloaderとかないと色々面倒なので設定しましょう  composer.jsonに追記します(コードは次のページで)  requireのバージョンとかちょっと違ってもキニシナイ!!  composer dump-autoload
6.  composer.json { "require": { "slim/slim": "^4.11", "slim/psr7": "^1.6" }, "autoload": { "psr-4": { "App¥¥": "app/" } } }
7.  んじゃ、コードを書いていきましょう!!
8.  元 config/routes.php <?php declare(strict_types=1); use Psr¥Http¥Message¥ResponseInterface as Response; use Psr¥Http¥Message¥ServerRequestInterface as Request; // 初期に書いてあるルーティング $app->get('/hello/{name}', function (Request $request, Response $response, array $args) { $name = $args['name']; $response->getBody()->write("Hello, $name"); return $response; }); // 追加のルーティング $app->get('/', function (Request $request, Response $response, array $args) { $response->getBody()->write("Top Page"); return $response; });
9.  config/routes.php <?php declare(strict_types=1); use Psr¥Http¥Message¥ResponseInterface as Response; use Psr¥Http¥Message¥ServerRequestInterface as Request; // 初期に書いてあるルーティング $app->get('/hello/{name}', ¥App¥Controller¥HelloController::class . ':index'); // 追加のルーティング $app->get('/', ¥App¥Controller¥HomeController::class);
10.  app/Controller/HelloController.php <?php declare(strict_types=1); namespace App¥Controller; use Psr¥Http¥Message¥ServerRequestInterface as Request; use Psr¥Http¥Message¥ResponseInterface as Response; class HelloController { // 多分「よくある」系の書き方 public function index(Request $request, Response $response, $args) { $name = $args['name']; $response->getBody()->write("Hello, $name"); return $response; } }
11.  app/Controller/HomeController.php <?php declare(strict_types=1); namespace App¥Controller; use Psr¥Http¥Message¥ServerRequestInterface as Request; use Psr¥Http¥Message¥ResponseInterface as Response; class HomeController { // 1クラスに「1つしかメソッドを書くつもりがない」場合、こういった書き方もできる public function __invoke(Request $request, Response $response, $args) { // 出力 $response->getBody()->write("Top Page"); return $response; } }
12.  おんなじように動きます!!  これで「ふつーのフレームワーク」と大体一緒!!  まだ足りない過ぎるけど  https://github.com/gallu/Slim- SimpleSkeleton/tree/cut_out_of_controller
13. Controllerの書き方を振り返ってみる // 初期に書いてあるルーティング $app->get('/hello/{name}', ¥App¥Controller¥HelloController::class . ':index'); // 追加のルーティング $app->get('/', ¥App¥Controller¥HomeController::class);
14. Controllerとして許容される形式は?  https://www.slimframework.com/docs/v4/objects/routi ng.html#container-resolution 以降に大体書いてあるの ですが  $app->get('/', '¥HomeController:home');  $app->get('/', ¥HomeController::class . ':home');  $app->get('/', [¥HomeController::class, 'home']);  $app->get('/', ¥HomeAction::class);  __invoke() メソッドがある場合  となります  あと実際には「関数」も通りますね
15. その辺のコードをざっくり見てみましょう  vendor/slim/slim/Slim/CallableResolver.phpの超訳 private function resolveSlimNotation(string $toResolve): array { [$class, $method] = :で文字列をsplit(:なかったらmethodには null) if (containerがclassを持ってたら) { $instance = $this->container->get($class); インスタンスがobject以外なら例外を投げて終了 } else { if (クラスが存在していなかったら) { if (メソッドがnullじゃなければ) { $class .= '::' . $method . '()'; } $classないよ～、って例外をぶん投げて終了 } $instance = new $class($this->container); } return [$instance, $method]; }
16. で……  vendor/slim/slim/Slim/CallableResolver.php public function resolve($toResolve): callable { $toResolve = $this->prepareToResolve($toResolve); if (is_callable($toResolve)) { return $this->bindToContainer($toResolve); } $resolved = $toResolve; if (is_string($toResolve)) { $resolved = $this->resolveSlimNotation($toResolve); $resolved[1] ??= '__invoke'; // 「メソッドなければnull」がここで効いてくる } $callable = $this->assertCallable($resolved, $toResolve); return $this->bindToContainer($callable); }
17.  なんてあたりで色々やってる感じです。  「配列でも受け入れる」あたりは prepareToResolve()に実 装があります  なんていう風に、入り口あたりから軽く「フレームワーク のコードを読む」事を時々すると、良い勉強になるんじゃ ないか、と!!
18. Containerとは?  容器とか箱とか入れ物とか……じゃなくて「DIコンテナ」 の事です  $instance = new $class($this->container);  「何に使うか」は後回しにして、まずは「使える」ようにしま しょう  https://www.slimframework.com/docs/v4/concepts/di. html を参考に最低限書いてみる ……とエラーになるので必要なものを追加でinstall  Fatal error: Uncaught Error: Class "DI¥Container" not found  composer require php-di/slim-bridge
19.  public/index.php <?php use Slim¥Factory¥AppFactory; use DI¥Container; require __DIR__ . '/../vendor/autoload.php'; // Create Container using PHP-DI $container = new Container(); // Set container to create App with on AppFactory AppFactory::setContainer($container); $app = AppFactory::create(); // ルーティングの読み込み require __DIR__ . '/../config/routes.php'; $app->run();
20.  これでコンテナのインスタンスが入る……んだけど $instance = new $class($this->container); でコンテナインスタンスを入れてるので、Controllerクラス を改修していきます  まずはざっくり場当たり的確認
21.  app/Controller/HomeController.php <?php declare(strict_types=1); namespace App¥Controller; use DI¥Container; use Psr¥Http¥Message¥ServerRequestInterface as Request; use Psr¥Http¥Message¥ResponseInterface as Response; class HomeController { public function __construct( private Container $container, ) { } // XXX 1クラスに「1つしかメソッドを書くつもりがない」場合、こういった書き方もできる public function __invoke(Request $request, Response $response, $args) { // 出力 var_dump($this->container ?? null); $response->getBody()->write("Top Page"); return $response; } }
22.  でまぁ「毎回決まったコンストラクタ書く」とか嫌なので、 速攻で親クラス作って切り出す
23.  app/Controller/BaseController.php <?php declare(strict_types=1); namespace App¥Controller; use DI¥Container; class BaseController { public function __construct( protected Container $container, ) { } }
24.  app/Controller/HomeController.php <?php declare(strict_types=1); namespace App¥Controller; use Psr¥Http¥Message¥ServerRequestInterface as Request; use Psr¥Http¥Message¥ResponseInterface as Response; class HomeController extends BaseController { // XXX 1クラスに「1つしかメソッドを書くつもりがない」場合、こういった書き方もできる public function __invoke(Request $request, Response $response, $args) { // 出力 $response->getBody()->write("Top Page"); return $response; } }
25. 一区切り  次回は「コンテナの使い方とDB接続ハンドル」あたり、お 送りできればよいかなぁ、と思ってます!  DIコンテナは「PHP-DI」なんで使い方興味ある人はググって!!  感想とか要望とか突っ込みとか、いただければ幸いで す!!  さて、LTの枠内に収まっているのか?(笑  今回は大丈夫、な、はず!!(笑
26. 余裕あったらおまけ  ところで、Slim-Skeleton、4.1.0から「Settings.php」とかっ てクラスが出来たんですねぇ。まぁ実装もシンプルだしこ れは便利かなぁ class Settings implements SettingsInterface { /** * @var array */ private $settings; /** * Settings constructor. * @param array $settings */ public function __construct(array $settings) { $this->settings = $settings; } /** * @param string $key * @return mixed */ public function get(string $key = '') { return (empty($key)) ? $this->settings : $this->settings[$key]; } }
27.  それはそれとして「名前空間 ¥App」が「 src/ ディレクトリ に紐付いてる」のが、相変わらずなんかもにょりますｗｗ ｗ  以上、おまけでした