Senparc.Weixin.MP SDK 微信公眾平臺開發教程（五）：使用Senparc.Weixin.MP SDK

SZW發表於2013-11-08

    Senparc.Weixin.MP SDK 已經涵蓋了微信 6.x 的幾乎所有公共 API。

    整個專案的原始碼以都可以在這個專案中獲取到：https://github.com/JeffreySu/WeiXinMPSDK

    PS：由於微信 API 以及 Senparc.Weixin SDK一直在不斷升級更新，最新的程式碼及 Demo 以上面的 GitHub 中的原始碼為準。

    我們現在從無到有建立一個ASP.NET MVC 專案，來看一下如何與微信進行對接（Webforms 原理也都是一樣，只不過把 Controller 中的 Action 換成 .aspx 頁面就可以了，可參考 Demo）。

    將要演示的專案原始碼也可以在開源專案中找到。因為原始碼中要兼顧多個不同 .net 版本的專案，因此有一個公用專案（CommonService），所以與下面展示的結構略有不同，不過邏輯完全一致：

    MVC：https://github.com/JeffreySu/WeiXinMPSDK/tree/master/Senparc.Weixin.MP.Sample

    WebForms：https://github.com/JeffreySu/WeiXinMPSDK/tree/master/Senparc.Weixin.MP.Sample.WebForms

 

　　現在就開始吧！ 

 

　　第一步：建立一個空的 ASP.NET MVC 專案（截圖以 ASP.NET MVC 4.0 為例，.net core 也是類似的），專案名稱如Senparc.Weixin.MP.Sample

 

　　第二步：引入Senparc.Weixin.MP.dll

    引入相關dll的方式有兩種：

  • 一種是複製 dll 到專案某資料夾中，然後直接在專案中新增 Senparc.Weixin.MP.dll 、依賴dll 及 Senparc.Weixin.MP.MvcExtension.dll 的引用（Senparc.Weixin.MP.MvcExtension.dll 只有 MVC 專案需要，WebForms 專案可以忽略）；
  • 第二種方式我們可以使用 Nuget 直接安裝到專案中。

    Nuget專案地址：https://www.nuget.org/packages/Senparc.Weixin.MP/

　　第一種方式已經足夠簡單（但是不建議，除非你需要修改 SDK 中的內容，使用自己編譯的 dll）。

　　下面介紹第二種：開啟選單【工具】> 【庫程式包管理器】 > 【程式包管理器控制檯】，如下圖：

　　點選後將會出現程式包管理器控制檯：

    如果是第一次安裝Senparc.Weixin.MP庫，則在PM>後面輸入命令：

Install-Package Senparc.Weixin.MP

    回車，Senparc.Weixin.MP.dll將會被自動引入到專案中。

    如果以後需要更新到最新版本，只需要使用Update-Package命令，將會自動線上更新：

Update-Package Senparc.Weixin.MP

    以上操作對MVC和WebForms專案都有效。

    如果是MVC專案，為了獲得更多針對MVC的擴充套件功能，我們可以繼續引入Senparc.Weixin.MP.MvcExtension.dll：

Install-Package Senparc.Weixin.MP.MVC

　　命令視窗輸出結果如下，表示已經安裝成功：

 

    我們觀察一下專案引用的程式集，這兩個dll已經被引用進來了（同時還會自動引入依賴的dll，如 Senparc.CO2NET）：

 

　　除了使用命令列的方式，也可以在【解決方案管理器】中的專案節點點選右鍵，選擇【管理 Nuget 程式包 ...】，在【瀏覽】標籤下輸入關鍵字“Senparc.Weixin.MP”，選中最新的版本，點選右側的【安裝】按鈕：

 

 

　　第三步：在全域性中進行設定

.net framework 專案：

1、開啟global.asax.cs檔案

2、在 Application_Start() 方法中加入如下程式碼（可參考 Demo）：

            /* CO2NET 全域性註冊開始
             * 建議按照以下順序進行註冊
             */

            //設定全域性 Debug 狀態
            var isGLobalDebug = true;
            var senparcSetting = SenparcSetting.BuildFromWebConfig(isGLobalDebug);

            //CO2NET 全域性註冊，必須！！
            IRegisterService register = RegisterService.Start(senparcSetting)
                                          .UseSenparcGlobal(false, null);

            /* 微信配置開始
             * 建議按照以下順序進行註冊
             */

            //設定微信 Debug 狀態
            var isWeixinDebug = true;
            var senparcWeixinSetting = SenparcWeixinSetting.BuildFromWebConfig(isWeixinDebug);

            //微信全域性註冊，必須！！
            register.UseSenparcWeixin(senparcWeixinSetting, senparcSetting);

 3、參考 Web.Config 的<appSetting>節點下加入引數設定（可參考 Demo）：

    <!-- 以下資訊會被自動識別，如無特殊說明，不用的引數可以刪除，但修改 key 後將會無法自動識別！ -->
    <!-- 自動識別引數開始 -->

    <!-- 以下為 CO2NET 的 SenparcSetting 全域性配置，請勿修改 key，勿刪除任何項 -->
    
    <!-- 預設快取名稱空間配置 -->
    <add key="DefaultCacheNamespace" value="DefaultCache" />
    <!-- Cache.Redis連線配置 -->
    <add key="Cache_Redis_Configuration" value="Redis配置" />
    <!--<add key="Cache_Redis_Configuration" value="localhost:6379" />-->
    <!-- Cache.Memcached連線配置 -->
    <add key="Cache_Memcached_Configuration" value="Memcached配置" />
    <add key="SenparcUnionAgentKey" value="SenparcUnionAgentKey" />
    
    <!-- 以下為 Senparc.Weixin 的 SenparcWeixinSetting 微信配置，不使用的引數可以刪除  -->
    
    <!-- 微信公眾號URL對接資訊 -->
    <add key="WeixinToken" value="應用伺服器（開發者伺服器）URL對應的Token" />
    <add key="WeixinEncodingAESKey" value="應用伺服器（開發者伺服器）URL對應的訊息加解密金鑰" />
    <!-- 高階介面資訊 -->
    <add key="WeixinAppId" value="微信AppId" />
    <add key="WeixinAppSecret" value="微信AppSecret" />
    <!-- SDK提供的代理功能設定 -->
    <add key="WeixinAgentUrl" value="外部代理Url" />
    <add key="WeixinAgentToken" value="外部代理Token" />
    <add key="SenparcAgentKey" value="盛派代理系統通用Key" />
    <add key="WeixinAgentWeiweihiKey" value="外部代理WeiWeiHiKey" />
    <!-- 微信支付相關引數 -->
    <!-- 微信支付V2 -->
    <add key="WeixinPay_Tenpay" value="WeixinPay_Tenpay" />
    <add key="WeixinPay_PartnerId" value="WeixinPay_PartnerId" />
    <add key="WeixinPay_Key" value="WeixinPay_Key" />
    <add key="WeixinPay_AppId" value="WeixinPay_AppId" />
    <add key="WeixinPay_AppKey" value="WeixinPay_AppKey" />
    <add key="WeixinPay_TenpayNotify" value="WeixinPay_TenpayNotify" />
    <!-- 微信支付V3 -->
    <add key="TenPayV3_MchId" value="TenPayV3_MchId" />
    <add key="TenPayV3_Key" value="TenPayV3_Key" />
    <add key="TenPayV3_AppId" value="TenPayV3_AppId" />
    <add key="TenPayV3_AppSecret" value="TenPayV3_AppSecret" />
    <add key="TenPayV3_TenpayNotify" value="http://YourDomainName/TenpayV3/PayNotifyUrl" />
    <!-- 開放平臺 -->
    <add key="Component_Appid" value="Component_Appid" />
    <add key="Component_Secret" value="Component_Secret" />
    <add key="Component_Token" value="Component_Token" />
    <add key="Component_EncodingAESKey" value="Component_EncodingAESKey" />
    <!-- 微信企業號 -->
    <add key="WeixinCorpId" value="WeixinCorpId" />
    <add key="WeixinCorpSecret" value="WeixinCorpSecret" />

    <!-- 小程式 -->
    <!-- 小程式訊息URL對接資訊 -->
    <add key="WxOpenToken" value="小程式訊息URL對應的Token" />
    <add key="WxOpenEncodingAESKey" value="小程式訊息URL對應的訊息加解密金鑰" />
    <!-- 小程式祕鑰資訊 -->
    <add key="WxOpenAppId" value="微信小程式AppId" />
    <add key="WxOpenAppSecret" value="微信小程式AppSecret" />

    <!-- 自動識別引數結束 -->
View Code

 

.net core 專案： 

1、開啟 Startup.cs 檔案（可參考 Demo）

2、在 ConfigureServices() 方法中加入：

        public void ConfigureServices(IServiceCollection services)
        {
            //...
            services.AddSenparcGlobalServices(Configuration)//Senparc.CO2NET 全域性註冊
                    .AddSenparcWeixinServices(Configuration);//Senparc.Weixin 註冊
        }

3、修改 Configure() 方法傳入引數，並新增程式碼：

        public void Configure(IApplicationBuilder app, IHostingEnvironment env, IOptions<SenparcSetting> senparcSetting, IOptions<SenparcWeixinSetting> senparcWeixinSetting)
        {
            //app.UseMvc()等設定...

            // 啟動 CO2NET 全域性註冊，必須！
            IRegisterService register = RegisterService.Start(env, senparcSetting.Value)
                                                        .UseSenparcGlobal(false, null);

            //開始註冊微信資訊，必須！
            register.UseSenparcWeixin(senparcWeixinSetting.Value, senparcSetting.Value)
        }

 

 4、在 appsetting.json 檔案下插入以下設定（可參考 Demo）：

  //以下資訊會被自動識別，如無特殊說明，不用的引數可以刪除，但修改 key 後將會無法自動識別！

  //CO2NET 設定
  "SenparcSetting": {
    //以下為 CO2NET 的 SenparcSetting 全域性配置，請勿修改 key，勿刪除任何項

    "IsDebug": true,
    "DefaultCacheNamespace": "DefaultCache",
    //分散式快取
    "Cache_Redis_Configuration": "Redis配置",
    //"Cache_Redis_Configuration": "localhost:6379",
    "Cache_Memcached_Configuration": "Memcached配置",
    "SenparcUnionAgentKey": "SenparcUnionAgentKey"
  },
  //Senparc.Weixin SDK 設定
  "SenparcWeixinSetting": {
    //以下為 Senparc.Weixin 的 SenparcWeixinSetting 微信配置

    //微信全域性
    "IsDebug": true,

    //以下不使用的引數可以刪除，key 修改後將會失效

    //公眾號
    "Token": "weixin",
    "EncodingAESKey": "",
    "WeixinAppId": "WeixinAppId",
    "WeixinAppSecret": "WeixinAppSecret",
    //小程式
    "WxOpenAppId": "WxOpenAppId",
    "WxOpenAppSecret": "WxOpenAppSecret",
    "WxOpenToken": "WxOpenToken",
    "WxOpenEncodingAESKey": "WxOpenEncodingAESKey",
    //企業微信
    "WeixinCorpId": "WeixinCorpId",
    "WeixinCorpSecret": "WeixinCorpSecret",

    //微信支付
    //微信支付V2（舊版）
    "WeixinPay_PartnerId": "WeixinPay_PartnerId",
    "WeixinPay_Key": "WeixinPay_Key",
    "WeixinPay_AppId": "WeixinPay_AppId",
    "WeixinPay_AppKey": "WeixinPay_AppKey",
    "WeixinPay_TenpayNotify": "WeixinPay_TenpayNotify",
    //微信支付V3（新版）
    "TenPayV3_MchId": "TenPayV3_MchId",
    "TenPayV3_Key": "TenPayV3_Key",
    "TenPayV3_AppId": "TenPayV3_AppId",
    "TenPayV3_AppSecret": "TenPayV3_AppId",
    "TenPayV3_TenpayNotify": "TenPayV3_TenpayNotify",

    //開放平臺
    "Component_Appid": "Component_Appid",
    "Component_Secret": "Component_Secret",
    "Component_Token": "Component_Token",
    "Component_EncodingAESKey": "Component_EncodingAESKey",

    //擴充套件及代理引數
    "AgentUrl": "AgentUrl",
    "AgentToken": "AgentToken",
    "SenparcWechatAgentKey": "SenparcWechatAgentKey"
  }
View Code

 

　　第四步：建立一個Controller，如WeixinController.cs

 

 

　　第四步：修改WeixinController.cs

    我們將下列程式碼加入WeixinController.cs：

 1 using System;
 2 using System.IO;
 3 using System.Web.Configuration;
 4 using System.Web.Mvc;
 5 using Senparc.Weixin.MP.Entities.Request;
 6 
 7 namespace Senparc.Weixin.MP.Sample.Controllers
 8 {
 9     using Senparc.Weixin.MP.MvcExtension;
10     using Senparc.Weixin.MP.Sample.CommonService.CustomMessageHandler;
11 
12     public partial class WeixinController : Controller
13     {
14         public static readonly string Token = Config.SenparcWeixinSetting.Token;//與微信公眾賬號後臺的Token設定保持一致，區分大小寫。
15         public static readonly string EncodingAESKey = Config.SenparcWeixinSetting.EncodingAESKey;//與微信公眾賬號後臺的EncodingAESKey設定保持一致，區分大小寫。
16         public static readonly string AppId = Config.SenparcWeixinSetting.WeixinAppId;//與微信公眾賬號後臺的AppId設定保持一致，區分大小寫。
17 
18         /// <summary>
19         /// 微信後臺驗證地址（使用Get），微信後臺的“介面配置資訊”的Url填寫如：http://weixin.senparc.com/weixin
20         /// </summary>
21         [HttpGet]
22         [ActionName("Index")]
23         public ActionResult Get(PostModel postModel, string echostr)
24         {
25             if (CheckSignature.Check(postModel.Signature, postModel.Timestamp, postModel.Nonce, Token))
26             {
27                 return Content(echostr); //返回隨機字串則表示驗證通過
28             }
29             else
30             {
31                 return Content("failed:" + postModel.Signature + "," + MP.CheckSignature.GetSignature(postModel.Timestamp, postModel.Nonce, Token) + "。" +
32                     "如果你在瀏覽器中看到這句話，說明此地址可以被作為微信公眾賬號後臺的Url，請注意保持Token一致。");
33             }
34         }
35 
36         /// <summary>
37         /// 使用者傳送訊息後，微信平臺自動Post一個請求到這裡，並等待響應XML。
38         /// PS：此方法為簡化方法，效果與OldPost一致。
39         /// v0.8之後的版本可以結合Senparc.Weixin.MP.MvcExtension擴充套件包，使用WeixinResult，見MiniPost方法。
40         /// </summary>
41         [HttpPost]
42         [ActionName("Index")]
43         public ActionResult Post(PostModel postModel)
44         {
45             if (!CheckSignature.Check(postModel.Signature, postModel.Timestamp, postModel.Nonce, Token))
46             {
47                 return Content("引數錯誤！");
48             }
49 
50             postModel.Token = Token;//根據自己後臺的設定保持一致
51             postModel.EncodingAESKey = EncodingAESKey;//根據自己後臺的設定保持一致
52             postModel.AppId = AppId;//根據自己後臺的設定保持一致
53 
54             //自定義MessageHandler，對微信請求的詳細判斷操作都在這裡面。
55             var messageHandler = new CustomMessageHandler(Request.InputStream, postModel);//接收訊息
56 
57             messageHandler.Execute();//執行微信處理過程
58 
59             return new FixWeixinBugWeixinResult(messageHandler);//返回結果
60 
61         }
62     }
63 }

 

    第一個 Get()  對應微信後臺設定 URL 時候的請求（只在驗證的時候用到），第二個 Post() 用於接收微信伺服器轉發過來的客戶請求。

    其中 CustomMessageHandler 是我們自己建立的一個類，用於實現 MessageHandler（有關MessageHandler的詳細介紹可以看《Senparc.Weixin.MP SDK 微信公眾平臺開發教程（六）：瞭解MessageHandler》，也可以看這裡），所有處理微信訊息的核心邏輯都被包含到 CustomMessageHandler 中執行。除了承擔處理微信響應的任務，MessageHandler 還實現了處理單個使用者對話上下文等功能，非常方便。

 

    至此，整個Senparc.Weixin.MP SDK已經基本開發完畢，可以直接釋出，並在微信後臺使用“高階功能”對接了。

    在微信後臺設定中，Url 填寫 http://xxx/Weixin，Token 填寫 Web.config 中的“WeixinToken ” 或 appsetting.json 中的“Token”所設定的值。

    （如何在微信後臺設定請看：Senparc.Weixin.MP SDK 微信公眾平臺開發教程（三）：微信公眾平臺開發驗證）

 

    接下去我們會介紹如何在MessageHandler中處理具體的微信請求（文字、圖片、位置、語音等等）。

 

系列教程索引

地址：http://www.cnblogs.com/szw/archive/2013/05/14/weixin-course-index.html

  1. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（一）：微信公眾平臺註冊
  2. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（二）：成為開發者
  3. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（三）：微信公眾平臺開發驗證
  4. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（四）：Hello World
  5. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（五）：使用Senparc.Weixin.MP SDK
  6. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（六）：瞭解MessageHandler
  7. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（七）：解決使用者上下文（Session）問題
  8. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（八）：通用介面說明
  9. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（九）：自定義選單介面說明
  10. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（十）：多客服介面說明
  11. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（十一）：高階介面說明
  12. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（十二）：OAuth2.0說明
  13. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（十三）：地圖相關介面說明
  14. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（十四）：請求訊息去重
  15. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（十五）：訊息加密
  16. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（十六）：AccessToken自動管理機制
  17. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（十七）：個性化選單介面說明
  18. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（十八）：Web代理功能
  19. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（十九）：MessageHandler 的未知型別訊息處理
  20. Senparc.Weixin.MP SDK 微信公眾平臺開發教程（二十）：使用選單訊息功能

 

相關文章