利用 Vely 在 Linux 構建你自己的 SaaS
Vely 將 C 語言的高性能和低內存占用與 PHP 等語言的易用性和安全性相結合。作為自由開源軟件，它以 GPLv3 和 LGPL 3 授權，所以你甚至可以用它來構建商業軟件。
利用 Vely 構建 SaaS
你可以使用 Vely 創建一個多租戶網絡應用程序，它可以作為軟件即服務模式（SaaS）在互聯網上運行。每個用戶都有一個完全獨立的數據空間。
在這個網絡應用程序示例中，用戶可以注冊一個筆記本服務來創建筆記，然后查看和刪除它們。它僅用了 7 個源文件，310 行代碼，就展示了如何集成多項技術:
- MariaDB
- 網絡瀏覽器
- Apache
- Unix 套接字
運作原理
以下是從用戶的角度來看應用程序是如何工作的。下圖是代碼演示。
該應用允許用戶通過指定電子郵件地址和密碼創建新的登錄名。你可以用任何你喜歡的方式設置它們，例如運用 CSS：
創建一個用戶賬戶
驗證用戶的電子郵件:
驗證用戶的電子郵件地址
每個用戶使用自己獨有的用戶名和密碼登錄：
用戶登錄
一旦登錄，用戶就可以添加筆記：
用戶可以添加筆記
用戶可以獲取筆記列表：
用戶列舉筆記
刪除筆記之前，應用會申請確認信息：
刪除筆記之前，應用會申請確認信息
用戶確認后，筆記被刪除：
用戶確認后，筆記被刪除
設置先決條件
遵照 Vely.dev 上的安裝指示。這是一個使用 DNF、APT、Pacman 或者 Zypper 等標準工具包的快速流程。
由于它們都是這個范例的一部分，你必須安裝 Apache 作為網絡服務器，安裝 MariaDB 作為數據庫。
安裝 Vely 后，如使用 Vim，打開里面的“語法高亮顯示”：
vv -m獲取源代碼
這個演示 SaaS 應用程序的源代碼是 Vely 安裝的一部分。為每個應用程序創建一個單獨的源代碼目錄不失為一個好主意（而且你可以按自己喜好命名）。在這種情況下，解包源代碼會幫你完成這些工作:
$ tar xvf $(vv -o)/examples/multitenant_SaaS.tar.gz
$ cd multitenant_SaaS默認情況下，該應用程序以 multitenant_SaaS 命名，但你可以將其命名為任何內容（如果這么做，其他每個地方你都需要改一下）。
創建應用程序
第一步是創建一個應用程序。使用 Vely 的 vf 工具就可以輕松完成：
$ sudo vf -i-u $(whoami) multitenant_SaaS這個命令創建了一個新的應用程序主目錄（/var/lib/vv/multitenant_SaaS），并幫你執行應用程序設置。通常，這意味著在該主目錄中創建各種子目錄并分配權限。在這種情況下，只有當前用戶（whoami 的結果）擁有目錄，具有 0700 權限，這確保了其他人沒有訪問文件的權限。
創建數據庫
在你鍵入任何代碼之前，你需要一個能夠存儲該應用程序所用信息的空間。首先，創建一個名為 db_multitenant_SaaS 的 MariaDB 數據庫，由用戶名為 vely 的用戶所有，密碼為 your_password 。你可以修改剛才提到的任何值，但得記住，在這個示例里，你需要將包含這些內容的每個地方都得修改一遍。
在 MySQL 中以 root 身份登錄：
create database if not exists db_multitenant_SaaS;
create user if not exists vely identified by 'your_password';
grant create,alter,drop,select,insert,delete,update on db_multitenant_SaaS.* to vely;然后在數據庫內創建數據庫對象（表，記錄等等）：
use db_multitenant_SaaS;
source setup.sql;
exit將 Vely 連接至數據庫
為了讓 Vely 知曉你數據庫的位置以及如何登錄進去，創建一個名為 db_multitenant_SaaS 的數據庫配置文件。（該名稱用于在源代碼中的數據庫聲明，所以如果你改了它，確保在它存在的每個地方都改一遍。）
Vely 使用原生的 MariaDB 數據庫連接，因此你可以指定給定的數據庫所能允許的任何選項:
$ echo '[client]
user=vely
password=your_password
database=db_multitenant_SaaS
protocol=TCP
host=127.0.0.1
port=3306' > db_multitenant_SaaS構建應用程序
使用 vv 工具構建應用程序，利用 --db 選項指定 MariaDB 數據庫和數據庫配置文件：
$ vv -q--db=mariadb:db_multitenant_SaaS啟用應用服務器
啟動你的網絡應用程序的服務器，需要使用 vf FastCGI 進程管理器。應用程序服務器使用 Unix 套接字與網絡服務器（創建反向代理）通信：
$ vf -w3 multitenant_SaaS這么做會啟用三個守護進程，為接收到的請求提供服務。你也可以啟動一個自適應服務器，它會增加進程的數量從而服務更多的請求，并在不需要他們時減少進程的數量：
$ vf multitenant_SaaS請參閱 vf 了解更多選項，以幫助你實現最佳性能。
當你需要停止你的應用程序服務器，使用 -m quit 選項：
$ vf -m quit multitenant_SaaS創建網絡服務器
這是一個網絡應用程序，那么應用程序就得需要一個網絡服務器。該示例通過一個 Unix 套接字監聽器使用 Apache。
1、設置 Apache
將 Apache 配置為一個反向代理，并將你的應用程序與之連接，你需要啟用 FastCGI 代理支持，這通常使用 proxy 和 proxy_fcgi 模塊。
對于 Fedora 系統（或者其它的，比如 Arch）來說，通過在 Apache 配置文件 /etc/httpd/conf/httpd.conf 中添加（或取消注釋）適當的 LoadModule 指令，就可啟用 proxy 和 proxy_fcgi 模塊。
以下指令適用于 Debian，Ubuntu 以及類似的系統，啟用 proxy 和 proxy_fcgi 模塊：
$ sudo a2enmod proxy
$ sudo a2enmod proxy_fcgi以下指令適用于 OpenSUSE，將這幾行添加在 /etc/apache2/httpd.conf 結尾處：
LoadModule proxy_module modules/mod_proxy.so
LoadModule proxy_fcgi_module modules/mod_proxy_fcgi.so2、配置 Apache
現在你必須將代理信息添加在 Apache 的配置文件中：
ProxyPass "/multitenant_SaaS" unix:///var/lib/vv/multitenant_SaaS/sock/sock|fcgi://localhost/multitenant_SaaS你的配置文件的位置可能會有所不同，這取決于不同的 Linux 發行版：
- Fedora、CentOS、Mageia 和 Arch：
/etc/httpd/conf/httpd.conf - Debian、Ubuntu、Mint：
/etc/apache2/apache2.conf - OpenSUSE：
/etc/apache2/httpd.conf
3、重新啟動
最后，重啟 Apache。在 Fedora 和類似系統，還有 Arch Linux 是如下指令：
$ sudo systemctl restart httpd在 Debian 和基于 Debian 的系統，還有 OpenSUSE 是如下指令：
$ sudo systemctl restart apache2設置本地郵箱
這個示例中，電子郵件是其功能的一部分。如果你的服務器已經可以發送電子郵件了，你可以跳過這一條。此外，你可以使用本地郵箱（myuser@localhost）來測試它。要做到這一點，需安裝 Sendmail。
在 Fedora 和類似系統中是如下指令：
$ sudo dnf installsendmail
$ sudo systemctl start sendmail而在 Debian 和類似系統（如 Ubuntu）：
$ sudo apt installsendmail
$ sudo systemctl start sendmail當應用程序向本地用戶發送電子郵件，比如說 OS_user@localhost，你就可以通過查看 /var/mail/ 處（即所謂“郵件池”）來確認電子郵件是否被發送。
從瀏覽器訪問應用服務器
假設你在本地運行該應用，可以通過使用 http://127.0.0.1/multitenant_SaaS?req=notes&action=begin 域名從你的網絡服務器訪問你的應用服務器。如果你在互聯網上的在線服務器運行該程序，你可能就需要調整防火墻設置以允許 HTTP 通信。
源代碼
該應用程序示例包含 7 個源文件。你可以自行回顧代碼（記住，這些文件只有 310 行代碼），下面是每個文件的概述。
SQL 設置（setup.sql）
創建的兩個表：
users：每個用戶的信息。在users表中，每個用戶都有自己唯一的 ID （userId列），以及其他信息，如電子郵件地址和該地址是否通過了驗證。還有一個哈希密碼。實際的密碼永遠不會存儲在純文本（或其他形式）中，單向哈希用于檢查密碼。notes：用戶輸入的筆記。notes表包含了所有的筆記，每個筆記都有一個userId列，表示哪個用戶擁有它們。userId列的值與users表中的同名列匹配。這樣，每個筆記顯然都屬于單個用戶。
該文件內容如下：
create table if not exists notes (dateOf datetime, noteId bigint auto_increment primary key, userId bigint, note varchar(1000));
create table if not exists users (userId bigint auto_increment primary key, email varchar(100), hashed_pwd varchar(100), verified smallint, verify_token varchar(30), session varchar(100));
create unique index if not exists users1 on users (email);運行時數據（login.h）
為了正確地顯示登錄、注冊和注銷鏈接，你需要一些在應用程序中任何地方都可以使用的標志。此外，應用程序使用 cookie 來維護會話，因此它需要在任何地方都可用，例如，驗證會話是否有效。發送到應用程序的每個請求都以這種方式進行確認。只有帶有可驗證 cookie 的請求是允許的。
所以要做到這種效果，你需要有一個 global_request_data 類型的 reqdata（請求數據），其中包含 sess_userId（用戶的 ID）以及 sess_id（用戶目前的會話 ID）。此外，還有一些不言自明的標志，可以幫助渲染頁面：
#ifndef _VV_LOGIN
#define _VV_LOGIN
typedef struct s_reqdata {
bool displayed_logout; // true 則顯示登出連接
bool is_logged_in; // true 則會話已驗證登錄
char *sess_userId; // 目前會話的用戶 ID
char *sess_id; // 會話 ID
} reqdata;
void login_or_signup ();
#endif會話檢查和會話數據（_before.vely）
Vely 里有一個 請求前處理程序before_request handler 的概念。你寫的代碼會在其它處理請求的代碼之前執行的。要達到這個目的，你只需要將這樣的代碼寫在名為 _before.vely 的文件中，然后剩余的部分將會自動處理。
SaaS 應用程序所作的任何事情，例如處理發送至應用程序的請求，必須驗證其安全性。這樣，應用程序就能知曉調用方是否有執行操作所需要的權限。
在這里，通過請求前處理程序進行權限檢查。這樣，無論其他代碼如何處理請求，都已經掌握了會話信息。
為保持會話數據（比如會話 ID 和用戶 ID）在你代碼中的任何地方都可用，你可以使用 global_request_data。它只是一個指向內存的通用指針（void*），任何處理請求的代碼都可以訪問它。這非常適合處理會話，如下所示:
#include "vely.h"
#include "login.h"
// _before() 是一個請求前處理程序。
// 它總是在處理請求的其他代碼之前執行。
// 對于任何類型的請求范圍設置或數據初始化，它都是一個很好的位置。
void _before() {
// 輸出 HTTP 請求頭
out-header default
reqdata *rd; // 這是全局請求數據，見 login.h
// 為全局請求數據分配內存，
// 將在請求結束時自動釋放
new-mem rd size sizeof(reqdata)
// 初始化標志
rd->displayed_logout = false;
rd->is_logged_in = false;
// 將我們創建的數據設置為全局請求數據，
// 可以從任何處理請求的代碼中訪問
set-req data rd
// 檢查會話是否存在（基于來自客戶端的 cookie）
// 這在任何其他請求處理代碼之前執行，
// 使其更容易準備好會話信息
_check_session ();
}檢查會話是否有效（_check_session.vely）
多租戶 SaaS 應用程序中最重要的任務之一就是通過檢查用戶是否登錄來（盡快）檢查會話是否有效。這是通過從客戶端（例如網絡瀏覽器）獲取會話 ID 和用戶 ID 的 cookie，并將它們與存儲會話的數據庫進行比較來實現的：
#include "vely.h"
#include "login.h"
// 檢查會話是否有效
void _check_session () {
// 獲取全局請求數據
reqdata *rd;
get-req data to rd
// 自用戶瀏覽器獲取 cookies
get-cookie rd->sess_userId="sess_userId"
get-cookie rd->sess_id="sess_id"
if (rd->sess_id[0] != 0) {
// 檢查給定用戶 ID 下的會話 ID 是否正確
char *email;
run-query @db_multitenant_SaaS = "select email from users where userId='%s' and session='%s'" output email : rd->sess_userId, rd->sess_id row-count define rcount
query-result email to email
end-query
if (rcount == 1) {
// 如果正確，設置登錄標志
rd->is_logged_in = true;
// 如果登出鏈接不顯示，則顯示它
if (rd->displayed_logout == false) {
@Hi <<p-out email>>! <a >Logout</a><br/>
rd->displayed_logout = true;
}
} else rd->is_logged_in = false;
}
}注冊、登錄、登出（login.vely）
任何多租戶系統的基礎便是具有用戶注冊\登錄和登出的功能。通常情況下，注冊包括驗證電子郵件地址；不止于此，同一電子郵件地址會作為一個用戶名。這里就是這種情況。
這里實現了幾個執行該功能所必須的子請求：
- 注冊新用戶時，顯示 HTML 表單以收集信息。它的 URL 請求簽名是
req=login&action=newuser。 - 作為對注冊表單的響應，創建一個新用戶。URL 請求的簽名是
req=login&action=createuser。輸入參數（input-param）信號獲取email和pwd的 POST 表單字段。密碼值是單向散列，電子郵件驗證令牌是一個隨機的 5 位數字。這些被插入到users表中，創建一個新用戶。系統會發送一封驗證郵件，并提示用戶閱讀郵件并輸入代碼。 - 通過輸入發送到該電子郵件的驗證碼來驗證電子郵件。URL 請求的簽名是
req=login&action=verify。 - 顯示一個登錄表單，讓用戶登錄。URL 請求的簽名是
req=login（例如，action為空）。 - 通過驗證電子郵件地址（用戶名）和密碼登錄。URL 請求的簽名是
req=login&action=login。 - 應用戶要求登出。URL 請求的簽名是
req=login&action=logout。 - 應用程序的登錄頁。URL 請求的簽名是
req=login&action=begin。 - 如果用戶當前已登錄，轉到應用程序的登錄頁面。
可以看看下面這些例子：
#include "vely.h"
#include "login.h"
// 處理云端多租戶應用程序的會話維護、登錄、注銷、會話驗證
void login () {
// 獲取 URL 的輸入參數 `action`
input-param action
// 獲取全局請求數據，我們在其中記錄會話信息，所以它很方便
reqdata *rd;
get-req data to rd
// 如果會話已經建立，我們不會
// 繼續到應用程序主頁的唯一原因是我們正在登出
if (rd->is_logged_in) {
if (strcmp(action, "logout")) {
_show_home();
exit-request
}
}
// 應用程序頁面啟動。顯示登錄或注冊的鏈接，
// 并顯示適當的主屏幕
if (!strcmp (action, "begin")) {
_show_home();
exit-request
// 開始創建新用戶。詢問電子郵件和密碼，
// 然后提交此表單時創建用戶。
} else if (!strcmp (action, "newuser")) {
@Create New User<hr/>
@<form action="https://opensource.com/?req=login" method="POST">
@<input name="action" type="hidden" value="createuser">
@<input name="email" type="text" value="" size="50" maxlength="50" required autofocus placeholder="Email">
@<input name="pwd" type="password" value="" size="50" maxlength="50" required placeholder="Password">
@<input type="submit" value="Sign Up">
@</form>
// 驗證用戶發送到電子郵件的代碼。代碼必須匹配，從而驗證電子郵件地址
} else if (!strcmp (action, "verify")) {
input-param code
input-param email
// 獲取基于電子郵件的驗證令牌
run-query @db_multitenant_SaaS = "select verify_token from users where email='%s'" output db_verify : email
query-result db_verify to define db_verify
// 將數據庫中記錄的令牌與用戶提供的令牌進行比較
if (!strcmp (code, db_verify)) {
@Your email has been verifed. Please <a >Login</a>.
// 如果匹配，更新用戶信息以表明已驗證。
run-query @db_multitenant_SaaS no-loop = "update users set verified=1 where email='%s'" : email
exit-request
}
end-query
@Could not verify the code. Please try <a >again</a>.
exit-request
// 創建用戶 —— 當用戶使用電子郵件和密碼提交表單以創建用戶時運行
} else if (!strcmp (action, "createuser")) {
input-param email
input-param pwd
// 創建散列（單向）密碼
hash-string pwd to define hashed_pwd
// 生成隨機的 5 位數字字符串驗證代碼
random-string to define verify length 5 number
// 創建用戶：插入電子郵件、哈希密碼、驗證令牌。當前驗證狀態為 0，或未驗證
begin-transaction @db_multitenant_SaaS
run-query @db_multitenant_SaaS no-loop = "insert into users (email, hashed_pwd, verified, verify_token, session) values ('%s', '%s', '0', '%s', '')" : email, hashed_pwd, verify affected-rows define arows error define err on-error-continue
if (strcmp (err, "0") || arows != 1) {
// 如果不能添加用戶，則可能該用戶不存在。不管怎樣，我們都無法繼續。
login_or_signup();
@User with this email already exists.
rollback-transaction @db_multitenant_SaaS
} else {
// 創建帶有驗證碼的電子郵件并將其發送給用戶
write-string define msg
@From: vely@vely.dev
@To: <<p-out email>>
@Subject: verify your account
@
@Your verification code is: <<p-out verify>>
end-write-string
exec-program "/usr/sbin/sendmail" args "-i", "-t" input msg status define st
if (st != 0) {
@Could not send email to <<p-out email>>, code is <<p-out verify>>
rollback-transaction @db_multitenant_SaaS
exit-request
}
commit-transaction @db_multitenant_SaaS
// 通知用戶查看郵件并輸入驗證碼
@Please check your email and enter verification code here:
@<form action="https://opensource.com/?req=login" method="POST">
@<input name="action" type="hidden" value="verify" size="50" maxlength="50">
@<input name="email" type="hidden" value="<<p-out email>>">
@<input name="code" type="text" value="" size="50" maxlength="50" required autofocus placeholder="Verification code">
@<button type="submit">Verify</button>
@</form>
}
// 這里在登錄用戶登出時運行
} else if (!strcmp (action, "logout")) {
// 更新用戶表以清除會話，即沒有該用戶登錄
if (rd->is_logged_in) {
run-query @db_multitenant_SaaS = "update users set session='' where userId='%s'" : rd->sess_userId no-loop affected-rows define arows
if (arows == 1) {
rd->is_logged_in = false; // 提示用戶未登錄
@You have been logged out.<hr/>
}
}
_show_home();
// 登錄：當用戶輸入用戶名和密碼時運行
} else if (!strcmp (action, "login")) {
input-param pwd
input-param email
// 創建單向散列，目的是與用戶表進行比較 —— 密碼**永遠不會**被記錄
hash-string pwd to define hashed_pwd
// 為會話 ID 創建一個隨機的 30 位長的字符串
random-string to rd->sess_id length 30
// 檢查用戶名和哈希密碼是否匹配
run-query @db_multitenant_SaaS = "select userId from users where email='%s' and hashed_pwd='%s'" output sess_userId : email, hashed_pwd
query-result sess_userId to rd->sess_userId
// 如果匹配，使用會話 ID 更新用戶表
run-query @db_multitenant_SaaS no-loop = "update users set session='%s' where userId='%s'" : rd->sess_id, rd->sess_userId affected-rows define arows
if (arows != 1) {
@Could not create a session. Please try again. <<.login_or_signup();>> <hr/>
exit-request
}
// 設置“用戶 ID”和“會話 ID”為 cookie。用戶的瀏覽器將在每個請求中返回這些信息
set-cookie "sess_userId" = rd->sess_userId
set-cookie "sess_id" = rd->sess_id
// 顯示主頁，確保會話是正確的，并設置標志
_check_session();
_show_home();
exit-request
end-query
@Email or password are not correct. <<.login_or_signup();>><hr/>
// 登錄界面，要求用戶輸入用戶名和密碼
} else if (!strcmp (action, "")) {
login_or_signup();
@Please Login:<hr/>
@<form action="https://opensource.com/?req=login" method="POST">
@<input name="action" type="hidden" value="login" size="50" maxlength="50">
@<input name="email" type="text" value="" size="50" maxlength="50" required autofocus placeholder="Email">
@<input name="pwd" type="password" value="" size="50" maxlength="50" required placeholder="Password">
@<button type="submit">Go</button>
@</form>
}
}
// 顯示登錄或注冊鏈接
void login_or_signup() {
@<a >Login</a> & & <a >Sign Up</a><hr/>
}通用應用程序（_show_home.vely）
借助本教程，你可以創建你想要的任何多租戶 SaaS 應用程序。上面的多租戶處理模塊（login.vely）調用 _show_home() 函數，它可以容納你的任何代碼。這個示例代碼展示了筆記應用程序，但它可以是任何內容。_show_home() 函數可以調用你想要的任何代碼，它是一個通用的多租戶應用程序插件：
#include "vely.h"
void _show_home() {
notes();
exit-request
}筆記應用程序（notes.vely）
該應用程序能夠添加、列舉以及刪除任何給定的筆記：
#include "vely.h"
#include "login.h"
// 多租戶云中的筆記應用程序
void notes () {
// 獲取全局請求數據
reqdata *rd;
get-req data to rd
// 如果會話有效，顯示登錄或注冊
if (!rd->is_logged_in) {
login_or_signup();
}
// 問候用戶
@<h1>Welcome to Notes!</h1><hr/>
// 如果沒有登出，退出 —— 這里確保對用戶身份的安全驗證
if (!rd->is_logged_in) {
exit-request
}
// 獲取 URL 參數，告訴筆記要做什么
input-param subreq
// 顯示筆記能夠做什么操作（添加或列舉筆記）
@<a >Add Note</a> <a >List Notes</a><hr/>
// 列舉該用戶的所有筆記
if (!strcmp (subreq, "list")) {
// **只**選取該用戶的筆記
run-query @db_multitenant_SaaS = "select dateOf, note, noteId from notes where userId='%s' order by dateOf desc" : rd->sess_userId output dateOf, note, noteId
query-result dateOf to define dateOf
query-result note to define note
query-result noteId to define noteId
// 使用快速緩存正則表達式將新行更改為<br/>
match-regex "\n" in note replace-with "<br/>\n" result define with_breaks status define st cache
if (st == 0) with_breaks = note; // 什么都沒有發現/替換，只用原來的
// 顯示筆記
@Date: <<p-out dateOf>> (<a >delete note</a>)<br/>
@Note: <<p-out with_breaks>><br/>
@<hr/>
end-query
}
// 要求刪除筆記
else if (!strcmp (subreq, "delete_note_ask")) {
input-param note_id
@Are you sure you want to delete a note? Use Back button to go back, or <a >delete note now</a>.
}
// 刪除筆記
else if (!strcmp (subreq, "delete_note")) {
input-param note_id
// 刪除筆記
run-query @db_multitenant_SaaS = "delete from notes where noteId='%s' and userId='%s'" : note_id, rd->sess_userId affected-rows define arows no-loop error define errnote
// 告知用戶狀態
if (arows == 1) {
@Note deleted
} else {
@Could not delete note (<<p-out errnote>>)
}
}
// 添加筆記
else if (!strcmp (subreq, "add_note")) {
// 從 note 表單中獲取 URL POST 數據
input-param note
// 在該用戶的 ID 下插入筆記
run-query @db_multitenant_SaaS = "insert into notes (dateOf, userId, note) values (now(), '%s', '%s')" : rd->sess_userId, note affected-rows define arows no-loop error define errnote
// 告知用戶狀態
if (arows == 1) {
@Note added
} else {
@Could not add note (<<p-out errnote>>)
}
}
// 顯示一個 HTML 表單來收集筆記，并將其發送回這里（使用 subreq="add_note" URL 參數）
else if (!strcmp (subreq, "add")) {
@Add New Note
@<form action="https://opensource.com/?req=notes" method="POST">
@<input name="subreq" type="hidden" value="add_note">
@<textarea name="note" rows="5" cols="50" required autofocus placeholder="Enter Note"></textarea>
@<button type="submit">Create</button>
@</form>
}
}具有 C 性能的 SaaS
Vely 語言使得 C 語言在你的網絡應用程序中得到充分利用這件事成為可能。多租戶 SaaS 應用程序便是從中受益的一個典型用例。
看一看參考代碼示例，寫一寫代碼，然后試試 Vely。
