コンテンツのアーキテクチャ

最終更新日： 2024年7月15日

作成対象：

  • 開発者

David's Model に準拠

David's Model は何年も前に David Nuescheler によって作成されたものですが、その考え方は今でも通用します。David's Model の主な考えは以下のとおりです。

  • データが第一、構造は二の次（おそらくですが）。
  • コンテンツ階層を推進し、成り行き任せにしない。
  • ワークスペース は clone()、merge()、update() のためのもの。
  • 同じ名前の兄弟に注意する。
  • 参照は害が多いと考えられる。
  • ファイルはファイルである。
  • ID は有害。

David モデルについては、Jackrabbit wiki（https://wiki.apache.org/jackrabbit/DavidsModel）に詳しい解説があります。

すべてがコンテンツである

あらゆるデータの格納には、データベースなど別個のサードパーティデータソースを利用するのではなく、リポジトリを使用する必要があります。これは、作成済みコンテンツ、画像などのバイナリデータ、コード、設定などに当てはまります。このようにすると、1 つの API セットを使用してすべてのコンテンツを管理でき、レプリケーションによってこのコンテンツのプロモーションを管理できます。また、バックアップやログなどの単一ソースも得られます。

「コンテンツモデルが第一」のデザイン原則を使用

新機能をビルドするときには、常に JCR コンテンツ構造の設計から始め、次にデフォルトの Sling サーブレットを使用したコンテンツの読み込みおよび書き込みに進みます。これにより、初期設定済みのアクセス制御メカニズムで実装が適切に動作することを保証し、不要な CRUD 形式のサーブレットの生成を回避できます。

RESTful に準拠

サーブレットをパスではなく resourceType に基づいて定義する必要があります。このようにすると、JCR アクセス制御を使用し、REST 原則に準拠し、要求で提供されるリソースおよびリソースリゾルバーを使用できます。また、これにより、サーバーサイドで URL をレンダリングするスクリプトを変更でき（クライアントサイドから URL を変更する必要がありません）、サーバーサイドの実装をクライアントに対して非表示にすることでセキュリティを強化します。

新しいノードタイプの定義を回避

ノードタイプはインフラストラクチャレイヤー内の下位レベルで機能し、ほとんどの要件は nt:unstructured、oak:Unstructured、sling:Folder または cq:Page のノードタイプに割り当てられた sling:resourceType を使用することで満たすことができます。ノードタイプはリポジトリではスキーマと同等で、ノードタイプを変更すると後でコストがかかる可能性があります。

JCR の命名規則に準拠

命名規則に準拠することにより、コードベースの一貫性が高まるので、不具合の発生率を低下させ、システムで作業する開発者の速度を高めることができます。AEM の開発においてアドビが使用した規則は次のとおりです。

  • ノード名

    • すべて小文字
    • 単語間の区切りにハイフンを使用

  • プロパティ名

    • キャメルケース、小文字で開始

  • コンポーネント（JSP/HTML）

    • すべて小文字
    • 単語間の区切りにハイフンを使用
前のページ開発のベストプラクティス
次のページソフトウェアのアーキテクチャ

Experience Manager