Documentation

グローバル言語キーのオーバーライド

Liferay DXP/Portalでは、言語キーを使用して、デフォルトロケールと他の多くのロケールの見出し、ラベル、およびメッセージを実装します。 モジュール内の新しい言語キー値を使用して、任意のロケールのこれらのキーをオーバーライドできます。

グローバル言語キーを調べる

グローバル言語キーは、ソースコードとDXP/Portalバンドルに含まれています。

ソースの場合:

バンドルの場合:

  • portal-impl.jar#content/Language[_xx_XX].properties

  • Liferay Foundation - Liferay Portal Language - Impl.lpkgcom.liferay.portal.language.lang-[version].jar#content/Language[_xx_XX].properties

さまざまな言語とロケールの言語キーは、ファイル名の末尾で識別できます。 たとえば、Language_ja.propertiesは日本語用です。

これらの言語キーファイルには、言語設定プロパティなど、オーバーライドできるプロパティが含まれています。

...
lang.user.name.field.names=prefix,first-name,middle-name,last-name,suffix
lang.user.name.prefix.values=Dr,Mr,Ms,Mrs
lang.user.name.required.field.names=last-name
lang.user.name.suffix.values=II,III,IV,Jr,Phd,Sr
...

メッセージやラベル用にオーバーライドできる単純なキーもたくさんあります。

category.admin=Admin
category.alfresco=Alfresco
category.christianity=Christianity
category.cms=Content Management
...

Liferay DXP/Portal 7.4以降では、メタデータを使用してオーバーライドを宣言できます。 以前のバージョンでは、Javaクラスがオーバーライドを宣言します。

お使いのバージョンが7.4より前の場合は、 以前のバージョンでのオーバーライド に進んでください。 それ以外の場合は、読み進めてください。

サンプルをデプロイする(7.4以降の場合)

この例では、home言語キー設定を次のように変更します。

サンプルをデプロイする方法は次のとおりです。

新しいLiferayインスタンスを実行します。

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.22-ga22

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

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

  1. 最新のサンプル をダウンロードして解凍します。

    curl https://learn.liferay.com/dxp/latest/ja/liferay-internals/extending-liferay/liferay-i2f4.zip -O
    
    unzip liferay-i2f4.zip
    
  2. プロジェクトモジュールをビルドしてデプロイします。

    cd liferay-i2f4
    
    ./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)
    

    注釈

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

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

    STARTED com.acme.i2f4.impl_1.0.0 [3209]
    
  4. サンプルモジュールのカスタマイゼーションを確認します。 ブラウザでhttps://localhost:8080を開きます。

  5. Click the menu icon (Menu). ホームアイコンラベルには、カスタム言語のキー値が使用されています。

    ホームアイコンにカスタム言語のキー値が使用されるようになりました。

  6. この例には、複数のロケールのカスタム言語キー値が含まれています。 たとえば、言語セレクターでブラジルポルトガル語または日本語を選択すると、そのロケールでのカスタマイゼーションが表示されます。 モジュールは、これらのロケールの言語キーもオーバーライドします。

    カスタム言語キーは、ブラジルポルトガル語と日本語にも使用されます。

例を見たところで、次にこれがどのように機能するかを確認していきます。

言語プロパティファイルを作成する

オーバーライドするキーを選択します。 サンプルモジュールは、home言語キーをオーバーライドします。

重要

宣言する言語キーの値は、それらの既存のキーの値をオーバーライドします。 他のすべての既存の言語キー設定は保持されます。

オーバーライドするキーを決定したら、モジュールのsrc/main/resources/contentフォルダに言語プロパティファイルを作成します。 ファイル名Language.propertiesを使用して、デフォルトのロケールの言語キーをオーバーライドします。 特定のロケールのキーをオーバーライドするには、言語プロパティのファイル命名規則を使用します。

Language[_xx_XX].properties

たとえば、日本語をオーバーライドする場合は、Language_ja.propertiesを使用します。

Bndファイルでオーバーライドを宣言する

モジュールのbnd.bndファイルで、言語リソースプロバイダーの機能を指定します。 サンプルのProvide-Capabilityヘッダーは次のとおりです。

注釈

この例では、サービスのランキングを省略しており、OSGiのデフォルトのランキング 0を使用しています。これは、デフォルトのグローバルリソースバンドルサービスのランキング -1よりも高くなっています。

グローバル言語キーのオーバーライドは、同じモジュール内にあるほうが管理が簡単です。

複数のモジュールを使用してグローバル言語キーをオーバーライドすることはお勧めしませんが、複数のモジュールで同じキーをオーバーライドすると、サービスランキングが最も高い言語リソースプロバイダーが優先されます。

たとえば、モジュールの言語キーがサービスランキング1のプロバイダーのキーよりも優先されるようにする場合は、ランキングを2以上に設定します。

Provide-Capability:\
    liferay.language.resources;\
        resource.bundle.base.name="content.Language";\
        service.ranking:Long="2"

モジュールをデプロイして、新しい言語キー値を確認します。

以前のバージョンでのオーバーライド

7.4より前のLiferay DXP/Portalバージョンでは、グローバル言語キーをオーバーライドするには、カスタマイズする翻訳ごとに 言語プロパティファイルjava.util.ResourceBundleが必要です。 次の例をデプロイしてそのコードを調べることにより、詳細を確認してください。

注釈

言語キーの多くはグローバル言語キーファイルにありますが、特定のアプリケーションモジュールにある場合もあります。 以前のバージョンでモジュール言語キーをオーバーライドするプロセスは、グローバルキーをオーバーライドするプロセスとは異なります。

以前のバージョンの例をデプロイする

この例では、publish言語キー設定を次のように変更します。

サンプルをデプロイする方法は次のとおりです。

  1. グローバル言語キーのオーバーライド をダウンロードして解凍します。

    curl https://learn.liferay.com/dxp/latest/ja/liferay-internals/extending-liferay/liferay-x8f3.zip -O
    
    unzip liferay-x8f3.zip
    
  2. プロジェクトモジュールをビルドしてデプロイします。

    cd liferay-x8f3
    
    ./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)
    
  3. Liferay Dockerコンテナコンソールでデプロイを確認します。

    STARTED com.acme.x8f3.impl_1.0.0 [3209]
    
  4. Navigate to a Site page and click the edit icon (Edit). 公開ボタンには、カスタム言語キーが表示されます。

    公開ボタンにカスタム言語キーが使用されるようになりました。

  5. 言語セレクターを使用してブラジルポルトガル語または日本語を選択すると、カスタム言語キーが表示されます。 モジュールは、モジュールに含める各ロケールの言語キーをオーバーライドします。

    カスタム言語キーは、ブラジルポルトガル語と日本語にも使用されます。

7.4以降の例と同様に、このモジュールは言語キーファイルのカスタム値を指定します。 ただし、メタデータ(bnd.bndファイルヘッダー)を使用してオーバーライドを宣言する代わりに、モジュールはResourceBundleクラスを使用します。

リソースバンドルクラスを作成する

オーバーライドする各ロケールには、java.util.ResourceBundleを拡張するクラスが必要です。 en_USロケールのリソースバンドルクラスの例を次に示します。

クラスの_resourceBundleフィールドにはResourceBundleが割り当てられます。 ResourceBundle.getBundleの呼び出しには、2つのパラメーターが必要です。 content.Language_en_USパラメーターは、モジュールのsrc/main/resources/contentフォルダに対する言語ファイルの修飾名です。 2番目のパラメーターは、リソースバンドルの言語構文を設定するcontrolです。 Liferayの構文と同じ言語構文を使用するには、Liferayのcom.liferay.portal.kernel.language.UTF8Controlクラスをインポートし、2番目のパラメーターをUTF8Control.INSTANCEに設定します。

クラスの@Componentアノテーションは、それをOSGi ResourceBundle サービスコンポーネントとして宣言します。 そのlanguage.idプロパティは、en_USロケール用にそれを指定します。

クラスは次のメソッドをオーバーライドします。

handleGetObject モジュールのリソースバンドル(モジュールの言語プロパティファイルに基づく)でキーを検索し、キーの値をObjectとして返します。

getKeys リソースバンドルのキーのEnumerationを返します。

リソースバンドルサービスコンポーネントは、デフォルトの言語キーをモジュールの言語キーオーバーライドにリダイレクトします。

複数のロケールのグローバル言語キーをオーバーライドするには、ロケールごとに個別のリソースバンドルクラスが必要です。 たとえば、チュートリアルコードには、ブラジルポルトガル語、英語、および日本語用のクラスがあります。 各リソースバンドルは、language.idコンポーネントのプロパティ定義と言語ファイルの修飾名パラメーターでロケールを指定する必要があります。 たとえば、日本語ロケールでは次のようになります。

コンポーネント定義:

リソースバンドルの割り当て:

モジュールをデプロイして、新しい言語キー値を確認します。

注釈

DXP 7.4以降にアップグレードする準備ができたら、言語キーオーバーライドモジュールを引き続き使用できます。 オプションとして、 above で示すように、ResourceBundle クラスを削除し、Provide-Capability ヘッダーを bnd.bnd ファイルで指定することで、モジュールを簡素化することができます。

関連情報

  • 以前のバージョンでのモジュール言語キーのオーバーライドをする