什麼是 Serverless Component

因為 Serverless Component 是基於無服務框架 （Serverless Framework）的，所以在閱讀這篇實踐文章之前，建議先大概瞭解下 serverless 命令的使用，因為下面的案例會使用到。

Serverless Component 的目標是磨平不同雲服務平臺之間差異，你可以將它看作是可以更輕鬆地構建應用程序的依賴模塊。目前 Serverless Component ，已經形成一個由社區貢獻驅動的生態系統，你可以瀏覽和使用社區的所有組件，快速開發一款自己想要的應用。

Serverless Component 工作原理

基於 Serverless Component 架構，你可以將任何雲服務打包成一個組件。這個組件將含有一份 serverless.yml 配置文件，並且通過簡單地進行配置就可以使用。我們拿 @serverless/tencent-express 來舉。

如果我們要使用它，只需要新建一個項目 express-demo，然後修改 serverless.yml 配置如下：

<code>express:
  component: '@serverless/tencent-express'
  inputs:
    region: ap-shanghai/<code>

因為 serverless 框架部署到雲的鑑權都是基於 dotenv 注入全局的變量來實現的，所以還得在根目錄下新增 .env 文件，並配置對應的鑑權參數。

之後我們就可以在 app.js 中輕鬆的編寫基於 express 的接口服務了：

<code>const express = require('express')
const app = express()
app.get('/', function(req, res) {
  res.send('Hello Express')
})
// 不要忘了導出，因為該組件會對它進行包裝，輸出成雲函數 

module.exports = app
/<code>

這背後所有的流程邏輯都是組件內部實現的，包括：雲函數的部署，API網關的生成等。

下面是一張簡單的組件依賴圖：

通過此圖可以清晰地查看組件帶來的收益，藉助社區現有的 @serverless/tencent-express 和 @serverless/tencent-website 組件，我們就可以很快構建想要的全棧應用。

全棧應用實戰

接下來將介紹如何藉助 Serverless Component 快速開發全棧Web應用。

在開始所有步驟前，需執行 npm install -g serverless 命令，全局安裝 serverless cli。

準備

新建項目目錄 fullstack-application-vue，在該項目目錄下新增 api 和 dashboard 目錄。然後新增 serverless.yml 和 .env 配置文件，項目目錄結構如下：

<code>├── README.md       // 項目說明文檔
├── api                   // Restful api 後端服務
├── dashboard           // 前端頁面
├── .env                    // 騰訊雲相關鑑權參數：TENCENT_APP_ID，TENCENT_SECRET_ID，TENCENT_SECRET_KEY
└── serverless.yml  // serverless 文件/<code>

後端服務開發

進入目錄 api，新增 app.js 文件，編寫 express 服務代碼，這裡先新增一個路由 /，並返回當前服務器時間：

<code>const express = require('express');
const cors = require('cors');
const app = express();

app.use(cors());
app.get('/', (req, res) => {
  res.send(JSON.stringfy({ message: `Server time: ${new Date().toString()}` }));
});
module.exports = app;
/<code>

前端頁面開發

本案例使用的是 Vue.js + Parcel 的前端模板，當然你可以使用任何前端項目腳手架，比如 Vue.js 官方推薦的 Vue CLI 生成的項目。進入 dashboard 目錄，靜態資源你可以直接複製我準備好的 項目模板，編寫入口文件 src/index.js:

<code>// 這裡初始是沒有 env.js 模塊的，第一次部署後會自動生成
require('../env');

const Vue = require('vue');

module.exports = new Vue({
  el: '#root',
  data: {
    message: 'Click me!',
    isVisible: true,
  },
  methods: {
    async queryServer() {
      const response = await fetch(window.env.apiUrl);
      const result = await response.json();
      this.message = result.message;
    },
  },
});
/<code>

配置

前後端代碼都準備好了，現在我們還需要簡單配置下 serverless.yml 文件了：

<code>name: fullstack-application-vue

frontend:
  component: '@serverless/tencent-website'
  # inputs 為 @serverless/tencent-website 組件的輸入
  # 具體配置說明參考：https://github.com/serverless-components/tencent-website/blob/master/docs/configure.md
  inputs:
    code:
      src: dist
      root: frontend
      hook: npm run build
    env:
        # 下面的 API服務部署後，獲取對應的 api 請求路徑
      apiUrl: ${api.url}

api:
  component: '@serverless/tencent-express' 

  # inputs 為 @serverless/tencent-express 組件的輸入
  # 具體配置說明參考：https://github.com/serverless-components/tencent-express/blob/master/docs/configure.md
  inputs:
    code: ./api
    functionName: fullstack-vue-api
    apigatewayConf:
      protocol: https/<code>

簡單的介紹下配置：首先，該文件定義了 frontend 和 api 兩個模塊，分別通過 component 屬性指定依賴的 Serverless Component 。對於一個標準的 Serverless Component ，都會接受一個 inputs 屬性參數，然後組件會根據 inputs 的配置進行處理和部署，具體有關配置的參數說明，請參考相關組件的官方配置說明。

部署

以上所有的步驟都完成後，接下來就是第一次部署了。

為什麼不是直接聯調開發呢？因為後端服務是雲函數，但是到目前為止，所有代碼都是在本地編寫，前端頁面接口請求鏈接還不存在。所以需要先將雲函數部署到雲端，才能進行前後端調試。這個也是本人目前遇到的痛點，因為每次修改後端服務後，都需要重新部署，然後進行前端開發調試。如果你有更好的建議，歡迎評論指教~

部署時，只需要運行 serverless 命令就行，當然如果你需要查看部署中的 DEBUG 信息，還需要加上 --debug 參數，如下：

<code>$ serverless
# or
$ serverless --debug/<code>

然後終端會 balabalabala~, 輸出一大堆 DEBUG 信息，最後只需要看到綠色的 done 就行了：

這樣一個基於 Serverless Component 的全棧應用就開發好了。趕緊點擊你部署好的鏈接體驗一下吧~

在線 Demo

數據庫連接

既然是全棧，怎麼少得了數據庫的讀寫呢？接下來介紹如何添加數據庫的讀寫操作。

準備

想要操作數據庫，必須先擁有一臺數據庫實例，騰訊雲Mysql雲數據庫 現在也很便宜，可以購買一個最基本按量計費 1核1G內存 的 1小時收費不到 4 毛錢，是不是非常划算。購買好之後初始化配置，然後新增一個 serverless 數據庫，同時新增一張 users 表：

<code>CREATE TABLE if not exists `test` ( `name` varchar (32) NOT NULL ,`email` varchar (64) NOT NULL ,`site` varchar (128) NOT NULL ) ENGINE = innodb DEFAULT CHARACTER SET = "utf8mb4" COLLATE = "utf8mb4_general_ci"/<code>

前端修改

首先修改前端入口文件 frontend/src/index.js 新增相關函數操作：

<code>require('../env');

const Vue = require('vue');
const axios = require('axios');
module.exports = new Vue({
  el: '#root',
  data: {
    // ...
    form: {
      name: '',
      email: '',
      site: '',
    },
    userList: [],
  },
  methods: {
    // ...
    // 獲取用戶列表 

    async getUsers() {
      const res = await axios.get(window.env.apiUrl + 'users');
      this.userList = res.data && res.data.data || [];
    },
    // 新增一個用戶
    async addUser() {
      const data = this.form;
      const res = await axios.post(window.env.apiUrl + 'users', data);
      console.log(res);
      if (res.data) {
        this.getUsers();
      }
    },
  },
  mounted() {
    // 視圖掛在後，獲取用戶列表
    this.getUsers();
  }
});
/<code>

當然你還需要修改視圖模板文件 frontend/index.html，在頁面模板中新增用戶列表和用戶表單：

<code>

  

    <label>
      Name:
    /<label>
    

  

  

    <label>
      Email:
    /<label>
    

  

   

    <label>
      Site:
    /<label>
    

  

  <button>Submit/<button>
/



  

    

      

        Name: {{ item.name }}
        Email: {{ item.email }}
        Site: {{ item.site }}
      

    

  

  No Data
//<code>

注意：如果還不熟悉 Vue.js 語法，請移至 官方文檔，當然如果你想快速上手 Vue.js 開發，也可以閱讀這份 Vue 從入門到精通 教程。

後端修改

這裡使用 .env 來進行數據庫連接參數配置，在 api 目錄下新增 .env 文件，將之前的數據庫配置填入文件中，參考 api/.env.example 文件。然後添加並安裝 dotenv 依賴，同時添加 mysql2 模塊進行數據庫操作，body-parser 模塊進行 POST 請求時的 body 解析。

之後新增後端api，進行數據庫讀寫，修改後的 api/app.js 代碼如下：

<code>'use strict';
require('dotenv').config();
const express = require('express');
const cors = require('cors');
const mysql = require('mysql2');
const bodyParser = require('body-parser');

// init mysql connection
function initMysqlPool() {
  const { DB_HOST, DB_PORT, DB_DATABASE, DB_USER, DB_PASSWORD } = process.env;

  const promisePool = mysql
    .createPool({
      host: DB_HOST,
      user: DB_USER,
      port: DB_PORT,
      password: DB_PASSWORD,
      database: DB_DATABASE,
      connectionLimit: 1,
    })
    .promise();

  return promisePool;
}

const app = express();
app.use(bodyParser.json());
app.use(cors());

if (!app.promisePool) {
  app.promisePool = initMysqlPool();
}

app.get('/', (req, res) => {
  res.send(JSON.stringify({ message: `Server time: ${new Date().toString()}` }));
});

// get user list
app.get('/users', async (req, res) => {
  const [data] = await app.promisePool.query('select * from users');
  res.send(
    JSON.stringify({
      data: data,
    }),
  ); 

});

// add new user
app.post('/users', async (req, res) => {
  let result = '';
  try {
    const { name, email, site } = req.body;
    const [res] = await app.promisePool.query('INSERT into users SET ?', {
      name: name,
      email: email,
      site: site,
    });
    result = {
      data: res && res.insertId,
      message: 'Insert Success',
    };
  } catch (e) {
    result = {
      data: e,
      message: 'Insert Fail',
    };
  }

  res.send(JSON.stringify(result));
});

module.exports = app;
/<code>

配置修改

這裡數據庫訪問需要通過騰訊雲私有網絡，所以還需要為雲函數配置私有網絡（VPC），同時還需要配置能夠操作數據庫的角色（關於角色配置，可以直接到 角色管理頁面），這裡我新建了一個 QCS_SCFFull 的角色，可以用來訪問數據庫。然後修改 serverless.yml 中的配置：

<code># ...
api:
  component: '@serverless/tencent-express'
  # more configuration for @serverless/tencent-website,
  # refer to: https://github.com/serverless-components/tencent-express/blob/master/docs/configure.md
  inputs: 

    code: ./api
    functionName: fullstack-vue-api
    role: QCS_SCFFull # 此角色必須具備訪問數據庫權限
    functionConf:
      # 這個是用來訪問新創建數據庫的私有網絡，可以在你的數據庫實例管理頁面查看
      vpcConfig:
          vpcId: vpc-6n5x55kb
          subnetId: subnet-4cvr91js
    apigatewayConf:
      protocol: https/<code>

最後重新部署一下就行了。

總結

當然全棧方案，並沒有這麼簡單，這裡只是簡單介紹，如何使用 Serverless Component ，快速實現一個全棧應用。如果要應用到實際的業務場景，我們還需考慮更多的問題。而且目前社區組件還不夠完善，很多功能還需要我們自己去探索發現。也希望更多牛人加入到 Serverless Component 社區，貢獻更多的優秀組件。

閱讀更多 Serverless 的文章

關鍵字: 美好，一直在身邊 雲計算 Dashboard