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

David's Model に準拠

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

  • データが最初に取り込まれ、構造が後になります。 多分。
  • コンテンツ階層は手動で設計し、成り行き任せにしない。
  • ワークスペースは clone(), merge()、および update().
  • 同じ名前の兄弟に注意する。
  • 参照は害が多いと考えられる。
  • ファイルはあくまでもファイル。
  • ID は悪いです。

David's Model は、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の開発では、次の規則をAdobeが使用します。

  • ノード名

    • すべて小文字
    • 単語間の区切りにハイフンを使用
  • プロパティ名

    • キャメルケース、小文字で開始
  • コンポーネント(JSP/HTML)

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

このページ