完全カスタマイズ構成
設定インターフェースを作成すると、設定用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 に変更してください。
次に、以下の手順に従ってください。
-
完全カスタム構成 をダウンロードして解凍します。
curl https://resources.learn.liferay.com/examples/liferay-u2g5.zip -Ounzip liferay-u2g5.zip -
モジュールのルートディレクトリから、ビルドとデプロイを実行します。
./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)注記このコマンドは、デプロイされたjarファイルをDockerコンテナの/opt/liferay/osgi/modulesにコピーするのと同じです。
-
Liferay Dockerコンテナコンソールでデプロイメントを確認してください。
STARTED com.acme.u2g5.web_1.0.0 [1034] -
サンプルモジュールが正しく動作することを確認してください。ブラウザで
https://localhost:8080を開いてください。 -
グローバルメニュー (
) → コントロールパネル → システム設定 → サードパーティ に移動します。 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 については、 を参照してください。。
設定画面を実装する
-
ConfigurationScreenの実装としてクラスを宣言し、@Componentアノテーションを付けます。@Component(service = ConfigurationScreen.class) -
カテゴリキー、設定エントリのキー、およびそのローカライズされた名前を設定します。サンプルプロジェクトでは、システム設定でカテゴリキーが
サードパーティに設定されています。構成名の文字列値は、バンドルの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");
}
- この例では、構成スコープは
システムに設定されます。詳細については、 スコープ構成 を参照してください。
@Override
public String getScope() {
return "system";
}
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);
}
}
- モジュールのシンボル名を定義するには、必ず
@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を作成する
-
設定インターフェースをJSPにインポートします。
<%@ page import="com.acme.u2g5.web.internal.configuration.U2G5WebConfiguration" %> -
リクエストオブジェクトから設定値にアクセスします。
<% U2G5WebConfiguration u2g5WebConfiguration = (U2G5WebConfiguration)request.getAttribute(U2G5WebConfiguration.class.getName()); %> -
属性
fontColor()、fontFamily()、fontSize()が JSP で使用できるようになりました。
このサンプルプロジェクトは、 ConfigurationScreen を使用してカスタム JSP で構成値を読み込んで表示する基本的な例を示しています。アプリケーションでは、独自のコードを記述し、ニーズに合わせて完全にカスタマイズされた設定UIを作成してください。