RESTEasy Привет мир пример

RESTEasy , проект JBoss, реализация спецификации JAX-RS . В этом руководстве мы покажем вам, как использовать инфраструктуру RESTEasy для создания простого веб-приложения в стиле REST.

Технологии и инструменты, используемые в этой статье:

, RESTEasy 2.2.1.GA

, JDK 1.6

, Maven 3.0.3

, Затмение 3.6

1. Структура каталогов

Просмотрите окончательную структуру каталогов этого урока. Просто стандартная структура веб-проекта.

структура каталогов

2. Стандартный веб-проект

Создайте стандартную структуру веб-проекта Maven.

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

Преобразование в веб-проект Eclipse.

mvn eclipse:eclipse -Dwtpversion=2.0

3. Зависимости проекта

Объявляет JBoss публичный репозиторий Maven и « resteasy-jaxrs » в файле Maven pom.xml . Это все, что вам нужно для использования RESTEasy .

File: 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 сервис. Смотрите демо в конце статьи, оно должно быть само за себя.

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

Теперь настройте слушатель и сервлет для поддержки RESTEasy. Прочитайте эту JBoss документацию для подробного объяснения.

Файл: 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>

Примечание Вам необходимо установить « resteasy.servlet.mapping.prefix », если ваше сервлет-отображение для сервлета resteasy имеет шаблон URL, отличный от « / «.

В вышеприведенном примере url-шаблон resteasy-сервлета имеет вид « /rest/ », поэтому вы должны установить для «resteasy.servlet.mapping.prefix» значение « /rest ** », иначе вы попадете ресурс не найден сообщение об ошибке.

Примечание Не забудьте установить для « resteasy.scan ** » значение true, чтобы RESTEasy автоматически находил и регистрировал вашу службу REST.

6. Демо

В этом примере веб-запрос от « projectURL/rest/message/ » будет соответствовать « MessageRestService », а « projectURL/rest/message/\ {любые значения} » будет соответствовать параметру @ PathParam ,

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

пример 1

__Test 2:

HTTP://локальный: 8080/RESTfulExample/отдых/сообщение/привет% 20world__

пример 2

Регистрация альтернативного сервиса REST

В приведенном выше примере вы регистрируете службу REST через прослушиватель « ResteasyBootstrap ». Здесь я покажу вам другой способ.

Создайте класс и расширьте javax.ws.rs.core.Application и добавьте службу REST вручную.

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;
    }
}

File: 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>

    <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>

Готово.

Скачать исходный код

Загрузите его - ссылка://wp-content/uploads/2011/06/RESTEasy-Hello-World-Example.zip[RESTEasy-Hello-World-Example.zip](7 КБ)

TOC