Symfony2コンポーネントを使用してPHPプロジェクトを復元する方法

この投稿は慣習的な記事の翻訳ではなく、レポート+プレゼンテーションなので、投稿のテキストは非常に無料です。

PHPは、個人のホームページページからFacebook、Vimeo、WordPress、さらにはYouPornのようなマストドンまで、多くのWebプロジェクトを綴る最も人気のあるプログラミング言語の1つであることは誰もが知っていると思います。

PHPは1995年に登場しましたが、OOPの完全なサポートは2005年にリリースされたPHP5でのみ実装されました。 この間、大量のコードが作成されましたが、良いものも悪いものも、非常に時代遅れで保守が困難なものもありました。

PHPエコシステム全体のような多くのプロジェクトは、現在、活気に満ちた都市ブロックの外観を表しています。

新しいPHPバージョン

新しい10年でPHP5.3とPHP5.4が生まれました。生産性の向上に加えて、多くの利点があります。 それらのほんの一部を次に示します。

1. 名前空間 （php 5.3）

namespace JoliCode\Conferences; use General\Talk\Session; class SymfonyLive extends Session { public function runPresentation() { } } 

• クラスの命名の偶然から保存します。
• 不確実性を減らします。
• 長いクラスの命名を避けます。

2. 匿名関数とクロージャー （php 5.3）、さらにはオブジェクト内（php 5.4）

 $container['session'] = function ($c) { return new Session($c['session_storage']); }; 

3. Pharアーカイブ （php 5.3）

1つの接続されたpharファイルの形式でライブラリを配布できます。

4. 「goto」 -何が.. .. ?? （PHP 5.3）

5. 特性 （php 5.4）

6.配列を宣言するための短い構文！ （php 5.4）

 function fruits() { return ['apple', 'banana', 'orange']; } echo fruits()[0]; // Outputs: apple  

などなど。

フレームワーク

PHPの新しいバージョンは、フレームワークの出現の触媒となっています。 その中でも、symfony、Zend Framework、Yii、CodeIgniter、CakePHPに言及する価値があります。 それらのほとんどすべてが、リリースされた2番目のバージョンで大幅に更新されました。

これらのフレームワークの1つであるSymfony2は、 一連の独立したコンポーネントと、PHP言語の新機能を使用し、古くなったコードでプロジェクトを復活させるのに役立つ多くのサードパーティソリューションで構築されています。

プロジェクト蘇生戦略

あなたのプロジェクトが5年間続いていると想像してください。 この期間中：

• 大量の機能が実装されています。
• プロジェクトは本番環境で動作します。
• 多くのユーザーが常に使用しています。
• より多くのデータが蓄積されました。
• 経験豊富なチームがプロジェクトの周りに形成されました。

この場合：

• ゆっくりと新しい機能を導入します。
• プロジェクトとそのインフラストラクチャのサポートに関する問題。
• 既存の機能を改善することは困難です。

方法1：ビッグバン

そのような状況で最も自然な欲求は、 すべてのコードを捨てて、それを再び書き直すことです！ このように行ったと想像してください。 間違いなく、私たちは新しいモダンなフレームワークの1つと連携する機会から満足を得ます。古いコードを忘れ、悪い夢のようにコードをブロックする場所もあります。

しかし、真実に直面した場合、プロセスは非常に大規模で複雑で長くなる可能性が高く、すべての機能を書き換えるには少なくとも1人年かかります。 同時に、プロジェクトの既存バージョンの開発が停止します。これにより、プロジェクトのビジネスに経済的損失が生じ、十分な注意が払われていないユーザーが流出します。 また、すべての機能を新しいプラットフォームに完全に移行できないというリスクも高くなります。 これらのリスクの理由の1つは、既存のデータをデータストレージシステムの新しい構造に移行する手段を開発する必要があることです。

方法2：一貫性を保つ

したがって、ハッキングする価値はありません。プロジェクトを段階的に更新する戦略はより合理的です。 同時に、プロジェクトの開発とサポートは停止しないため、ビジネスは停止しません。 このアプローチでは、プロジェクトで新しいフレームワーク全体を使用することはできませんが、個々の部分を使用できます。 この場合のSymfony2コンポーネントは非常に適しています。 依存関係はありませんが、ポイントアンドポイント機能を提供します。

行動に移る

ステップ1.プロジェクトをPHP 5.3またはPHP 5.4に転送する

まず、PHPを少なくともPHPバージョン5.3に更新します。 これを慎重に行います。最初にdev-serverで更新を実行し、システムのどの部分も落ちていないことを確認します。 その後、prodサーバーで確認できます。 同時に、プロジェクト全体ではなくA / Bテストモードでこれを行うことをお勧めします。これにより、一部のユーザーのみが新しい環境にアクセスできます。

すべてが正常に機能していると確信したら、先に進むことができます。

ステップ2.将来のシステムリファクタリングの基盤を準備する

主要コンポーネントであるClassLoader、DependencyInjection、およびHTTPFoundationを接続します。 これらはリファクタリングを支援し、新しいコンポーネントを接続するための基盤となります。

これらのコンポーネントおよび以下のすべてのコンポーネントは、 Composerパッケージマネージャーを使用して簡単に接続できます。 サードパーティライブラリ上のプロジェクトの依存関係をjson形式で簡潔に記述し、それらを自動的にインストールおよび更新し、プロジェクトに接続するための自動ロードファイルを生成することもできます。 Habréには、その使用方法に関する優れた記事があります。

この場合、Composerの構成ファイルは次のようになります。

 { "autoload": { "psr-0": {} }, "name": "xavierlacot/blog", "description": "My old blog on steroids", "require": { "php": ">=5.3.3", "symfony/class-loader": "2.1.*", "symfony/dependency-injection": "2.1.*", "symfony/http-foundation": "2.1.*" } } 

コンポーネントをインストールします。

 $ php composer.phar install Installing dependencies from lock file - Updating symfony/class-loader (dev-master) 

そして、それらをプロジェクトに接続します。

 <?php //    Composer  require 'vendor/autoload.php'; 

これで使用できます！

クラスローダー。 クラス起動標準

1年半前、PHPコミュニティはいくつかの契約を採択しました。そのうちの1つであるPSR-0契約は 、現代のクラスオートローダーとの互換性に関するルールとコード要件を説明しています（オートローダーの歴史はこことここでよく書かれています ）

要するに、この標準では次の2種類のクラス命名が許可されています。

名前空間経由（現代的なアプローチ）

 class: Symfony\Component\HttpFoundation\Request path: vendor/src/Symfony/Component/HttpFoundation/Request.php 

アンダースコアを使用して（PEAR標準、廃止されたアプローチ）

 class: Twig_Extension_Core path: vendor/twig/lib/Twig/Extension/Core.php 

この場合、クラスファイルが接続されると、オートローダーは自動的にスラッシュ（\）とアンダースコア（_）をディレクトリセパレーター（/）に置き換え、.php拡張子を最後に追加します。

ClassLoaderコンポーネントを使用すると、PSR-0契約に従ってクラスのオートロードを整理できます 。

ステップ3.クラスのリファクタリングとClassLoaderの使用

たとえば、LDAPを操作するための特定のクラスがあります。

 <?php class prefixedLdapConnector { public function __construct() { // -  } } 

PSR-0標準に準拠しています。

 <?php namespace Prefix\Ldap\Client; class Client { public function __construct() { // -  } } 

ClassLoaderにPrefixトップレベルスペースを登録します。

 use Symfony\Component\ClassLoader\UniversalClassLoader; $loader = new UniversalClassLoader(); $loader->registerNamespace('Prefix', __DIR__ . '/src/'); $loader->register(); 

コードでPrefix \ Ldap \ Clientクラスを使用すると、ClassLoaderが自動読み込みを処理します。

 //    ClassLoader use Prefix\Ldap\Client; $client = new Client(); 

ステップ4.要求処理のリファクタリング/応答の準備。 HttpFoundationを使用する

HTTPFoundationコンポーネントは、着信要求の処理とサーバー応答の準備を簡素化します。

プロジェクトに2行を追加します。

 //     ClassLoader,    use Symfony\Component\HttpFoundation\Request; //     Request  HTTPFoundation $request = Request::createFromGlobals(); 

着信リクエストに関するすべてを知っている$リクエストオブジェクトを取得します。

• $ request-> request replace $ _POST
• $ request-> queryは$ _GETを置き換えます
• $ request-> Cookieが$ _COOKIEを置き換えます
• など

そして、応答と同様に：

 use Symfony\Component\HttpFoundation\Response; $response = new Response(); $response->setContent('This will be the response content'); $response->headers->set('Content-Type', 'text/html'); $response->setStatusCode(200); //   Response $response->prepare($request); $response->send(); 

なぜ通常のPHP変数とメソッドを新しいクラスに置き換えるのかと思われます。 実際、このアプローチには多くの利点があります。 まず、オブジェクトの形式で提示された要求および応答データを操作するための、より理解しやすいレベルの抽象化を入力できます。 プロジェクトの任意の領域からの要求と応答を完全に制御できます。 第二に、このコンポーネントは多くの独立した開発者によってテストされており 、セキュリティ要件に準拠しています。 3番目に、HTTPFoundationを使用するコードはテストがはるかに簡単です。

ステップ5.プロジェクトの機能をサービスに設計します。 依存性注入コンポーネント

ほとんどすべてのプロジェクトには、さまざまなライブラリ、クラス、または適切なプログラム関数が担当する多くの関数があります。 依存性注入コンポーネントを使用すると、この機能またはその機能を実装するオブジェクトを作成および構成するプロセスを整理および集中化できます。 このようなオブジェクトには、郵便サービス、データベースマネージャー、テンプレートエンジンなどが含まれます。



メールを送信するためのクラスがあるとしましょう：

 <?php namespace Prefix\Mailer; class Mailer { $prefix = ''; public function send($to, $subject, $body) { //  } } 

そして、コードでは、メールは次のように送信されます。

 function saveUser($name, $email) { $mailer = new Mailer(); $mailer->send($user->getEmail(), 'Welcome ' . $user->getName(), 'A test'); } 

リファクタリングを少し行い、サービスコンテナを作成して、その中に郵便クラスを登録しましょう。

 use Symfony\Component\DependencyInjection\ContainerBuilder; $container = new ContainerBuilder(); $container->register('mailer', 'Mailer'); 

文字を送信する行で2番目の小さなリファクタリングを行ってみましょう。

 function saveUser($name, $email) { // stuff here $mailer = $this->container->get('mailer'); $mailer->send($user->getEmail(), 'Welcome '.$user->getName(), 'A test'); } 

これらの小さな変更により、一度にいくつかのボーナスが付与されます。

• プロジェクトの他の場所のサービスコンテナからオブジェクトを取得しても、Mailerクラスのオブジェクトは1回だけ作成されます。
• メーラーサービスを一元的に構成できるようになりました。
• 別のサービスに簡単に置き換えることができます。

同様に、プロジェクトライブラリを次々にサービスとして指定し、すべての作業をサービスコールで整理できます。

ステップ6.次は？

Symfony2の最初の3つのコンポーネントを接続することにより、同じアルゴリズムを使用して他の同等に有用なコンポーネントの使用を開始できます 。

• コンソール -コンソールスクリプトの開発（コマンドラインまたはcronから呼び出されます）
• Finder-ファイルとフォルダーの検索
• ルーティング-HTTPリクエストと設定可能なパラメーターのセット間の対応を設定できます
• テンプレート -プロジェクトでテンプレートを操作するために必要なすべてを提供します
• その他。

一歩一歩、コンポーネントごとに、あなたのプロジェクトは次第に変化し、根本的な決定なしに新しい生活を始めます。 頑張ってリファクタリングをお楽しみください！