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

完全カスタマイズ構成

設定インターフェースを作成すると、設定用UIが自動的に生成されます。ただし、構成に完全にカスタムのUIが必要な場合もあります。たとえば、Liferayの構成管理を使用する代わりに、プログラムで構成を処理するよう計画している場合などです。または、完全にカスタムのUIを作成する柔軟性が必要な場合もあります。その方法は以下の通りです。

サンプルプロジェクトを参照してください

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

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

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

次に、以下の手順に従ってください。

  1. 完全カスタム構成 をダウンロードして解凍します。

    curl https://resources.learn.liferay.com/examples/liferay-u2g5.zip -O
    
    unzip liferay-u2g5.zip
    
  2. モジュールのルートディレクトリから、ビルドとデプロイを実行します。

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

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

  3. Liferay Dockerコンテナコンソールでデプロイメントを確認してください。

    STARTED com.acme.u2g5.web_1.0.0 [1034]
    
  4. サンプルモジュールが正しく動作することを確認してください。ブラウザで https://localhost:8080 を開いてください。

  5. グローバルメニュー (Global Menu) → コントロールパネル → システム設定 → サードパーティ に移動します。 U2G5 設定 をクリックします。

    システム設定のU2G5設定に移動してください。

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

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

設定可能な属性は、設定インターフェースで定義します。サンプルプロジェクトには、 fontColor、 fontFamily、および fontSize の 3 つの設定可能な属性があります。

@ExtendedObjectClassDefinition(
	category = "u2g5", generateUI = false,
	scope = ExtendedObjectClassDefinition.Scope.SYSTEM
)
@Meta.OCD(
	id = "com.acme.u2g5.web.internal.configuration.U2G5WebConfiguration",
	localization = "content/Language", name = "u2g5-configuration-name"
)
public interface U2G5WebConfiguration {

	@Meta.AD(deflt = "blue", required = false)
	public String fontColor();

	@Meta.AD(deflt = "serif", required = false)
	public String fontFamily();

	@Meta.AD(deflt = "16", required = false)
	public int fontSize();

}

@ExtendedObjectClassDefinition アノテーションの下では、 generateUI が false に設定されていることに注意してください。これにより、設定UIが自動生成されなくなります。

注記

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

設定画面を実装する

  1. ConfigurationScreen の実装としてクラスを宣言し、 @Component アノテーションを付けます。

    @Component(service = ConfigurationScreen.class)
    
  2. カテゴリキー、設定エントリのキー、およびそのローカライズされた名前を設定します。サンプルプロジェクトでは、システム設定でカテゴリキーが サードパーティ に設定されています。構成名の文字列値は、バンドルの Language.properties ファイル内の language キーによって設定されます。

@Override
public String getCategoryKey() {
	return "third-party";
}

@Override
public String getKey() {
	return "u2g5-configuration-name";
}

@Override
public String getName(Locale locale) {
	return LanguageUtil.get(
		ResourceBundleUtil.getBundle(locale, U2G5ConfigurationScreen.class),
		"u2g5-configuration-name");
}
  1. この例では、構成スコープは システム に設定されます。詳細については、 スコープ構成 を参照してください。
@Override
public String getScope() {
	return "system";
}
  1. render() メソッドは ConfigurationProvider を使用して構成を取得します。サーブレットコンテキストはリクエストディスパッチャへのアクセスを提供し、これによりカスタムJSPが設定を読み取ることが可能になります。
@Override
public void render(
		HttpServletRequest httpServletRequest,
		HttpServletResponse httpServletResponse)
	throws IOException {

	try {
		RequestDispatcher requestDispatcher =
			_servletContext.getRequestDispatcher("/u2g5.jsp");

		httpServletRequest.setAttribute(
			U2G5WebConfiguration.class.getName(),
			_configurationProvider.getSystemConfiguration(
				U2G5WebConfiguration.class));

		requestDispatcher.include(httpServletRequest, httpServletResponse);
	}
	catch (Exception exception) {
		throw new IOException("Unable to render /u2g5.jsp", exception);
	}
}
  1. モジュールのシンボル名を定義するには、必ず @Reference アノテーションを使用してください。
@Reference(
	target = "(osgi.web.symbolicname=com.acme.u2g5.web)", unbind = "-"
)

Web-ContextPathを追加する

Web-ContextPath を bnd.bnd ファイルで指定します。例えば、サンプルプロジェクトでは、Bnd ファイルに Web-ContextPath: /u2g5-web が含まれています。これにより、構成画面ファイルに ServletContext オブジェクトが登録されます。ポートレットの場合、サーブレットコンテキストは自動的に作成されますが、このサンプルにはポートレットがないため、この行をBndファイルに追加する必要があります。

カスタムJSPを作成する

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

    <%@ page import="com.acme.u2g5.web.internal.configuration.U2G5WebConfiguration" %>
    
  2. リクエストオブジェクトから設定値にアクセスします。

    <%
    U2G5WebConfiguration u2g5WebConfiguration = (U2G5WebConfiguration)request.getAttribute(U2G5WebConfiguration.class.getName());
    %>
    
  3. 属性 fontColor()、 fontFamily()、 fontSize() が JSP で使用できるようになりました。

このサンプルプロジェクトは、 ConfigurationScreen を使用してカスタム JSP で構成値を読み込んで表示する基本的な例を示しています。アプリケーションでは、独自のコードを記述し、ニーズに合わせて完全にカスタマイズされた設定UIを作成してください。