ナビゲーション・ヘッダーをスキップ
Oracle ADF UIX開発者ガイド 目次へ
目次
前のページへ戻る
前へ
次のページへ進む
次へ

6. ADF UIXでの国際化

このトピックでは、Oracle ADF UIXで国際化アプリケーションを開発する方法を説明します。実行時に自動的にローカライズされるUIX ComponentsおよびUIX XMLのページの記述方法や、ページを正しいロケールおよびキャラクタ・セットで配信する方法、および両方向言語をサポートする方法などについて説明します。

ここでは、次の項目について説明します。

概要

多くの異なる言語を使用する多数のユーザーにアプリケーションをデプロイすることはごく一般的です。 Javaに習熟している場合、サーブレットをNLS(National Language Support)準拠にする方法を知っている場合もあるでしょう。 Javaでは内部的にUnicode文字列が使用されるため、文字列の処理は、通常、NLSに準拠しています。 また、JavaのResourceBundleは翻訳テキストにアクセスするための堅固な標準的メカニズムです。 ただし、サーブレットには、従来のJavaアプリケーションでは考慮する必要がなかった多くの問題があります。

第1に、従来のJavaアプリケーションでは複数のロケールがサポートされていましたが、通常、実行できるのは1回に1つのみでした。 Webアプリケーションでは、1つのWebサーバーで、それぞれ独自のロケールを使用する多くのユーザーをサポートする必要があります。 ここでは、1つのページを複数言語で実行できる、UIX ComponentsまたはUIX XMLのページの記述方法を学びます。 また、ユーザーの指定ロケールをUIXで自動的に検出する方法、およびその選択をオーバーライドする方法を学びます。

第2に、JavaサーバーではUnicode文字列のみが使用されますが、ユーザーのブラウザでは、任意の数の文字コードが実行されます。 「文字コード」とは、数字、アルファベットまたは漢字などのテキストと、バイト・ストリームとのマッピングです。 JavaのUnicodeサポートは便利ですが、(正確には、使用されるUTF-16文字コードでは)各文字について2バイトから4バイトが必要とされ、帯域幅が消費されます。 デフォルトのHTMLエンコーディング(西ヨーロッパ言語ISO-8859-1)では各文字に1バイトしか使用しませんが、ごく一部のUnicode文字しかサポートされません。 ここでは、UIXでキャラクタ・セット・エンコーディングが処理される方法、および必要に応じてその動作をオーバーライドする方法を説明します。

第3に、アラビア語やヘブライ語などの両方向言語をサポートするページの記述方法を説明します。 UIX ComponentsおよびUIX XMLを使用すると、簡単に記述できます。

また、適切に実装するためにはWebアプリケーションの開発者が長時間作業する必要があったいくつかのタスクを、自動的および透過的に処理する方法を学びます。

ローカライズ: UIX ComponentsおよびUIX XMLの翻訳

UIXのLocaleContext API

oracle.cabo.share.nls.LocaleContext APIは、UIXでのローカライズにおいて重要です。 APIには、ロケール、レンダリングの方向(左から右、または右から左)およびTimeZoneといった、ページを正しく翻訳するために必要な情報が含まれています。 また、負荷の高いResourceBundle.getBundle() Java APIを繰り返しコールしないための、ResourceBundleオブジェクトのキャッシュも含まれています。

その他ほとんどすべてのコンテキスト・オブジェクトからLocaleContextを取得できます。 UIX ComponentsのRenderingContextとUIXサーブレットのBajaContextインタフェースのどちらにも、getLocaleContextメソッドがあります。 可能な場合は、これらのRenderingContextおよびBajaContextのデフォルトの実装によりユーザーのリクエストが自動的に確認され、accept-languages HTTPヘッダーを使用して適切なロケールが推測されます。 そのため、ほとんどのアプリケーションでロケールを取得するための操作をせずに、正しいロケールが得られます。 必要に応じて選択をオーバーライドする方法は後で学びますが、ここではLocaleContextの利用方法を説明します。

UIX Componentsの翻訳

UIX Componentsを翻訳する1つの方法はごく明白です。 リクエストごとにUIX ComponentsのBeanを新規に作成し、正しく翻訳されたテキストを設定する方法です。

  Locale locale = localeContext.getLocale();
  ResourceBundle bundle =
    ResourceBundle.getBundle(_BUNDLE_CLASS_NAME, locale);

  ButtonBean button = new ButtonBean();
  button.setText(bundle.getString("buttonText"));

ただし、この場合、リクエストごとにボタン(およびページのその他すべての部品)を作成するか、ロケールごとに1つのコピーを保存する必要があります。 これでは負荷がかかります。 Beanを一度作成し、ローカライズされたテキストをそのBeanで独自に取得する方が効率的です。 UIX Componentsでは、動的出力(データ・バインド)をサポートする場合と同じ方法で、これをサポートします。 (「ADF UIXでのデータ・バインディング」のトピックをまだ読んでいない場合は、必要に応じて参照してください。)

簡単で便利なクラスoracle.cabo.ui.data.bind.BundleBoundValueを使用して、この作業すべてを実行できます。 このクラスでは、ResourceBundleの名前およびキーを取得して、翻訳されたテキストを自動的に取得するBoundValueを返します。

  ButtonBean button = new ButtonBean();
  button.setTextBinding(new BundleBoundValue(_BUNDLE_CLASS_NAME,
                                            "buttonText"));

これで終了です。 このボタンにより、翻訳済テキストが実行時に自動的に取得されます。

UIX XMLの翻訳

UIX Componentsの場合と同様に、UIX XMLを翻訳する1つの方法は明白です。 UIX XMLページを英語で作成し、ファイルをそのまま翻訳チームに渡す方法です。 UIX XMLは、翻訳者が不得意とするJSPなどの様々なファイル形式に比べて処理が容易です。しかし、翻訳作業ができたとしてもこのようなアプリケーションの形態はシステムにも相当の負担がかかります。 すべてのファイルを実行時にロードする必要があるため、メモリーが無駄に使用されるのみでなく、ページに修正を加えるたびに、そのページのすべてのコピーも修正する必要があります。 ユーザーがページをカスタマイズした場合、そのページのすべてのコピーもカスタマイズすることになります。 しかし、もっと効率的な方法があります。

UIX XMLのユーザーは、UIX Componentsの開発者と同じ方法を使用できますが、推奨される方法は、<dataScope>要素、およびこのセクションで紹介する新規要素の<bundle>を使用する方法です。

<dataScope>要素の基本を参照します。 この要素では、そこに含まれるすべての要素にデータのソースを公開します。 その中の<provider>要素内に、それぞれname属性を1つずつ持つ一連の<data>要素を追加します。

 <dataScope>
   <provider>
     <data name="...">
        ... a data provider ...
     </data>

     <data name="...">
        ... a second data provider ...
     </data>
   </provider>
   <contents>
       ... Everything in here can use this data ...
   </contents>
 </dataScope>

<bundle>要素は、<inline>および<method>などのほかのデータ・プロバイダ要素に似ています。 ただし、<bundle>ResourceBundlesを使用します。 ResourceBundleの完全なJavaクラス名である属性のclassを使用します。 一度定義されると、すべてのコンテンツをキーと値のペアとして公開します。


 <dataScope>
   <provider>
     <data name="nls">
       <bundle class="your.Bundle"/>
     </data>
   </provider>
   <contents>

      <button text="${uix.data.nls.buttonText}"/>

   </contents>
 </dataScope>

これですべてです。 翻訳済テキストをこの新規のnlsデータ・プロバイダにバインドすると、実行時にすべてが自動的に表示されます。 もちろん、(個々の<data>要素内にある)複数の<bundle>要素を使用して、複数のResourceBundlesにバインドできます。 また、一般的に、<dataScope>要素はページの最上部に置かれるため、 <bundle>要素はページ全体で一度宣言するのみです。

DataObjectの翻訳

DataObjectの場合について考えます。 UIX XMLおよびUIX Componentsコードから完全に分離されたデータソースはすべて、実行時にRenderingContextを取得するため、残りのページでも同じLocaleContextにアクセスします。 翻訳済テキストを表示することも可能です。

public class YourDataObject implements DataObject
{
  public Object getValue(RenderingContext context, Object select)
  {
    if (select.equals(_TRANSLATED_KEY))
    {
      ResourceBundle bundle =
       context.getLocaleContext().getBundle(_BUNDLE_NAME);
      return bundle.getObject(_SOME_KEY);
    }

    ...
  }
}

ロケールのオーバーライド

多くのクライアントではUIXのLocaleデフォルト設定のみで十分ですが、この選択をオーバーライドする場合があります。 特に、一部のWebアプリケーションでは、ユーザーが設定できる作業環境の言語を選択します。

UIXサーブレットを使用して開発中の場合、PageBrokerの実装にコードを数行追加するのみです。

public class YourPageBroker extends UIXPageBroker
{
  public void requestStarted(BajaContext context)
  {
    Locale locale = ...;
    context.setLocaleContext(new LocaleContext(locale));
  }

}

非常に簡単です。 UIXサーブレットにより、ロケールがUIX ComponentsのRenderingContextに自動的に渡されます。 UIX Componentsを直接使用している場合は、UIX ComponentsのServletRenderingContext.setLocaleContext()メソッドをコールするだけです。

多言語ページ

UIX Componentsの各ページは、1つのLocaleのみで実行されます。 デフォルト以外の言語で文字列を表示できないわけではありません。 UIX Componentsでは文字を自動的にエスケープし、ブラウザで正しく読み込まれるようにします。

1つ注意する点があります。 多言語ページを正しく表示できるブラウザを使用する必要があることです。たとえば、Netscape 4は、多言語対応に優れているとは言えません。

メッセージの書式

UIX ComponentsとUIX XMLの両方で、java.text.MessageFormatクラス、および高速な置換を行うoracle.cabo.share.util.FastMessageFormatに対する統合サポートを提供しています。

これらのクラスでも、データ・バインディング・アーキテクチャおよびBoundValueインタフェースを基にすべてが作成されています。 UIX Componentsでは、oracle.cabo.ui.data.bind.MessageFormatBoundValueクラスを提供しています。 このクラスでは1つのBoundValueからメッセージの書式マスクを動的に取得し、そのマスクに挿入する各オブジェクトをBoundValue配列に入れます。 たとえば、ResourceBundleに次のようなエントリがあるとします。

  ...
  {"textFormat", "From {0} to {1}"}
  ...

次のコードでは、2つの文字列を自動的に取得し、その書式マスクに挿入し、現行ロケールの正しい書式を取得します。

  StyledTextBean styledText = new StyledTextBean();
  // Get the format mask from a ResourceBundle
  BoundValue formatMask = new BundleBoundValue(_BUNDLE_CLASS_NAME,
                                               "textFormat");
  // And get each of the two pieces that go into the mask
  // from DataObjects:
  BoundValue firstEntry = new DataBoundValue("firstSelectKey");
  BoundValue secondEntry = new DataBoundValue("secondSelectKey");

  // And wrap it all up in a MessageFormatBoundValue
  styledText.setTextBinding(new MessageFormatBoundValue(
                              formatMask,
                              new BoundValue[]{firstEntry,
                                               secondEntry});

この例は、少し複雑です。 ただし、強力です。

<messageFormat>要素を使用して、UIX XML内で同じ機能が得られます。


 <dataScope>
   <provider>
     <data name="nls">
       <bundle class="your.Bundle"/>
     </data>
   </provider>
   <contents>
     <styledText>
       <boundAttribute name="text">
         <messageFormat format="${uix.data.nls.textFormat}">
           <dataObject select="firstSelectKey"/>
           <dataObject select="secondSelectKey"/>
         <messageFormat>
       </boundAttribute>
     </styledText>
   </contents>
 </dataScope>
小さな機能に対して長いテキストが記述されていますが、ここで注目するのは、<boundAttribute>要素とその内部です。
  1. 属性をDataObject以外にバインドする場合、<<boundAttribute>を使用する必要があります。
  2. <messageFormat>では、バインド先となる値を定義します。 上の例ではリソース・バンドルから書式を動的に取得するよう選択していますが、format属性を直接設定することも可能です。
  3. BoundValueを定義する2つの子は、それぞれ1つのデータを取得してメッセージの書式にマージします。

このセクションの最初に記載したFastMessageFormatクラスが、デフォルトで使用される書式設定クラスです。 特に次のような索引ベースの単純な置換のみが可能です。

    some{1}text{0}here{2}andthere

また、この索引文字に対して、先頭に一重引用符を付けることでエスケープすることが可能です。 Javaのビルトイン書式設定クラスは負荷が高いため、可能であれば使用しないことをお薦めします。ただし、MessageFormatBoundValueクラス、およびUIXの<messageFormat>オブジェクトには、fast属性が用意されています。 fast属性をfalseに設定した場合、機能は増えますが、実装は遅くなります。

文字コード

前に説明したように、文字コードは、テキストとバイト・ストリームとのマッピングを定義したものです。

UIXサーブレットを使用せずにUIX ComponentsまたはUIX XMLを単独で使用する場合、追加で行う作業がいくつかあります。 code>ServletResponseにWriterを要求し、使用するエンコーディングをサーブレットAPIに指示する必要があります。 ServletRequestのパラメータが正しいキャラクタ・セットに適切にデコードされていることも確認します。

UIXサーブレットを使用している場合は、UIXでこれらが自動的に処理されます。 UIXで推奨されるデフォルトの文字コードは、UTF-8です。 これは、特別なUnicodeエンコーディングです。 UTF-16(Java文字列に使用されるエンコーディング)のように、Unicodeキャラクタ・セットのすべての文字がサポートされます。 UTF-16とは異なり、文字ごとに2バイトから4バイトは使用されません。 1バイトから3バイトが使用されます。 ASCII文字(0(ゼロ)から127)の場合、1バイトのみが使用されます。 HTMLのタグはすべてASCIIのため、HTMLページのほとんどのコンテンツではASCIIが使用されています。このエンコーディングの場合、実質的に使用される領域が少なくなります。

UIXサーブレットでこのデフォルトをオーバーライドするには、PageBrokerの実装にコードを数行追加するだけです。

public class YourPageBroker extends UIXPageBroker
{
  public void requestStarted(BajaContext context)
  {
    String desiredEncoding = ...;
    context.getPageDecoder().setRequestCharacterEncoding(desiredEncoding);
  }
}

ここでもこれですべてです。 requestStarted()内でコールしていることが重要です。

一部のサーブレット・エンジンでは、サーブレット・リクエストの自動的なデコードがサポートされているので、注意してください。 たとえば、サーブレット2.3仕様では、ServletRequest.setCharacterEncoding()メソッドを定義しています。 サーブレット2.3エンジン(Tomcat 4.0など)を使用している場合は、上のコードを次のように変更する必要があります。

public class YourPageBroker extends UIXPageBroker
{
  // Servlet 2.3 code only!
  public void requestStarted(BajaContext context)
  {
    String desiredEncoding = ...;
    context.getServletRequest().setCharacterEncoding(desiredEncoding);
  }
}

また、一部のサーブレット・エンジンで、サーブレット仕様の独自の拡張を使用して、エンコーディングを明示的に設定できるものもあります。 これらのエンジンのいずれかを使用している場合でも、requestStarted()をオーバーライドしてsetRequestCharacterEncoding()をコールする必要があります。ただし、nullを渡して、UIXサーブレットで二重にデコードしないように指示します。

手間がかかりますが、サーブレット2.3仕様でブラウザ間で一貫した動作が提供されるまでは、サーブレット・エンジンの標準以外の動作を自動的にするためにいくつかの操作が必要です。

ただし、文字コードが設定されている場合は、次の処理が自動的に行われます。

デコードされた文字を正しく表示するには、ServletRequestではなく、PageEventを使用する必要があります。 サーブレット2.3エンジンではServletRequestが適切に機能しますが、それでもPageEventを使用してください。 PageEventではファイルのアップロード時に発行されるパラメータも含まれ、UIXの携帯情報端末サポートに必要な追加のデコードも実行されます。 また、最も重要なことは、追加修正や拡張が可能な抽象層であることです。

両方向言語

UIX Componentsのスタックを使用すると、アラビア語やヘブライ語などの両方向言語の処理が単純化されます。 それには、ユーザーのブラウザで両方向言語がサポートされている必要があります。 Internet Explorer 5、Netscape 6およびMozillaなどです。

UIX ComponentsではgetReadingDirection()メソッドを使用して、LocaleUtilsからデフォルトのレンダリング方向を取得します。 LocaleUtilsは、ロケールカらのレンダリング方向(アラビア語およびヘブライ語は右から左、その他すべての言語は左から右)にデフォルト設定します。 ページを右から左にレンダリングすることをブラウザに指示するのは、<HTML>タグのdir="rtl"属性です。 UIXサーブレットを介してUIX XMLを使用している場合、これらの処理が行われます。 UIX ComponentsまたはUIX XMLを直接使用している場合、この処理にはDocumentBeanまたは<document>要素を使用できます。

ページに方向が指定されている場合、正しい水平位置揃え定数を一貫して使用するだけです。 HTMLで通常サポートされているleftrightおよびcenterの他に、UIX Componentsではstartendがサポートされます。 これらは、デフォルトのleftおよびrightと同じように動作しますが、自動的に右から左方向モードに切り替わります。 UIX StylesのXSSテクノロジにより、UIX ComponentsのビルトインのCSSスタイルはすべて、自動的に切り替えられます。

ビルトインXSSを拡張している場合(「ADF UIXのカスタマイズ」を参照)明示的にtext-alignを指定するのではなく、StartTextAlignおよびEndTextAlignプロパティを注意して使用します。

<styleSheetDocument xmlns="http://xmlns.oracle.com/uix/style">

  <import href="blaf.xss"/>

  <styleSheet>
    <!-- Bad -->
    <style name="YourBadStyle">
      <property name="text-align">right</property>
       ....
    </style>

    <!-- Good -->
    <style name="YourGoodStyle">
      <includeStyle name="EndTextAlign"/>
      <property name="text-align">right</property>
       ....
    </style>

  </styleSheet>

</styleSheetDocument>

まとめ

UIXでは多くの国際化タスクが自動化されていますが、ユーザーが処理する必要のあるタスクもいくつかあります。

独自のResourceBundleを記述して、翻訳する必要はもちろんあります。