サーブレット-ヒットカウンター

Webページのヒットカウンター

多くの場合、Webサイトの特定のページでのヒットの総数を知りたいと思うでしょう。サーブレットのライフサイクルはサーブレットが実行されるコンテナによって制御されるため、サーブレットを使用してこれらのヒットをカウントするのは非常に簡単です。

以下は、サーブレットのライフサイクルに基づく単純なページヒットカウンターを実装するために実行する手順です。

  • init()メソッドでグローバル変数を初期化します。

  • doGet()またはdoPost()メソッドが呼び出されるたびにグローバル変数を増やします。

  • 必要に応じて、データベーステーブルを使用して、destroy()メソッドにグローバル変数の値を格納できます。この値は、次回サーブレットが初期化されるときにinit()メソッド内で読み取ることができます。このステップはオプションです。

  • セッション内での一意のページヒットのみをカウントする場合は、isNew()メソッドを使用して、そのセッションで同じページがすでにヒットしているかどうかを確認できます。このステップはオプションです。

  • グローバルカウンターの値を表示して、Webサイトでのヒットの総数を表示できます。このステップもオプションです。

ここでは、Webコンテナが再起動されないと想定しています。再起動するかサーブレットが破棄されると、ヒットカウンタがリセットされます。

この例は、単純なページヒットカウンターを実装する方法を示しています-

import java.io.*;
import java.sql.Date;
import java.util.*;
import javax.servlet.*;
import javax.servlet.http.*;

public class PageHitCounter extends HttpServlet {

   private int hitCount; 

   public void init() { 
      // Reset hit counter.
      hitCount = 0;
   } 

   public void doGet(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {

      // Set response content type
      response.setContentType("text/html");

      // This method executes whenever the servlet is hit 
      // increment hitCount 
      hitCount++; 
      PrintWriter out = response.getWriter();
      String title = "Total Number of Hits";
      String docType = "<!doctype html public \"-//w3c//dtd html 4.0 " + "transitional//en\">\n";
      
      out.println(docType +
         "<html>\n" +
            "<head><title>" + title + "</title></head>\n" +
            "<body bgcolor = \"#f0f0f0\">\n" +
               "<h1 align = \"center\">" + title + "</h1>\n" +
               "<h2 align = \"center\">" + hitCount + "</h2>\n" +
            "</body>
         </html>"
      );
   }
   
   public void destroy() { 
      // This is optional step but if you like you
      // can write hitCount value in your database.
   } 
}

次に、上記のサーブレットをコンパイルして、web.xmlに次のエントリを作成しましょう。

<servlet>
   <servlet-name>PageHitCounter</servlet-name>
   <servlet-class>PageHitCounter</servlet-class>
</servlet>

<servlet-mapping>
   <servlet-name>PageHitCounter</servlet-name>
   <url-pattern>/PageHitCounter</url-pattern>
</servlet-mapping>
....

次に、URL http:// localhost:8080 / PageHitCounterを使用してこのサーブレットを呼び出します。これにより、このページが更新されるたびにカウンターが1つ増え、次の結果が表示されます-

Total Number of Hits

6

Hit Counter for a Website:

多くの場合、Webサイト全体のヒットの総数を知りたいと思うでしょう。これはサーブレットでも非常に簡単で、フィルターを使用してこれを実現できます。

以下は、フィルターライフサイクルに基づく単純なWebサイトヒットカウンターを実装するために実行する手順です。

  • フィルタのinit()メソッドでグローバル変数を初期化します。

  • doFilterメソッドが呼び出されるたびにグローバル変数を増やします。

  • 必要に応じて、データベーステーブルを使用して、グローバル変数の値をfilterのdestroy()メソッドに格納できます。この値は、次回フィルターが初期化されるときにinit()メソッド内で読み取ることができます。このステップはオプションです。

ここでは、Webコンテナが再起動されないと想定しています。再起動するかサーブレットが破棄されると、ヒットカウンタがリセットされます。

この例は、単純なWebサイトヒットカウンターを実装する方法を示しています-

// Import required java libraries
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;

public class SiteHitCounter implements Filter {

   private int hitCount; 

   public void  init(FilterConfig config) throws ServletException {
      // Reset hit counter.
      hitCount = 0;
   }

   public void  doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 
      throws java.io.IOException, ServletException {

      // increase counter by one
      hitCount++;

      // Print the counter.
      System.out.println("Site visits count :"+ hitCount );

      // Pass request back down the filter chain
      chain.doFilter(request,response);
   }
   
   public void destroy() { 
      // This is optional step but if you like you
      // can write hitCount value in your database.
   } 
}

次に、上記のサーブレットをコンパイルして、web.xmlに次のエントリを作成しましょう。

....
<filter>
   <filter-name>SiteHitCounter</filter-name>
   <filter-class>SiteHitCounter</filter-class>
</filter>

<filter-mapping>
   <filter-name>SiteHitCounter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>
....

次に、URL http:// localhost:8080 /などのURLを呼び出します。これにより、ページがヒットするたびにカウンターが1つ増え、ログに次のメッセージが表示されます-

Site visits count : 1
Site visits count : 2
Site visits count : 3
Site visits count : 4
Site visits count : 5
..................