【Androidアプリ開発】AndroidでのOAuth認証が簡単に実装できるOAuthHelperを作ってみた

もうほぼタイトル通りなのですが、AndroidでのOAuth認証と、OAuth認証で取得したAuthTokenの使い方を理解するのにとても苦労したので、OAuth認証が簡単に実装できるOAuthHelperというクラスを作ってみました。ソースコードは以下のGitHubに公開しています。
syarihu/OAuthHelperSample
https://github.com/syarihu/OAuthHelperSample

OAuthHelperとは

このOAuthHelperは、自分が使いたいGoogle APIのScopeをインスタンス生成時の引数に渡して認証処理を開始するメソッドを実行することで、後は自動でアカウントの選択、認証許可確認、AuthTokenの取得までを行います。なので、これを使えばAuthTokenが返ってきた後のGoogle APIの処理を書くだけで良くなるので、認証部分を書く手間が省けます。

使い方

これを使うためには、少しだけ準備をする必要があります。
以下にその準備から実装までの手順を記載します。
  1. Google API Consoleで今回利用したいGoogle APIを有効にする
    当たり前の話なのですが、Google APIを利用するためにはそのAPIを有効にする必要があります。なので、以下のURLからプロジェクトを作成し、利用したいAPIを有効にします。
    https://console.developers.google.com/
  2. Google API ConsoleでOAuthのクライアントIDを作成する
    AndroidアプリでのOAuth認証では、クライアントキーなどは必要ありませんが、あらかじめGoogle APIを利用するアプリのパッケージ名と署名証明書フィンガープリントを登録しておく必要があります。
    これらの登録は、Google API Consoleでプロジェクトを選択し、左側にある「APIと認証」の「認証情報」をクリックし、「新しいクライアントIDを作成」ボタンを押すことで、登録することができます。
    クライアントIDの作成画面はこんな感じです。


  3. AndroidManifestに必要なパーミッションを追加する
    ようやく実際のソースコードの話になります。OAuth認証を利用するには、以下の２つのパーミッションが必要になります。
    <uses-permission android:name="android.permission.USE_CREDENTIALS" />
<uses-permission android:name="android.permission.GET_ACCOUNTS"/>
    Google APIを利用する際に必要になると思うので、これも入れておきます。 
    <uses-permission android:name="android.permission.INTERNET" />
  4. OAuthHelper#OnAuthListenerを実装する
    AndroidアプリでOAuth認証を実装したいActivityにOAuthHelper#OnAuthListenerを実装して、getAuthTokenをオーバーライドします。
    getAuthTokenの引数にあるauthTokenには取得されたAuthTokenが入ります。なので、ここにAuthTokenを使ったGoogle APIの処理を書きます。
    AuthTokenは通常のGoogle APIを利用する際のAPI Keyとは違い、APIの利用時に以下のようにパラメータを渡すことで、APIを利用できます（※参考記事１を参照）。
    key: access_token
    value: 取得したAuthToken
  5. OAuthHelperのインスタンスを作成する
    これが実装できたら、OAuthHelperのインスタンスを作成します。OAuthHelperでは第一引数にActivity、第二引数にScopes、第三引数にOnAuthListenerが必要となります。Google Url Shortenerの利用を例として、具体的には以下のように書きます。
    mHelper = new OAuthHelper(this, "oauth2:" + UrlshortenerScopes.URLSHORTENER, this);
  6. OAuthHelper#onActivityResultを実装する
    アカウント選択画面や認証許可画面からActivityに戻ってきた際の処理を受け取るため、ActivityのonActivityResult内にOAuthHelper#onActivityResultを実装します。具体的には以下のように書きます。
    @Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    // アカウント選択や認証画面から返ってきた時の処理をOAuthHelperで受け取る
    mHelper.onActivityResult(requestCode, resultCode, data);
}
  7. OAuth認証を開始する
    8. 最後に、OAuth認証の開始メソッドを実行します。OAuth認証の開始は以下のメソッドで行うことができます。このメソッドの引数については、後述します。
    mHelper.startAuth(false);

以上で完了です。このように、簡単に実装することができます。
これを実装したものを実際に実行すると、こんな感じで認証を開始してくれます。

  1. アカウント選択画面の表示

  2. 認証許可画面の表示

  3. 返ってきたAuthTokenを使ったGoogle APIの利用
    （今回はGoogle Url Shortenerを利用）


注意点

AccountManagerがキャッシュしているAuthTokenが無効になって使えなくなってしまった場合や、ユーザーがアクセス許可を解除してしまった場合、AuthTokenの再取得をしてあげなければなりません。
そのために用意したのが、先ほどのstartAuthの引数です。この引数は、AuthTokenを再取得するかどうかの値です。なので、通常はfalseで良いのですが、Authenticationエラーが返ってきた際にはこの引数をtrueにしてあげることで、AuthTokenの再取得や再度認証許可画面を表示することができます。

まとめ

このAuth認証の方法を見つけるのにかなり時間がかかってしまいましたが、なんとか便利に使えるクラスの実装を行うことができたので良かったです。
最初にも書きましたが、このOAuthHelperのサンプルプロジェクトは以下のGitHubに公開していますので、良かったら参考にしてみてください。
syarihu/OAuthHelperSample
https://github.com/syarihu/OAuthHelperSample
また、何か修正する箇所があれば遠慮無く指摘してくれると助かります！
それでは、お疲れさまでした！

参考記事

  1. Using OAuth 2.0 for Installed Applications - Google Identity Platform — Google Developers
    https://developers.google.com/identity/protocols/OAuth2InstalledApp#callinganapi
  2. Getting Started - URL Shortener API — Google Developers
    https://developers.google.com/url-shortener/v1/getting_started#AboutAuthorization
  3. AndroidでOAuth認証をしたい - Qiita
    http://qiita.com/kurukurupapa@github/items/fee066909294e177026a



コメント

コメントを投稿

人気の投稿

[Qiita] Google Playのクローズドベータ版テストでメールアドレスを指定して公開する

イメージ
※この記事は以前Qiitaに投稿されていた古い記事です はじめに ふと、Google Playのクローズドベータ版テストを試してみたくなって使ってみたので手順を書いてみました。 Google Playのクローズドベータ版テストについて Google Playで決まったユーザーのみにアプリをテストしてもらいたい場合、クローズドベータ版テストを使用することができます。 クローズドベータテストには以下の3種類がありますが、今回はメールアドレスを指定する方法でテストを公開してみます。 メールアドレスを指定して公開する Googleグループのユーザーに公開する Google+コミュニティのユーザーに公開する 前提条件 テスターのメールアドレスはGoogleアカウントまたはGoogle Appsアカウントであること テスト開始手順 テスターの設定 Google Play デベロッパーコンソール にログイン アプリを選択 左のメニューから[APK]を選択 タブの中央にある[ベータ版テスト]を選択 [クローズドベータ版テストを設定]を選択 [Create list]を選択 リスト名を入力(「〜事業部」や「〜チーム」など、リスト内のテスターがどのような人なのかを識別するための名前を入力する) メールアドレスを入力(以下の3通りのどれか) メールアドレスを1つずつ入力してカンマかエンターを押す カンマ区切りのメールアドレスをコピペしてエンターを押す CSVファイルをアップロードする [保存]を押す 公開したいリストにチェックを入れる 右上の[更新を送信]を押す (製品版の公開と同じく即時公開はされないため、公開されるまで少し時間がかかる) 青い枠で囲われているオプトインURLをテスターに共有する 公開したベータ版をそのまま製品版に移行するには[製品版にプロモート]を押すことで、簡単に移行できます。 APKを公開する Google Play デベロッパーコンソール にログイン アプリを選択 左のメニューから[APK]を選択 タブの中央にある[ベータ版テスト]を選択 [ベータ版に新しいAPKをアップロード]を選択 APKファイルを選択 [このバージョンの新機能]を記載
続きを読む

[Qiita] Androidの実機でPCのlocalhostに接続したり、Webページの要素を検証する

イメージ
※この記事は以前Qiitaに投稿されていた古い記事です はじめに 実機でPCのlocalhostに接続したいときや、実機で見ているWebページの要素を検証したいことがあったので、その方法をメモとして書いておきます。 必要なもの Android Android 4.0以上 最新のChrome PC Chrome 32以上 Android SDK SDKが必要というよりはadbが必要なので、既にSDKが入っている場合はadbにパスを通しておくだけで良いです。 ※ Chrome拡張で「adb」というものがありますが、現在は非推奨になっているため、ここでは使いません。 Android SDKをインストールする 手元にWindowsが無いため、今回はMacの説明のみ書きます。 既にAndroid SDKが入っている場合は、この手順は必要無いです。 Android SDKをダウンロードする ここ から、自分の環境のAndroid SDKをダウンロードします。 今回はadbのみ必要なため、SDKのみのダウンロードをします。 ダウンロードしたzipを任意の場所に置き、zipを解凍する ターミナルでダウンロードしたSDKのディレクトリ配下のtoolsディレクトリを開く cd [ 任意のディレクトリ ] /android-sdk-macosx/tools android というシェルスクリプトを起動する ./android Android SDK Managerが起動するので、 Android SDK Platform-tools のみにチェックを入れて右下のinstallボタンを押す 同意してインストールする 完了したら Close を押してAndroid SDK Managerも閉じる adbにパスを通す 先ほどのインストールでplatform-toolsというディレクトリが生成されているはずなので、そこにパスを通します。 ~/.bash_profile を開く vi ~/.bash_profile 以下のようにSDKのディレクトリ配下のplatform-toolsディレクトリにパスを通す export PATH = $PATH : [ SDKのディレクト
続きを読む

【Linux】Linuxでディレクトリ毎にzip圧縮する

Linuxで、ディレクトリ毎にzip圧縮したかったのだが、一発でできるようなコマンドが無かったため、ディレクトリ毎にzip圧縮するシェルスクリプトを作ってみた。 適当なファイルを作って、下記のスクリプトを書いて、ファイル名を「zip_per_directory.sh」みたいな感じにして保存する。 #! /bin/sh IFS=" " for dir in `find ./ -type d` do dir=`basename $dir` if [ $dir != `basename ./` ] then zip -r $1$dir.zip $1$dir fi done 次に、そのままだと実行できないので実行権限を与える。 $ chmod +x zip_per_directory.sh 後は、圧縮したいディレクトリが入っている場所にさっき作ったファイルを移動して、ターミナルでディレクトリを移動してから実行する。 $ cd 圧縮したいディレクトリが入ってるパス $ ./zip_per_directory.sh 実行すると、カレントディレクトリにあるディレクトリをすべて自動で圧縮してくれるので、終わるまで待つだけ。 圧縮する際にはそのディレクトリにシェルスクリプトのファイルを移動しなければならないが、ディレクトリを右クリックして圧縮するという作業を何回も繰り返すよりは楽にできるのでは無いかと思う。
続きを読む