Flashで作るmixiアプリ
FlashからOpenSocial JavaScriptAPIを使う方法
前提
PC版のmixiアプリではOpenSocial JavaScriptAPI経由でプロフィールやコミュニティリストといった情報を取得したり、メッセージや友人を招待する機能を呼び出すことが可能です。このAPIをFlashから利用したい場合はExternalInterfaceを使用しFlashとコンテナ（JavaScriptAPIがあるHTML）間で通信します。
注意すべきこと
ガジェットが起動してすぐにJavaScriptAPIから取得した情報を保持した後、コンテナ経由で読み取るといったことも可能ではあります。ですが、JavaScriptAPIはサーバーとのやりとりを行う非同期処理のため上記の方法ではFlashの呼び出しが先に実行され、値が取得できない恐れがあります。そのため、JavaScriptAPIを使用し結果を受け取るにはFlashとコンテナ間にも非同期処理が必要になります。ですがExternalInterfaceにはコンテナと非同期でやりとりをするような仕組みがありません。
現在、有志の方が提供しているFlashのOpenSocial用のライブラリにはopensocial-actionscript-clientとopensocial-as3-client（開発停止）がありますが、いずれもあまりメンテナンスがされてないので使用するにはそれなりのリスクとコストを伴います。そのため、今回はサンプルとして実装した個人プロダクトのJSDelegateライブラリを使用します。
OpenSocial JavaScriptAPIとFlashとの連携実装方法の1つとして参考にしていただければ幸いです。
実装方法
このライブラリは2つのFlashのクラスと1つのJavaScriptの決まりごとから成り立っています。
- JSDelegate（http://github.com/takimo/as3jsdelegate）
ExternalInterfaceの通信を管理し、非同期に渡ってきた結果をCall元に伝える役割です。 - JSCall
コンテナで実行したいメソッドとそれに渡す引数を定義するクラスです。このクラスはリクエストIDといったユニークな値を保持し、コンテナとFlash間で非同期処理を可能にしています。 - JavaScriptの決まりごと
Flashから呼び出されるメソッドの第1引数にはparamerter、第2引数には上記で説明したリクエストIDが渡されます。呼び出されたメソッドは必要な処理を行った後、FlashオブジェクトのreplayCallメソッドの第1引数に結果を渡します。この時、第2引数にリクエストIDを渡すことでコンテナとFlash間の非同期処理が行われます。
|
|
| 図1：連携実装方法の概要図 |
試しに
それでは試しに上記のライブラリを使用してFlashからOpenSocialJavaScriptAPIを使用してみたいと思います。まず、OpenSocialで取り扱っている情報を取得できるように、以下のようなメソッドを定義したGadgetXMLを用意します。
次にFlash側の実装方法を見ていきましょう。Flashに書くことは以下のようになります。
- どんなメソッドを使うのか、それに渡す引数を設定する
- 結果が返ってきたら、どのような処理を行うのか
- 1と2の設定を実行する
JSCallインスタンスはJavaScriptから値が返ってくるとJSCallEvent.RECIVEというeventをdispatchしてくれます。そのeventにhandlerをつけることで、返り値を第1引数に渡ってくるJSCallEvent.resultから取得することができます。このresultプロパティには様々な型の値が返ってくる可能性があります。
このように、使用したいメソッドと必要なパラメータを設定することでJavaScriptAPIを使用できるようになります。
今回は非同期でOpenSocial JavaScriptAPIを使うための実装方法の１つとしてご紹介させていただきました。
Flashで作られているソーシャルアプリはとてもたくさんあるのにも関わらず、技術情報はあまり共有されていないというのが自分が感じている現状です。OpenSocialプラットフォームを公開している会社に身をおくものとして、もっとFlashで作られるアプリが作りやすい環境をいろんな方と議論をして進めていきたいと考えております。
次章は外部と連携をするようなアプリを実装する際に気をつけたいセキュリティのことを紹介します。
