Woa(Wechat Official Account)是一個基於.net 7開發的微信公眾平臺介面項目,利用Supabase作為數據存儲和消息通信服務,同時提供了ChatGPT和Claude2等目前熱門的生成式AI會話功能接入。 ...
在《開源BaaS平臺Supabase介紹》一文中我們對什麼是BaaS以及一個優秀的BaaS平臺--Supabase做了一些介紹。在這之後,出於探究的目的,我利用一些空閑時間基於Microsoft .NET 7和Supabase開發了一個微信公眾號介面的項目並且發佈在Github上。歡迎各位朋友查閱、指導。如果您覺得這個項目對您有用,還希望給一個小小的Star:
本項目還包含了一些《使用MediatR實現CQRS》和《使用MediatR和FluentValidation實現CQRS應用程式的數據驗證》的內容。目前項目正在不斷進行完善,如果您有什麼想法、意見、建議等,可以在文章下麵留言或者在Github上提交Issue。
項目介紹
Woa(Wechat Official Account)是一個基於.net 7開發的微信公眾平臺介面項目,利用Supabase作為數據存儲和消息通信服務,同時提供了ChatGPT和Claude2等目前熱門的生成式AI會話功能接入。
項目結構
- Woa.Webapi: 微信公眾平臺介面及其他WebApi介面。
- Woa.Chatbot: 聊天機器人,提供Chat GPT、Claude2等聊天機器人接入。項目類型為Worker Service。
- Woa.Sdk: 微信公眾平臺、OpenAI、Claude介面Api封裝。
- Woa.Common: 公共基礎類庫。
Chatbot的代碼為何要分離出來呢?當然是為了異地單獨部署咯!備案(國內伺服器)和訪問OpenAI,只能選一個。
運行和部署
開通及配置公眾號
通過Woa的名稱可以看出來,這是一個專門為微信公眾號準備的項目,那要完整的運行項目,那我們得:
1. 申請開通公眾號
關於如何開通公眾號,網上已經有很詳細的教程了,本篇文章里不再贅述,主要是因為說來說去無非就是其他人已經寫好的內容複製過來。
公眾號開通之後,需要配置伺服器地址(微信公眾平臺向介面發送的消息全部都是通過這個介面的),請求令牌(Token,用於服務端介面鑒別消息是否來自騰訊伺服器),開發者Id等等。
正式的公眾號並不是所有介面都能使用的,根據賬號類型、認證狀態的不同,公眾號的介面許可權也不一樣,為了方便介面對接調試,我們還需要同時開通公眾平臺測試賬號。測試賬號的所有介面許可權都是開通的。
2. 準備功能變數名稱
既然是開發公眾號介面,一個可用的功能變數名稱當然是必不可少的,國內的功能變數名稱註冊商有很多,例如時代互聯、貝銳、阿裡雲、騰訊雲等等,註冊過程比較簡單。
3. 內網穿透工具
開發過程中需要不斷地進行調試,作為一名正常的程式員,我們不可能每次更改都要打包發佈到公網伺服器進行測試,即麻煩也不靠譜,最好的辦法就是使用內網穿透,把微信服務的請求映射到我們自己的電腦上。
實現內網穿透的工具很多,例如GoProxy,ngrok等等,然而這兩者都需要自己搭建一臺伺服器,實施過程也比較麻煩。我推薦的方案是使用natapp(官網地址:https://natapp.cn/),NATAPP提供免費隧道和收費隧道兩種,並且可以自己註冊固定的二級功能變數名稱。
準備Supabase服務
1. 註冊Supabase賬號
Supabase賬號註冊比較簡單,打開官網(https://supabase.com/)點擊右上角Sign in按鈕進入到登錄界面,然後點擊Sign Up Now並且填寫好郵箱、密碼提交註冊即可。別忘了到郵箱裡面查看一下supabase發送的賬號激活郵件。
2. 創建項目
使用第一步註冊的郵箱登錄到官網,在dashboard頁面點擊New project。在創建新項目頁面填寫好相關的信息後點擊Create new project。Supabase雲服務的伺服器提供商是AWS,目前可供選擇的亞洲節點只有孟買、新加坡、東京和首爾,我選擇的是新加坡節點,別問為什麼,問就是我樂意……
創建成功後,瀏覽器會自動跳轉到項目概覽頁面,如下圖:
supabase 基於 PostgreSQL 資料庫,因此當你創建完項目後,就自動為你分配好了一個可訪問的 PostgreSQL 資料庫,你完全可以將其當做一個遠程的 PostgreSQL 數據主機。
可以在如下頁面中查看到有關資料庫連接的信息:
通過Navicat已經能夠成功連接到資料庫
配置項目
打開Woa.Webapi項目的appsettings.json,修改以下節點的配置項:
{
"Wechat": {
"Host": "https://api.weixin.qq.com",
"AppId": "",
"AppSecret": "",
"AppToken": "",
"EncodingKey": "",
"EncryptType": "None",
"OpenId": "",
"EnableCustomMessage": false,
"EnableTemplateMessage": true,
"ReplyTitle": "查看回覆",
"ReplyDescription": "點擊查看回覆",
"ReplyUrl": null,
"ReplyPicUrl": null
},
"Supabase": {
"Url": "",
"Key": ""
}
}
- AppId:開發者ID
- AppSecret:開發者密碼,公眾號不提供展示開發者密碼的功能,需要自己保存,忘記開發者密碼只能進行重置。
- AppToken:令牌,在公眾號自行設置,用於鑒別介面收到的請求是否來源於微信伺服器。
- EncodingKey:消息加解密密鑰,將用於消息體加解密過程。
- EncryptType:消息加密模式,可選值有None(明文模式)、Compatible(相容模式)、Safe(安全模式)三個。
- OpenId:公眾號原始Id,正式賬號可以在公眾號設置的註冊信息欄找到。測試公眾號在測試號管理頁面右上角位置的微信號後面的字元串。
- EnableCustomMessage:是否開通客服消息許可權。在介面許可權頁面查看開通狀態,開通此介面許可權必須通過微信認證。開通客服消息許可權後,Chatbot回覆的內容將通過客服消息介面非同步下發給用戶。
- EnableTemplateMessage:是否開通模板消息。
- ReplyTitle:回覆消息標題。未開通客服消息的公眾號,介面收到用戶發送的消息後將同步回覆一條圖文消息,Chatbot回覆之後用戶可以通過點擊圖文消息查看回覆內容。
- ReplyDescription:回覆消息描述信息。
- ReplyUrl:回覆消息Url。路由格式未
/api/wechat/{id:long}/reply
。 - ReplyPicUrl:消息圖片Url。
Supabase
- Url:項目Url地址,可以在supabase的項目配置裡面找到。
- Key:項目API Key。
打開Woa.Chatbot項目的appsettings.json,修改以下節點的配置項:
{
"Bot": {
"Name": "OpenAi",
"OpenAi": {
"Host": "https://api.openai.com",
"Token": "",
"Organization": "",
"Model": "gpt-3.5-turbo"
},
"Claude": {
"Host": "https://api.anthropic.com",
"Key": "",
"Version": "2023.6.1",
"Model": "claude-2"
}
},
"Supabase": {
"Url": "",
"Key": ""
}
}
Supabase節點的配置與Woa.Webapi保持一致,OpenAI的配置在OpenAI開發者平臺能找到。
運行項目
運行NATAPP:
在natapp官網下載客戶端軟體到本地,根據操作系統不同,需要下載不同的版本。打開終端並定位到natapp客戶端所在文件夾,執行以下指令啟動natapp客戶端:
.natapp -authtoken=xxxxxx
如果覺得每次查詢authtoken很費勁,也可以在natapp官網下載config.ini,與natapp客戶端軟體放到一起,將authtoken寫到配置文件裡面,啟動的時候就不需要再指定authtoken參數。
具體教程可以在官網找到,這裡不再贅述。
Woa.Chatbot和Woa.Webapi可以通過IDE啟動,或者通過終端輸入指令運行:
dotnet run
小知識
微信公眾號的縮寫為什麼是MP?
微信公眾平臺的網址是mp.weixin.qq.com,這裡面的mp其實是Media platform的縮寫,可以理解為媒體平臺,用於進行個人或企業等文化活動的宣傳營銷。事實上微信公眾號的功能、用途和media platform的意思是完全契合的。
Worker Service是什麼?
Worker Service是.NET Core 3.0引入的項目模板,通常用於構建需要長時間運行的服務,執行一些規律發生的工作負載。適用場景包括:
- 處理來自隊列、服務匯流排或事件流的消息、事件
- 響應對象、文件存儲中的文件更改
- 聚合數據存儲中的數據
- 豐富數據提取管道中的數據
- AI/ML 數據集的格式化和清理
- 不需要用戶交互的應用程式
由於Worker Service的宿主不監聽任何埠,用戶是不能直接訪問的,所以它無法對外提供類似WebApi、gRPC的服務。
點關註,不迷路。
如果您喜歡這篇文章,請不要忘記點贊、關註、轉發,謝謝!如果您有任何高見,歡迎在評論區留言討論……