0から目指すWebマスター Web制作に関する備忘録
検索

JavaScript

JSONP Javascriptがちょっと分かってきた人のために

いまどき「マッシュアップ」という言葉を使うこと自体ちょっぴり恥ずかしいのですが、外部APIを連携する際のお覚書き。

これまで外部APIの連携は、「php」と「Ajax」でやっていたのですが、「jsonp」の手軽さに驚愕しました。
jsonpはセキュリティ的に使用上要注意とよく聞きます。
そのため、jsonpを使用することを避けてきたわけですが・・・。
これがどうして。
なんで今まで使わなかったんだろうと後悔です。

前置きはこのくらいにして、早速サンプルファイルを紹介(そのままコピペで試せます)。
JSONPを実装しようとすると、コールバック関数、オブジェクトとかいう言葉をよく聞きますが、一旦考えずに形だけ把握します。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Content-Language" content="ja" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<script type="text/javascript">
function data(param){
alert(param.ビートルズ.リズムギター);
alert(param["ローリング・ストーンズ"]["ギター"]);
}
</script>
<script type="text/javascript">
data({
"ビートルズ":{
"リズムギター":"ジョン・レノン",
"ベース":"ポール・マッカートニー",
"リードギター":"ジョージ・ハリスン",
"ドラムス":"リンゴ・スター"
},
"ローリング・ストーンズ":{
"ギター":"ブライアン・ジョーンズ",
"リードボーカル":"ミック・ジャガー",
"ギター":"キース・リチャーズ",
"ドラムス":"チャーリー・ワッツ"
}
});
</script>
</head>
<body>
<p>alertで「ビートルズのリズムギター」と「ローリング・ストーンズのギター」を表示します。</p>
</body>
</html>

ここで注目するポイントは、
function data(param){
alert(param.ビートルズ.リズムギター);
alert(param["ローリング・ストーンズ"]["ギター"]);
}

まず、data()という関数を用意する。
dataという関数名は、その後に続くdata({~})のdataという名と一致させる必要がある。
dataという名前である必要はなく、callback()という関数を用意し、その後に続くデータをcallback({~})としても問題ない。

続いて、data()関数にparam(名前はなんでもよい)という引数を入れる。
このparamにすべてのデータが入っていると想像すると分かりやすいかも。

さらに、データの呼び出し方。
param.ビートルズ.リズムギター
と.(ドット)つなぎで情報をたどる方法と
param["ローリング・ストーンズ"]["ギター"]
と配列のようにつなぐ方法がある。
ただ、データが日本語の場合、配列のようにつながないと思わぬエラーの原因になりかねないので注意が必要だ。
試しに
param.ローリング・ストーンズ.ギター
と書き直すとエラーになるのが分かる。原因は、データ内に「・」があるため。

次に、下記ソースを外部化(とりあえず、サンプルファイルと同じ階層にsample.jsというファイル名)します。

data({
"ビートルズ":{
"リズムギター":"ジョン・レノン",
"ベース":"ポール・マッカートニー",
"リードギター":"ジョージ・ハリスン",
"ドラムス":"リンゴ・スター"
},
"ローリング・ストーンズ":{
"ギター":"ブライアン・ジョーンズ",
"リードボーカル":"ミック・ジャガー",
"ギター":"キース・リチャーズ",
"ドラムス":"チャーリー・ワッツ"
}
});

外部化したあとのソースは下記。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Content-Language" content="ja" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<script type="text/javascript">
function data(param){
alert(param.ビートルズ.リズムギター);
alert(param["ローリング・ストーンズ"]["ギター"]);
}
</script>
<script type="text/javascript" src="sample.js"></script>
</head>
<body>
<p>alertで「ビートルズのリズムギター」と「ローリング・ストーンズのギター」を表示します。</p>
</body>
</html>

実は、この「sample.js」にあたる部分を、JSONP形式で用意されたファイル名に置きなおすことで、JSONP形式で返ってくるデータ名を関数名に置き直すと、すでにマッシュアップの下準備が完了している。

FOOMOOのAPIを例にしてみよう。
※FOOMOOのAPIを利用するには、事前に登録が必要です。
http://webservice.recruit.co.jp/hotpepper/
ホットペッパー Webサービス

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Content-Language" content="ja" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<script type="text/javascript">
function callback(param){
alert(param.results.api_version);
alert(param.results.shop[0].name);
}
</script>
<script type="text/javascript" src="http://webservice.recruit.co.jp/hotpepper/gourmet/v1/?key=1f6b15afdba1e98d&large_area=Z011&format=jsonp"></script>
</head>
<body>
<p>alertでapiのバージョンとデータ一件目の店名を表示します。</p>
</body>
</html>

http://webservice.recruit.co.jp/hotpepper/gourmet/v1/?key=1f6b15afdba1e98d&large_area=Z011&format=jsonp
を直接たたくと分かるが、JSONP形式で返ってくるデータ名は「callback」である。そこで関数名を「callback」にし、呼び出したいデータを呼ぶ。

最後に、コールバック関数名の変更の仕方を紹介
実は提供側がサポートしているかによってしまうが、リクエストパラメータに試しに「callback=test」を追加して直打ちしてみる。
http://webservice.recruit.co.jp/hotpepper/gourmet/v1/?key=1f6b15afdba1e98d&large_area=Z011&format=jsonp&callback=test
JSONP形式で返ってくるデータ名が「test」に変わったのを確認できる。
つまりコールバック関数名が変わった。
この辺はAPIの提供側に依存するため、よしなに確認する。