開源OSS.Social微信項目進階介紹

  在開源OSS.Social微信項目解析的隨筆中,我簡單給大家分享了進行中微信項目的概要設計,主要在講述解決思路和過程,沒有詳細實現和使用介紹。本着不能馬虎的態度,這篇文章我來給大家分解一下項目結構,使用方式以及後邊的規劃,希望能夠讓大家通達曉暢。同時,當前項目正在進行 .Net Standard 類庫的過渡,相信一段時間之後就可以同時對 .net framework 和 .net core 提供支持。

  這個項目是整個OSS系列開源項目之一,主要是對 社交化產品的接口包裝,而微信項目是當前正在進行的項目,在整個微信的項目中,包含三個大模塊(請見上文,或見模塊劃分思維導圖),這裏對三個模塊做一個分步講解。

一.實時消息模塊

  當前模塊主要是對實時消息的處理,其概要設計想法和相關流程圖已經在上文中做了介紹,這裏對項目的具體實現做下分解演示。

  首先我介紹下消息模塊的文件結構

  當前模塊主要在項目中的Msg文件夾下,對應的實體則在 Msg/Mos 文件夾中,文件夾下有三個類:

  WxMsgBaseHandler(基礎消息類型處理)

  WxMsgHandler(高級擴展消息處理)

  Cryptography(微信安全模式加密補位方法處理)

  在實體文件夾中,主要包含 基類(BaseMos), 普通消息類型實體(RecMsgMos-基礎消息接收實體,RecEventMsgMos-基礎事件消息接收實體) 和 消息響應實體 (ReplyMsgMos-響應消息實體)三個部分,這裏面大家主要需要關心的是 BaseMos中的(BaseRecMsg,BaseRecEventMsg) 和 BaseReplyMsg,分別對應着 正常消息、事件消息,以及響應消息的基類。 

  瞭解基本結構之後我們來看下具體調用方式,因爲這個模塊提供了兩種調用模式,這裏分別介紹: 

  1. 基礎消息模式,這個模式主要是對微信常見的消息類型的調用,在RecMsgMos和RecEventMsgMos文件中的實體也主要是對 基礎模式接收消息的定義,當前模式的適用場景是開發者不需要考慮例如卡券等特殊事件消息,使用當前模式即可,調用演示如下:

  a. 自定義消息處理類WxBasicMsgService,繼承自WxBasicMsgHandler,只需要給相關的事件委託Handler(請注意和事件消息的事件做區分)添加處理事件即可,傳入的消息實體會根據不同委託事件一一對應,例如TextHandler對應的是TextRecMsg

 

  當前基礎消息類型實現對應的事件爲:

  正常消息:

  TextHandler(文本消息)

  ImageHandler(圖片消息)

  VoiceHandler(語音消息)

  VideoHandler(視頻)

  LocationHandler(位置消息)

  LinkHandler(鏈接消息)

  事件消息:

  SubscribeEventHandler(訂閱事件)

  ScanEventHandler(掃描事件)

  LocationEventHandler(上報位置事件)

  ClickEventHandler(點擊菜單事件)

  ViewEventHandler(點擊菜單跳轉事件)

  b. 聲明配置信息

  c. 頁面調用

 

  2. 高級消息模式,這個模式包含了基礎模式的所有事件,主要適用場景是對有特殊事件消息有定製的情況。其調用方式和基礎模式不同在於自定義消息處理類部分,這裏展示一個簡單自定義高級模式處理類:

  高級模式需要調用註冊方法,RegisterMsgHandler-註冊正常消息,RegisterEventMsgHandler-註冊事件消息。第一個參數是消息類型名稱,如果是事件消息,則是事件名稱。第三個參數是具體的邏輯處理委託。第二個參數則是接收消息的實體類型,這裏是舉例所以我直接使用了LocationRecEventMsg,當然你也可以定義你需要的接收實體,正常消息繼承自BaseRecMsg,事件消息繼承自BaseRecEventMsg,舉個例子:

public class CustomRecMsg : BaseRecMsg
{
  protected override void FormatPropertiesFromMsg()
  {
    base.FormatPropertiesFromMsg();
    Content = this["Content"];
  }
  public string Content { get; set; }
}

如果對於消息模塊還有其他疑問,可以添加osscoder公衆號提問,晚上我會統一解決。 

二.功能接口模塊

  這個模塊主要是公號內的功能性接口,調用時需要調用全局的AccessToken,接口文件主要在Offcial文件夾下,根據功能對象分類下屬又做了子模塊分類,文件結構和消息模塊下的類似,不過需要注意的是同一個文件夾下有幾個類文件,但是類名都是同一個,例如Basic文件加下有User,Menu,Media等多個api文件,但類名同爲:WxOffBasicApi。

  這裏使用了Partail關鍵字,保證結構的清晰,同時保證調用時的簡單。詳細的分類可以見下面的結構:

  也就是功能模塊接口主要有以下幾個:WxOffBasicApi,WxOffCardApi,WxOffStatApi(統計,簡寫了),WxOffStoreApi,WxOffAssist,直接聲明實例調用即可,當然當前接口還沒有完全結束,主要集中在圖中未標狀態的部分,如果想要使用沒有的接口,這裏提供一個WxOffBaseApi基類中的方法調用示例,只需要返回一個WxBaseResp或者它的子類即可,WxBaseResp中有IsSuccess屬性,可以通過它來判斷當前的返回結果:

 

當然文件的命名也有一個簡單規則:

請求實體:Wx+ 動作 + 對象/模塊名稱 + Req/Resp (如:WxAddMemberCardReq)
對象實體:Wx + 對象/模塊名稱 + Mo (如:WxMemberCardMo)
接口類:Wx+Off+模塊名稱+Api  

三. 社交接口模塊

  當前模塊主要集中在Sns文件夾下,功能是面向用戶相關的,微信的這塊功能主要集中在授權和獲取授權用戶的基本信息,文件組成比較簡單,裏面提供了兩種頁面授權模式,PC掃碼授權和手機微信端頁面授權。調用方式也十分的簡單,如圖:

 

以上是幾個部分的結構和調用方式介紹,所有實例代碼都在OSS.Social.Samples中,可以去github或者 開源中國 下載查看。 

四.  OSS項目的規劃

  當前已經開源的項目有 OSS.Common ,  OSS.Http, OSS.Social。 後期的計劃還會有支付,客服,和用戶三個項目,最近兩週我的主要安排是完成OSS.Social 項目,同時完成 以上項目的.Net Standard 項目,完成對.net core 的支持,也歡迎有共同愛好的同學前來貢獻代碼,完成這個簡單,基礎,實用的系列項目。

 

續:這裏把實時消息的處理流程再做一次回顧,可以和使用介紹再對照體會一下



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