baserCMS５開発の取り組み

今回の一番の大掛かりの課題は、CakePHP４系対応。

昨今のPHPフレームワーク事情において、巷では数年前よりもっぱらLaravelが主流となりつつありますが、baserCMSにおいては、次期バージョンにおいても従来より利用しているCakePHPをアップグレードして引き続き利用する方針となりました。

Laravelの話もありましたが、オープンソースのWebアプリケーションとしては、規約を重視したCakePHPの方が可読性も上がり、レビューもしやすいだろうということで続行採用に至りました。

CakePHP３系から導入されたミドルウェアの仕組み、ORマッパーの大幅な変更と、ヘルパー関連の変更に非常に泣かされている状況です。

ただ、CakePHPも進化しており現在のバージョンは４となります。日本でもまた広く使われるようになるといいですね。

開発における基本方針は次のとおり

• コアをコンパクトに、CakePHPのプラグインとして開発し疎結合化する
• プラグインを作りやすくするためのAPIを充実させる
• コアとして提供すべきプラグインは「コアプラグイン」として梱包する
• 単体テストとリファクタリングがしやすい構成を目指す
• ベストの仕組みを検討しつつ現状の着地点を探る

というわけで、baserCMS５は、CakePHPのプラグインとして動作するように開発を進めています。CakePHPを利用した開発プロジェクトにおいて、ComposerでbaserCMSがインストールできるイメージです。

これは、baserCMS４までが、CakePHPの 開発の雛形である app に依存しすぎていたため、疎結合化をすすめるためその方針としています。

コアをコンパクトにし、プラグインをどんどん作っていき、プラグイン向けのAPIを充実させるという方針のため、プラグイン（アプリ）が増えていきますが、別々のレポジトリでの開発だと非常に非効率です。

プラグイン自体は、コアパッケージの中にコアプラグインとして梱包する方針のため、単一のリポジトリに特定のプロジェクトのすべてのアプリを含めることができるようにするための「モノレポ」を採用しました。

baserCMS５では、MonorepoBuilder を利用しています。

同じレポジトリ内で開発することができ、リリース時には、別々のレポジトリに分割することができます。

• BaserCore
• BcAdminThird

CakePHPの開発の場合、まず、Fat Controller になり、その後、Fat Model となる傾向があります。そうなってくるとモデルにおいてデータ操作とビジネスロジックがゴチャゴチャになって辛くなってきます。

そこで、ドメイン駆動設計にならい、ビジネスロジックはサービスクラスに分離した上で、CakePHP4.2から導入されたDIコンテナを利用し、コントローラーにサービスを注入する方式を取ることとしました。

• アーキテクチャー設計方針

baserCMSのプラグインでは、データベースのテーブルやデータを利用する前提のものも多いのですが、プラグインをインストールする際にテーブルを初期化できる仕組みを作りたい。

CakePHPのテーブルを管理する仕組みとして Migrations がありますが、PHPで操作できる環境を提供してくれていたので助かりました。こちらを利用してインストールの仕組みを作りました。

• 非シェル環境でのマイグレーションを実行する

CakePHPの通常の仕組みでは、プラグインを追加するためには、Composerを利用するか、手動で package.json とオートローダーを更新する必要があるのですが、baserCMSは、管理画面からプラグインの有効化、無効化をでき、動的にプラグインを読み込む仕組みを前提としているため、別の方法でなんとかしたいと考えました。

調べたところ、ClassLoader クラスの addPsr4() でなんとか動的に読み込むことができそうということで管理画面を使ったプラグインのオートロードに成功しました。

baserCMS５からは、データベースのデータの取得、操作できる APIを提供する前提として開発しています。その際、管理画面用のコントローラー、フロントエンド用のコントローラー、API用のコントローラーを分けて構成するようにしました。

- src/
    - Controller
        - PagesController
        - Admin
            - PagesController
        - Api
            - PagesController

また、APIの認証には、JWT認証を採用しました。

ログイン用のAPIのエンドポイントにログイン名とパスワードを送りつけ認証が成功すると、アクセストークンとリフレッシュトークンを返します。

リソースにアクセスする際は、リクエストヘッダーにアクセストークンを付けてリクエストするイメージです。

baserCMS４系と同様、Docker を利用しています。Mac環境の表示速度改善のため、Docker on Vagrant の環境も準備していますが、VirtualBox が M1チップになかなか対応しない、、、どうしたものか。

• baserCMS５開発環境の構築

ユニットテストは baserCMS４と変わらず PHPUnitを利用しています。

baserCMS５は、基本的に全メソッドを網羅する前提で開発しており、新しいメソッドはほとんどテスト駆動で開発を進めています。

CI（継続的インテグレーション）には、これまで TravisCI を利用していましたが、TravisCIが、有料化しサイトのドメインも変わったので、どうしたものかと考えていましたが、GitHub Actions が意外に簡単で便利でしたのでこちらに移行しました。

• baserCMS５ GitHub Actions YAML

baserCMS５の開発のほとんどは移行がメインとなるため、移行漏れがないような進行管理が必要です。

Reflection を駆使しつつ、プロジェクト内の全ファイルと全メソッドを自動的に洗い出し、スプレッドシートで管理できるようにしています。

• baserCMS５進行管理

また、各メソッドに対して、次の内容についてコメントヘッダーのアノテーションでマーキングできるようにし、スプレッドシートにも自動で反映できるようにしています。

• @checked：移行のためのチェックが完了しているかどうか
• @noTodo：残タスクがないかどうか
• @unitTest：ユニットテストの実装が完了しているかどうか

ドキュメントは GitHub Pages を利用しています。また設計書として、ユースケース図、ドメインモデル図、クラス図を作成するため、PlantUML を使っています。

• baserCMS５開発への貢献方法
• baserCMS５ユーザー設計書

baserCMS５の開発を推進するため、毎月第４水曜日19時に baserCMSネクストミーティングをオンラインで開催しています。そこでは、開発の進捗状況の共有や、現在発生している課題や新しい仕様の共有などを行っており、誰でも参加可能ですので、ご興味のある方は気軽に参加下さい。

また、毎月第３土曜日11:00〜19:00では、オンラインで開発合宿を開催しています。こちらもどなたでも参加可能です。開発についての質問なども受け付けていますのでこちらもご興味のある方はどうぞ。

ネクストミーティングと合宿の日程については、baserCMS公式サイトのNEWSで随時告知しています。

次の合宿は2022年1月15日11:00〜、ネクストミーティングは、2022年1月26日(水)19:00〜です。

• ネクストミーティングの振り返りと開発合宿のお知らせ

CakePHP４系への移行は非常に大掛かりなものとなりますが、その他に次の新機能要件を進めています。

• カスタムコンテンツ（管理画面の入力項目をノーコードで設定できる機能）
• REST API
• オートアップデート（パッチバージョンのみが対象）
• ダッシュボード機能強化

カスタムコンテンツとREST APIを実装することで、ヘッドレスCMSとしての対応も可能となります。

baserCMS５の開発は、コードネーム「ucmitz」として３つのマイルストーンを持ち、現在、１つ目の ucmitz バージョン１がリリース済です。現在、2022年２月にucmitzバージョン２をリリースできるよう開発を進めており、最終的に、2022年6月に、baserCMS５をリリースできることを目標としています。

現時点でもかなり伸び伸びとなっていますが、できるだけ予定どおりにリリースできるように頑張っていきたいと思います。

今回の記事で、baserCMS５の開発のご興味を持って頂いたのであれば、ぜひ合宿に参加しましょう！