Twitterクライアント開発の初歩の初歩 8

This entry was posted in Android on by .
このエントリーをはてなブックマークに追加
Pocket

AndroidでTwitterクライアントを作ったり、自前のアプリにタイムラインを表示したりする方法です。

java環境ではTwitter4Jという素晴らしいライブラリがあるので、これを使って作っていきます（Ver4.0.0を使用）。
＃感謝感謝(TдT)です！

 

手順

  1. Twitter Developersでアプリを登録
  2. クライアントアプリの作成
    • OAuth認証をしてAccessTokenを取得する
    • AccessTokenを使ってつぶやいてみる

 

１．Twitter Developersでアプリ登録

まずは作成するアプリがTwitterAPIを使用できるようにするため、Twitter DevelopersでTwitterアプリを登録します。

・Twitter Developersにアクセスして、メニューから“My applications”を選択
Twitter Developers

 
・“Create New App”をクリック
Create New App

 
・アプリ情報の入力
Create Application

Name:アプリの名前
Description:アプリの説明
Website:アプリのURL
　・・・アンドロイドアプリの場合はサイトないので適当(自分のTwitterページとか)に入力しておけばいいみたいです）
Callback URL:OAuth後にTwitter認証ページからコールバックさせたいURL
　・・・これもアンドロイドアプリの場合はアプリ内で設定するので未入力でいいです

ちなみに、ここで設定した内容が認証ページに反映されるようです。

認証画面

 
・アプリを作ったら“API Keys”タブでAPI KeyとAPI secretをメモっておきます。後で作るプログラム内で使います。
＃あとこれが漏れると簡単にアプリ乗っ取られるので管理は慎重に！

API KEYS

 
・次に“Permissions”タブでアクセス権限の設定をします。
permissions

タイムライン見るだけなら「Read only」でよくて、アプリ内でツイートとかする場合は「Read and Write」という具合に、作るアプリに適した権限を選びましょう。

しかし、ここではハマった！
Read and Writeに変更すると下記エラーが！！
permissionエラー

詳細を見に行くとなにやらツイッタープロフィールで携帯電話番号を登録しないといけないらしい・・・が！？プロフィール設定にそんな項目ないし？？

モバイル設定

と思ったら、言語設定を英語にしたら出てきた・・・。

モバイル設定

よしこれで進めると思ったら・・・登録できない・・・何やら日本の電話会社はまだサポート外みたいですね・・・あれっこれ積んだ？

困ったときは慌てずググる(｀・ω・´)キリッ

どうやらメール通知設定で携帯のメールアドレス登録すればいいみたいです。
＜参考にさせて頂いたページ＞
Twitterのアプリケーション新規登録時に、開発者のTwitterアカウントと携帯電話の関連付けが必須になった模様。

メールアドレス登録してしばらく待つと・・・できた。Permissionを「Read and Write」に変更することができました。

以上でTwitterDevelopersでの設定は終わりです。
さてさて、次はソフトを作っていきます。

 

 

2.クライアントアプリの作成

2.0.Twitter4Jライブラリの組込み

Twitter4Jからライブラリをダウンロードします。
ZIP解凍して出てきたファイルの
・lib/twitter4j-core-4.0.0.jar
・lib/twitter4j-async-4.0.0.jar
を開発環境のlibsフォルダにコピーします。

＃非同期APIを使用するためtwitter4j-asyncも組み込んでいます。同期APIを使用するだけなら不要ですが、Androidの場合はActivityのメインスレッドでhttpリクエストをするとNetworkOnMainThreadExceptionが発生するので、基本通信処理は非同期で実装します

 

2.1.OAuth認証をしてAccessTokenを取得する

初めにアプリがユーザーのアカウントを使用できるようにOAuth認証を行い、ユーザーのAccessTokenを取得します。

ソースを表示
印刷SyntaxHighlighterについて
1public class MainActivity extends Activity {
2    private final String API_KEY = "TwitterDevelopersでメモったAPI KEY";
3    private final String API_SECRET = "TwitterDevelopersでメモったAPI SECRET";
4     
5    private AsyncTwitter mTwitter;
6    private RequestToken mReqToken;
7 
8    private final TwitterListener mListener = new TwitterAdapter() {
9        @Override
10        public void gotOAuthRequestToken(RequestToken token) {
11            mReqToken = token;
12            Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse(mReqToken.getAuthorizationURL()));
13            startActivity(intent);
14        }
15 
16        @Override
17        public void gotOAuthAccessToken(AccessToken token) {
18            //token.getToken()とtoken.getTokenSecret()を保存する
19        }
20 
21    };
22     
23    @Override
24    protected void onCreate(Bundle savedInstanceState) {
25        super.onCreate(savedInstanceState);
26        setContentView(R.layout.activity_main);
27         
28        mTwitter = new AsyncTwitterFactory().getInstance();
29        mTwitter.addListener(mListener);
30        mTwitter.setOAuthConsumer(API_KEY, API_SECRET);
31        mTwitter.getOAuthRequestTokenAsync("twittercallback://callback");
32         
33    }
34 
35    @Override
36    protected void onNewIntent(Intent intent) {
37        //ブラウザからのコールバックで呼ばれる
38        final Uri uri = intent.getData();      
39        final String verifier = uri.getQueryParameter("oauth_verifier");
40        if (verifier != null) {
41            mTwitter.getOAuthAccessTokenAsync(mReqToken, verifier);
42        }
43    }
44}

・AndroidManifest.xml

ソースを表示
印刷SyntaxHighlighterについて
1//抜粋
2    <uses-permission android:name="android.permission.INTERNET"/>
3 
4        <activity
5            android:name="com.example.twittertest.MainActivity"
6            android:label="@string/app_name" android:launchMode="singleTask">
7            <intent-filter>
8                <action android:name="android.intent.action.MAIN" />
9 
10                <category android:name="android.intent.category.LAUNCHER" />
11            </intent-filter>
12            <intent-filter>
13                <action android:name="android.intent.action.VIEW"/>
14                <category android:name="android.intent.category.DEFAULT"/>
15                <category android:name="android.intent.category.BROWSABLE"/>
16                <data android:scheme="twittercallback"/>               
17            </intent-filter>
18        </activity>

ざっくりしたOAuth処理の流れ

  • 29行目：
    • AsyncTwitterに処理完了時のリスナーを登録する
    getOAuthRequestTokenAsync()に対してgotOAuthRequestTokenAsync()が呼ばれるように、基本的には要求メソッド名の過去形になっているようです
  • 30行目：
    • API KEY、API Secret（Consumer KeyとConsumer Secret）をセット
  • 31行目：
    • RequestTokenの取得要求をService Provider（=Twitter.com）に投げる※別タスクで実行されます
    引数はCallBack先のURL。アンドロイドアプリの場合は自身が呼ばれるように「独自スキームを作りIntentフィルターに設定」と「戻り先ActivityのlanchmodeをsingleTaskにする」をManifest.xmlに記述しておく
  • 10-14行目：
    • RequestTokenが取得できたら、それをくっつけてユーザーをService Providerへリダイレクト
    ブラウザを起動してTwitter認証ページにユーザーを誘導しています
  • ブラウザ：
    • ブラウザでユーザーが許可/不許可を選択すると、ブラウザは31行目で設定したURLに認証結果パラメータを付加してコールバックする
  • 36-43行目：
    • ブラウザからのコールバックを受け取ったら、パラメータから”oauth_verifier”を取得し、今度はRequestTokenとoauth_verifierを使ってAccessToken取得要求を投げる
  • 17-19行目：
    • AccessToken、AccessToken Secretが取得できたらそれを保存しておく

OAuth認証は以上です。
一度AccessTokenとAccessToken Secretを取得したら、次回からはそれを使ってTwitterAPIにアクセスできるので、この認証処理は不要になります。

 

2.2.AccessTokenを使ってつぶやいてみる

後はとても簡単。AccessTokenをセットして、各処理を行うメソッドをリスナーと共に実行すればいいだけです。

例えばつぶやくなら、リスナーにupdatedStatus()を実装して、updateStatus()を呼び出します。

＃リスナーは基本的には要求メソッドを過去形にしたものが対応付いているようですね（全部は確認していませんが・・・なんとなく）

ソースを表示
印刷SyntaxHighlighterについて
1private final String API_KEY = "TwitterDevelopersでメモったAPI KEY";
2private final String API_SECRET = "TwitterDevelopersでメモったAPI SECRET";
3private final String ACCESS_TOKEN = "アクセストークン";
4private final String ACCESS_TOKEN_SECRET = "アクセストークンシークレット";
5 
6private final TwitterListener mListener = new TwitterAdapter() {
7    @Override
8    public void updatedStatus(Status status) {
9        Log.d("updatedStatus", "Status ID:" + status.getID());
10    }
11 
12    @Override
13    public void searched(QueryResult queryResult) {
14        for (Status status : queryResult.getTweets()) Log.d("searched", "Status ID:" + status.getID());
15    }
16 
17};
18 
19@Override
20protected void onCreate(Bundle savedInstanceState) {
21    super.onCreate(savedInstanceState);
22    setContentView(R.layout.activity_main);
23     
24    mTwitter = new AsyncTwitterFactory().getInstance();
25    mTwitter.addListener(mListener);
26    mTwitter.setOAuthConsumer(API_KEY, API_SECRET);
27     
28    AccessToken accessToken = new AccessToken(ACEESS_TOKEN, ACEESS_TOKEN_SECRET);
29    mTwitter.setOAuthAceessToken(accessToken);
30}
31 
32//ツイートする
33public void tweet(String text) {
34    mTwitter.updateStatus(text);
35}
36 
37//検索する
38public void searchTweet(String text) {
39    Query query = new Query();
40    query.setQuery(text);
41    query.setCount(80); //検索件数
42    query.setResultType(Query.RECENT); //日付の新しいものから
43    mTwitter.search(query);
44}

＃ツイートはtweetじゃなくてupdateStatusなんですね。確かに本家もツイートじゃなくてStatusを更新するっていう扱いですね。へーへー

 

サンプルアプリ

サンプルアプリ

Twitter4Jを使ったサンプルアプリを下記に置いておきますので参考までに。
EditTextに入力文字をツイートしたり検索したりして結果を表示します。

https://github.com/workpiles/TwitterTest

 
 

あとがき

AndroidでTwitterクライアントを作る基本的な部分はこんなところです。思ったより簡単にできましたね(*^^*)

・・・というのもTwitter4Jがめんどくさい通信部分をすべてラップしてくれているからですね。ホント素晴らしいですな(TдT)

今回はAsyncTwitterクラスを使用してみましたが、リスナー処理が別タスクになっているんですね。
そのため、検索完了後に結果を画面に表示しようとした場合、画面更新処理をメインタスクへPostしてあげないといけないのが若干めんどくさかったりもします。
非同期のTwitterクラスを使って通信部分はAsyncTaskで実装した方がコード的にはスッキリするかもしれません。

Twitterを使ってみようと思ったきっかけは、アンドロイドマーケットに出してる「20×20九九トレに」Twitterを使って対戦機能を実装してみたかったからです。プレイゴーストデータを検索して取得するようなことをやりたいとなると、単純にIntent飛ばしてTwitterクライアント起動する方法ではできないので。
Twitter機能実装したアプリも3/25になんとかリリースしてひと段落！

まだツイートする、検索する、リツイートする程度の機能しか触ってませんが・・・今後自前でクライアント機能を実装するようなアプリ作るかな・・・。
機会があればもっと違った機能も動かして見たいと思います。

 
 
 

関連記事

koike へ返信する コメントをキャンセル

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

8 thoughts on “Twitterクライアント開発の初歩の初歩”

  • Reply ↓
    M.aoki

    こんにちは！
    このサイトのhttp://workpiles.com/2014/03/android-twitter4j-asynctwitter/
    を参考にTwitter4jやJavaの勉強をさせていただいております。

    質問なのですが、Intentでブラウザ画面に誘導することができなくて困っております。

    状況なのですが、最初の認証画面が出なく、ボタンやエディットテキストが出ます。そしてUpdateStatusを押すと
    LogCatに認証できませんでしたと出ます。
    アクセストークンとアクセストークンシークレットをソースで書いたらつぶやき、検索はすることができました。
    Intentのところを教えていただいてもよろしいでしょうか？

    • Reply ↓
      koike Post author

      こんにちは。

      認証画面が表示されない件ですが、下記を再度確認してみてください。
      （github上のサンプルコードを元に記載しています）

      １．API_KEY、API_SECRETが間違っていないか。
      ２．SharedPreferencesに間違った（古い）Token&Secretが残ったままになっていないか。
      ３．gotOAuthRequestToken()内のgetAuthorizationURL()でちゃんと認証ページのURL(※１)が取得できているか。
      ※１：https://api.twitter.com/oauth/authorize?oauth_token=*

      認証画面の表示は、getOAuthRequestTokenAsync()に対するgotOAuthRequestToken()がコールされることにより表示されます。
      どちらもちゃんと呼ばれているかをデバッグで確認してみると、解決の手掛かりになるかもしれません。

      以上、コメントの内容から想像出来る範囲で考えてみました。参考になれば幸いです。

      • Reply ↓
        M.aoki

        返信ありがとうございました。
        さっそくデバッグをしてみたところ、どうやらSharedPreferencesに間違った（古い）Token&Secretが残ったままになっていて、
        if (token == null) {
        mTwitter.getOAuthRequestTokenAsync(“twittercallback://callback”);
        } else {
        mTwitter.setOAuthAccessToken(token);
        }
        のところで下のElseの方が選択されているのでIntentで認証画面に誘導されないのではないかと考えました。
        もし、間違ったTokenがSharedPreferencesに残っている場合、どうすればリフレッシュされるのでしょうか？
        お忙しい中すみませんが、よろしくお願いいたします。

  • Reply ↓
    M.aoki

    すみません
    原因が分かったので報告させていただきます。
    Twitter側のCallBackURLを適当に書いたらWebページに飛びました。
    あんまりそのあたりはまだ調べているのでこれが原因かわかりませんが、
    一応問題解決したので報告させていただきました。

    こんな初心者にアドバイスしていただきありがとうございます。Javaの勉強になりました。
    お手数おかけしてすみませんでした。

  • Reply ↓
    ars42525

    2.1.OAuth認証をしてAccessTokenを取得する の部分のソースを使って実装してみたのですが、アプリ起動時に認証画面が出ず、何も表示されません
    認証が成功するかを確認したいので、トークンの保存などはしておらず、古いトークンが残っているということはなさそうです。
    このコードだけでは認証はできないのでしょうか？
    それとも他になにか原因があるのでしょうか？

    • Reply ↓
      koike Post author

      > このコードだけでは認証はできないのでしょうか？
      　可能だと思います。
      　最新のTwitter4j（4.0.4）で試してみましたが、問題なく認証画面に遷移できました。

      > それとも他になにか原因があるのでしょうか？
      　実行環境など不明なためなんとも言えませんが…
      　Twitterアプリ側で【Test OAuth】が問題なくうごくか確認してみてはどうでしょう。
      　
      以上、参考になれば幸いです。