0620 - 關於 Klib 分享的技術選型，各類糾結以後，我選了以下方案

時間 2019-11-30

標籤關於 klib 分享技術選型各類糾結以後以下方案简体版

原文原文鏈接

技術方案選型是件頗有意思的事，各個環節都有各類選擇，能夠組合出各類可能。在這些可能性中，挑選出最佳方案，是我很喜歡作的事。css

最近剛剛完成 Klib 的標註分享，趁着熱乎勁，小結一下：過程當中糾結了哪些方案，之後最後選擇了什麼。html

0) 先來看看最終效果

這就是 Klib 分享標註的操做流程：點擊分享，當即獲得能夠全球訪問的網頁。操做不能更簡單，背後的技術邏輯卻很複雜：python

實際的開發是混在一塊兒的、思路也是交叉的，不過，爲了介紹方便，我大體按照數據流來推演。mysql

1) Klib 與接口服務器

這部分的功能比較直接：Klib 將標註內容發送給接口服務器，服務器處理完後返回結果。nginx

須要介紹的，卻是功能以外的東西：sql

如何防止接口被攻擊
如何作身份識別

這部份內容實際上是很複雜的，我最終採用了和 Klib 安全性相稱的方案。數據庫

1.0) 防止接口被攻擊

1.0.0) 接口服務器使用 https

這是最基礎、但很是有效的方式，全程使用 https 加密，已經能夠大大提升安全性。編程

1.0.1) 防止接口被非法使用

若是接口是公開的、全部人均可以任意訪問，就能夠隨意地向服務器丟垃圾數據，迅速將服務器擠爆。flask

好比好的作法是 使用非對稱加密，即便用一對私鑰、公鑰，使用 私鑰加密 的數據，只能使用 公鑰解密；反之，使用 公鑰加密 的數據，只能使用 私鑰解密。總體流程大體以下：api

接口服務器開放 公鑰 A
每一個 Klib 客戶端生成新的 私鑰 B 和 公鑰 B
Klib 客戶端使用 公鑰 A 加密 公鑰 B，並將其發送給接口服務器
接口服務器使用 私鑰 A 解密後，存儲該客戶端對應的 公鑰 B
以後，Klib 客戶端發送數據時，使用 私鑰 B 加密，接口服務器收到後使用 公鑰 B 解密，並用 公鑰 B 加密後返回數據

聽起來有點像繞口令？

開發上也有點麻煩，畢竟服務器還要保存每一個 Klib 客戶端對應的公鑰。若是有多個服務器，則須要在不一樣服務器間同步公鑰，更加麻煩。對於我這個小產品 + 實驗功能來講，暫時不須要這麼高的安全級別。

因而，我採用了更簡單、但夠用的 AES 對稱加密。即 Klib 客戶端和接口服務器使用相同的 AES 加密方法、同一個密碼，加密請求和響應的數據；若是不能提供正確的加密，就沒法使用服務器接口。

這一方案主要的風險是：黑客能夠反編譯 Klib 獲得密碼。除了 Klib 自己會編譯並簽名，我還在代碼里加密存儲密碼。基本上除了跟我有八輩子解不開的愁，99.9999% 的人是不會花精力來破解這個密碼的。

1.0.2) 使用時間戳 + MD5

即便加密過的數據，最終也只是表現爲一個 http 請求，而這個請求是可能被本地攔截，進而用於模擬正經常使用戶請求。

對應的防禦是，在 http 請求中加入時間戳，並對 http 頭的內容部分計算 MD5（或 CRC 等），服務器端進行驗證，就可保證 http 頭不被濫用。

其實，這是 OAuth 的範疇。好在，我在開發圖牀神器 iPic 時，前後從客戶端的角度實現了七牛、又拍、阿里雲、Imgur、Flickr、Amazon S3 的 OAuth，此次實現一個簡單的服務器端部分，也不算麻煩。

1.1) 如何作身份識別

上面說的是在面對黑客時的防禦，聽着有點暈是吧？下面來講說正常狀況下的身份識別。

好比：若是用戶嘗試中止一個分享，如何判斷該用戶是否有權限？

若是有帳戶系統，這點比較容易解決。而 Klib 還沒有引用帳戶系統，怎麼辦呢？比較高級的是使用區塊鏈（咳咳），我目前的作法是：用戶使用 Klib 分享一本書的標註時，服務器會返回一個隨機數。下次用戶在中止分享時，只要能提供這個隨機數，即斷定爲有效請求。在上述各類防禦的前提下，能夠有效地防止被惡意中止分享。

2) 接口服務器

接口服務器是整個系統中最複雜的部分，它的職責比較多：

驗證請求，並接收數據
存儲數據
根據數據生成靜態網頁
將靜態網頁輸送給靜態服務器
更新、刪除分享時，更新數據存儲和靜態服務器

驗證請求和前面的介紹是對應的，這裏略過不表。

2.0) 使用 Python + Flask 實現功能部分

所謂接口服務器，首先就是要開放接口（開門接客）具體的，就是 http 請求的路由表。好比，當 Klib 客戶端向 api.klib.me/share 發送數據時，要有相應的代碼來接收處理這個請求。

在以前的文章我入門 Python 後總結的基礎教程中，我已經介紹了使用 Flask 框架，這裏再也不重複。

2.1) 使用 Nginx + Gunicorn 搭建服務器

同上，請參考我入門 Python 後總結的基礎教程。

另外，使用 Supervisorctl 保證服務可靠運行。

2.2) 使用 MySQL + SQLAlchemy 存儲數據

從數據存儲的角度看，書的標註都是很規整的，無非是書名、做者、筆記內容等等。因而我選擇了最經常使用的關係型數據庫：MySQL

若是直接使用 SQL 語句操做數據庫，既繁瑣又不安全，這裏我使用可稱爲 ORM (Object Relational Mapping) 界事實標準的 SQLAlchemy 構建 Model、操做數據庫。

我原本想說「這沒什麼好介紹的」，但實際上，MySQL 的坑不少。好比，若是要支持 Emoji 表情，就要全程使用 utf8mb4 編碼。還有不少其餘的坑，此處略去一萬字…

2.3) 使用 Jinja 模板生成靜態網頁

關於標註部分，Klib 發送的是 Markdown 格式，如：

# 簡單思考

## 卷首語

- 商業的本質就是「持續提供用戶真正想要的東西」，除此無他。

- 召集具有迴應用戶需求的熱情與能力的員工，併爲他們營造出無拘無束可最大限度地發揮其才能的環境，除此無他。

## 第一章　經商不是「打仗」

- 重要的是不斷磨鍊對「大衆真實需求」的感知能力和使之實體化的技術。

- 音樂和體育不一樣，不用與任何人戰鬥。複製代碼

須要使用 markdown 模式將其轉換成 html 格式，如：

<h1>簡單思考</h1>
<h2>卷首語</h2>
<ul>
   <li>
      <p>商業的本質就是「持續提供用戶真正想要的東西」，除此無他。</p>
   </li>
   <li>
      <p>召集具有迴應用戶需求的熱情與能力的員工，併爲他們營造出無拘無束可最大限度地發揮其才能的環境，除此無他。</p>
   </li>
</ul>
<h2>第一章　經商不是「打仗」</h2>
<ul>
   <li>
      <p>重要的是不斷磨鍊對「大衆真實需求」的感知能力和使之實體化的技術。</p>
   </li>
   <li>
      <p>音樂和體育不一樣，不用與任何人戰鬥。</p>
   </li>
</ul>複製代碼

這裏讚歎一下：Python 輪子就是多。只需輕輕地導入 markdown 模塊，便可優雅地將 Markdown 轉換爲 html 格式，舒爽。

import markdown
html_str = markdown.markdown(markdown_str)複製代碼

對於最終生成的靜態網站，像 css/js 等部分都是同樣的，只是頁面標題、正文等內容性的東西不一樣。因而，使用 Jiaja 模式表示這些通用部分，並 {{ title }} 這樣的標註符表示各個分享所不一樣的內容部分；再用 render_template 方法替換模板中的內容，便可生成對應的靜態文件。

感嘆：這樣簡潔直接的操做、無需各類複雜的配置，就能獲得最後想要的東西，真真是編程中最可愛的環節。