Hatena::ブログ(Diary)

MoonMt.Lab IT開発技術 調査報告書 RSSフィード

2015年03月15日

REST風サービスをJavaEEで構築する方法02(雛形プロジェクト編)

今回は最低限のREST風サービスを構築する方法を紹介する。

<前提条件>
下記の記事を読了していること。
REST風サービスをJavaEEで構築する方法01(導入編)

<全体像から見た位置づけ>
Api層の実装を行う。
f:id:MoonMtLab:20150314191001p:image:w640

<手順概要>
1.プロジェクトの作成
2.クラスの作成
3.クラスを記述する
4.ApplicationConfigクラスを自動生成する

<手順詳細>
1.プロジェクトの作成
画面上部にある【新規プロジェクト】ボタンを押下する。
f:id:MoonMtLab:20150315112937p:image

表示された「新規プロジェクト」ダイアログで[Java Web]>[Webアプリケーション]を選択し、【次>】ボタンを押下する。
f:id:MoonMtLab:20150315112938p:image:w640

プロジェクト名に「SampleRest」(※)を設定し、【次>】ボタンを押下する。
(※)任意の名前をつけることができる。
f:id:MoonMtLab:20150315113545p:image:w640

特に変更せず、【次>】ボタンを押下する。
f:id:MoonMtLab:20150315113546p:image:w640

何も選択せずに、【終了(F)】ボタンを押下する。
f:id:MoonMtLab:20150315113547p:image:w640

プロジェクトツリーに「SampleRest」という名前のプロジェクトが作成されたことを確認する。
f:id:MoonMtLab:20150315113548p:image

2.クラスの作成
プロジェクトツリー上の「ソース・パッケージ」を右クリックし、[新規]>[Javaクラス]を選択する。
f:id:MoonMtLab:20150315113549p:image

表示されたダイアログのクラス名に「SampleApi」(※)・パッケージ名に「lab.moonmt.SampleRest.api」(※)を設定し、【終了(F)】ボタンを押下する。
(※)任意の名前をつけることができる。
f:id:MoonMtLab:20150315113550p:image:w640

クラスが作成された事を確認する
f:id:MoonMtLab:20150315113551p:image

3.クラスを記述する
手順2で作成したクラスを編集し、処理内容を記述する。

package lab.moonmt.SampleRest.api;

import javax.ws.rs.GET;
import javax.ws.rs.Path;

@Path("sampleApi")          //...(1)
public class SampleApi {
    
    @GET                    //...(2)
    @Path("getSample")      //...(3)
    public String getSampleMethod(){
                        
        return "Hello REST world";
    }  
}

ソースコード解説

番号説明
(1)@Pathアノテーションを使用し、クラスにアクセスするためのパスを設定する
(2)@GETアノテーションを使用し、GETメソッドである事を設定する
(3)@Pathアノテーションを使用し、メソッドにアクセスするためのパスを設定する



4.ApplicationConfigクラスを自動生成する
手順3で記述したクラス名の行番号付近を押下すると幾つかの選択肢が表示される。
その中の「Java EE 6仕様を使用してRESTを構成します」を押下すると、「ApplicationConfig」クラスが自動生成される。
f:id:MoonMtLab:20150315113552p:image

<動作確認>
画面上部の実行ボタンを押下し、プロジェクトを実行する。
f:id:MoonMtLab:20150315113553p:image

WebブラウザのURL欄に下記のURLを入力する
http://localhost:8080/SampleRest/webresources/sampleApi/getSample


URL解説

URL(部分)説明
webresources手順4で自動生成された「ApplicationConfig」クラス内の「@javax.ws.rs.ApplicationPath」に指定されている。任意の文字列に変更が可能である。
sampleApi手順3で記述したクラスの「@Path」に指定している文字列
getSample手順3で記述したメソッドの「@Path」に指定している文字列


ブラウザ上に「Hello REST world」が表示されることを確認する。

Enjoy Programing!!


<関連記事>
REST風サービスをJavaEEで構築する方法01(導入編)
・REST風サービスをJavaEEで構築する方法02(雛形プロジェクト編)[本記事]
REST風サービスをJavaEEで構築する方法03(RESTクライアント編)
REST風サービスをJavaEEで構築する方法04(各メソッド編)
REST風サービスをJavaEEで構築する方法05(パラメータの受け取り編)
REST風サービスをJavaEEで構築する方法06(JSON返却編1)
REST風サービスをJavaEEで構築する方法07(JSON返却編2)
REST風サービスをJavaEEで構築する方法08(Logic層編)
REST風サービスをJavaEEで構築する方法09(DB接続設定編)
REST風サービスをJavaEEで構築する方法10(DAO層編1)
REST風サービスをJavaEEで構築する方法11(DAO層編2)
REST風サービスをJavaEEで構築する方法12(DAO層編3)
REST風サービスをJavaEEで構築する方法13(SQLログ編)


<お勧め書籍>
わかりやすいJavaEEウェブシステム入門
JavaEEに関して基本的なことが分かり易く記述されている。
JavaEEに関する最初の1冊としてお勧めである。
Beginning Java EE 6 GlassFish 3で始めるエンタープライズJava
「金魚本」の愛称を持つJavaEEの教科書的な書籍である。
JavaEEを腰を据えて学びたい人にお勧めする1冊!!

スパム対策のためのダミーです。もし見えても何も入力しないでください
ゲスト


画像認証

リンク元