iOSアプリとEvernoteの統合：最初のステップ

Evernoteの利点の1つは、その遍在性です。 当社のアプリケーションは、ほぼすべての重要なモバイルプラットフォーム、2つの最も人気のあるコンピューターOS、およびその他すべての場合（Webインターフェイス経由）で動作します。 しかし、私たちはそこで止まるつもりはありません。



現在、より多くのモバイルアプリケーションがEvernoteに情報を読み書きする機能をサポートしています。 私たちはそれをとても気に入っており、さらに続けたいと思っています-あなたのノートにアクセスする方法が多いほど、より良いです（いずれにせよ、私たちに思えます）。 開発者として、3000万人以上のユーザーにアクセスし、これらの人々の目でアプリケーションの価値を即座に高め、外部の「デジタルメモリ」と通信する機会を開くことができます。



Evernoteプラットフォーム（または開発全般）の学習を始めたばかりで、アプリケーションをサービスに統合したい開発者向けのマニュアルを定期的に発行することにしました。



この投稿では、EvernoteをテストiOSアプリケーションに統合するための特定の手順について説明します。 Xcodeで新しいプロジェクトを開始し、Evernoteソフトウェア開発キット（SDK）をダウンロードしてインストールし、Cloud APIを介してEvernoteと対話するシンプルなアプリケーションを作成します。



始める前に、将来の独立した仕事に必要なものをリストします。

1. sandbox.evernote.comのアカウントは、開発者向けのEvernoteサンドボックスサーバーです。 Evernote Cloud APIを介して実行されるアプリケーションをデバッグするために使用されます。 ここでテストアカウントを作成できます。
2. Evernote APIキー（キーをリクエスト ）。 APIキーは、 コンシューマキーとコンシューマシークレットの2つの部分で構成されます。 （ 注：独自のアプリケーションを開発している場合は、アプリケーションの開発が終了したら、Evernoteメインサーバーでキーを有効にするように依頼する必要があることに注意してください。これはdev.evernote.com/supportのフォームから行えます ）。
3. 執筆時点でのXcodeの最新バージョンは、Intel Macにインストールされている4.3.2です。

すべて在庫がありますか？ それでは、始めましょう。



このアプリケーションは、現在のユーザーの名前とアカウント内のメモの総数を表示するという2つのことを正確に行います。



*アプリケーションのためにこのアイデアを偶然に選択したことを明確にする価値があり、開始時にこの情報に簡単にアクセスするためのAPIがあるかどうかわかりませんでした*

基礎を築く

コードを書き始めて最初のユーザーに感銘を与える前に、Xcodeプロジェクトを作成し、iOS用のEvernote SDKをインストールする方法を準備する必要があります。

Xcodeプロジェクトの作成

1. Xcodeを起動し、メニューから「ファイル」>「新規」>「プロジェクト」を使用してプロジェクトを作成します。
2. プロジェクトテンプレートを指定するように求められたら、左側のメニューの[iOS]で[アプリケーション]を選択し、[シングルビューアプリケーション]をクリックします。 次に「次へ」をクリックします。
   
   
   
   
   
   
   
   
3. 次の画面で、新しいアプリケーションのいくつかの特性を明確にする必要があります。
   
   
   • 製品名に「EvernoteCounter」を指定します。
   • 会社識別子は任意です。 この値は、世界中のアプリケーションを識別するために使用されますが、コンピューターよりも先に実行することはないため、重要ではありません。 この例では、「com.somecompany」を指定しました。
   • クラスプレフィックスに「EC」を指定します（「EvernoteCounter」の略）。 この略語は、コードの記述を開始するときにすべてのクラス名に先行します。
   • デバイスファミリで「iPhone」を指定します。
   • 3つのボックスがすべてオフになっていることを確認してください。
   • 完了したら、次のようにフィールドに入力する必要があります。
     
     
     
     
4. 最後に、プロジェクトの場所を示すように求められます。 あなたの裁量でそれを選択してください。

Xcodeプロジェクトの準備ができました。 数分間それを脇に置きます。 アプリケーションがEvernoteクラウドAPIとやり取りするには、SDKが必要です。 それを取得して、プロジェクトに追加しましょう。

iOS用Evernote SDKをダウンロードしてインストールします

1. Evernote SDKはすべてGithubで入手できます。 その中にはiOS SDKがあります 。
2. 右中央の「ダウンロード」リンクをクリックします。
3. 表示されるページで、「zipとしてダウンロード」をクリックします。 SDKの現在のバージョンをダウンロードします。
4. ファイルを解凍すると、次のようなディレクトリが表示されます。
   
   
   
   

ダウンロードしたSDKディレクトリで、 evernote-sdk-ios



フォルダーを選択し、 evernote-sdk-ios



プロジェクトにドラッグします。





Xcodeは、あなたが何をしたかについていくつか質問をします。 デフォルトではすべてを残すことができます-[完了]をクリックします。



iOS用Evernote SDKにはSecurity.framework



コンポーネントが必要なので、アプリケーション開発プロセスに含める必要があります。

1. Xcodeウィンドウの左上隅にあるプロジェクトをクリックします。
2. ウィンドウの上部中央にある[ビルドフェーズ]をクリックします。
3. 「ライブラリとバイナリをリンク」リストを展開し、左下のプラス記号をクリックします。
4. 表示されるリストの検索バーで、「セキュリティ」と入力し始めます。
5. Security.framework
   
   
   
   がリストに表示されたら、それをクリックして強調表示し、「追加」をクリックします。
   
   
   
   

すべての準備作業が完了したので、楽しい部分に移りましょう。

アプリケーション作成

すでに述べたように、アプリケーションはたった1つのことを行うことができます-Evernoteアカウントでユーザーを認証し、このアカウントのメモの総数を表示します。



アプリケーションのルート機能を掘り下げる前に、OAuthを使用してEvernote Cloud APIを介して認証用に構成する必要があります。 iOS SDKを使用すると、数分で問題なくこのバンドルを実装できます。

OAuthの構成

まず、 ECAppDelegate.m



を変更する必要があります。 デフォルトでは、XcodeはdidFinishLaunchingWithOptionsメソッドを自動的に作成します。 変更する前に、このメソッドは次のようになります。





画像をクリックしてGithubでこのコードを表示します



OAuthが機能するためには、正しいホストと認証の特権でEvernoteSession



インスタンスを作成する必要があります。 変更されたECAppDelegate.m



は次のようになります。





画像をクリックしてGithubでこのコードを表示します



EVERNOTE_HOST



は、対話するリモートホストです。 アプリケーションの開発中は、サンドボックスサーバーであるsandbox.evernote.comに連絡する必要があります。 アプリケーションをリリースする前に、必ずEVERNOTE_HOST



を www.evernote.com



www.evernote.com



、前に書いたようにメインサーバーでキーのアクティベーションを要求します。



CONSUMER_KEY



とCONSUMER_SECRET



は、以前に受け取ったAPIキーの2つの部分です。 そのため、実際のキーのパラメーターで使用可能な値を変更する必要があります。



次に、 EvernoteSession



新しいインスタンスを初期化し、そのプロパティを指定します：host、 consumerKey



、 consumerSecret



。 最後に、新しいセッション変数には、アプリケーションがEvernote Cloud APIと対話するたびに使用されるシングルトンオブジェクトが割り当てられます。



また、ヘッダーファイルにEvernoteSession.hを含めることを忘れないでください。 ECViewController.h



がECViewController.h



に含まれた直後に適切な宣言を追加します。





画像をクリックしてGithubでこのコードを表示します



OAuthプロシージャにはWebページを介したアプリケーションの承認が含まれるため、アプリケーションが開いているリンクを処理できることを確認する必要があります。 幸いなことに、これはすでにiOS SDKに組み込まれており、 ECAppDelegate.m



ファイルの最後にこのメソッドを追加するECAppDelegate.m



です（ end



直前）。





画像をクリックしてGithubでこのコードを表示します

ユーザーインターフェイスの作成

これで、アプリケーション用のシンプルなインターフェイスを作成できます。 左側のECViewController.xib



をクリックします。 インタレストエディタが開き、iPhone画面で計算された設定が表示されます。 ここでは、ボタン、テキストフィールドなどのインターフェイス要素をドラッグ、作成、カスタマイズできます。このアプリケーションでは、いくつかのテキストフィールド（Evernoteのユーザー名用、メモの数用）、各フィールドの署名、ボタンが必要ですどの手順が起動されるかをクリックします。 （テキストフィールドはUILabel



タイプでなければならないことに注意してください。これにより、値を動的に設定できます。これについては後で説明します）。



必要なすべてのインターフェイス要素をオブジェクトライブラリからエディターフィールドにドラッグします。 完了すると、次のようになります。







ボタンのクリックを処理するには、 IBOutlet



プロパティとIBAction



メソッドを宣言する必要があります。 これらすべてをECViewController.h



ファイルに追加しましょう。





画像をクリックしてGithubでこのコードを表示します



次に、テキスト値領域を関連付けます。これは、ユーザー名とメモの数をECViewController



対応するプロパティ（ usernameField



とnoteCountField



）に表示します。

1. 左側のプロジェクトブラウザーでECViewController.xib
   
   
   
   をクリックして、インターフェイスレイアウトを開きます。
2. 次に、「プレースホルダー」の下の「ファイルの所有者」を右クリックして、リンクパネルを展開します。
3. usernameField
   
   
   
   の右側の空の領域をクリックし、次に示すように、対応する値の領域にドラッグします。
   
   
   
   
4. noteCountField
   
   
   
   でも同じことをnoteCountField
   
   
   
   ます。

次に、以前に発表したretrieveUserNameAndNoteCount



メソッドにボタンを関連付ける必要があります。 これを行うには、コントロールを押しながらボタンを「ファイルの所有者」にドラッグします。 マウスボタンを放した後、表示される[送信済みイベント]ウィンドウでretrieveUserNameAndNoteCount



を選択しretrieveUserNameAndNoteCount



。



これで、タスクを実行する準備ができたテキストフィールドとボタンができましたECViewController.m



内部作業を実行する必要があります。 Xcodeが生成した後、デフォルトでこのファイルがどのように見えるかを以下に示します。





画像をクリックしてGithubでこのコードを表示します



タスクを完了するには（アカウントのユーザー名とメモの数を表示）、2つのメソッドを作成する必要があります。

もちろん、最初のボタンは、ボタンがクリックされたときに呼び出されるメソッドであるretrieveUserNameAndNoteCount



です。



この方法は次のとおりです。

1. Evernote Cloud APIで認証を提供します（何か問題が発生した場合はエラーメッセージを表示します）。
2. 現在のユーザーに関する情報をEDAMUser
   
   
   
   オブジェクトとしてEDAMUser
   
   
   
   ます。 （ところで、「EDAM」は「Evernoteデータアクセスと管理」の略です）。
3. usernameFieldの値としてユーザー名を指定しusernameField
   
   
   
   。
4. 別のメソッドを呼び出して、このユーザーのメモの数を取得します。

完成したメソッドは次のとおりです。





画像をクリックしてGithubでこのコードを表示します



心配する必要はありません。今、これらすべてを詳細に分析します。



まず、 EvernoteSession



ローカルインスタンスを取得します（唯一のインスタンス（シングルトン）であるため、 ECAppDelegate.m



作成したものと同じになります）。 その後、 authenticateWithCompletionHandler



呼び出します。 このメソッドは、EvernoteクラウドAPIでセッションの認証を試みます（これについては、以下のOAuthセクションで説明します）。 認証中にエラーが発生した場合、または何らかの理由で認証が失敗した場合、これに関する情報がNSLogを使用して記録され、ダイアログボックス（ UIAlertView



インスタンス）に表示され、認証の失敗がユーザーに報告されます。



認証が成功した場合、アプリケーションのメインロジックに進むことができます。 アプリケーションが認証トークンを受信するとすぐに、そのトークンは1年間有効であり、ユーザーは再度ログインする必要があることに注意してください。 ただし、ユーザーがアプリケーションを再インストールすることに決めた場合は、再度ログインする必要があります。



まず、使用するアカウントを決定する必要があります。 これを行うには、 EvernoteUserStore



（ userStore



）のローカルインスタンスを作成し、そのgetUserWithSuccess



メソッドを呼び出します。 これは非同期要求であり、応答ではブロックの形式で実装された関数を要求します（実際、これらは匿名関数です）。 最初のブロックは単一のパラメーターEDAMUser



を受け入れ、要求が成功したことを報告します。 2番目のブロック（ failure



）は、 NSError



インスタンスを1つ受け入れます。これは、正確に何が問題であったかを説明しています。 エラーが検出されると、アプリケーションはそれを単にログに記録し、それ以外は何もしません。



APIリクエストが成功した場合、 EDAMUser



インスタンスからusername



プロパティをリクエストし、それをusernameField



の値として指定しusernameField



。



最後に、他のメソッドcountAllNotesAndSetTextField



を呼び出します。





画像をクリックしてGithubでこのコードを表示します



このメソッドは、その名前が雄弁に言っているように、アカウント内のノートの数をカウントし、画面に表示します。 仕組みを見てみましょう。



最初に、 noteCount



カウンターnoteCount



を宣言しnoteCount



。 この変数では、アカウントのメモがカウントされます（これについては後で詳しく説明します）。



次に、 noteStore



というEvernoteNoteStore



ローカルインスタンスを作成します。 このオブジェクトを使用して、 listNotebooksWithSuccess



（次の行で呼び出します）などのメソッドを使用して、EvernoteクラウドAPIからノート、ノートブックなどへのアクセスを要求します。 Cloud APIには、アカウント内のすべてのノートの数を取得する既製の方法が含まれていないため、次の一連のアクションを実行する必要があります。

1. listNotebooksWithSuccess
   
   
   
   を使用して、ユーザーアカウント内のすべてのノートブックのリストを取得します
2. このリストを調べて、各ノートブックのノートの数を取得します。

回答listNotebooksWithSuccess



、 listNotebooksWithSuccess



ように、いくつかのブロックです。 最初は成功したサーバー応答を処理し、 EDAMNotebook



オブジェクトのコレクションを含む単一のNSArray



パラメーターを受け入れます-ユーザーのアカウントの各ノートブックに1つ。



各EDAMNotebook



オブジェクトには、一意のGUIDパッド識別子が含まれています。 このGUIDを使用して、対応するノートブックにあるノートを検索できるようにするEDAMNoteFilter



インスタンスを作成します。 最後に、 EDAMNoteFilter



をパラメーターとして使用して、 findNoteCountsWithFilter



を呼び出して、このノートブック内のノートの数を（ EDAMNoteCollectionsCounts



オブジェクトのインスタンスとして） EDAMNoteCollectionsCounts



ます。



番号が得られたので、それをnoteCount



変数に追加し、画面のnoteCountField



を更新します。 結果は次のとおりです。

OAuth

セッションが認証に合格しない場合（つまり、トークンが受信されない場合）、ボタンをクリックすると、アプリケーションはモバイルSafariに制御を移し、Evernote Webサイトが開きます。 そこで、ユーザーはEvernoteアカウントにログインし、アプリケーションがアカウントにアクセスすることを許可する必要があります。



ユーザーがログインすると、ブラウザーはアプリケーションに制御を戻し、ユーザーがボタンをクリックしたかのようにプロセスが続行します。 すべてがうまくいった場合、上記のようにユーザー名とメモの数が画面に表示されます。

結論として

また、注目に値するもう1つのポイント：EvernoteCounterアプリケーションは、iOS SDKの統合と使用の容易さを示すために作成されました。 これが大量使用の実際のアプリケーションである場合、エラーが発生する可能性のある条件にもっと注意を払い、「保護」プログラミングの実践に取り組む必要があります。 ただし、理解のためにテストアプリケーションのコードを複雑にしないために、ここでは省略しました。



XcodeのEvernoteCounterプロジェクト全体は、Githubで入手できます。 コードを支援および改善したい場合は、変更を提案することをheしないでください（このアプリケーションの新しい機能については話していないことに注意してください。