Documentation

ポートレットフィルタを使用したポートレットアクティビティの監査

ポートレットフィルターは、各 ポートレットリクエスト処理フェーズ の開始時にリクエストと応答をインターセプトするため、そこに機能を追加できます。 これにより、レンダリング、アクション、イベント、およびリソース提供の各フェーズでのポートレットアクティビティの監査に役立ちます。

次の手順に従って、ポートレットアクティビティを監査するためのポートレットフィルターを作成します。

  1. フルネーム(com_liferay_blogs_web_portlet_BlogsPortletなど)でターゲットポートレットを識別します。

  2. 監査するポートレットフェーズを決定し、 javax.portlet.filter パッケージから対応するポートレットフィルターインターフェースを実装します。

    各ポートレットフェーズの詳細については、 Portlets を参照してください。

  3. @Componentアノテーションを使用して、OSGiフレームワーク内のコンポーネントをポートレットフィルターとして宣言し、それをPortletFilter.classサービスとして識別します。

    注釈

    ポートレットフィルターは、 OSGi Declarative Service (DS)コンポーネント です。 フィルターは、portlet.xml記述子または @PortletLifecycleFilterアノテーションを使用して、ポートレットに適用することもできます。 詳細については、ポートレット3.0仕様を参照してください。

  4. @Component宣言に次のプロパティを入力します。

    • "javax.portlet.name=[portlet_Name]":このプロパティは、フィルターのターゲットポートレットを設定します。

    • "service.ranking:Integer=100":このプロパティは、フィルターのランキングを設定し、高い方の整数が最初に実行されます。 フィルターに最高ランクを割り当てて、フィルターチェーンの最初からフィルターが起動するようにします。

  5. フィルターのdoFilterメソッドをオーバーライドして、ポートレットフェーズの目的の側面を監査します。

次の例では、RenderFilterを使用して、ブログポートレットのレンダリングフェーズを監査します。

サンプルのポートレットフィルターをデプロイする

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

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.29-ga29。

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

Then, follow these step to download, build, and deploy the sample Portlet Filter to the new docker container:

  1. サンプルモジュールをダウンロードして解凍します。

    curl https://learn.liferay.com/dxp/latest/ja/liferay-internals/extending-liferay/portlet-filters/liferay-b4k8.zip -O
    
    unzip liferay-b4k8.zip
    
  2. 次のgradlewコマンドを実行してJARファイルをビルドし、それを新しいDockerコンテナにデプロイします。

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

    JARは、build/libsフォルダ(つまり、b4k8-impl/build/libs/com.acme.b4k8.impl-1.0.0.jar)に生成されます。

  3. モジュールが正常にデプロイされ、コンテナコンソールを介して開始されたことを確認します。

    Processing com.acme.b4k8.impl-1.0.0.jar
    STARTED com.acme.b4k8.impl_1.0.0 [1656]
    
  4. ブログウィジェットをサイトページに追加して、ポートレットフィルターが機能していることを確認します。

    ブログポートレットに対して描画リクエストが行われるたびに、コンテナコンソールに、レンダリング時間、平均レンダリング時間、およびレンダリングの総数の監査を含む警告メッセージが表示されます。

    WARN [http-nio-8080-exec-2][B4K8PortletFilter:54] Blogs portlet rendered in 3 ms with an average of 3 ms out of 1 renders.
    WARN [http-nio-8080-exec-10][B4K8PortletFilter:54] Blogs portlet rendered in 0 ms with an average of 1 ms out of 2 renders.
    

サンプルのレンダリングフィルターコード

提供されているサンプルのフィルターは、ブログポートレットを対象とし、RenderFilterインターフェイスを使用してそのレンダリングフェーズを監査します。

@Component(
   property = {
      "javax.portlet.name=com_liferay_blogs_web_portlet_BlogsPortlet",
      "service.ranking:Integer=100"
   },
   service = PortletFilter.class
)
public class B4K8PortletFilter implements RenderFilter {

   @Override
   public void destroy() {
   }

   @Override
   public void doFilter(
         RenderRequest renderRequest, RenderResponse renderResponse,
         FilterChain filterChain)
      throws IOException, PortletException {

      long startTime = System.currentTimeMillis();

      filterChain.doFilter(renderRequest, renderResponse);

      long renderTime = (System.currentTimeMillis() - startTime) / 1000;

      _totalTime.add(renderTime);

      _count.increment();

      if (_log.isWarnEnabled()) {
         long count = _count.longValue();

         long averageRenderTime = _totalTime.longValue() / count;

         _log.warn(
            "Blogs portlet rendered in " + renderTime +
               " ms with an average of " + averageRenderTime +
                  " ms out of " + count + " renders.");
      }
   }

   @Override
   public void init(FilterConfig filterConfig) throws PortletException {
   }

   private static final Log _log = LogFactoryUtil.getLog(
      B4K8PortletFilter.class);

   private final LongAdder _count = new LongAdder();
   private final LongAdder _totalTime = new LongAdder();

}

このコードでは、フィルターは最初にOSGi DSコンポーネントとして宣言され、PortletFilter.classサービスとして識別されます。 この宣言の一部として、2つのプロパティも設定します。最初のプロパティはBlogsPortletを対象とし、2番目のプロパティは重要度を100に設定します。

ポートレットフィルターは次に RenderFilter インターフェースを実装し、 PortletFilter インターフェースを拡張します。 このインターフェースには3つのメソッド(つまり、initdestroydoFilter)が含まれており、ブログポートレットへの描画リクエストとその応答の両方でフィルタリングタスクを実行します。

  • init:ポートレットフィルターが最初にLiferayにデプロイされ、ポートレットコンテナ内で初期化されたときに呼び出されます。

  • destroy:サービスからポートレットフィルターを削除するために呼び出されます。

  • doFilter:クライアントリクエストにより描画リクエスト/応答のペアがチェーンを通過するたびに、ポートレットコンテナによって呼び出されます。

    この例では、doFilterは次の方法でブログポートレットを監査します。

    1. レンダリングフェーズの開始時間をメモします。

      long startTime = System.currentTimeMillis();
      
    2. FilterChaindoFilterメソッドを実行して、チェーン内のすべてのRenderFilterを呼び出します。

      filterChain.doFilter(renderRequest, renderResponse);
      
    3. ブログポートレットがレンダリングフェーズを完了するのにかかる時間を計算します。

      long renderTime = (System.currentTimeMillis() - startTime) / 1000;
      
    4. 現在のレンダリング時間をすべてのレンダリングの合計時間に追加します。

      _totalTime.add(renderTime);
      
    5. ポートレットレンダリングの総数を増やします。

      _count.increment();
      
    6. LongAdderユーティリティを使用してポートレットの平均レンダリング時間とレンダリングの総数を保存し、次にLogユーティリティを使用してこれらの値をポートレットの現在のレンダリング時間とともに表示します。

      if (_log.isWarnEnabled()) {
         long count = _count.longValue();
      
         long averageRenderTime = _totalTime.longValue() / count;
      
         _log.warn(
            "Blogs portlet rendered in " + renderTime +
               " ms with an average of " + averageRenderTime +
                  " ms out of " + count + " renders.");
      }
      

    描画リクエストが行われるたびに、このdoFilterが呼び出されます。

追加情報