--- title: "用微軟的開源的 YARP 反向代理打造專屬的負載平衡軟體及多功能網關" description: "介紹如何使用微軟開源的 YARP 反向代理打造軟體負載平衡器，涵蓋路由轉發、Sticky Cookie、CustomHeader 長連接與健康檢查等實務配置。" canonical_url: "https://blog.markkulab.net/post/yarp-reverse-proxy" author: "Mark Ku" author_url: "https://blog.markkulab.net/author/mark-ku" site: "Mark Ku's Blog" date_published: "2022-01-14 01:01:01 +0800" category: "Infra" tags: ["yarp", "reverse proxy", "load balancing", "dotnet", "gateway", "infra"] language: "zh-TW" license: "CC BY 4.0" license_url: "https://creativecommons.org/licenses/by/4.0/" attribution: "轉載或引用請註明作者並附上原文連結" --- # 用微軟的開源的 YARP 反向代理打造專屬的負載平衡軟體及多功能網關 ## 用微軟的開源的 YARP 反向代理打造專屬的負載平衡軟體及多功能網關 ## 前言 有用過負載平衡器，應該多多少少都有聽過業界知名的 F5 Networks 公司的 F5 的負載平衡器，但一台要價將近 20~30萬，對於中小型企業來說，這是不小的費用，如果你想導入負載平衡器，但預算又沒這麼寬裕，可以考慮微軟的開源 YARP 來實作軟體負載平衡。 ## 軟體負載平衡優點有 * 橫向擴展( Scale Up )伺服器 * Api 閘道，動態變換 API 路由 * 滾動式部署 ( Rolling Deploy ) * 停機部署時掛上維護頁面 ( Downtime ) * 條件化擴充防止 DDOS 的攻擊 * Search Engine Bot 直接轉發到 SSR 站台 ## 何謂負載平衡 在多台腦間分配所要處理的任務，讓網路連接、CPU、記憶體、磁碟存取IO或其他資源中，最大化吞吐率、最小化回應時間、同時也避免單一伺服器過載，造成用戶端不回應，以達到最佳化資源使用。 且在這雲端時代，透過負載平衡，可以輕易的橫向擴充伺服器( Scale Up )，假設一小電商網站平常的用量，只需要6核 12 緖的 CPU，但遇到雙11 或週年慶活動時，伺服器常常會過載，無法支撐這麼多用戶，這時候可以租用雲端服務主機，如: Azure、GCP AWS ，並把 加入到負載平衡主機中，這時就達到彈性調度伺服器承載更多用戶的功效。 ## 我的網路拓樸 ![YARP反向代理與負載平衡的網路拓樸圖](https://blog.markkulab.net/content/markku/posts/yarp-reverse-proxy/images/DHlLuaS.png) ## 負載平衡的長連接機制 大部份的負載平衡都會提供兩種 Sticky Cookie 及 CustomHeader 來保持與用戶端的持續連接，YARP 也支援這兩種機制。 ## Sticky Cookie 在多台網頁伺服器主機的環境下，為了確保一個用戶訪問同一台伺服器，負載平衡器(LTM) 在網頁回傳時，會塞一個Cookie，網頁重新整理後，LTM 就會依據 Cookie 連接到原本的伺服器 ## CustomHeader 在瀏覽器 3rd Cookie 的限制越來越嚴格的情況下，有越來越多的網站因為有機會被鑲嵌，因此不能用 cookie ，而此種方法 LTM 會在 CustomHeader Reponse header 傳遞持續連接的 token ，前端接收到可以將其存起來，下次請求在帶至後端，這樣用戶就能夠持續連在同一台伺服器中。 ## 我主要參考了這位大大的文章，並 Fork 他的專案，並修掉了一些bug [文章連結](https://codingnote.cc/zh-tw/p/355452/) [專案連結](https://github.com/fanslead/ReverseProxy.Store/) ## 下載及啟動專案，輸入密碼 password 進入後台 (需要安裝 net core 6 sdk 和 runtime) ## 接下來，介紹幾種常見的規則配置 ## 一、整個網站的請求轉發 ### 1、至伺服器群組 > 新增伺服器群組 ![編輯伺服器群組設定介面，顯示負載平衡策略與目的地](https://blog.markkulab.net/content/markku/posts/yarp-reverse-proxy/images/J3MY0MJ.png) ### 2、至路由列表 > 新增 ![YARP Gateway路由編輯介面，配置路徑與方法](https://blog.markkulab.net/content/markku/posts/yarp-reverse-proxy/images/XYWtpxA.png) 選取先前建立的伺服器群組，並依據下圖來配置 Path = {**catch-all} Transforms 1 PathPattern = {**catch-all} Transforms 2 RequestHeadersCopy = true ## 二、指定 API 路由轉發 ### 1、至伺服器群組 > 新增伺服器群組 ![YARP Gateway編輯伺服器群組設定介面](https://blog.markkulab.net/content/markku/posts/yarp-reverse-proxy/images/6rSdzGA.png) ### 2、至路由列表 > 新增 選取先前建立的伺服器群組，並依據下圖來配置 Path = /api/{**remider} Transforms 1 PathPrefix = /api/v1/{**remider} ![編輯路由視窗顯示API路徑與轉換配置](https://blog.markkulab.net/content/markku/posts/yarp-reverse-proxy/images/EBUTuXd.png) ## 三、SignalR 轉發 可以參考這篇[文章](https://www.cnblogs.com/fanshaoO/p/15561726.html)配置 ## 四、LTM 長連接配置 ### 1.Cookie 長連接配置 ![會話與Cookie配置介面，顯示LTM長連接設定](https://blog.markkulab.net/content/markku/posts/yarp-reverse-proxy/images/y0UjT5u.png) ### 2.Custom Header 長連接配置 ![YARP會話與Cookie長連接配置畫面](https://blog.markkulab.net/content/markku/posts/yarp-reverse-proxy/images/JmvIQ8L.png) ## 五、 建議要將健康檢查的主動偵測勾選，YARP 主動偵測到一台主機掛了， 就不會派發任務給該台伺服器 ![健康檢查設定，主動偵測開關已開啟](https://blog.markkulab.net/content/markku/posts/yarp-reverse-proxy/images/Dr0dcCG.png) ## 官方文件 前面談到的所有的後台 UI 操作都對應的是 YARP 的設定檔，如果有興趣，可以仔細研讀一下。 [官方文件](https://microsoft.github.io/reverse-proxy) --- ## 關於本文與作者 本文出自 [Mark Ku's Blog](https://blog.markkulab.net/post/yarp-reverse-proxy) 授權條款： [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) — 轉載或引用請註明作者並附上原文連結 ### 關於作者 **[Mark Ku](https://blog.markkulab.net/author/mark-ku)** — Software Solution Provider - 10+ 年資深軟體工程師，現為 AI 應用 Builder - 專注大型平台架構設計，從北美電商到AI SaaS訂閱收費系統 - 結合 AI Agent 與自動化，打造高效可演進的產品技術基礎 ### 作者開發的免費工具 以下工具皆可免費使用： - [免費 PDF 簽名工具](https://blog.markkulab.net/tools/pdf-sign): 線上 PDF 簽名工具，瀏覽器內完成手繪、打字、上傳簽名，可拖曳放置、縮放、下載。所有處理都在你的裝置完成，檔案不會上傳。 - [VS Code Refactory](https://blog.markkulab.net/tools/refactory): Refactory 是一款 VS Code 重構擴充套件：34 個重構動作、37 條 code smell 檢查、Code Health 儀表板、18 種語言、534 支測試。懂你的專案慣例：介面放哪、DI 註冊寫在哪、'use client' 該不該加；還會用 git 修改頻率 × 複雜度排出「該先修哪個檔案」，並一鍵把壞味道交給你自己電腦上的 Claude Code 修。免費使用，原始碼不離開你的機器。 - [DB-Kit 資料庫管理工具](https://blog.markkulab.net/tools/db-kit): DB-Kit 是一個用 Tauri + Rust + React 打造的輕量跨平台資料庫管理工具，用單一一致的介面同時管理 MySQL、MariaDB、PostgreSQL、SQL Server、Oracle、SQLite、MongoDB、Redis、Kafka、Elasticsearch 與 RabbitMQ 十一種資料來源：連線密碼以 OS keychain 加密、SSH Tunnel、完整 CRUD、視覺化查詢建構器、多結果集同時顯示、跨連線資料傳輸與比對同步、Excel / CSV 匯入匯出、執行計畫視覺化、ER 圖、排程備份、SQL 壓力測試（p50～p99 延遲百分位）、15 條規則的 SQL 審查、Kafka 訊息瀏覽與監控告警；繁中 / 英文雙語介面，內建 AI 助手（自然語言生成 SQL、AI 審查與調校建議）與命令列工具 dbk。免費開源（MIT），提供 Windows / macOS / Linux 安裝檔。 - [VS Code Super Mermaid](https://blog.markkulab.net/tools/super-mermaid): Super Mermaid 是一款 VS Code 擴充套件：開箱即用的漂亮 Mermaid 圖表，自動上色、即時預覽、滑鼠平移縮放、PNG / SVG 高解析匯出，內建 21 種範本與多種主題。免費開源（MIT）。 - [React Super Mermaid](https://blog.markkulab.net/tools/react-super-mermaid): react-super-mermaid 是一個開源 React 元件庫：一行 即可渲染漂亮的 Mermaid 圖表，內建 colorful / sketch 主題、平移縮放、圖內搜尋、SVG / PNG 高解析匯出。輕量、SSR 安全、完整 TypeScript 型別。免費開源（MIT）。 - [Jira / Confluence Super Mermaid](https://blog.markkulab.net/tools/jira-super-mermaid): Atlassian Forge app：在 Jira issue 與 Confluence 內文直接寫 Mermaid 語法，畫流程圖、時序圖、狀態機與甘特圖。11 種圖表、SVG / PNG 匯出、明暗主題、完整中日韓文字支援。取得 Runs on Atlassian 資格：圖表存在你自己的站台，app 不呼叫任何第三方服務。免費，即將上架 Atlassian Marketplace。 - [Mermaid 線上預覽](https://blog.markkulab.net/tools/mermaid-preview): 在瀏覽器裡寫 Mermaid、即時看圖，整張圖表壓進網址就能分享。免註冊、不上傳伺服器，相容 mermaid.live 的分享連結。 - [React Intl Phone Number](https://blog.markkulab.net/tools/react-intl-phone-number): react-intl-phone-number 是一個開源 React 元件：framework-agnostic、不依賴 antd，提供 E.164 進出、可搜尋國旗 / 國碼下拉、可配置驗證等級（strict / mobile-strict / loose）、可主題化 CSS 與 i18n，電話邏輯由 google-libphonenumber 驅動。輕量、完整 TypeScript 型別。免費開源（MIT）。 - [Uptime Kuma Cluster](https://blog.markkulab.net/tools/uptime-kuma-cluster): 把單機版 Uptime Kuma 改造成高可用叢集：OpenResty + Lua 智慧負載平衡、MariaDB 共享狀態、健康檢查與自動 Failover，附叢集管理 REST API，一行 Docker Compose 啟動。免費開源（MIT）。 - [特教專案](https://blog.markkulab.net/education): 為特殊教育學生製作的學習教材 ### 每日 Podcast - [科技新鮮事](https://blog.markkulab.net/category/tech-news): 每日精選 AI 與科技趨勢，透過語音摘要快速掌握最新技術動態，涵蓋 AI 應用、軟體架構、DevOps 與工程實戰。 — RSS: https://blog.markkulab.net/feed.xml - [AI股市蝦聊](https://blog.markkulab.net/category/ai-stock-chat): 每個交易日用 AI 分析台股盤勢，以雙人對話聊當天的盤中觀察與隔日預測。 — RSS: https://blog.markkulab.net/ai-stock-chat/feed.xml ### 電子報 [訂閱電子報](https://blog.markkulab.net/subscribe) — 第一時間收到新文章通知，無垃圾信、隨時可取消訂閱。