チュートリアル: シンプルなレンダリングを作成する

SXA は、リポジトリを使用して MVC ビューのモデルを提供します。したがって、コントローラーを完成させたら、リポジトリをコントローラーに注入する必要があります。次の 2 つの方法でリポジトリを挿入できます。

SXA はベース リポジトリを提供します。たとえば、VariantsRepository および ListRepository は便利なプロパティを提供し、独自のリポジトリの実装が簡単になります。もう 1 つの例は、ModelRepository次のような便利なプロパティを提供するベース クラスです。

リポジトリが空で、基本インターフェース メソッドを使用しているだけの場合でも、すべてのリポジトリには独自のインターフェースが必要です。これは、後で依存関係挿入コンテナーを登録するときに使用されるためです。

public interface ISimpleComponentRepository: IModelRepository
{
} 

以下に、単純なリポジトリの例を示します。

    public class SimpleComponentRepository : ModelRepository, ISimpleComponentRepository
    {
        public override IRenderingModelBase GetModel()
        {
            SimpleComponentModel model = new SimpleComponentModel();

            FillBaseProperties(model);
            model.Title = GetTitle();

            return model;
        }

        private string GetTitle()
        {
            return PageContext.Current[Templates._Title.Fields.Title];
        }
    }

設定ファイルを使用して、リポジトリを DI コンテナーに登録してください。

ビューは次のようになります。

@model Sitecore.SXA.Startup.Feature.SimpleComponent.Models.SimpleComponentModel

div @Html.Sxa().Component("simple-component", Model.Attributes)
    div class="component-content"
        h1>You are on @Model.Title page/h1
    /div
/div

ユーザーがツールボックスからアクセスするためのレンダリングを作成するには、Sitecore でアイテムを作成し、コントローラー名とアクション名を使用してアイテムをコードにリンクする必要があります。

Sitecore でコントローラー レンダリングを作成するには:

依存関係挿入 (DI) は、オブジェクトとそのコラボレーター、または Sitecore 依存関係挿入を使用できる依存関係の間で疎結合を実現するための手法です。依存関係挿入を行わない場合、クラスはコラボレーターを直接インスタンス化するか、静的参照を使用する必要があります。依存関係挿入では、クラスが必要とするオブジェクトが提供されます。ほとんどの場合、クラスはコンストラクターを介して依存関係を宣言します。Sitecore は、コンストラクター インジェクションと呼ばれるこのアプローチのみをサポートします。Sitecoreによる DI の実装には、Microsoft.Extensions.DependencyInjection ASP.NET Core からの抽象化が使用されます。

設定ファイルを使用して、リポジトリを DI コンテナーに登録してください。

<?xml version="1.0" encoding="utf-8" ?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
    <sitecore>
        <services>
            <register serviceType="YOUR_NAMESPACE.ISimpleComponentRepository, YOUR_ASSEMBLY_NAME" 
                      implementationType="YOUR_NAMESPACE.SimpleComponentRepository, YOUR_ASSEMBLY_NAME" 
                      lifetime="Singleton"/>
        </services>
    </sitecore>
</configuration> 

SXA レンダリングの場合、Sitecore 基本クラス IServicesConfigurator を使用して、以下のコードからサービスを設定することもできます。

using Microsoft.Extensions.DependencyInjection;
using PageTitle.Controllers;
using PageTitle.Repositories;
using Sitecore.DependencyInjection;

namespace PageTitle
{
    public class RegisterDependencies : IServicesConfigurator
    {
        public void Configure(IServiceCollection serviceCollection)
        {
            serviceCollection.AddTransient<ISimpleComponentRepository, SimpleComponentRepository>();
            serviceCollection.AddTransient<SimpleComponentController>();
        }
    }

次に、その RegisterDependencies クラスを指す設定ノードを使用して設定を追加する必要があります。

次に例を示します。

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
  <sitecore>    
    <services>
      <configurator type="SimpleComponent.RegisterDependencies, SimpleComponent" />
    </services>
  </sitecore>
</configuration>

デフォルトの SXA レンダリングには、グリッドとスタイルのサポートが付属しています。カスタム レンダリングを SXA グリッドおよびスタイリングに準拠させる場合は、パラメーター テンプレートを提供し、いくつかの基本 SXA テンプレートを割り当てる必要があります。

レンダリングにグリッドとスタイルのサポートを追加するには:

サイトのプレゼンテーション フォルダーで、エクスペリエンス エディターのツールボックスに表示するレンダリングを設定できます。ツールボックスを再構築することもできます。

SXA ツールボックスにレンダリングを追加するには: