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

最近の記事

文章のユーザビリティ

この書籍の中で、ライティングのユーザビリティについて触れている項目があり、激しく共感する部分だったので、ここで備忘録としてピックアップする。 ・・・

ライティング

インタフェースデザイン

この書籍は、I部 リサーチ、II部 デザイン、III部 インプリメンテーションと三部構成になっている。この記事では、その中から、I部 リサーチ、・・・

デザイン思考

フルHD映像を4Kにする → スーパースケール

これを知ったときはマジか!と飛び跳ねた。あらためて思い返してみると、確かに公式チュートリアルでも触れていたことをうっすら思い出す。そしてそのときとやり方がなん・・・

DaVinci Resolve

Macで編集時と書き出し後で色味が変わってしまう場合に試してみたいこと

試したことはまだないけど、Macで編集時と書き出し後で色味が変わって困ったときのために備忘録。 プロジェクト設定 > 「カラーマネジメント・・・

DaVinci Resolve

プロジェクト設定と環境設定

プロジェクト設定と環境設定について詳しく解説されている情報がなかなか見つからないので、要所要所で知り得た情報を更新していきます。 プロジェクト設定 ・・・

DaVinci Resolve

項目”Clipy”は開いているため、ゴミ箱に入れることができません。←アンインストールしようとしたときの話し

Clipyが超絶便利そうだったので、macOS Big Sur にインストール&再起動して使ってみた。ところが、command + c を複数の箇所で行い、c・・・

徒然なままに

setTimeout は requestAnimationFrame に変えるべき?

requestAnimationFrame をはじめて見たので調べていたら、setTimeout や setInterval は requestAnimati・・・

JavaScript

書籍「小さなチーム、大きな仕事」からピックアップ

6年ぶりに読み返したが、今なおハッとさせられることが多く見つかる。 この本で忘れないようにしたい項目をピックアップするだけでも役に立ちそ・・・

起業向け情報

書籍「完全網羅 起業成功マニュアル」からピックアップ

この記事では、以前に読んだ際に付箋を付けていたが、その部分だけを備忘録としてピックアップするため、本の要約ではない。実際は、何倍も濃い内容で、練・・・

起業向け情報

書籍「はじめの一歩を踏み出そう」から気になったフレーズをピックアップ

もう一回、全部読み返したいところだが、書籍がありすぎるので、当時付箋紙をつけていたところだけをピックアップ。書籍内ではより具体的な説明があるので・・・

起業向け情報

人気の記事

ブラウザによるwidthプロパティの解釈の違い

正しいCSSを記述しているにもかかわらず、表示が崩れることがある。ブラウザによる解釈の違い(バグ)が原因であるが、IE5や古いブラウザにバグが見られる。・・・

CSS2007年1月1日

外付けハードディスクを起動ディスクにする

iBook G4(OS10.3.x)がある。Safariのバージョンは、1.xだ。2は10.4にしないと使えない。もっと詳しく言えば、10.4.10以下でないと・・・

お仕事・制作日記2008年9月8日

画面が縦向きか横向きかを知る

ブラウザ、モバイルファースト、メディアクエリー、マルチ画面、タブレット・・・ 想定すべき画面サイズ、利用シーンに適した情報のコントロールが崩壊しつつある。 とい・・・

JavaScript2012年11月12日

透明GIF画像の書き出し方法

たとえば、白文字が混じった画像を透明GIFにする場合、背景だけでなく白文字までが透明化されてしまう。 ずっと悩んでいたがようやく解決できたので覚え書き。 形・・・

Fireworks2008年7月11日

jQuery Mobileを使った最小ソース

jQurey Mobile。まもなくβ版がリリースされるそうですが、現状のα版3を見てみました。 最低限必要なソースまで削り落として、ちょっとjQuery Mo・・・

JavaScript2011年2月23日

ファイル名を拡張子なしで取得するサンプル

変数bnにphpファイルのファイル名を拡張子なしで取得するサンプル $bn = basename($_SERVER['PHP_SELF'], ".php");・・・

php2011年10月27日

Sassファイルを保存するとcssファイルが自動作成されて困る→サイト管理

sassファイルを保存すると、cssファイルが自動生成されるという症状でしばらくの間、ストレスだったがようやく解決。 例えば、var.scssを修正して保存す・・・

Dreamweaver2018年9月27日

文字コード変換

記述方法は間違いないのに、文字化けしてしまう。 xhtmlはutf-8で宣言していたのだが、Javascriptで記述された日本語がブラウザで確認すると文字化け・・・

Dreamweaver2007年12月9日

ファイル名を拡張子なしで取得するサンプル

変数bnにhtmlファイルのファイル名を拡張子なしで取得するサンプル var bn = location.href.split("/"); bn = bn[b・・・

JavaScript2011年10月27日

ローカル環境MAMPにWordPressをインストール

ローカル環境はMAMPを使いました。 データベースを作成する MAMPを起動し、「サーバを起動」後、「オープンWebStartの」をクリックします。 「ツ・・・

MAMP2015年2月5日

コメントありの記事

インタフェースデザイン

「test」

デザイン思考

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

「>ころころさん コメントありがとうございます! 確かに、APIドキュメント見ましたが、ライブに関する情報は今のところ取得できないようですね。 インスタライ・・・」

API

Sony Eマウント フルサイズ対応のカメラレンズを収集するページを作ってみた

「SIGMAから超軽量で明るい単焦点レンズが2本発売になりましたので、リストにレンズ情報追加しました!」

お仕事・制作日記

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

「>名無しさん ご指摘、ありがとうございます! 記事冒頭の「まずはサンプル」のサンプルが動いていませんでしたので修正しました。」

JavaScript

えっ!?Yahooの検索結果から遷移しようとしたら全く違うサイトにリダイレクトされてしまった...

「>前田さん コメントありがとうございます。 環境は分かりかねますが、修正したいファイルのパーミッションを604や644に変更すると書き込みできるようになります(・・・」

お仕事・制作日記

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

「アバターを取得する「get_avatar」についても追記しました!」

WordPress

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

「「値をクリアする」を追加しました。チェックボックスやラジオボタンの値を何も選択していない状態に戻すときについて触れています。」

JavaScript

iframeの高さを自動調整する

「>匿名さん コメントありがとうございます。 サンプルでは、beforeは何も処理していないので期待する表示にならない、で正解です。 クリックした後が、対応・・・」

JavaScript

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

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

MAMP

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

「コメントありがとうございます! そもそもできるかはわかりませんが、ソースを書き換える必要はあります。 下記記事などが参考になるかもしれません。 illustra・・・」

Illustorator

WEB制作マークアップJavaScriptJSONP Javascriptがちょっと分かってきたかも | シンプルシンプルデザイン