百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 热门文章 > 正文

轻量级开源小程序SDK发车啦

bigegpt 2024-08-07 17:48 9 浏览

Magicodes.WxMiniProgram.Sdk

轻量级微信小程序SDK,支持.NET Framework以及.NET Core。目前已提供Abp模块的封装,支持开箱即用。

地址:https://github.com/xin-lai/Magicodes.WxMiniProgram.Sdk

Nuget

新的包

主要功能

轻量级微信小程序SDK,以便于简单方便的实现小程序服务端API的调用。具体见单元测试。

RoadMap

  • 完善接口

    • 登录

    • 用户信息

    • 接口调用凭证

    • 数据分析

    • 客服消息

    • 模板消息

    • 统一服务消息

    • 动态消息

    • 插件管理

    • 附近的小程序

    • 小程序

    • 内容安全

    • 广告

    • 图像处理

    • OCR

    • 运维中心

    • 搜索

    • 生物认证

    • 订阅消息

  • AccessToken自动传参,无需显式指定

  • 方法参数改成类参数,并且支持通过特性校验

更新历史

0.0.5

  • 重构AccessToken管理

  • 添加对分布式架构支持(使用分布式缓存)

  • 重构Http请求模块,移除HttpClient

  • 添加获取二维码接口(Create、Get、GetUnlimited),详见单元测试

开始使用

如果使用Abp相关模块,则使用起来比较简单,具体您可以参考相关单元测试的编写。主要有以下步骤:

  1. 引用对应的Abp的Nuget包

如果仅需某个支付,仅需引用该支付的包。下面以通联支付为例,我们需要在工程中引用此包:

  1. 在对应工程的Abp的模块(AbpModule)中,添加

    对“WxMiniProgramSdkModule”的依赖,如:添加模块依赖

[DependsOn(typeof(WxMiniProgramSdkModule))]
  1. 直接使用

通过构造函数或者属性注入相关服务,即可直接使用。

如何配置?

对于ABP集成,则可以通过以下方式获取配置:

  • 配置文件,如:

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

以上为个人小程序号配置,仅用于测试,请勿乱搞!

  • 配置管理器

需存储JSON对象,对应的key为“App_MiniProgram”。

对于非ABP集成,则需要自己实例化或注入配置类对象,可以参考单元测试的编写。

非ABP集成

请参考Abp相关模块的封装或者相关的单元测试代码,目前“Test”工程对应非ABP集成方式的使用,“Abp.Test”工程对应集成ABP之后的使用。

分布式缓存配置

为了支持分布式架构,已引入IDistributedCache来支持分布式缓存,在开发测试或单主机服务中,需使用以下代码进行注入:

services.AddDistributedMemoryCache;

如需使用Redis,请参考下面代码:

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

如何添加API?(PR)

由于作者精力有限,非常欢迎各位参与共建。主体步骤如下所示:

1.添加目录

在工程【Magicodes.WxMiniProgram.Sdk】下的【Services】目录下添加对应业务模块目录,比如二维码为“QRCode”。

2.添加对应接口的AppService

例如添加QRCodeAppService,继承自ServiceBase

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 = , bool isHyaline = false,int width = 430) {if (string.IsOrWhiteSpace(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 }); }

如上述代码所示,注意事项如下:

  1. 通过DownloadData函数下载二维码

  2. 如需使用access_token,请在Url添加access_token={ACCESS_TOKEN}【后续将进一步优化】

如需返回JSON对象,示例如下所示:

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.IsOrWhiteSpace(code)) throw new ArgumentException("参数不能为空!", nameof(code));//获取api请求urlvar url =$"{ApiName}/jscode2session?appid={_config.MiniProgramAppId}&secret={_config.MiniProgramAppSecret}&js_code={code}&grant_type=authorization_code";
return await HttpGet<GetSnsInfoByCodeOutput>(url); }}

注意事项如下:

  • 添加GetSnsInfoByCodeOutput,需继承自ServiceOutputBase

  • 使用HttpGet或HttpPost方法来完成请求

  • Output类中的属性请遵守C#命名规范,可以使用“JsonProperty”特性进行配置


    /// <summary>/// 凭证有效时间,单位:秒/// </summary> [JsonProperty("expires_in")]public int Expires { get; set; }
    /// <summary>/// access_token/// </summary> [JsonProperty("access_token")]public string AccessToken { get; set; }

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.ShouldNotBeOrWhiteSpace; }}

官方订阅号

关注“麦扣聊技术”订阅号免费获取:

  • 最新文章、教程、文档

  • 视频教程

  • 基础版免费授权

  • 模板

  • 解决方案

  • 编程心得和理念

相关QQ群

编程交流群<85318032>

产品交流群<897857351>

官方博客/文档站

  • http://www.cnblogs.com/codelove/

  • https://docs.xin-lai.com/

其他开源库地址

  • https://gitee.com/magicodes/Magicodes.Admin.Core

  • https://github.com/xin-lai

转载是一种动力 分享是一种美德

如果喜欢作者的文章,请关注【麦扣聊技术】订阅号以便第一时间获得最新内容。本文版权归作者和湖南心莱信息科技有限公司共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。

文档官网:docs.xin-lai.com

相关推荐

pyproject.toml到底是什么东西?(py trim)

最近,在Twitter上有一个Python项目的维护者,他的项目因为构建失败而出现了一些bug(这个特别的项目不提供wheel,只提供sdist)。最终,发现这个bug是由于这个项目使用了一个pypr...

BDP服务平台SDK for Python3发布(bdp数据平台)

下载地址https://github.com/imysm/opends-sdk-python3.git说明最近在开发和bdp平台有关的项目,用到了bdp的python的sdk,但是官方是基于p...

Python-for-Android (p4a):(python-for-android p4a windows)

一、Python-for-Android(p4a)简介Python-for-Android(p4a),一个强大的开发工具,能够将你的Python应用程序打包成可在Android设备上运行...

Qt for Python—Qt Designer 概览

前言本系列第三篇文章(QtforPython学习笔记—应用程序初探)、第四篇文章(QtforPython学习笔记—应用程序再探)中均是使用纯代码方式来开发PySide6GUI应用程序...

Python:判断质数(jmu-python-判断质数)

#Python:判断质数defisPrime(n):foriinrange(2,n):ifn%i==0:return0re...

为什么那么多人讨厌Python(为什么python这么难)

Python那么棒,为什么那么多人讨厌它呢?我整理了一下,主要有这些原因:用缩进替代大括号许多人抱怨Python完全依赖于缩进来创建代码块,代码多一点就很难看到函数在哪里结束,那么你就需要把一个函数拆...

一文了解 Python 中带有 else 的循环语句 for-else/while-else

在本文中,我们将向您介绍如何在python中使用带有else的for/while循环语句。可能许多人对循环和else一起使用感到困惑,因为在if-else选择结构中else正常...

python的numpy向量化语句为什么会比for快?

我们先来看看,python之类语言的for循环,和其它语言相比,额外付出了什么。我们知道,python是解释执行的。举例来说,执行x=1234+5678,对编译型语言,是从内存读入两个shor...

开眼界!Python遍历文件可以这样做

来源:【公众号】Python技术Python对于文件夹或者文件的遍历一般有两种操作方法,一种是至二级利用其封装好的walk方法操作:import osfor root,d...

告别简单format()!Python Formatter类让你的代码更专业

Python中Formatter类是string模块中的一个重要类,它实现了Python字符串格式化的底层机制,允许开发者创建自定义的格式化行为。通过深入理解Formatter类的工作原理和使用方法,...

python学习——038如何将for循环改写成列表推导式

在Python里,列表推导式是一种能够简洁生成列表的表达式,可用于替换普通的for循环。下面是列表推导式的基本语法和常见应用场景。基本语法result=[]foriteminite...

详谈for循环和while循环的区别(for循环语句与while循环语句有什么区别)

初九,潜龙勿用在刚开始使用python循环语句时,经常会遇到for循环和while循环的混用,不清楚该如何选择;今天就对这2个循环语句做深入的分析,让大家更好地了解这2个循环语句以方便后续学习的加深。...

Python编程基础:循环结构for和while

Python中的循环结构包括两个,一是遍历循环(for循环),一是条件循环(while循环)。遍历循环遍历循环(for循环)会挨个访问序列或可迭代对象的元素,并执行里面的代码块。foriinra...

学习编程第154天 python编程 for循环输出菱形图

今天学习的是刘金玉老师零基础Python教程第38期,主要内容是python编程for循环输出菱形※。(一)利用for循环输出菱形形状的*号图形1.思路:将菱形分解为上下两个部分三角形图案,分别利用...

python 10个堪称完美的for循环实践

在Python中,for循环的高效使用能显著提升代码性能和可读性。以下是10个堪称完美的for循环实践,涵盖数据处理、算法优化和Pythonic编程风格:1.遍历列表同时获取索引(enumerate...