AWS Serverless RESTful API

AWS Serverless RESTful APIs


This site is Serverless.

近幾年在雲架構上討論熱度較高的 2 大主題分別是 容器化（Containerize）與 無伺服器（Serverless）架構。本篇文章會帶你瞭解什麼是 AWS 無伺服器架構，以及如何使用 Serverless Framework 這個框架，快速開發 RESTful APIs。

大綱

  1. 什麼是 XaaS？
  2. AWS 無伺服器架構
  3. Serverless Framework
    1. CRUDable Service
    2. 基礎設施即程式碼

什麼是 XaaS？

馬雲說過一句話：「過去的一百年，我們把人變成了機器，未來的一百年，我們將會把機器變成人。」

人算不如天算，天算就是雲計算。
人算不如天算，天算就是雲計算。

如果要用一句話來定義 XaaS（X as a Service）的話，那就是「萬物皆服務」。
舉凡 IaaS（基礎設施及服務）、PaaS（平台即服務）或 SaaS（軟體即服務）等⋯⋯，用一張圖來概括各個 XaaS 的關係：



身為程式設計師，我們就是那個負責寫服務來取代人類的存在。
所以能夠以最快速度開發出可驗證的服務原型，就成了開發者彼此之間的競爭條件之一，也是本篇文章的目的。

AWS 無伺服器架構

AWS 是目前雲技術的領頭羊，如果想要用 AWS 來開發 Serverless 的 RESTful APIs，主要會由 3 個核心服務所構成：
  1. AWS Lambda（Functions as a Service）
  2. Amazon API Gateway（REST API Endpoint as a Service）
  3. Amazon DynamoDB（NoSQL DB as a Service）

利用 3 個 XaaS 組成一個 BaaS（後端即服務）
利用 3 個 XaaS 組成一個 BaaS（後端即服務）

這裡不會贅述如何操作這些 AWS 服務，如果你已經熟悉這些服務，可以直接前往下一章的 Serverless Framework；如果還不知道它們是怎麼運作的，強烈建議先跑過一遍官方的幾篇教學與實作，理解這 3 個傢伙為什麼這麼酷，也才能理解為什麼接下來要介紹的 Serverless Framework 比它們更酷！
  1. 無伺服器運算和應用程式
  2. Build a Serverless Web Application

Serverless Framework

接下來進入本篇文章的重點，如果每次建立 REST API 都需要手動操作 Lambda、API Gateway 和 DynamoDB 這些服務的話就太麻煩了，所以這裡介紹一個第三方社群維護的框架：Serverless Framework。


Serverless Framework 提供了一整套專為「無伺服器架構」所設計的開發＆部署工具，除了 AWS 之外還支援了 Google Cloud Platform 和 Microsoft Azure 等雲服務平台，讓開發者只需專注在 Web、Mobile 和 IoT 應用的核心功能，而無需煩惱基礎設施的維護。
先來跑一遍官方的快速入門暖暖身，首先安裝 Serverless 的 CLI：
$ npm install serverless --global
注意：因為 Serverless CLI 會透過 AWS SDK 間接操作你的 AWS 帳戶，所以在開始之前，請先確認本機端已經配置完 AWS 的 credential，詳細設定方法可以參考官方文件的《Credentials》。
新增一個 Node.js 環境的專案 hello-service：
$ serverless create --template aws-nodejs --path hello-service
Serverless 會幫你建立了一個基本的 Lambda Function hello：
module.exports.hello = (event, context, callback) => {
  const response = {
    statusCode: 200,
    body: JSON.stringify({
      message: 'Go Serverless v1.0! Your function executed successfully!',
      input: event,
    }),
  };

  callback(null, response);
};
部署 Lambda Function 至 AWS：
$ serverless deploy --verbose
--verbose 顯示部署過程的細節。
如果每次都需要重新部署所有 Lambda Function 會很沒效率，Serverless 也可以只部署單個 Lambda Function：
$ serverless deploy function --function hello
--function 指定 Lambda Function 的名稱。
部署完成之後，使用 invoke 執行 Lambda Function：
$ serverless invoke --function hello --log
--log 顯示執行回傳的結果。
{
    "statusCode": 200,
    "body": "{\"message\":\"Go Serverless v1.0! Your function executed successfully!\",\"input\":{}}"
}
CLI 也可以使用 logs 和 --tail 來持續監控 Lambda Function 的執行結果：
$ serverless logs --function hello --tail
瞭解整個 Serverless 的運作方式之後，CLI 還有提供 remove 指令，讓你可以將整個專案從 AWS 帳戶移除，畢竟佔用這些資源是要計費的：
$ serverless remove

CRUDable Service

瞭解 Serverless Framework 如何輕易地部署 Lambda Function 之後，我們來看看 Serverless Framework 如何開發一套完整、可以 CRUD 資料庫的 REST API 服務。
下載 Serverless 社群寫好的 To-do CRUD 範例：
$ serverless install --url https://github.com/pmuens/serverless-crud
注意：因為這個範例有用到其它第三方的 npm packages，所以部署前記得先 npm install 安裝。
部署 To-do service 至 AWS：
$ serverless deploy --verbose
部署完成之後，CLI 會顯示你的 API Gateway endpoints：
...

endpoints:
  POST - https://18055egsjj.execute-api.us-east-1.amazonaws.com/dev/todos
  GET - https://18055egsjj.execute-api.us-east-1.amazonaws.com/dev/todos
  GET - https://18055egsjj.execute-api.us-east-1.amazonaws.com/dev/todos/{id}
  PUT - https://18055egsjj.execute-api.us-east-1.amazonaws.com/dev/todos/{id}
  DELETE - https://18055egsjj.execute-api.us-east-1.amazonaws.com/dev/todos/{id}

...

Read All To-dos

使用 cURL 或 HTTPie 之類的 HTTP client 來測試結果，首先是取得所有 to-dos：
$ http GET https://18055egsjj.execute-api.us-east-1.amazonaws.com/dev/todos
沒意外的話，會回傳空的 To-do 陣列：
HTTP 200 OK

[]
打開程式碼，Read all to-dos 的 Lambda Function 很簡單，透過 AWS SDK 的 DynamoDB scan API 來取得所有 todos table 的 items：
// todos-read-all.js

const AWS = require('aws-sdk');
const dynamoDb = new AWS.DynamoDB.DocumentClient();

module.exports = (event, callback) => {
  const params = {
    TableName: 'todos',
  };

  return dynamoDb.scan(params, (error, data) => {
    if (error) {
      callback(error);
    }
    callback(error, data.Items);
  });
};

Create To-do

接著我們試著新增一筆 to-do：
$ http POST https://<省略>/todos body="Hodor"
新增成功並回傳一筆包含 id、body 和 updateAt 欄位的 to-do item：
HTTP 200 OK

{
    "body": "Hodor",
    "id": "1b691310-a0e7-11e7-b1c4-1d790783726f",
    "updatedAt": 1506230011585
}
Create 的 Lambda Function 也很好懂，透過 UUID 以及 DynamoDB 的 put API 新增一筆 to-do item：
// todos-create.js

...
const uuid = require('uuid');

module.exports = (event, callback) => {
  const data = JSON.parse(event.body);

  data.id = uuid.v1();
  data.updatedAt = new Date().getTime();

  const params = {
    TableName: 'todos',
    Item: data
  };

  return dynamoDb.put(params, (error, data) => {
    if (error) {
      callback(error);
    }
    callback(error, params.Item);
  });
};

Read One To-do

接著我們試著讀取剛才新增的 id 為 1b691310-a0e7-11e7-b1c4-1d790783726f 的 to-do：
$ http GET https://<省略>/todos/1b691310-a0e7-11e7-b1c4-1d790783726f

HTTP 200 OK

{
    "body": "Hodor",
    "id": "1b691310-a0e7-11e7-b1c4-1d790783726f",
    "updatedAt": 1506230011585
}
這裡要注意，DynamoDB 讀取所有 items 所使用 API 是 scan，讀取單筆 item 的 API 是 get：
// todos-read-one.js

...

module.exports = (event, callback) => {
  const params = {
    TableName: 'todos',
    Key: {
      // 透過 event.pathParameters 來取得 URL 的 todo item id
      id: event.pathParameters.id
    }
  };

  return dynamoDb.get(params, (error, data) => {
    if (error) {
      callback(error);
    }
    callback(error, data.Item);
  });
};

Update To-do

更新已經存在的單筆 to-do：
$ http PUT https://<省略>/todos/1b691310-a0e7-11e7-b1c4-1d790783726f body="Hold The Door"

HTTP 200 OK

{
    "body": "Hold The Door",
    "id": "1b691310-a0e7-11e7-b1c4-1d790783726f",
    "updatedAt": 1506230311609
}
更新 DynamoDB item 的程式碼基本上與新增的方式差不多：
// todos-update.js

...

module.exports = (event, callback) => {
  const data = JSON.parse(event.body);

  data.id = event.pathParameters.id;
  data.updatedAt = new Date().getTime();

  const params = {
    TableName : 'todos',
    Item: data
  };

  return dynamoDb.put(params, (error, data) => {
    if (error) {
      callback(error);
    }
    callback(error, params.Item);
  });
};

Delete To-do

最後剩下刪除已存在的單筆 to-do：
$ http DELETE https://<省略>/todos/1b691310-a0e7-11e7-b1c4-1d790783726f

HTTP 200 OK

{
    "id": "1b691310-a0e7-11e7-b1c4-1d790783726f"
}
刪除的 Lambda Function 程式碼：
// todos-delete.js

...

module.exports = (event, callback) => {
  const params = {
    TableName : 'todos',
    Key: {
      id: event.pathParameters.id
    }
  };

  return dynamoDb.delete(params, (error, data) => {
    if (error) {
      callback(error);
    }
    callback(error, params.Key);
  });
};

基礎設施即程式碼

跑完上面的 to-do services 之後有沒有感到很神奇呢？竟然一個 serverless deploy 指令，就可以把原本需要手動配置的所有 AWS 基礎服務都自動建立好了，這是因為 Serverless Framework 用到了 AWS CloudFormation 這個服務。


我們先打開 serverless.yml 這個檔案來看看 Lambda Function 和 API Gateway 的配置：
functions:
  create:
    ...
  readAll:
    ...
  readOne:
    handler: handler.readOne
    events:
      - http:
          path: todos/{id}
          method: get
          ...
  update:
    ...
  delete:
    ...
DynamoDB 的設定：
resources:
  Resources:
    TodosDynamoDbTable:
      ...
      Properties:
        AttributeDefinitions:
          -
            AttributeName: id
            AttributeType: S
        KeySchema:
          -
            AttributeName: id
        ...
        TableName: 'todos'
這就是 Infrastructure as a Code（基礎設施即程式碼）的威力，它的好處：
  • 隨地配置：直接使用程式碼控制你的基礎設施資源，忘記那些繁瑣的操作流程
  • 易於維護：因為程式碼可以上版本控制，所以可以多人共同維護一份基礎設施
  • 持續交付：因為可以進版本控制，所以更容易整合進 CI/CD 的自動化流程

結論

  1. XaaS（萬物皆服務）是未來的趨勢，而服務的本質就是 API，誰能夠越快地開發出原型、越有機會成功
  2. 如果要用 AWS 的無伺服器架構來開發 REST API，核心服務分別是 Lambda、API Gateway 和 DynamoDB
  3. Serverless Framework 利用「基礎設施即程式碼」的概念，讓開發者可以更迅速地在 AWS 上建立一套可維護的 CRUD RESTful API Services

參考文章

留言

張貼留言

這個網誌中的熱門文章

COSCUP 2012

今年很幸運的有搶到入場資格，這也是小弟第一次參加 COSCUP ，趁現在剛結束滿腔熱血的狀態下來寫篇心得文。 今年 COSCUP 一共有兩天的行程，在中研院人文館舉辦，每個時段都有 3~4 場的分享，不過常常碰到某個時段三場都想聽，也常常碰到某個時段的題目都沒興趣...orz Day1 第一天忘了做筆記，只好憑記憶跟拿些圖來湊一湊 我的專屬識別證唷>.^ 早上第一場是微軟傳教士分享的 Windows Azure 感覺還不錯，而且有繁體中文的介面。 第二場我去聽了 Fred 的 Nodee.js OS，不過我覺得他自己改的 Linux 比較炫。 第三場請到 Penk 大大來 demo 他的平板 UI，印象深刻的一句話是 科技業是唯一比女行時尚還追求時尚的行業 我的解讀是幹這行每天都在學新技術 囧.. 第四場超讚，講者 demo 他用 javascript 寫的超任模擬器，眼淚都快飆出來了，而且老師很幽默: 目前國外有人正在研究如何用 javascript 寫出一個超任模擬器，如果他成功，那會是全世界第三個，因為前面兩個被我寫出來了XDDD 接下來的下午場雖然都有去聽，可是比較沒有什麼印象的點，只記得最後閃電秀的大大們XD，你們實在太讚了! Day2 難得有位置，明明很晚到... 第一場請到廣達的 Ted 先生，本來以為會很無聊，但從頭聽到尾，學到蠻多東西的: 研發的目的 1.不想被外界surprise 2.想給外界surprise   不相信外星人就無法創造飛行車   要把複雜的東西變簡單其實是最不簡單的   設計一個你最討厭的東西 試著把它做好 第二場去聽 Tool Objects in jQuery，主要重點: 用 Queue 取代巢狀 Callback Deferred 可以看做是 Call by future  $.when 可以用來管理複數非同步的結果  pipe 跟 when 的關係可以看作串聯與並聯 一些 Callback 常用的 function: add fire once memory unique stopOnFalse differed 第三場的場次是我最掙扎的，有Heroku，有Emacs，有Twitter Bootstrap，還有手
閱讀完整內容

Hahow 為什麼沒有 iOS App

圖片
大綱 前言 Hahow 為什麼沒有 iOS App？ 為什麼有了「App 內購買」還是被拒絕？ 為什麼 Hahow 要使用「消耗型項目」IAP？ 為什麼 Udemy 可以使用「消耗型項目」IAP？ Hahow iOS App 接下來的計畫？ 結語 前言 最近看到一篇 The Verge 報導 ，Apple 的律師要求 App Store 的前任經理停止發行《App Store Confidential》這本書，因為此書透露了「重大的商業機密」，違反了員工與公司簽訂的合約。 但是此書的作者 Sadowski 表示，這本書的很多內容其實是大家都知道的，例如：應用程式必須將使用者轉化為 Apple 的 付費客戶。 來源 appleinsider 眾所周知，Apple 的 App Store 平台審核機制封閉，很多東西是他們說的算。 作為一位曾經參與 Hahow App 的開發人員，看到這一篇報導感觸很深，滿肚子苦水不吐不快。 許多 Hahow 的使用者常常詢問，為什麼 Android 的 App 已經上架這麼久了，iOS App 卻還看不見影呢？ https://hahow.app Hahow 為什麼沒有 iOS App？ 其實 iOS App 一直都是與 Android App 同步開發的。 最早可以回朔到 2017 年 10 月，當初 Web 使用者不斷反應，希望可以在手機上，下載 Hahow 的課程，方便通勤時間也能離線觀看。 於是我自己利用公司讀書會的機會，嘗試使用 React Native 開發了一個 Hahow App 的原型（Prototype），簡單演示了「下載離線觀看」和「通知」兩個手機上才能做到的功能。 Prototype 讀書會簡報 也因此，成功說服了幾位頭頭，於 2018 年 2 月正式投入開發 Hahow App。 並於 2018 年 6 月，順利在 Google Play 上架 Android App。 有關於我們如何用 Expo 這個 React Native SDK 開發 App、踩過哪些坑，以及專案的 Scrum 怎麼跑之類的，會再另外找時間分享一篇《Hahow 如何開發 Android App》文章，這裡就先不多贅述。 Go
閱讀完整內容

swfobject - 網頁輕鬆嵌入Flash

Flash在網頁上的應用已經越來越普遍了，未來一樣占有一席之位，但是從以前到現在，對於發佈Flash到網頁上常常碰到一些不必要的問題，例如XP SP2更新後，IE瀏覽器上方會出現檔掉的訊息，或是Flash外框出現虛線，需要滑鼠點一下才能開始動作等...，而且使用者並未安裝Flash Player的情況下或版本太低都會無法順利的瀏覽。 最近剛好看到一個不錯的東西，就是這次要介紹的swfobject，一般我們要嵌入swf到HTML時，通常會寫的語法如下: < object id ="FlashID" classid ="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" width ="300" height ="120" > < param name ="movie" value ="test.swf" /> < param name ="quality" value ="high" /> < param name ="wmode" value ="opaque" /> < param name ="swfversion" value ="6.0.65.0" /> </ object > 上面的程式碼使用到<object>標籤，早一點的甚至還要再寫<embed>才能動作，因為IE跟其他瀏覽器的種種原因，使得這種寫法不但又臭又長，也不符合標準。 那使用swfobject有什麼好處呢?我們繼續看下去吧。 首先我們得先去swfobject的網頁 http://code.google.com/p/swfobject/ ，然後下載目前的最新版本 swfobject_2_2.zip 。
閱讀完整內容