Lumen マイクロフレームワークにおける PSR2 および PSR4 仕様の適用と推進

Lumen マイクロフレームワークにおける PSR2 および PSR4 仕様の適用と推進

はじめに:
PHP 言語の広範な適用と開発により、コード仕様は次のようになりました。コードの品質と読みやすさを維持するための重要な側面。 PHP FIG (PHP FIG、PHP Framework Interop Group) は、PHP 開発のための一連のベスト プラクティス仕様 (PSR、PHP 標準推奨事項) を作成しました。そのうちの PSR2 と PSR4 は 2 つの重要な仕様です。この記事では、Lumen マイクロフレームワークで PSR2 および PSR4 仕様を適用および推進する方法に焦点を当て、具体的なコード例を示します。

1. Lumen での PSR2 仕様の適用と推進:

1. コード スタイル:
   PSR2 仕様では、インデント、改行、ネーミングなどを含むコード スタイルの詳細な要件が設定されています。 Lumen プロジェクトでは、次の側面を通じて PSR2 仕様を適用および推進できます。

(1) インデントと改行: インデントには均一に 4 つのスペースを使用し、各行の長さは制限されません。 80文字を超えてください。

具体的なコード例:

<?php

namespace AppHttpControllers;

use IlluminateHttpRequest;

class UserController extends Controller
{
    public function index(Request $request)
    {
        // your code here
    }
}

(2) 命名規則: クラス名にはキャメルケースを使用し、関数名と変数名には小文字とアンダースコアを使用します。クラスと名前空間の間では {} を使用します。

具体的なコード例:

<?php

namespace AppServices;

use AppRepositoriesUserRepository;

class UserService
{
    protected $userRepository;

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

    public function getUserById($id)
    {
        // your code here
    }
}

2. コメント:
   PSR2 仕様では、コメントの形式と内容が規定されています。 Lumen プロジェクトでは、良いコメントの習慣を身につけ、標準化されたコメント形式を使用する必要があります。

(1) ファイル コメント: 各ファイルには、ファイルの作成者、作成日、変更記録などを示すファイル コメントが含まれている必要があります。

具体的なコード例:

<?php

/**
 * UserController.php
 *
 * This file is part of the Lumen project.
 *
 * @author John Doe <john.doe@example.com>
 * @created 2022-09-01
 * @updated 2022-09-10
 */

namespace AppHttpControllers;

// ...

(2) 関数コメント: 各関数には、関数のパラメーター、戻り値、関数の説明などを示す関数コメントを含める必要があります。

具体的なコード例:

/**
 * Get user by ID.
 *
 * @param int $id User ID
 * @return array
 */
public function getUserById($id)
{
    // your code here
}

2. Lumen での PSR4 仕様の適用と推進:

1. ディレクトリ構造:
   PSR4 仕様は自動ロード用に提案されています詳細な要件。 Lumen プロジェクトでは、PSR4 仕様に従ってコードのディレクトリ構造を整理し、コードの保守性とスケーラビリティを向上させることができます。

具体的なコード例:

│   app/
│   ├── Http/
│   │   ├── Controllers/
│   │   └── Middleware/
│   ├── Models/
│   ├── Repositories/
│   └── Services/

2. 名前空間とクラスの自動ロード:
   PSR4 仕様の要件に従って、コンポーザーで名前付けを構成する必要があります。 .json ファイル スペースとクラスの間のマッピング関係。Composer を使用してクラスを自動的にロードします。

具体的なコード例 (composer.json):

{
    "autoload": {
        "psr-4": {
            "App\": "app/"
        }
    }
}

ターミナルで次のコマンドを実行して、クラスの自動読み込みを更新します:

composer dump-autoload

適用後上記の構成では、手動でファイルを導入しなくても、完全な名前空間を使用してクラスを参照できます。

具体的なコード例:

<?php

namespace AppHttpControllers;

use AppServicesUserService;
use IlluminateHttpRequest;

class UserController extends Controller
{
    protected $userService;

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

    public function index(Request $request)
    {
        // your code here
    }
}

結論:
Lumen マイクロフレームワークでは、PSR2 および PSR4 仕様を適用および推進することで、プロジェクトのコード品質、可読性、保守性を向上させることができます。標準化されたコーディング スタイルとアノテーション仕様を使用することで、開発者はコードをより簡単に理解し、保守できるようになります。同時に、PSR4 仕様に従ってコードのディレクトリ構造を整理し、設定クラスを自動ロードすることで、コードのスケーラビリティと再利用性を向上させることができます。実際のプロジェクトでは、良いコーディング習慣を身に付け、実際の状況に基づいて適用および推進する適切な仕様を選択する必要があります。

以上がLumen マイクロフレームワークにおける PSR2 および PSR4 仕様の適用と推進の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。