ナビゲーションをスキップ

WebLogic Server Web アプリケーション、サーブレット、JSP の開発

  前 次 前/次ボタンと目次ボタンとの区切り線 目次  

サーブレットの作成とコンフィグレーション

以下の節では、サーブレットを作成およびコンフィグレーションする方法について説明します。

 


サーブレットのコンフィグレーション

サーブレットは、J2EE 標準の Web アプリケーション デプロイメント記述子 web.xml の複数のエントリで Web アプリケーションの一部として定義します。web.xml ファイルは、Web アプリケーションの WEB-INF ディレクトリにあります。

web.xml のルート servlet 要素の下の最初のエントリには、サーブレットの名前が定義され、そのサーブレットを実行するコンパイル済みクラスが指定されます。あるいは、サーブレット クラスを指定する代わりに、JSP を指定することもできます。servlet 要素には、サーブレットの初期化属性とセキュリティ ロール用の定義も含まれています。

web.xml 内の servlet-mapping 要素の下の 2 番目のエントリには、このサーブレットを呼び出す URL パターンが定義されています。

サーブレット マッピング

サーブレット マッピングとは、サーブレットへのアクセス方法を制御することです。次の例は、Web アプリケーションでサーブレット マッピングを使用する方法を示しています。この例には、(web.xml デプロイメント記述子の) サーブレット コンフィグレーションとマッピングがあり、その後にこれらのサーブレットの起動に使う URL を示す表 (「url-pattern と呼び出されるサーブレット」を参照) があります。

一般的なサーブレット マッピングのルールや規約など、サーブレット マッピングの詳細については、サーブレット 2.4 仕様のセクション 11 を参照してください。

コード リスト 4-1 サーブレット マッピングの例

<servlet>
  <servlet-name>watermelon</servlet-name>
  <servlet-class>myservlets.watermelon</servlet-class>
</servlet>
<servlet>
  <servlet-name>garden</servlet-name>
  <servlet-class>myservlets.garden</servlet-class>
</servlet>
<servlet>
  <servlet-name>list</servlet-name>
  <servlet-class>myservlets.list</servlet-class>
</servlet>
<servlet>
  <servlet-name>kiwi</servlet-name>
  <servlet-class>myservlets.kiwi</servlet-class>
</servlet>
<servlet-mapping>
  <servlet-name>watermelon</servlet-name>
  <url-pattern>/fruit/summer/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
  <servlet-name>garden</servlet-name>
  <url-pattern>/seeds/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
  <servlet-name>list</servlet-name>
  <url-pattern>/seedlist</url-pattern>
</servlet-mapping>
<servlet-mapping>
  <servlet-name>kiwi</servlet-name>
  <url-pattern>*.abc</url-pattern>
</servlet-mapping>

表 4-1 url-pattern と呼び出されるサーブレット

URL

呼び出される
サーブレット

http://host:port/mywebapp/fruit/summer/index.html

watermelon

http://host:port/mywebapp/fruit/summer/index.abc

watermelon

http://host:port/mywebapp/seedlist

list

http://host:port/mywebapp/seedlist/index.html

デフォルト サーバ (コンフィグレーションされている場合)、または HTTP 404 エラー メッセージ (「File not found」)。

list サーブレットが /seedlist* にマップされていた場合、list サーブレットが呼び出される。

http://host:port/mywebapp/seedlist/pear.abc

kiwi

list サーブレットが /seedlist* にマップされていた場合、list サーブレットが呼び出される。

http://host:port/mywebapp/seeds

garden

http://host:port/mywebapp/seeds/index.html

garden

http://host:port/mywebapp/index.abc

kiwi

ServletServlet は、サーブレットのデフォルト マッピングの作成に使用できます。たとえば、/myservlet/* に対するすべてのサーブレットにマップするデフォルト マッピングを作成すると、http://host:port/web-app-name/myservlet/com/foo/FooServlet を使用してサーブレットを呼び出せます。このデフォルト マッピングを作成するには、web.xml ファイルに次のコードを追加します (web.xml ファイルは、Web アプリケーションの WEB-INF ディレクトリにあります)。

<servlet>
  <servlet-name>ServletServlet</servlet-name>
  <servlet-class>weblogic.servlet.ServletServlet</servlet-class>
</servlet>

<servlet-mapping>

<servlet-name>ServletServlet</servlet-name>
  <url-pattern>/myservlet/*</url-pattern>
</servlet-mapping>

 


デフォルト サーブレットの設定

各 Web アプリケーションには、デフォルト サーブレットがあります。このデフォルト サーブレットは管理者が指定できますが、指定しない場合、WebLogic Server では FileServlet という内部サーブレットがデフォルト サーブレットとして使用されます。

どのサーブレットでも、デフォルト サーブレットとして登録できます。独自のデフォルト サーブレットを作成すれば、独自のロジックを使用して、デフォルト サーブレットに送られるリクエストの処理方法を定義できます。

設定したデフォルト サーブレットは、FileServlet に取って代わります。FileServlet はほとんどのファイル (テキスト ファイル、HTML ファイル、イメージ ファイルなど) を提供するために使用されるので、デフォルト サーブレットの設定は注意深く行う必要があります。デフォルト サーブレットでこれらのファイルを提供するには、その機能をデフォルト サーブレットに記述する必要があります。

ユーザ定義のデフォルト サーブレットを設定するには、次の手順に従います。

  1. クライアントによる Web アプリケーションへのアクセス方法のコンフィグレーション」の説明に従い、サーブレットを定義します。次のように、servlet-mapping に url-pattern = "/" を付けて追加します。
  2. <servlet-mapping>
    <servlet-name>MyOwnDefaultServlet</servlet-name>
    <url-pattern>/myservlet/*(</url-pattern>
    </servlet-mapping>
  3. FileServlet で他の拡張子付きのファイルを提供する場合は、次の手順に従います。
    1. サーブレットを定義し、myFileServlet などの <servlet-name> を指定します。
    2. <servlet-class>weblogic.servlet.FileServlet と定義します。
    3. <servlet-mapping> 要素を使ってファイル拡張子を myFileServlet にマップします (デフォルト サーブレット用のマッピングに追加して)。たとえば、myFileServlet.gif ファイルを提供するには、*.gifmyFileServlet にマップします。

注意 : docHome が指定されていない場合、ソース ファイル名決定時の FileServlet には、SERVLET_PATH が含まれています。そのため、FileServlet/dir/* などにマップすることで、特定のディレクトリからのファイルのみを明示的に提供できます。

 


サーブレット初期化属性

サーブレットの初期化属性は、Web アプリケーションのデプロイメント記述子 web.xml の中の servlet 要素の init-param 要素に、param-name タグと param-value タグを使って定義します。web.xml ファイルは、Web アプリケーションの WEB-INF ディレクトリにあります。次に、例を示します。

コード リスト 4-2 web.xml 内のサーブレット初期化属性のコンフィグレーション例

<servlet>
  <servlet-name>HelloWorld2</servlet-name>
  <servlet-class>examples.servlets.HelloWorld2</servlet-class>
  <init-param>
    <param-name>greeting</param-name>
    <param-value>Welcome</param-value>
  </init-param>
  <init-param>
    <param-name>person</param-name>
    <param-value>WebLogic Developer</param-value>
  </init-param>
</servlet>

 


単純な HTTP サーブレットの記述

この節では、Hello World というメッセージを出力する単純な HTTP サーブレットを記述する手順について説明します。これらの手順を示すサンプル コード (HelloWorldServlet) の全文がこの節の最後にあります。JDBC、RMI、JMS など各種の J2EE および WebLogic Server サービスをサーブレットで使用する方法の詳細については、このマニュアルで後述します。

  1. 以下の適切なパッケージおよびクラスをインポートします。
  2. import javax.servlet.*;
    import javax.servlet.http.*;
    import java.io.*;
  3. javax.servlet.http.HttpServlet を拡張します。次に、例を示します。
  4. public class HelloWorldServlet extends HttpServlet{
  5. service() メソッドを実装します。
  6. サーブレットの主要な機能は、Web ブラウザからの HTTP リクエストを受け取って、HTTP 応答を返すことです。この処理は、サーブレットの service() メソッドによって行われます。サービス メソッドには、出力を生成する応答オブジェクトと、クライアントからのデータを受け取るリクエスト オブジェクトがあります。

    これ以外にも、doPost() メソッドや doGet() メソッドを実装したサーブレットのサンプルを見たことがあるかもしれません。これらのメソッドは、POST または GET リクエストにのみ応答するものです。service() メソッドを実装しておけば、1 つのメソッドですべてのリクエスト タイプを処理できます (ただし、service() メソッドを実装した場合、このメソッドの最初で super.service() を呼び出さない限り、doPost() メソッドや doGet() メソッドを実装することはできません)。HTTP サーブレットの仕様ではこれ以外に、他のリクエスト タイプの処理に使用されるメソッドも解説していますが、全部をまとめて、サービス メソッドと総称しています。

    サービス メソッドはすべて、同じパラメータ引数を取ります。HttpServletRequest は、リクエストの情報を提供し、HttpServletResponse は HTTP クライアントに応答する際にサーブレットによって使用されます。サービス メソッドは次のようになります。

    public void service(HttpServletRequest req,
    HttpServletResponse res) throws IOException
    {
  7. 次のように、コンテンツ タイプを設定します。
  8. res.setContentType("text/html");
  9. 次のように、出力に使用する java.io.PrintWriter オブジェクトへの参照を取得します。
  10. PrintWriter out = res.getWriter();
  11. 次の例に示すように、PrintWriter オブジェクトに対し println() メソッドを使用して、HTML を生成します。
  12. out.println("<html><head><title>Hello World!</title></head>");
    out.println("<body><h1>Hello World!</h1></body></html>");
    }
    }
  13. サーブレットを次のようにコンパイルします。
    1. 開発環境シェルの設定を、クラスパスとパスを正しく指定して行います。
    2. サーブレットの Java ソース コードが格納されているディレクトリから、サーブレットが格納されている Web アプリケーションの WEB-INF/classes ディレクトリに、サーブレットをコンパイルします。次に、例を示します。
    3. javac -d /myWebApplication/WEB-INF/classes myServlet.java
  14. WebLogic Server にホストが配置される Web アプリケーションの一部として、サーブレットをデプロイします。
  15. ブラウザからサーブレットを呼び出します。
  16. サーブレットの呼び出しに使用する URL は、(a) そのサーブレットが含まれる Web アプリケーション名、(b) Web アプリケーションのデプロイメント記述子にマップされるサーブレット名によって決まります。リクエスト パラメータも、サーブレットを呼び出す URL に含まれることがあります。

    一般的には、サーブレットの URL は以下のパターンに従います。

    http://host:port/webApplicationName/mappedServletName?parameter

    URL の各要素は次のように定義します。

    たとえば、examplesWebApp にデプロイされ、使用中のマシンで稼動している WebLogic Server から提供される HelloWorldServlet (このマニュアルで使われているサンプル) を Web ブラウザで呼び出す場合、次のような URL を入力します。

    http://localhost:7001/examplesWebApp/HelloWorldServlet

    URL の host:port 部分は、WebLogic Sever にマップされている DNS 名に置き換えることもできます。

 


高度な機能

上記の手順で、基本的なサーブレットが作成できます。サーブレットでは、さらに高度な機能を使用することもできます。

 


HelloWorldServlet サンプルの全文

この節では、前述の手順で使用した Java ソース コード サンプルの全文を示します。このサンプルは HTTP リクエストに応答する簡単なサーブレットです。このマニュアルの後半では、このサンプルを拡張することにより、HTTP パラメータ、クッキー、およびセッション トラッキングの使い方を説明します。

コード リスト 4-3 HelloWorldServlet.java

import javax.servlet.*;
import javax.servlet.http.*;
import java.io.*;
public class HelloWorldServlet extends HttpServlet {
public void service(HttpServletRequest req,
HttpServletResponse res)
throws IOException
{
// 先にコンテンツ タイプを設定する
res.setContentType("text/html");
// ここで HTML を挿入する PrintWriter を取得する
PrintWriter out = res.getWriter();
    out.println("<html><head><title>" +
"Hello World!</title></head>");
out.println("<body><h1>Hello World!</h1></body></html>");
}
}

WebLogic Server 配布キットの samples/examples/servlets ディレクトリに、このソース コードと、サンプルをコンパイルして実行するための手順説明があります。

 

フッタのナビゲーションのスキップ  ページの先頭 前 次