2010年5月18日 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/

<?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の提供側に依存するため、よしなに確認する。

何かお困りではありませんか？

さいごまで記事を読んでいただき、ありがとうございます！
何かお困りなことはありませんか？
当方、ホームページ制作・改修/WordPress構築/Webデザイン/UI・UXデザイン/Webディレクション/広告運用/ブランディング/マーケティング/撮影・レタッチ/動画撮影・編集/プロトタイプ制作、幅広く対応しておりますので、まずはお気軽にご相談いただけると嬉しいです！ご連絡お待ちしております。
Stay Safe.
詳細 »　案件、承っております

「図解モチベーション大百科」を読んで

書籍「図解モチベーション大百科」。主に行動経済学、実験心理学を扱った国内外の文献から、編著者なりの解釈で紹介された本。ここでは備忘録として書・・・

マーケティング・ブランディング 2021年5月11日

MAMPでMySQL Serverが突然起動しなくなった時 → ログファイル削除

「（匿名）さんコメントありがとうございます。何も設定変更していないのに、それまで使用できていたサーバーが突然使えなくなるのは辛いですよね、、。ここで紹介したや・・・」

MAMP コメント2021年2月22日 21:01

ホーム画面からの起動か判別する

「コメントありがとうございます。この記事で紹介している機能は、記事内のサンプル「ホーム画面からの起動か判別する」というリンクをクリックすることで確認できます。・・・」

JavaScript コメント2019年10月25日 14:52

JSONP Javascriptがちょっと分かってきたかも

何かお困りではありませんか？

最近の記事

記事の投稿IDなどの投稿者（ユーザー）情報を取得する方法 → get_the_author_meta

「私たちの働き方とマネジメント」を読んで

「副業するならカメラマン」を読んで

「やりたいことを全部やってみる」を読んで

「世界一やさしいブログxYouTubeの教科書1年生」を読んで

「図解モチベーション大百科」を読んで

ローカル環境（MAMP）でgmailからメール送信できるようにする

ユーザビリティと機能はどちらが上？

ビジネスカードとショップカード

DtoC におけるプロモーションと広告運用

人気の記事

WP_Queryを使って絞り込み検索するのにコレは便利！

iframeの高さを自動調整する

http://localhost:8888/ → http://localhost/

overflowをautoにした要素のスクロール位置を変更する → scrollTop scrollLeft

iOS Safariで絶対配置(position:fixed)して惰性スクロールしてもロックしない、フリーズ回避方法

Instagram API を使ってインスタに投稿した画像データを取得する

イラストレーターでレイヤーごとにPNGで書き出す

WordPressのカテゴリー一覧ページでカテゴリー名とスラッグを取得する → get_queried_object()

favicon.icoをWordPressの管理画面からアップロードできない→ wp-config.php を一時的に修正

Advanced Custom Fields を使った条件分岐(セレクトボックス、チェックボックス、ラジオボタン、真偽)のテンプレート記述方法

コメントありの記事

jQueryでformを操る【nameの値を取得する/クリアする】