RESTEasy hello worldの例

投稿日: 2019-11-05 2019-11-05
タグ: hello world, jax-rs, resteasy

RESTEasy

、JBossプロジェクト、http://jsr311.java.net/[JAX-RS]仕様の実装。このチュートリアルでは、RESTEasyフレームワークを使用して簡単なRESTスタイルWebアプリケーションを作成する方法を示します。

この記事で使用する技術とツール:

RESTEasy 2.2.1.GA
JDK 1.6
Maven 3.0.3
Eclipse 3.6

1.ディレクトリ構造

このチュートリアルの最終的なディレクトリ構造を確認してください。標準のWebプロジェクト構造。

ディレクトリ構造、タイトル= "rest-folder"、width = 431、height = 341

2.標準Webプロジェクト

標準のMaven Webプロジェクト構造を作成します。

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

Eclipse Webプロジェクトに変換します。

mvn eclipse:eclipse -Dwtpversion=2.0

3.プロジェクトの依存関係

Mavenの `pom.xml`ファイルにJBoss public Mavenリポジトリと”

resteasy-jaxrs

“を宣言します。

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サービス

簡単な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をサポートするようにリスナーとサーブレットを構成します。詳細については、http://docs.jboss.org/resteasy/docs/2.2.1.GA/userguide/html/Installation__Configuration.html[JBoss documentation]を参照してください。

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>

    <!-- 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サーブレットのサーブレットマッピングに ”

/

“以外のurlパターンがある場合は、 ”

resteasy.servlet.mapping.prefix

“を設定する必要があります。

上記の例では、resteasy servletのurl-patternは ”

/rest/

“なので、 “resteasy.servlet.mapping.prefix”を ”

/rest ** “に設定する必要があります。そうしないと、リソースが見つかりませんでした。

注意

RESTEasyがあなたのRESTサービスを自動的に見つけて登録するように、

resteasy.scan ** をtrueに設定してください。

6.デモ

この例では、「

projectURL/rest/message/

」からのWebリクエストは「

MessageRestService

」に一致し、「

projectURL/rest/message/\ {any values}

」は

@ PathParam

パラメータに一致します。

テスト1:http://localhost:8080/RESTfulExample/rest/message/mkyong

例1、タイトル= "rest-demo1"、width = 616、height = 294

__テスト2:

http://localhost:8080/RESTfulExample/rest/message/hello％20world__

例2、タイトル= "rest-demo2"、width = 655、height = 302

代替RESTサービス登録

上記の例では、 ”

ResteasyBootstrap

“リスナーを介してRESTサービスを登録しています。ここで私は別の方法を示します。

クラスを作成し、 `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 KB）

参考文献

インストールと設定]。

http://www.ibm.com/developerworks/webservices/library/ws-restful/

[IBM

: RESTful Web services: The basics].

http://www.oracle.com/technetwork/articles/javase/index-137171.html

[RESTful

ウェブサービス]。

http://ja.wikipedia.org/wiki/Representational

State

Transfer[Wiki:

Representational State Transfer]

リンク://タグ/hello-world/[hello world]

jax-rs

リンク://タグ/resteasy/[resteasy]

getdocs

13036