php slim skeletonダウンロード-PHP php slim skeletonソースコードダウンロード

イベント駆動型のスリム4フレームワークスケルトン

AMQPとCQRSを使用したイベント駆動型のSlim 4フレームワークスケルトン

インストール

デフォルトのインストールプロファイル

デフォルトのインストールプロファイルには例がありません。何が起きているかを知っていて、きれいなスレートから始めたい場合は、このプロファイルを使用する必要があります。

 > composer create-project robiningelbrecht/php-slim-skeleton [app-name] --no-install --ignore-platform-reqs --stability=dev
# Build docker containers
> docker-compose up -d --build
# Install dependencies
> docker-compose run --rm php-cli composer install

完全なインストールプロファイル

完全なインストールプロファイルには、完全な作業例があります。

 > composer create-project robiningelbrecht/php-slim-skeleton:dev-master-with-examples [app-name] --no-install --ignore-platform-reqs --stability=dev
# Build docker containers
> docker-compose up -d --build
# Install dependencies
> docker-compose run --rm php-cli composer install
# Initialize example
> docker-compose run --rm php-cli composer example:init
# Start consuming the voting example queue
> docker-compose run --rm php-cli bin/console app:amqp:consume add-vote-command-queue

いくつかの例

新しいルートの登録

 namespace App  Controller ;

class UserOverviewRequestHandler
{
    public function __construct (
        private readonly UserOverviewRepository $ userOverviewRepository ,
    ) {
    }

    public function handle (
        ServerRequestInterface $ request ,
        ResponseInterface $ response ): ResponseInterface
    {
        $ users = $ this -> userOverviewRepository -> findonyBy ( /*...*/ );
        $ response -> getBody ()-> write ( /*...*/ );

        return $ response ;
    }
}

config/routes.phpにアクセスして、requesthandlerのルートを追加します。

 return function ( App $ app ) {
    // Set default route strategy.
    $ routeCollector = $ app -> getRouteCollector ();
    $ routeCollector -> setDefaultInvocationStrategy ( new RequestResponseArgs ());
    
    $ app -> get ( ' /user/overview ' , UserOverviewRequestHandler::class. ' :handle ' );
};

完全なドキュメント

コンソールコマンド

コンソールアプリケーションは、Symfonyコンソールコンポーネントを使用してCLI機能を活用します。

#[AsCommand(name: ' app:user:create ' )]
class CreateUserConsoleCommand extends Command
{
    protected function execute ( InputInterface $ input , OutputInterface $ output ): int
    {
        // ...
        return Command:: SUCCESS ;
    }
}

完全なドキュメント

ドメインコマンドとコマンドハンドラー

スケルトンを使用すると、コマンドとコマンドハンドラーを使用してアクションを実行できます。これら2は常にペアで行われます。書き込みモデルに新しいコマンドを作成するとき、対応するコマンドハンドラーも作成する必要があります。

新しいコマンドを作成します

 namespace App  Domain  WriteModel  User  CreateUser ;

class CreateUser extends DomainCommand
{
 
}

対応するコマンドハンドラーを作成します

 namespace App  Domain  WriteModel  User  CreateUser ;

#[AsCommandHandler]
class CreateUserCommandHandler implements CommandHandler
{
    public function __construct (
    ) {
    }

    public function handle ( DomainCommand $ command ): void
    {
        assert ( $ command instanceof CreateUser);

        // Do stuff.
    }
}

完全なドキュメント

イベント

このプロジェクトのアイデアは、すべてがイベント駆動型であるか、またはそうすることができるということです。イベントソーシングはデフォルトでは提供されません。

新しいイベントを作成します

 class UserWasCreated extends DomainEvent
{
    public function __construct (
        private UserId $ userId ,
    ) {
    }

    public function getUserId (): UserId
    {
        return $ this -> userId ;
    }
}

イベントを記録します

 class User extends AggregateRoot
{
    private function __construct (
       private UserId $ userId ,
    ) {
    }

    public static function create (
        UserId $ userId ,
    ): self {
        $ user = new self ( $ userId );
        $ user -> recordThat ( new UserWasCreated ( $ userId ));

        return $ user ;
    }
}

イベントを公開します

 class UserRepository extends DbalAggregateRootRepository
{
    public function add ( User $ user ): void
    {
        $ this -> connection -> insert ( /*...*/ );
        $ this -> publishEvents ( $ user -> getRecordedEvents ());
    }
}

イベントを聞いてください

#[AsEventListener(type: EventListenerType:: PROCESS_MANAGER )]
class UserNotificationManager extends ConventionBasedEventListener
{
   
    public function reactToUserWasCreated ( UserWasCreated $ event ): void
    {
        // Send out some notifications.
    }
}

完全なドキュメント

rabbitmqを使用したコマンドの非同期処理

このプロジェクトの選択されたAMQP実装はRabbitMQですが、AmazonのAMQPソリューションなどに簡単に切り替えることができます。

新しいキューの登録

#[AsEventListener(type: EventListenerType:: PROCESS_MANAGER )]
class UserCommandQueue extends CommandQueue
{
}

キューイングコマンド

 class YourService
{
    public function __construct (
        private readonly UserCommandQueue $ userCommandQueue
    ) {
    }

    public function aMethod (): void
    {
        $ this -> userCommandQueue -> queue ( new CreateUser ( /*...*/ ));
    }
}

キューを消費します

 > docker-compose run --rm php-cli bin/console app:amqp:consume user-command-queue

完全なドキュメント

データベースの移行

データベースの移行を管理するために、Doctrine/Migrationsパッケージが使用されます。

#[Entity]
class User extends AggregateRoot
{
    private function __construct (
        #[Id, Column(type: ' string ' , unique: true , nullable: false )]
        private readonly UserId $ userId ,
        #[Column(type: ' string ' , nullable: false )]
        private readonly Name $ name ,
    ) {
    }

    // ...
}

データベーススキーマの現在の状態をORMを使用して定義し、その移行を実行することによって定義されるマッピング情報と比較することにより、Doctrineに移行を生成させることができます。

 > docker-compose run --rm php-cli vendor/bin/doctrine-migrations diff
> docker-compose run --rm php-cli vendor/bin/doctrine-migrations migrate

完全なドキュメント

テンプレートエンジン

このプロジェクトに最適なテンプレートエンジンはTwigであり、HTML関連のものをレンダリングするために使用できます。

テンプレートを作成します

< h1 >Users</ h1 >
< ul >
    {% for user in users %}
        < li >{{ user . username | e }}</ li >
    {% endfor %}
</ ul >

テンプレートをレンダリングします

 class UserOverviewRequestHandler
{
    public function __construct (
        private readonly Environment $ twig ,
    ) {
    }

    public function handle (
        ServerRequestInterface $ request ,
        ResponseInterface $ response ): ResponseInterface
    {
        $ template = $ this -> twig -> load ( ' users.html.twig ' );
        $ response -> getBody ()-> write ( $ template -> render ( /*...*/ ));

        return $ response ;
    }
}