フィードバックを送信
Configuration Framework
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

構成フォームレンダラー

構成インターフェースを作成すると、構成 UI が自動的に生成されます。 ただし、UIのルックアンドフィールをカスタマイズしたい場合もあります。 たとえば、会社のデザインの美的感覚に一致するようにUIを変更するとします。 ConfigurationFormRendererの実装でこれを行う方法は次のとおりです。

サンプルプロジェクトを参照する

新しいLiferay DXPインスタンスを起動し、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:2025.q1.6-lts

メールアドレス test@liferay.com とパスワード testを使用して、 http://localhost:8080 で Liferay にサインインします。 プロンプトが表示されたら、パスワードを learnに変更します。

次に、以下の手順に従います。

  1. 構成フォーム レンダラーをダウンロードして解凍します。

    curl https://resources.learn.liferay.com/examples/liferay-b7r2.zip -O

    unzip liferay-b7r2.zip

  2. モジュールのルートから、ビルドおよびデプロイします。

    ./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)
    注

    このコマンドは、デプロイされたjarをDockerコンテナの/opt/liferay/osgi/modulesにコピーするのと同じです。

  3. Liferay Dockerコンテナコンソールでデプロイを確認します。

    STARTED com.acme.b7r2.web_1.0.0 [1034]

  4. サンプルのモジュールが機能していることを確認します。 ブラウザでhttps://localhost:8080を開きます。

  5. コントロール パネル → 構成 → システム設定 → サードパーティに移動します。 B7R2 構成をクリックします。

    システム設定でU2G5構成に移動します。

    このビューはカスタムJSPファイルによって提供されることに注意してください。

構成インターフェースを作成する

構成インターフェイスで構成可能な属性を定義します。 サンプルプロジェクトには、b7r2Colorという1つの構成可能な属性があります。

public interface B7R2WebConfiguration {

	@Meta.AD(deflt = "blue", name = "b7r2-color", required = false)
	public String b7r2Color();

}

ConfigurationFormRendererを使用する場合、 generateUI アノテーションは、 生成された UI を非表示にするために必要ではないことに注意してください。

注

DXP 7.4 U51 または Portal 7.4 GA51 より前の Liferay バージョンでは、 ConfigurationBeanDeclaration が必要です。 以前のバージョンの Liferay での ConfigurationBeanDeclarationを参照してください。

Configuration Form Rendererを実装する

  1. ConfigurationFormRendererの実装を作成します。 @Componentアノテーションで、サービスをConfigurationScreen.classとして宣言します。

    @Component(service = ConfigurationScreen.class)

  2. getPid()メソッドをオーバーライドします。 構成クラスの@Meta.OCDアノテーションで指定されている完全な構成IDを必ず返すようにしてください。

@Override
public String getPid() {
	return "com.acme.b7r2.web.internal.configuration.B7R2WebConfiguration";
}
  1. getRequestParameters()メソッドをオーバーライドします。 このメソッドでは、カスタムUIによって送信されたパラメーターを読み取り、それらをマップに配置します。ここで、キーは構成インターフェースにあるフィールドと一致します。
@Override
public Map<String, Object> getRequestParameters(
	HttpServletRequest httpServletRequest) {

	String b7r2Color = ParamUtil.getString(httpServletRequest, "b7r2Color");

	return new HashMap<String, Object>() {
		{
			put("b7r2Color", b7r2Color);
		}
	};
}

  1. render()メソッドをオーバーライドします。 この例では、 ConfigurationProviderが構成オブジェクトにアクセスします。 サーブレットコンテキストは、リクエストディスパッチャへのアクセスを提供します。これにより、カスタムJSPが構成を読み取ることができます。

  2. 必ず@Referenceアノテーションを使用して、モジュールのシンボル名を定義してください。

    @Reference(
	target = "(osgi.web.symbolicname=com.acme.b7r2.web)"
)

Web-ContextPathを追加する

bnd.bndファイルでバンドルのWeb-ContextPathを指定します。 たとえば、サンプルプロジェクトのBndファイルにはWeb-ContextPath: /b7r2-webがあります。 これは、configuration form rendererファイルにServletContextオブジェクトを登録するものです。 サーブレットコンテキストはポートレット用に自動的に作成されますが、このサンプルにはポートレットがないため、サーブレットコンテキストをbnd.bndファイルに追加する必要があることに注意してください。

カスタムJSPを作成する

  1. 構成インターフェースをJSPにインポートします。

    <%@ page import="com.acme.u2g5.web.internal.configuration.B7R2WebConfiguration" %>

  2. リクエストオブジェクトから構成値にアクセスします。

    <%
B7R2WebConfiguration b7r2WebConfiguration = (B7R2WebConfiguration)request.getAttribute(B7R2WebConfiguration.class.getName());
%>

  3. <aui:input> タグを使用して、ユーザーがJSPファイルに送信する新しい構成入力を読み取ります。

    <aui:input name="b7r2Color" value="<%= b7r2WebConfiguration.b7r2Color() %>" />

このサンプルプロジェクトは、ConfigurationFormRendererを使用してカスタマイズされた基本的な構成UIを示しています。 アプリケーションでは、独自のコードを記述して、構成UIのルックアンドフィールをさらにカスタマイズしてください。

Capability:
Development and Tooling
Resource Type:
Official Documentation
Feature:
Core Frameworks
Deployment Approach:
Liferay PaaS
Liferay Self-Hosted