Pierwszy Servlet "Hello World"

Jak już wcześniej pisałem, servlet jest to program napisany w języku Java przynależącego do pakietu javax obsługujący zapytania HTTP.

Teraz napiszę, jak krok po kroku możemy stworzyć własny servlet, który pozwoli nam wyświetlić w przeglądarce napis "Hello World".

Potrzebujemy:

• Eclipse EE
• Apache Tomcat

1. Tworzymy nowy projekt

Jako że servlet należy do dynamicznych komponentów języka Javy, tworzymy nowy projekt "Dynamic Web Project". Klikamy na File -> New -> Dynamic Web Project.

Wpisuje nazwę projektu i klikamy dalej, otworzy nam się okno z konfiguracją budowania aplikacji, ale tutaj nic zmieniać nie musimy. Klikamy dalej. Otworzy nam się okienko, które prosi o konfiguracje modułu webowego projektu.

Eclipse prosi nas o podanie "Context root" oraz "Content directory". Ja je ustawiłem jak jest pokazane wyżej. Ważne jest, aby zaznaczyć "Generate web.xml deployment descriptor". Dzięki temu, eclipse stworzy nam plik web.xml w którym skonfigurujemy sobie rozmieszczenie poszczególnych komponentów projektu, ale o tym za chwile.

Jeśli udało nam się wszystko poprawnie wykonać, powinniśmy zobaczyć nowy projekt o nazwie "HelloWorld" w Project Explorerze.

Przyjrzyjmy się teraz dokładnie naszemu nowo powstałemu projektowi:

Strukturę "Dynamic Web Project 3.0" widzimy po prawej. Składa się ona z:

• JAX-WS Web Services

Folder ten zawiera serwisy sieciowe oparte o Java Api for XML. Folder ten nas nie będzie interesował w tym projekcie.

• Deployment Description: HelloWorld

Folder ten zawiera wszystkie komponenty, jakie zostały zawarte w naszym projekcie. Wspiera on wyszukiwanie, edytowanie oraz tworzenie nowych komponentów projektu, takich jak np Servlety. Eclipse mapuje katalogi projektu w poszukiwaniu odpowiednich komponentów i segreguje ich do odpowiednich katalogów.

• Java Resources

Folder ten zawiera wszystkie komponenty stworzone przez nas, takie jak pakiety, klasy czy interfejsy. To tu będą definiowane wszystkie źródłowe pliki.

• JavaScript Resources

Dynamic Web Project w pełni wspiera język JavaScript i tutaj zawarte są komponenty tego języka, które później będzie można wykorzystywać przy tworzeniu stron www.

• build

Folder zawiera wszystkie komponenty projektu, które będą tworzone przy buildowaniu projektu. Folder ten nas nie będzie interesował w tym projekcie.

• webapp

Folder zawierający pliki konfiguracyjne projektu.

Plik MANIFEST.MF w folderze META-INF zawiera informacje o zależnościach z innych dynamicznych web modułów.

WEB-INF zawiera folder lib, gdzie można dodać wszystkie biblioteki, z których chcielibyśmy w przyszłości korzystać w naszej aplikacji. Folder również zawiera plik web.xml.

To co nas będzie interesować, to głównie foldery Java Resources -> src oraz webapp -> WEB-INF.

Napiszemy teraz własny Servlet.

W folderze Java Resource -> src stworzymy pakiet "pl.javastart.servlets" oraz klasę HelloWorldServlet.java.

package pl.javastart.servlets;
 
 import java.io.IOException;
 import java.io.PrintWriter;
 
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 public class HelloWorldServlet extends HttpServlet {
 	private static final long serialVersionUID = 1L;
 
 	protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 		PrintWriter out = response.getWriter();
 		out.print("Hello World");
 	}
 }

O to nasz pierwszy servlet wyświetlający napis "Hello World". Widzimy tutaj, że nasza klasa HelloWorldServlet dziedziczy po klasie HttpServlet. Dzięki temu, Tomcat będzie wiedział z jakim programem ma do czynienie i odpowiednio go przetworzy. Widzimy tutaj, że nasz servlet będzie wykonywał tylko funkcję "doGet". Gdy przeglądarka wyśle requesta (zapytanie) GET, servlet go przyjmie i odeśle response (odpowiedź dla przeglądarki) posiadający napis "Hello World".

Teraz musimy powiedzieć Tomcatowi, gdzie jest w projekcie nasz servlet oraz jak ma go mapować. Do tego służy plik web.xml o którym wspominałem wcześniej.

<?xml version="1.0" encoding="UTF-8"?>
 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
   <servlet>
     <servlet-name>Hello World</servlet-name>
     <servlet-class>pl.javastart.servlets.HelloWorldServlet</servlet-class>
   </servlet>
   <servlet-mapping>
     <servlet-name>Hello World</servlet-name>
     <url-pattern>/test</url-pattern>
   </servlet-mapping>
 </web-app>

W sekcji <servlet> definiujemy nazwę naszego servletu (<servlet-name>) oraz podajemy ścieżkę (<servlet-class>) do klasy reprezentującą nasz servlet (paczka pl.javastart.servlets oraz klasa HelloWorldServlet).

W sekcji <servlet-mapping> ustalamy sposób w jaki tomcat ma mapować poszczególne servlety naszego projektu. Dla servletu "Hello World" link url (<url-pattern>) ustawiłem wartość "/test". Oznacza to, że gdy w przeglądarce wpiszemy "http://[adres serwera]/[nazwa projektu]/test" uruchomimy nasz servlet. <url-pattern> możemy ustawić na cokolwiek.

Pora uruchomić nasz projekt.

Klikamy prawym guzikiem na nasz projekt, wybieramy Run as -> Run on Server. Otworzy nam się się okno:

Wybieramy naszego Tomcata, klikamy Finish i powinna nam się otworzyć strona internetowa z adresem "http://localhost:8080/HelloWorld/". Jest to domyślny adres naszego projektu. Przeglądarka wyświetli nam w nagłówku strony "HTTP STATUS 404 - /HelloWorld/". Oznacza to, że przeglądarka nie znalazła zasobu na tej strony, ale wystarczy, że dopiszemy do końca linku "test" i uruchomimy nasz Servlet.

http://localhost:8080/HelloWorld/test

Brawo, właśnie swoimi umiejętnościami programistycznymi możesz pochwalić się w internecie :).

Tips and tricks:

1. Po każdorazowej zmianie w projekcie (edycja klasy, pliku konfiguracyjnego) musimy zrestartować naszego Tomcata, aby mógł załadować nowe zmiany.

2. Servlet możemy stworzyć troszkę czybciej, wystarczy kliknąć prawy na Deployment Descriptor: Hello World -> Servlets -> New -> Servlet.

Zadania do realizacji:

1. Napisz drugi Servlet, który będzie stroną startową naszego projektu (czyli będzie odpalany po uruchomieniu projektu w tomcacie).

2. Dodaj link w startowym Servlecie do HelloWorldServlet. (tip : link definiujemy za pomocą <a href="adres url">Tekst widoczny w przeglądarce</a>).

3. Dowiedz się, jaka jest różnica między metodą HTTP GET i POST.