Asial Blog

Recruit! Asialで一緒に働きませんか?

AWS SDK for JavaScriptでAmazon S3とDynamoDBをクライアントサイドJavaScriptのみで操作する

カテゴリ :
フロントエンド(HTML5)
タグ :
Tech
JavaScript
HTML5
aws


久保田です。

AWS SDK for JavaScriptのデベロッパープレビューがリリースされました。AWSは今までウェブサービスのサーバサイドからしか扱えませんでしたが、このライブラリを用いることで、AWSのサービスをクライアントサイドのJavaScriptからでも操作できるようになります。つまり、IaaSとして利用できるAWSをサーバサイドのプログラム無しでBaaSのように扱うことができます。最も有名なBaaSの一つであるParse.comもバックエンドにはAWSを利用していることが知られていますが、今回登場したAWS SDK for JavaScriptを用いるとParse.comのようなBaaSと同じようなことがAWSでもできるのではないかと注目されているようです。

この記事では、AWSで提供されているファイルストレージのS3と分散キーバリューストアのDynamoDBを、AWS SDK for JavaScriptを使ってクライアントサイドJavaScriptから扱う例を紹介します。

Amazon S3をJavaScriptから扱う



ファイルストレージのS3をJavaScriptから扱う例を最初に紹介します。

Facebookアカウントで認証してS3にファイルをアップロードする例を紹介します。その次に、埋め込みのクレデンシャルを用いて認証無しでS3を操作する例を紹介します。

S3バケットを作成する



まずは、 JavaScriptで操作するためのS3バケットを作成します。

AWS Management Consoleにアクセスして、S3の管理画面に移動します。「Create Bucket」をクリックして、JavaScriptから操作するS3のバケットを作成します。



S3のバケットを作成したら、次にそのS3に対して他のドメインからAjaxでアクセスできるようにするために、CORS(Cross Origin Resource Sharering)を設定します。作成したBucketの詳細からPermissionsを選択して、「Add CORS Configulation」をクリックすると、CORSを設定ダイアログが表示されます。




ここに、以下の設定を貼り付けて保存してください。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  3.     <CORSRule>
  4.         <AllowedOrigin>*</AllowedOrigin>
  5.         <AllowedMethod>GET</AllowedMethod>
  6.         <AllowedMethod>PUT</AllowedMethod>
  7.         <AllowedMethod>POST</AllowedMethod>
  8.         <AllowedMethod>DELETE</AllowedMethod>
  9.         <AllowedHeader>*</AllowedHeader>
  10.     </CORSRule>
  11. </CORSConfiguration>

この設定では、どんなドメインからでもajaxでリクエストを投げられるようになります。認証は別にあるので、これでも一応問題ありませんが気になる場合はAllowOrigin要素内に自分がアクセスするオリジンを指定するようにしてください。

Facebookアプリを作成する



ユーザをFacebookアカウントで認証するには、まずFacebookアプリの情報を設定しておく必要があります。

Facebook Developersのアプリ一覧にアクセスして、「新しいアプリを作成」をクリックします。Facebookアプリのデベロッパではない人はデベロッパとして登録しておいてください。



アプリを作成した後は、アプリを通じてウェブサイトでFacebook認証を行うための設定を追加します。「Facebookでログインが可能なウェブサイト」の欄に、AWS SDK for JavaScriptを使うサイトのドメインを設定します。



Facebook認証でS3を操作するためのパーミッションを追加する



次に、Facebookアカウントで認証したユーザがS3を扱えるための設定を追加します。IAMの管理画面にアクセスして、左のメニューのRolesをクリックします。

「Create New Role」をクリックすると、ロールを新規作成するためのダイアログが表示されます。ロールの種類を選択するダイアログが表示されるので、新しいロールを作成します。Select Role Typeでは、Role for Web Identity Provider Accessを選択します。次の画面では、認証に利用するIdentityProviderを選択します。「Facebook」を選択して、Application Idの欄では、先ほど作成したFacebookアプリのApp IDを入力します。






次に表示されるポリシーの選択では、Custom Policyを選択します。Policy Nameには適当な名前を入力して、Policy Documentには以下のポリシーを設定してください。(バケット名)には、先ほど作成したS3のバケット名を入れます。

  1. {
  2.   "Version": "2012-10-17",
  3.   "Statement": [
  4.     {
  5.       "Action": [
  6.         "s3:PutObject",
  7.         "s3:PutObjectAcl"
  8.       ],
  9.       "Resource": [
  10.         "arn:aws:s3:::(バケット名)/facebook-${graph.facebook.com:id}/*"
  11.       ],
  12.       "Effect": "Allow"
  13.     }
  14.   ]
  15. }

このポリシーでは、バケット以下に作成したfacebook-(ユーザのfacebookのID)ディレクトリ以下のフォルダにアップロードすることを許可するポリシーです。このポリシーを追加することで、facebookアカウントで認証したユーザが各々アップロードできるディレクトリを隔離できます。

作成したロールのARNも後で使うので確認して下さい。ロールを選択して詳細情報を見るとARNが書いてあります。



JavaScriptを記述する



Facebookアカウントで認証してS3へファイルをアップロードする例が以下になります。

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Facebook認証でのS3アップロード</title>
  6. <script type="text/javascript" src="https://sdk.amazonaws.com/js/aws-sdk-2.0.0-rc1.min.js"></script>
  7. </head>
  8. <body>
  9.  
  10. <h1>Facebook認証でのS3アップロード</h1>
  11.  
  12. <input type="file" id="file-chooser" /> 
  13. <button id="upload-button" style="display: none">Upload to S3</button>
  14. <div id="results"></div>
  15. <div id="fb-root"></div>
  16.  
  17. <script type="text/javascript">
  18. // FacebookアプリのApp ID
  19. var appId = 'xxxxxxxxxxxxxxxxxxxx';
  20.  
  21. // ロールのARN
  22. var roleArn = 'arn:aws:iam::xxxxxxxxxxxx:role/HogeRole';
  23.  
  24. // S3のバケット名
  25. var bucketName = '(バケット名)';
  26.  
  27.  
  28. var fbUserId;
  29. var bucket = new AWS.S3({params: {Bucket: bucketName}});
  30. var button = document.getElementById('upload-button');
  31.  
  32. button.addEventListener('click', function() {
  33.     var fileChooser = document.getElementById('file-chooser');
  34.     var results = document.getElementById('results');
  35.     var file = fileChooser.files[0];
  36.  
  37.     if (file) {
  38.         results.innerHTML = '';
  39.  
  40.         var objKey = 'facebook-' + fbUserId + '/' + file.name;
  41.         var params = {Key: objKey, ContentType: file.type, Body: file, ACL: 'public-read'};
  42.  
  43.         bucket.putObject(params, function (err, data) {
  44.             if (err) {
  45.                 results.innerHTML = 'ERROR: ' + err;
  46.             } else {
  47.                 alert('アップロードされました');
  48.             }
  49.         });
  50.     }
  51. }, false);
  52.  
  53. /*
  54.  * Facebook認証処理
  55.  * https://developers.facebook.com/docs/javascript/gettingstarted/
  56.  */
  57. window.fbAsyncInit = function() {
  58.     FB.init({ appId: appId });
  59.     FB.login(function(response) {
  60.         bucket.config.credentials = new AWS.WebIdentityCredentials({
  61.             ProviderId: 'graph.facebook.com',
  62.             RoleArn: roleArn,
  63.             WebIdentityToken: response.authResponse.accessToken
  64.         });
  65.         fbUserId = response.authResponse.userID;
  66.         button.style.display = 'block';
  67.     });
  68. };
  69.  
  70. // Facebook SDKを読み込む
  71. (function(d, s, id){
  72.     var js, fjs = d.getElementsByTagName(s)[0];
  73.     if (d.getElementById(id)) {return;}
  74.     js = d.createElement(s); js.id = id;
  75.     js.src = "//connect.facebook.net/ja_JP/all.js";
  76.     fjs.parentNode.insertBefore(js, fjs);
  77. }(document, 'script', 'facebook-jssdk'));
  78. </script>
  79. </body>
  80. </html>

このHTMLをfacebookアプリで設定したドメインに設置してアクセスしてください。facebookの認証のためのダイアログが表示され、認証が済むとアップロードフォームが表示されます。このフォームでファイルをアップロードすると、S3のバケットにアップロードされます。アップロードしたファイルは、S3のダッシュボードで確認できます。



埋め込みのクレデンシャルで認証なしでS3を操作する



今度は、Facebookアカウントで認証するのではなく、予め発行したクレデンシャルをウェブページに埋め込んで認証なしでS3を扱う方法を紹介します。

この方法では、ウェブページにクレデンシャルを埋め込む形式のため、秘密にしなければいけないアクセスキーが容易に盗まれてしまいます。従って、一般に公開する用途には向いていません。限られた人だけが利用するバックエンド用のページ内などで使うことを想定してください。

まずIAMの管理画面にアクセスして、ウェブページに埋め込むクレデンシャルのための新しいユーザを作成します。左メニューのUsersをクリックして、Create New Usersをクリックしてください。



適当な名前を入力して、次に進むとユーザとそれに対応するアクセスキーが生成されます。Show User Security Credentialsをクリックして、Access Key IDとSecret Access Keyをメモしておいてください。このユーザの権現を利用したいときには、このアクセスキーが必要となります。



作成したユーザがS3を操作できるパーミッションを追加します。先ほど作成したユーザを選択してPermissions → Attach User PolicyをクリックしてCustom permissionをクリックします。ここでは、以下の様なポリシーを追加します。(バケット名)にはあなたのバケット名を入れてください。

  1. {
  2.   "Version": "2012-10-17",
  3.   "Statement": [
  4.     {
  5.       "Action": [
  6.         "s3:*"
  7.       ],
  8.       "Resource": [
  9.         "arn:aws:s3:::(バケット名)"
  10.       ],
  11.       "Effect": "Allow"
  12.     }
  13.   ]
  14. }

IAMで作成したユーザのARNも後で利用するのでメモしておいてください。



S3の方にもパーミッションの設定があるのでこれも追加します。S3のバケットのPropertiesを開いて、PermissionsからEdit policyを選択すると、そのバケットのポリシーを編集するダイアログが開きます。ここに、先ほど追加したユーザがこのバケットの編集を許可するための設定を追加します。

  1. {
  2.     "Version": "2008-10-17",
  3.     "Statement": [
  4.         {
  5.             "Effect": "Allow",
  6.             "Principal": {
  7.                 "AWS": "(IAMで作成したユーザのARN)"
  8.             },
  9.             "Action": "s3:*",
  10.             "Resource": "arn:aws:s3:::(バケット名)/*"
  11.         }
  12.     ]
  13. }

このポリシーでは、指定したユーザに対して先ほど作成したバケットへのS3の全てのアクションを許可しています。

ようやく準備が整ったのでS3をJavaScriptから扱うコードを記述します。Facebook認証する箇所が無い代わりに、先ほど作成したユーザのクレデンシャルを埋め込んでいることに注意ください。

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>埋め込みクレデンシャルでのS3アップロード</title>
  6. <script type="text/javascript" src="https://sdk.amazonaws.com/js/aws-sdk-2.0.0-rc1.min.js"></script>
  7. </head>
  8. <body>
  9.  
  10. <h1>埋め込みクレデンシャルでのS3アップロード</h1>
  11.  
  12. <input type="file" id="file-chooser" /> 
  13. <button id="upload-button">Upload to S3</button>
  14. <div id="results"></div>
  15.  
  16. <script type="text/javascript">
  17.  
  18. // S3のバケット名
  19. var bucketName = '(バケット名 )';
  20.  
  21. // ユーザ作成時のアクセスキーを設定
  22. AWS.config.update({accessKeyId: '(アクセスキー)', secretAccessKey: '(シークレットアクセスキー)'});
  23.  
  24. var bucket = new AWS.S3({params: {Bucket: bucketName}});
  25.  
  26.  
  27. var button = document.getElementById('upload-button');
  28. button.addEventListener('click', function() {
  29.     var fileChooser = document.getElementById('file-chooser');
  30.     var results = document.getElementById('results');
  31.  
  32.     var file = fileChooser.files[0];
  33.     if (file) {
  34.         results.innerHTML = '';
  35.         
  36.         var objKey = file.name;
  37.         var params = {Key: objKey, ContentType: file.type, Body: file, ACL: 'public-read'};
  38.         
  39.         bucket.putObject(params, function (err, data) {
  40.             if (err) {
  41.                 results.innerHTML = 'ERROR: ' + err;
  42.             } else {
  43.                 var params = {Bucket: bucketName, Key: objKey};
  44.                 bucket.getSignedUrl('getObject', params, function (error, url) {
  45.                     if (error) {
  46.                         alert(error);
  47.                     } else {
  48.                         var html = "<a href='" + url + "'>ファイルがアップロードされました</a>";
  49.                         results.innerHTML += html;
  50.                     }
  51.                 });
  52.             }
  53.         });
  54.     }
  55. }, false);
  56.  
  57. </script>
  58. </body>
  59. </html>

クレデンシャルの埋め込みでは、以下のようにアクセスキーを直接指定しています。IAMで作成したユーザのアクセスキーを指定してください。

  1. AWS.config.update({accessKeyId: 'アクセスキー', secretAccessKey: 'シークレットアクセスキー'});

DynamoDBをJavaScriptから扱う



DynamoDBは、AWS上で利用できる分散NoSQLデータベースです。DynamoDBで扱うデータは、通常のリレーショナルデータベースとは違ってスキーマレスで、事前にテーブルのメンバーを定義しておく必要がありません。さらにDynamoDBに保存したデータは自動的に複数のサーバにレプリケーションされます。

ここでは、まずS3の例と同様にFacebookアカウントで認証してDynamoDBにデータを保存したり取得する例を紹介します。次に埋め込みのクレデンシャルを用いて認証なしでDynamoDBを扱う例を紹介します。

DynamoDBのテーブルを作成する



扱うDynamoDBのテーブルを作成します。DynamoDBでは、保存するデータを分散するためのhashkeyとrangekeyのカラム名を指定できます。hashkeyの値が分散すればするほどデータの取得や保存を効率良く行えます。ここでは、hashkeyにuserid、rangekeyにはcreatedAtを設定します。DynamoDBでは、テーブルのカラムのインデックスをつけたり、処理量を監視するアラートを設定できますが、今回はインデックスやアラートなどのオプションは一切付けずにテーブルを作成します。




Facebook認証でDynamoDBを操作するためのパーミッションを追加する



DynamoDBのテーブルを作成した次は、Facebook認証でDynamoDBを扱うためのパーミッションを設定します。先ほど作成したRoleに新しいPolicyを追加します。DynamoDBのテーブル一覧画面でAccess Controlボタンをクリックすると、Facebook認証でテーブルのパーミッションを追加するためのダイアログが表示されます。




  1. {
  2.   "Version": "2012-10-17",
  3.   "Statement": [{
  4.       "Effect": "Allow",
  5.       "Action": [
  6.         "dynamodb:BatchGetItem",
  7.         "dynamodb:BatchWriteItem",
  8.         "dynamodb:DeleteItem",
  9.         "dynamodb:GetItem",
  10.         "dynamodb:PutItem",
  11.         "dynamodb:Query",
  12.         "dynamodb:UpdateItem"
  13.       ],
  14.       "Resource": ["(作成したDynamoDBのテーブルのARN)"],
  15.       "Condition": {
  16.         "ForAllValues:StringEquals": {
  17.           "dynamodb:LeadingKeys": ["${graph.facebook.com:id}"]}
  18.     }
  19.   }]
  20. }

表示されたポリシーをコピーし、S3のFacebook認証時に使ったロールに対して新しいポリシーを追加します。IAMのダッシュボードから先ほど作成したRoleを選択し、Add attach policyでコピーしたポリシーを登録してください。

JavaScriptでDynamoDBにデータを追加する



JavaScriptからDynamoDBにデータを保存し、リストする例が以下になります。ロールのARNやFacebook App IDやDynamoDBのリージョンには適切な値を入れてください。

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Facebook認証でDynamoDBを操作する</title>
  6. <script type="text/javascript" src="https://sdk.amazonaws.com/js/aws-sdk-2.0.0-rc1.min.js"></script>
  7. </head>
  8. <body>
  9.  
  10. <h1>Facebook認証でDynamoDBを操作する</h1>
  11.  
  12. <button onclick="javascript:add()">+TODO</button>
  13. <div id="TODOList"></div>
  14.  
  15. <script type="text/javascript">
  16.  
  17. // FacebookアプリのApp ID
  18. var appId = 'xxxxxxxxxxxxxxxxxxxx';
  19.  
  20. // ロールのARN
  21. var roleArn = '(ロールのARN)';
  22.  
  23. // DynamoDBのテーブル名
  24. var tableName = '(テーブル名)';
  25.  
  26. // DynamoDBテーブルのリージョン
  27. var region = 'ap-northeast-1';
  28.  
  29.  
  30. var fbUserId;
  31. var table = new AWS.DynamoDB({params: {TableName: 'fuga'}, region: region});
  32.  
  33. function add() {
  34.     var itemParams = {
  35.         Item: {
  36.             userid: {S: fbUserId}, 
  37.             createdAt: {S: '' + new Date().getTime()}, 
  38.             todo: {S: prompt("TODO")}
  39.         }
  40.     };
  41.     table.putItem(itemParams, function(error) {
  42.         if (error) {
  43.             alert("Error: " + error);
  44.         } else {
  45.             alert("追加しました");
  46.             load();
  47.         }
  48.     });
  49. }
  50.  
  51. function load() {
  52.     table.query({
  53.         AttributesToGet : ['todo'],
  54.         KeyConditions:
  55.         {
  56.             userid : {
  57.                 AttributeValueList: [
  58.                     {S: fbUserId, }
  59.                 ],
  60.                 "ComparisonOperator": "EQ"
  61.             }
  62.         }
  63.     }, function(error, data) {
  64.         if (error) {
  65.             alert(error);
  66.         } else {
  67.             var wrapper = document.getElementById('TODOList');
  68.             wrapper.innerHTML = '';
  69.  
  70.             data.Items.map(function(item) {
  71.                 var p = document.createElement('p');
  72.                 p.textContent = item.todo.S;
  73.                 return p;
  74.             }).forEach(function(p) {
  75.                 wrapper.appendChild(p);
  76.             });
  77.         }
  78.     });
  79. }
  80.  
  81. </script>
  82.  
  83. <div id="fb-root"></div>
  84.  
  85. <script type="text/javascript">
  86. /*
  87.  * Facebook認証処理
  88.  * https://developers.facebook.com/docs/javascript/gettingstarted/
  89.  */
  90. window.fbAsyncInit = function() {
  91.     FB.init({ appId: appId });
  92.     FB.login(function(response) {
  93.         table.config.credentials = new AWS.WebIdentityCredentials({
  94.             ProviderId: 'graph.facebook.com',
  95.             RoleArn: roleArn,
  96.             WebIdentityToken: response.authResponse.accessToken
  97.         });
  98.         fbUserId = response.authResponse.userID;
  99.         load();
  100.     });
  101. };
  102.  
  103. // Facebook SDKを読み込む
  104. (function(d, s, id){
  105.     var js, fjs = d.getElementsByTagName(s)[0];
  106.     if (d.getElementById(id)) {return;}
  107.     js = d.createElement(s); js.id = id;
  108.     js.src = "//connect.facebook.net/ja_JP/all.js";
  109.     fjs.parentNode.insertBefore(js, fjs);
  110. }(document, 'script', 'facebook-jssdk'));
  111. </script>
  112. </body>
  113. </html>

埋め込みのクレデンシャルでDynamoDBを扱う



今度は、埋め込みのクレデンシャルを用いてDyanmoDBも操作します。作成したユーザに対して、新しくDynamoDBを扱うためのパーミッションを設定します。ユーザのPermissions → Attach User Policyを選択して以下のポリシーを追加します。

  1. {
  2.   "Version": "2012-10-17",
  3.   "Statement": [
  4.     {
  5.       "Action": [
  6.         "dynamodb:*"
  7.       ],
  8.       "Effect": "Allow",
  9.       "Resource": "*"
  10.     }
  11.   ]
  12. }

このポリシーでは、DynamoDBに関する全ての動作を許可するようになっています。実際に運用する際には、許可するアクションやリソースの指定は厳しく行って下さい。

認証には、facebook認証のためのコードを取り除いて、パーミッションを設定したこのユーザのクレデンシャルをS3の時と同様に以下のように埋め込んでください。

  1. AWS.config.update({accessKeyId: 'アクセスキー', secretAccessKey: 'シークレットアクセスキー'});

終わりに



この記事では、AWS SDK for JavaScriptを使ってS3やDynamoDBを扱う例を紹介しました。

今のところAWS SDK for JavaScriptで利用できるのはAWSの中でもS3やDynamoDBやSNSなどですが、順次利用できるサービスは増えていくものと思われます。

参考