NetBeansモジュールでのRESTfulサービス・クライアントの作成

NetBeans IDE 6.9より、NetBeansモジュール・プロジェクトでRESTがネイティブ・サポートされます。そのため、NetBeansモジュールでRESTfulクライアント・コードを直接生成できるようになります。また、Jersey RESTfulクライアント・コードをJavaまたはアプリケーションに挿入できます。

このチュートリアルでは、TwitterのWhat Are You Doingサービスを使用するNetBeansプラットフォーム・アプリケーションを作成し、Twitterの友達のステータス・メッセージ一覧を表示します。最初に、プラットフォーム・アプリケーションを作成します。このアプリケーションで必要となるライブラリを選択します。次に、NetBeansモジュールを作成します。最後に、RESTfulクライアントといくつかの基本的な表示要素をモジュールに追加します。クライアントは、OAuth認証を使用します。

目次

このページの内容は、NetBeans IDE 6.9から7.1に適用されます

このチュートリアルに従うには、次のソフトウェアとリソースが必要です。

ソフトウェアまたはリソース 必須バージョン
NetBeans IDE Java EEダウンロード・バンドル
Java Development Kit (JDK) バージョン6またはバージョン7

プラットフォーム・アプリケーションの作成

NetBeansプラットフォーム・アプリケーションにはNetBeans IDEライブラリを追加できます。この項では、プラットフォーム・アプリケーションを作成し、必要なライブラリを追加します。

 

モジュール・スイートを作成するには:

  1. 「ファイル」>「新規プロジェクト」(LinuxおよびWindowsでは[Ctrl]-[Shift]-[N]、MacOSでは[⌘]-[Shift]-[N])をクリックします。新規プロジェクト・ウィザードが開きます。
  2. 「NetBeansモジュール」カテゴリを選択します。次に、「NetBeansプラットフォーム・アプリケーション・プロジェクト」を選択します。「次」をクリックします。
  3. プロジェクトに「RestfulClientPlatformApp」という名前を付けます。プロジェクトの場所を選択します。その他のデフォルト設定を受け入れ、「終了」をクリックします。「プロジェクト」ウィンドウにRestfulClientPlatformAppプロジェクトが表示されます。
  4. 「プロジェクト」ウィンドウで「RestfulClientPlatformApp」プロジェクト・ノードを右クリックし、「プロパティ」を選択します。「プロパティ」ダイアログが開きます。
  5. 「プロジェクト・プロパティ」ダイアログで「ライブラリ」を選択します。プラットフォームのライブラリのみが表示されることに注意してください。
  6. 「enterprise」ライブラリを展開します。「RESTful Webサービス・ライブラリ」の「含む」ボックスを選択します。
    「RESTful Webサービス・ライブラリ」を含むように選択した状態を示すスイートのプロパティ
  7. 「解決」ボタンが赤色で強調表示されます。これは、RESTful Webサービス・ライブラリが、このスイートに含まれていない他のライブラリに依存しているためです。「解決」ボタンをクリックして、それらのライブラリを含めます。
  8. 「OK」をクリックします。プラットフォーム・アプリケーションで、クライアント・モジュールを作成する準備ができました。

クライアント・モジュールの作成

TwitterのWhat Are You Doingサービスを使用するためのクライアントとして機能するモジュールは、わずかな手順で作成できます。Twitterサービスは、追加設定なしの状態でNetBeans IDE Webサービス・マネージャに登録されています。別の機能を追加できます。

モジュールを作成してクライアント機能を追加するには:

  1. 「プロジェクト」ウィンドウで、「RestfulClientPlatformApp」の「モジュール」サブノードを右クリックして「新規を追加...」を選択します。新規モジュール・プロジェクト・ウィザードが開きます。
  2. モジュールにTwitterClientModuleという名前を付けます。その他のフィールドはデフォルトの設定を受け入れ、「次」をクリックします。「基本モジュール構成」パネルが開きます。
  3. 「コード名ベース」に、「org.my.twitter.friends」など任意の名前を入力します。その他のフィールドはデフォルトの設定を受け入れ、「終了」をクリックします。「プロジェクト」ウィンドウで、TwitterClientModuleがプラットフォーム・アプリケーションの「モジュール」ノードに表示されます。
  4. 「TwitterClientModule」ノードを右クリックし、「プロジェクトを開く」を選択します。「TwitterClientModule」ノードが、「プロジェクト」ウィンドウのルート・レベルに表示されるようになります。
    「TwitterClientModule」ルート・ノードが表示された「プロジェクト」ウィンドウ
  5. 新しいルート・レベルの「TwitterClientModule」ノードを選択します。新規ファイル・ウィザードを起動します([Ctrl]-[N]/[⌘]-[N]、「新規ファイル」アイコン、またはノードのコンテキスト・メニュー)。
  6. 新規ファイル・ウィザードで、「Webサービス」カテゴリおよび「RESTful Javaクライアント」ファイル・タイプを選択します。「次」をクリックします。「新規RESTful Javaクライアント」パネルが開きます。
  7. クラスにTwitterClientという名前を付け、パッケージに任意の名前を付けるか、以前に作成したコード名ベースを選択します。
    クラスとパッケージ名を示す新規RESTfulクライアント・ウィザード
  8. 「RESTリソースを選択」で、「IDE登録済み」を選択します。「参照」をクリックし、「Twitter」>「Twitter OAuth」>「[statuses]」>「[friends_timeline.{format}]」を表示します。このリソースを選択し、「OK」をクリックします。
    「使用可能なRESTリソース」ダイアログで選択されたfriends_timelineのRESTリソース

    注意: 追加のWebサービスをIDEに登録できます。「サービス」ウィンドウに移動し、「Webサービス」ノードを右クリックし、「Webサービスを追加」を選択します。ローカル・ファイルまたはRESTful URLを追加できます。
    「サービス」ウィンドウでのWebサービス・マネージャの「Webサービスの追加」オプション

  9. 認証タイプとして「OAuth」が自動的に選択されます。デフォルトをすべて受け入れ、「終了」をクリックします。
    完了した新規RESTfulクライアント・ウィザード
  10. 警告ダイアログが表示されます。このダイアログで、WADLファイルのXMLスキーマ参照からJavaアーティファクトを生成するかどうかを質問されます。「はい」をクリックします。
  11. さらに、クラスパスにモジュールを追加することを求める警告が表示されることがあります。「OK」をクリックします。
    依存性の不足に関する「警告」ダイアログ
  12. クラスパスにモジュールを追加する必要がある場合は、「TwitterClientModule」ノードを右クリックして「プロジェクト・プロパティ」を開きます。「ライブラリ」セクションに移動し、「依存性の追加」ボタンでモジュールを追加します。このボタンを押すと、モジュールの依存性を参照できる一覧が開きます。
    TwitterClientModuleのプロパティ・ウィンドウの「ライブラリ」セクション

TwitterClientクラスが生成され、エディタで開きます。TwitterClientクラスは複雑で、次のフィールド、メソッドおよび内部クラスを含んでいます。

  • CONSUMER_KEY: Consumer Key文字列
  • CONSUMER_SECRET: Consumer Secret文字列
  • initOAuth(): OAuh初期化のメソッド
  • getFriendsTimeline(): HTTPメソッドに対応するメソッド: getFriendsTimeline (RESTリソースから) 
  • makeOAuthRequestUnique(): 1つのセッションでの複数のAPIコールに有用
  • login: Twitterアプリケーションへのログインに使用(認証を強制)。このメソッドは、もう2つの生成されたメソッド(getOAuthAccessTokenおよびgetOAuthRequestToken)をコールします。

次に、TwitterからOAuthキーを取得してTwitterClientに追加します。

TwitterからのOAuthキーの取得

NetBeansプラットフォーム・アプリケーションがTwitterのデータにアクセスできるようにするには、確認文字列に加えてCUSTOMERおよびCUSTOMER_SECRETキーをTwitterから取得する必要があります。Twitterは、これらのキーを必要とするOAuth認証を使用しています。しかし、OAuthはサーバー上のWebアプリケーションによってコールされる前提で設定されています。認証キーを取得するために、「仮の」Webアプリケーションを登録します。

TwitterからOAuthキーを取得するには:

  1. ブラウザを開きます。「Twitter」>「アプリケーション」ページに移動し、「新しいアプリケーションを追加」をクリックします。Twitterアカウントにログインしている必要があります。複数のアカウントがある場合は、正しいアカウントにログインしていることを確認してください。
  2. アプリケーション名」テキスト・フィールドに「NB Platform Friends Application」と入力します。
  3. アプリケーションの説明」フィールドに説明を入力します。これは必須です。「friends_timeline操作をコールするNetBeansプラットフォーム・アプリケーション」などのように入力できます。
  4. アプリケーションのウェブ・サイトURL」フィールドに任意のURLを入力します。
  5. アプリケーションの種類」オプションで「クライアント・アプリケーション」ラジオ・ボタンを選択します。
  6. 標準のアクセス・タイプ」オプションで、「読取りおよび書込み」のラジオ・ボタンを選択します。
  7. 他のオプションをデフォルトのままにして「保存する」を押します。登録したアプリケーションの詳細が記載されたブラウザ・ページが開きます。重要な詳細情報はConsumer keyおよびConsumer secretです。
  8. ブラウザからConsumer keyをコピーします。IDEで、CONSUMER_KEYが設定されている行を見つけます。引用符の間にConsumer keyの値を貼り付けます。
    CONSUMER_KEYおよびCONSUMER_SECRETの場所を示すTwitterClient
  9. Consumer secret keyをブラウザからTwitterClientにコピーして貼り付けます。変更を保存します。

ウィンドウのデザイン

プロジェクトを完成させるために、ウィンドウを追加します。このウィンドウにUIコンポーネントを実装し、ボタンをクリックすると友達のステータス一覧が表示されるなどのアクションを追加します。

ウィンドウをデザインするには:

  1. 「プロジェクト」ウィンドウで、モジュールのノードを右クリックし、「新規」>「ウィンドウ」を選択します。新規ウィンドウ・ウィザードが開き、「基本設定」パネルが表示されます。
  2. 「基本設定」パネルの「ウィンドウの位置」で「editor」を選択し、「アプリケーションの起動時に開く」を選択して、「次」をクリックします。「名前、アイコン、および場所」パネルが開きます。
  3. 「クラス名の接頭辞」フィールドに「twitterFriendsStatus」と入力します。「org.my.twitter.friends」パッケージを選択します。「終了」をクリックします。
    クラス名の接頭辞とパッケージ名が表示された新規ウィンドウ・ウィザードの「名前、アイコン、および場所」パネル
  4. twitterFriendsStatusTopComponentファイルが「デザイン」ビューに開きます。右側にSwingのUIコンポーネントのパレットが表示されます。
    新しいウィンドウの「デザイン」ビューとSwingコンポーネントのパレットで、コンポーネントがまだ追加されていない状態
  5. 次のGUI要素をデザイン領域にドラッグします。
    コンポーネント 表示テキスト 設定
    ボタン Get Friends' Statuses

    変数名をgetStatusesButtonに変更します。

    「enabled」プロパティを選択解除します。

    選択解除された「enabled」プロパティ

    ボタン Log in 変数名をloginButtonに変更します
    スクロール・ペイン --  
    テキスト領域 -- スクロール・ペインにドラッグします

    必要に応じて、テキスト領域とスクロール・ペインのサイズを変更し、ボタンの位置を調整します。
    完了したウィンドウが表示された新しいウィンドウの「デザイン」ビュー

  6. ログイン・ボタンをダブルクリックします。IDEによってボタンのアクション・メソッドが生成され、エディタが「ソース」ビューに切り替わってそのアクション・メソッドにフォーカスされます。
  7. ログイン・ボタンのアクション・メソッドの本体に、次のコードを入力するかコピーします。このコードは、アプリケーションをTwitterにログインさせるメソッドを起動し、getStatusesボタンを有効にして、ログイン・ボタンを無効にします。アプリケーションがログインする必要があるのは一度のみです。TwitterClientは、そのloginメソッドをコールするためにインスタンス化する必要はないことに注意してください。
    private void loginButtonActionPerformed(java.awt.event.ActionEvent evt) {                                   
       TwitterClient.login();
       getStatusesButton.setEnabled(true);
       loginButton.setEnabled(false);
    } 
  8. getStatusesボタンをダブルクリックします。IDEによってボタンのアクション・メソッドが生成され、エディタが「ソース」ビューに切り替わってそのアクション・メソッドにフォーカスされます。
  9. getStatusesボタンのアクション・メソッドの本体に、次の処理コードを貼り付けるか入力します。このコードは、loginメソッドによって作成されたトークンを使用して、TwitterClientのインスタンス化およびOAuthの初期化を行います。その後コードはgetFriendsTimelineをコールし、ステータスの一覧を取得して、各ステータスのユーザー名およびテキストを含む行をStringに追加した後、Stringをテキスト領域に渡します。
    private void getStatusesButtonActionPerformed(java.awt.event.ActionEvent evt) {                                         
    TwitterClient client = new TwitterClient("xml");
    client.initOAuth();
    Statuses response = client.getFriendsTimeline(Statuses.class, null, null, null, "10");
    response.getStatus().size();
    String text = "";
    for (StatusType st : response.getStatus()) {
    text += st.getUser().getName() + ": " + st.getText() + "\n";
    }
    jTextArea1.setText(text);
    }
  10. クラスが見つからないことを示す警告アイコンがコードに表示されます。[Ctrl]-[Shift]-[I] (MacOSの場合は[⌘]-[Shift]-[I])を押します。「すべてのインポートを修正」ダイアログが開きます。twitter.twitteroauth.twitterresponseクラスを選択します。「OK」をクリックします。
    インポートする正しいクラスが表示された「すべてのインポートを修正」ダイアログ

これでアプリケーションは完成しました。RestfulClientPlatformAppを実行すると、NetBeansプラットフォームが開き、デザインしたウィンドウが「出力」セクションに表示されます。「Log In」をクリックするとダイアログが開き、アプリケーションによるデータ・アクセスを認証するためのリンクが表示されます。

アプリケーションにデータを渡すためのOAuthを認証するためのダイアログ

リンクをクリックするとブラウザ・ページが開き、アプリケーションによるTwitterデータへのアクセスを許可するかどうかがTwitterによって質問されます。「許可する」をクリックすると、ページが更新されてPINがリフレッシュされます。PINをコピーし、認証ダイアログのベリファイア文字列フィールドに貼り付けます。「OK」をクリックします。

「Log In」ボタンが無効になり、「Get Friends' Statuses」ボタンが有効になります。「Get Friends' Statuses」をクリックすると、Twitterの友達の最新のステータス・メッセージ一覧が表示されます。

ステータス・メッセージが表示された実行中のアプリケーション

その他の課題

有益なアイデアをいくつか紹介します。

  • friends_timeline APIの他のメソッドを使用して、もう1つのウィンドウをモジュールに追加します。
  • 別のTwitterリソースを使用して、もう1つのモジュールをプロジェクトに追加します。
  • 「新規プロジェクト」>「サンプル」>「NetBeansモジュール」で「Facebookモジュールのサンプル」を開いて学習します。

関連項目

NetBeans IDEを使用したJava EEアプリケーションの開発方法の詳細は、次のリソースを参照してください。

メーリング・リストに登録することによって、NetBeans IDE Java EE開発機能に関するご意見やご提案を送信したり、サポートを受けたり、最新の開発情報を入手したりできます。

メーリング・リストに登録することによって、NetBeansプラットフォームでのRCPアプリケーション開発に関して、ご意見やご提案を送信したり、サポートを受けたり、情報を入手したりできます。

get support for the NetBeans

Support


By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2018, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo