基於Supabase開發公衆號接口

《開源BaaS平臺Supabase介紹》一文中我們對什麼是BaaS以及一個優秀的BaaS平臺--Supabase做了一些介紹。在這之後,出於探究的目的,我利用一些空閒時間基於Microsoft .NET 7和Supabase開發了一個微信公衆號接口的項目並且發佈在Github上。歡迎各位朋友查閱、指導。如果您覺得這個項目對您有用,還希望給一個小小的Star:

https://github.com/Codespilot/Woa

本項目還包含了一些《使用MediatR實現CQRS》和《使用MediatR和FluentValidation實現CQRS應用程序的數據驗證》的內容。目前項目正在不斷進行完善,如果您有什麼想法、意見、建議等,可以在文章下面留言或者在Github上提交Issue。

項目介紹

Woa(Wechat Official Account)是一個基於.NET 7開發的微信公衆平臺接口項目,利用Supabase作爲數據存儲和消息通信服務,同時提供了ChatGPT和Claude2等目前熱門的生成式AI會話功能接入。

項目結構

image-20230818220702050

  • 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,目前可供選擇的亞洲節點只有孟買、新加坡、東京和首爾,我選擇的是新加坡節點,別問爲什麼,問就是我樂意……

image-20230718012201884

創建成功後,瀏覽器會自動跳轉到項目概覽頁面,如下圖:

image-20230718013320596

supabase 基於 PostgreSQL 數據庫,因此當你創建完項目後,就自動爲你分配好了一個可訪問的 PostgreSQL 數據庫,你完全可以將其當做一個遠程的 PostgreSQL 數據主機。

可以在如下頁面中查看到有關數據庫連接的信息:

image-20230718013827318

通過Navicat已經能夠成功連接到數據庫

image-20230718014020220

配置項目

打開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": ""
	}
}

Wechat

  • 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的服務。


點關注,不迷路。

如果您喜歡這篇文章,請不要忘記點贊、關注、轉發,謝謝!如果您有任何高見,歡迎在評論區留言討論……

公衆號

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章