輕量級開源小程序SDK發車啦

輕量級微信小程序SDK，支持.NET Framework以及.NET Core。目前已提供Abp模塊的封裝，支持開箱即用。

Nuget

新的包

主要功能

輕量級微信小程序SDK，以便於簡單方便的實現小程序服務端API的調用。具體見單元測試。

RoadMap

更新歷史

0.0.5

開始使用

如果使用Abp相關模塊，則使用起來比較簡單，具體您可以參考相關單元測試的編寫。主要有以下步驟：

如果僅需某個支付，僅需引用該支付的包。下面以通聯支付為例，我們需要在工程中引用此包：

在對應工程的Abp的模塊（AbpModule）中，添加對“WxMiniProgramSdkModule”的依賴，如：

 [DependsOn(typeof(WxMiniProgramSdkModule))]

如何配置？

 "App_MiniProgram": {
    "MiniProgramAppId": "wx25fa5d55ef27e086",
    "MiniProgramAppSecret": "ab02ac4499c9764108a78e19476d7101"
  }

對於非ABP集成，則需要自己實例化或注入配置類對象，可以參考單元測試的編寫。

非ABP集成

請參考Abp相關模塊的封裝或者相關的單元測試代碼，目前“Test”工程對應非ABP集成方式的使用，“Abp.Test”工程對應集成ABP之后的使用。

分布式緩存配置

為了支持分布式架構，已引入IDistributedCache來支持分布式緩存，在開發測試或單主機服務中，需使用以下代碼進行注入：

services.AddDistributedMemoryCache();

services.AddDistributedRedisCache(options =>
{
    options.Configuration = "localhost";
    options.InstanceName = "SampleInstance";
});

如何添加API？（PR）

由於作者精力有限，非常歡迎各位參與共建。主體步驟如下所示：

1.添加目錄

在工程【Magicodes.WxMiniProgram.Sdk】下的【Services】目錄下添加對應業務模塊目錄，比如二維碼為“QRCode”。

2.添加對應接口的AppService

3.基於ServiceBase提供的封裝來編寫接口邏輯

 /// <summary>
    /// 獲取小程序碼，適用於需要的碼數量較少的業務場景。通過該接口生成的小程序碼，永久有效，有數量限制
    /// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/qr-code/wxacode.get.html
    /// </summary>
    /// <param name="path">掃碼進入的小程序頁面路徑，最大長度 128 字節，不能為空；對於小游戲，可以只傳入 query 部分，來實現傳參效果，如：傳入 "?foo=bar"，即可在 wx.getLaunchOptionsSync 接口中的 query 參數獲取到 {foo:"bar"}。</param>
    /// <param name="autoColor">自動配置線條顏色，如果顏色依然是黑色，則說明不建議配置主色調</param>
    /// <param name="lineColor">auto_color 為 false 時生效，使用 rgb 設置顏色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十進制表示</param>
    /// <param name="isHyaline">是否需要透明底色，為 true 時，生成透明底色的小程序碼</param>
    /// <param name="width">二維碼的寬度，單位 px。最小 280px，最大 1280px</param>
    /// <returns></returns>
    public async Task<byte[]> Get(string path, bool autoColor = false, object lineColor = null, bool isHyaline = false,
        int width = 430)
    {
        if (string.IsNullOrWhiteSpace(path)) throw new ArgumentException("參數不能為空！", nameof(path));
        return await DownloadData("wxa/getwxacode?access_token={ACCESS_TOKEN}", RestSharp.Method.POST, new
        {
            path,
            width,
            auto_color = autoColor,
            line_color = lineColor ?? new { r = 0, g = 0, b = 0 },
            is_hyaline = isHyaline
        });
    }

public class SnsAppService : ServiceBase
{
    private const string ApiName = "sns";
    private readonly IMiniProgramConfig _config;

    public SnsAppService(IMiniProgramConfig config)
    {
        _config = config;
    }

    /// <summary>
    ///     根據登錄憑證獲取Sns信息（openid、session_key、unionid）
    /// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/login/auth.code2Session.html
    /// </summary>
    /// <param name="code">登錄時獲取的 code</param>
    public async Task<GetSnsInfoByCodeOutput> JscodeToSession(string code)
    {
        if (string.IsNullOrWhiteSpace(code)) throw new ArgumentException("參數不能為空！", nameof(code));
        //獲取api請求url
        var url =
            $"{ApiName}/jscode2session?appid={_config.MiniProgramAppId}&secret={_config.MiniProgramAppSecret}&js_code={code}&grant_type=authorization_code";

        return await HttpGet<GetSnsInfoByCodeOutput>(url);
    }
}

4.編寫相關單元測試，並確保通過

單元測試請參考工程【Test】和【Abp.Test】，可以通過ServiceOutputBase的IsSuccess方法來判斷是否成功：

public class TokenTest : AbpTestBase
{
    public TokenTest(ITestOutputHelper testOutputHelper)
    {
        _testOutputHelper = testOutputHelper;
        _tokenAppService = Resolve<TokenAppService>();
    }

    private readonly ITestOutputHelper _testOutputHelper;
    private readonly TokenAppService _tokenAppService;

    [Fact]
    public async Task Get_Test()
    {
        var result = await _tokenAppService.GetAsync();
        _testOutputHelper.WriteLine(JsonConvert.SerializeObject(result));
        result.IsSuccess().ShouldBe(true);
        result.AccessToken.ShouldNotBeNullOrWhiteSpace();
    }
}