RESTEasy Hallo Weltbeispiel

RESTEasy , Projekt JBoss, Implementierung der Spezifikation JAX-RS . In diesem Lernprogramm zeigen wir Ihnen, wie Sie mit dem RESTEasy-Framework eine einfache Webanwendung im REST-Stil erstellen.

In diesem Artikel verwendete Technologien und Tools:

RESTEasy 2.2.1.GA
JDK 1.6
Maven 3.0.3
Eclipse 3.6

1. Verzeichnisstruktur

Überprüfen Sie die endgültige Verzeichnisstruktur dieses Lernprogramms. Nur eine Standard-Webprojektstruktur.

Bild://wp-content/uploads/2011/06/rest-folder.png[Verzeichnisstruktur, Titel = "Restordner", Breite = 431, Höhe = 341]

2. Standard-Webprojekt

Erstellen Sie eine Standard-Maven-Webprojektstruktur.

mvn archetype:generate -DgroupId=com.mkyong.common -DartifactId=RESTfulExample
    -DarchetypeArtifactId=maven-archetype-webapp -DinteractiveMode=false

Konvertieren Sie in ein Eclipse-Webprojekt.

mvn eclipse:eclipse -Dwtpversion=2.0

3. Projektabhängigkeiten

Erklärt das öffentliche Maven-Repository von JBoss und „ resteasy-jaxrs “ in Ihrer Maven-Datei pom.xml Das ist alles was Sie brauchen, um RESTEasy zu verwenden.

Datei: pom.xml

<project ...">

    <repositories>
       <repository>
          <id>JBoss repository</id>
          <url>https://repository.jboss.org/nexus/content/groups/public-jboss/</url>
       </repository>
    </repositories>

    <dependencies>

        <dependency>
            <groupId>org.jboss.resteasy</groupId>
            <artifactId>resteasy-jaxrs</artifactId>
            <version>2.2.1.GA</version>
        </dependency>

    </dependencies>
</project>

4. REST-Service

Ein einfacher REST-Service. Siehe Demo am Ende des Artikels, es sollte selbsterklärend sein.

package com.mkyong.rest;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.Response;

@Path("/message")
public class MessageRestService {

    @GET
    @Path("/{param}")
    public Response printMessage(@PathParam("param") String msg) {

        String result = "Restful example : " + msg;

        return Response.status(200).entity(result).build();

    }

}

5. web.xml

Konfigurieren Sie nun Listener und Servlet so, dass RESTEasy unterstützt wird. Lesen Sie diese http://docs.jboss.org/resteasy/docs/2.2.1.GA/userguide/html/Installation__Configuration.html (Dokumentation zu JBoss), um eine detaillierte Erklärung zu erhalten.

Datei: web.xml

<web-app id="WebApp__ID" version="2.4"
    xmlns="http://java.sun.com/xml/ns/j2ee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
    http://java.sun.com/xml/ns/j2ee/web-app__2__4.xsd">
    <display-name>Restful Web Application</display-name>

    <!-- Auto scan REST service -->
    <context-param>
        <param-name>resteasy.scan</param-name>
        <param-value>true</param-value>
    </context-param>

    <!-- this need same with resteasy servlet url-pattern -->
    <context-param>
        <param-name>resteasy.servlet.mapping.prefix</param-name>
        <param-value>/rest</param-value>
    </context-param>

    <listener>
        <listener-class>
            org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap
        </listener-class>
    </listener>

    <servlet>
        <servlet-name>resteasy-servlet</servlet-name>
        <servlet-class>
            org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher
        </servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>resteasy-servlet</servlet-name>
        <url-pattern>/rest/** </url-pattern>
    </servlet-mapping>

</web-app>

Hinweis Sie müssen „ resteasy.servlet.mapping.prefix “ festlegen, wenn Ihre Servlet-Zuordnung für das Resteasy-Servlet ein anderes URL-Muster als „ / “ hat.

In obigem Beispiel ist das Resteasy-Servlet-URL-Muster " /rest/ ", daher müssen Sie für "resteasy.servlet.mapping.prefix" ebenfalls " /rest ** " setzen. Andernfalls schlagen Sie vor Ressource nicht gefunden Fehlermeldung.

Hinweis Vergessen Sie nicht, „ resteasy.scan ** “ auf true zu setzen, damit RESTEasy Ihren REST-Dienst automatisch findet und registriert.

6. Demo

In diesem Beispiel stimmt die Webanforderung von „ projectURL/rest/message/ “ mit „ MessageRestService “ überein, und „ projectURL/rest/message/\ {any values} “ entspricht dem Parameter @ PathParam .

Test 1: http://localhost : 8080/RESTfulExample/rest/message/mkyong

Beispiel 1

__Test 2:

http://localhost : 8080/RESTfulExample/rest/message/hallo% 20world__

Beispiel 2

Alternative REST-Service-Registrierung

Im obigen Beispiel registrieren Sie den REST-Dienst über den Listener „ ResteasyBootstrap “. Hier zeige ich Ihnen einen anderen Weg.

Erstellen Sie eine Klasse, erweitern Sie javax.ws.rs.core.Application und fügen Sie Ihren REST-Service manuell hinzu.

package com.mkyong.app;

import java.util.HashSet;
import java.util.Set;
import javax.ws.rs.core.Application;
import com.mkyong.rest.MessageRestService;

public class MessageApplication extends Application {
    private Set<Object> singletons = new HashSet<Object>();

    public MessageApplication() {
        singletons.add(new MessageRestService());
    }

    @Override
    public Set<Object> getSingletons() {
        return singletons;
    }
}

Datei: web.xml , kein Listener mehr, konfigurieren Sie Ihre Anwendungsklasse wie folgt:

<web-app id="WebApp__ID" version="2.4"
    xmlns="http://java.sun.com/xml/ns/j2ee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
    http://java.sun.com/xml/ns/j2ee/web-app__2__4.xsd">
    <display-name>Restful Web Application</display-name>

    <context-param>
        <param-name>resteasy.servlet.mapping.prefix</param-name>
        <param-value>/rest</param-value>
    </context-param>

    <servlet>
        <servlet-name>resteasy-servlet</servlet-name>
        <servlet-class>
            org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher
                </servlet-class>
        <init-param>
            <param-name>javax.ws.rs.Application</param-name>
            <param-value>com.mkyong.app.MessageApplication</param-value>
        </init-param>
    </servlet>

    <servlet-mapping>
        <servlet-name>resteasy-servlet</servlet-name>
        <url-pattern>/rest/** </url-pattern>
    </servlet-mapping>

</web-app>

Erledigt.