完全なカスタム構成

Documentation Menu
戻る

完全なカスタム構成

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

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

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

docker run -it -m 8g -p 8080:8080 liferay/dxp:7.4.13-u55。

メールアドレス[email protected]_とパスワード_test_を使用して、http://localhost:8080でLiferayにサインインしてください。 プロンプトが表示されたら、パスワードを _learn_に変更します。

次に、以下の手順を実行します。

  1. 完全カスタム設定 をダウンロードし、解凍してください。

    curl https://resources.learn.liferay.com/dxp/latest/ja/building-applications/core-frameworks/configuration-framework/liferay-u2g5.zip -O

    unzip liferay-u2g5.zip

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

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

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

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

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

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

  5. ［コントロールパネル］ → ［設定］ → ［System Settings］ → ［Third Party］ に移動します。 ［U2G5 Configuration］ をクリックします。

    システム設定で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が自動生成されなくなります。

note

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

設定画面を実装する

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

    @Component(service = ConfigurationScreen.class)

  2. カテゴリーキー、設定エントリーのキー、およびそのローカライズされた名前を設定します。 サンプルプロジェクトでは、システム設定でカテゴリーキーがthird-partyに設定されています。 構成名のString値は、バンドルのLanguage.propertiesファイルの言語キーによって設定されます。


@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. この例では、構成スコープは systemに設定されています。 詳細については、スコープ設定を参照してください。
@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)"
)

Web-ContextPathを追加する

bnd.bndファイルでバンドルのWeb-ContextPathを指定します。 たとえば、サンプルプロジェクトの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を作成します。

Not finding what you're looking for?

Pardon our dust as we revamp and transition our product documentation to this site. If something seems missing, please check Liferay Help Center documentation for Liferay DXP 7.2 and previous versions.

Try Liferay's Help Center