当前项目主要是针对社交网站的接口封装,在项目前期主要以微信平台sdk开发为主,根据接口功能层次简单分类,
此项目以标准库的形式提供服务,也就是可以同时支持.Net Framework(4.6及以上版本) 和 .Net Core
如果有问题,也可以在公众号(osscoder)中提问:
一. 授权对接模块 (Oauth)
nuget下安装命令:Install-Package OSS.SnsSdk.Oauth
用户授权(oauth2.0),用户授权基础信息
二. 会话消息模块 (msg)
nuget下安装命令:Install-Package OSS.SnsSdk.Msg.Wx
会话管理,接收用户的会话信息,以及对应的响应
三. 公号高级功能 (offcial)
nuget下安装命令:**Install-Package OSS.SnsSdk.Official.Wx**
这个模块主要是对公众号内部的功能,像关注用户,标签,素材,统计,小店等功能的对接
这里根据接口使用频率以及使用对象 分为两个组成部分
1.通用功能部分 (offcial 下 Basic 文件夹)
这一部分主要是正常运营,使用率高的功能。
包括用户信息,标签,素材,菜单管理等
2.管理部分 (offcial 下 其他文件夹)
这一部分主要是运营管理,使用频率较低,需要技术支持的功能。
包括统计,卡券,门店,设备,客服等功能
1.基础授权调用(sns文件夹下)
//声明配置信息
private static AppConfig m_Config = new AppConfig()
{
AppSource = "11",
AppId = "你的appId",
AppSecret = "你的secretkey"
};
// 接口api实例
private static WxOauthApi m_AuthApi = new WxOauthApi(m_Config);
// 获取微信授权地址
public ActionResult auth()
{
var res = m_AuthApi.GetAuthorizeUrl("http://www.social.com/wxoauth/callback",
AuthClientType.WxOffcial);
return Redirect(res);
}
// 微信回调页,此页面获取accesstoken 获取用户基础信息
public ActionResult callback(string code, string state)
{
var tokecRes = m_AuthApi.GetAuthAccessToken(code);
if (tokecRes.IsSuccess())
{
var userInfoRes = m_AuthApi.GetWxAuthUserInfo(tokecRes.AccessToken, tokecRes.OpenId);
return Content("你已成功获取用户信息!");
}
return Content("获取用户授权信息失败!");
}
2.会话调用 (Msg文件夹下)
a.首先声明配置信息
// 声明配置
private static readonly WxMsgServerConfig config = new WxMsgServerConfig()
{
Token = "你的token",
EncodingAesKey = "你的加密key",
SecurityType = WxSecurityType.Safe,// 在微信段设置的安全模式
AppId = "你的appid" //
};
b. 定义一个处理句柄(可以实现一个自己的Handler,继承自WxMsgHandler 即可)
private static readonly WxMsgHandler msgService = new WxMsgHandler(config);
c. 调用时将当前请求的内容传入程序入口即可:
using (StreamReader reader = new StreamReader(Request.InputStream))
{
requestXml = reader.ReadToEnd();
}
try
{
var res = msgService.Process( requestXml, signature, timestamp, nonce,echostr);
if (res.IsSuccess())
return Content(res.data);
}
catch (Exception ex)
{
}
return Content("success");
其中WxMsgHandler 可以是自己继承WxMsgHandler 实现的具体处理类,通过重写相关用户事件返回对应结果即可。
3.高级功能调用(Offcial文件夹下)
微信公众号的其他高级功能接口都需要一个全局的accesstoken接口,像推送模块信息等,accesstoken自动获取已经被封装在sdk底层的请求处理中,默认会使用系统缓存保存,过期自动更新,如果需要保存到像redis中可以通过oscommon中的缓存模块注入,添加一个针对sns的缓存模块实现就可以了(后续给出一个示例),access和appid一一对应,不用担心多个公众号的冲突问题。
a. 声明配置信息:
//声明配置信息
private static AppConfig m_Config = new AppConfig()
{
AppSource = "11",
AppId = "你的appId",
AppSecret = "你的secretkey"
};
b. 声明一个实例:
private static readonly WxOffMassApi m_OffcialApi = new WxOffMassApi(m_Config);
c. 具体使用
m_OffcialApi.SendTemplateAsync("openid","templateId","url",new {})
当前这部分接口框架逻辑部分已经处理完毕,公号主要功能已经完成,还差小店和设备管理(Offcial)等部分的接口完善,后续将很快更新,如果有需要的也可以自己实现或贡献过来,添加一个新接口只需要几行代码即可,详见贡献代码。
这个项目当前主要集中在微信sdk处理,微信部分主体框架部分已经完成,需要对接口进行补充,根据已经封装完毕的框架完成一个接口将非常简单(优雅?!),以获取用户基本信息为例,简单分为以下两部步:
1.声明对象实体
// 获取用户基本信息请求实体
public class WxOffcialUserInfoReq
{
public string openid { get; set; }
public string lang { get; set; }
}
// 响应实体,继承WxBaseResp
public class WxOffcialUserInfoResp:WxBaseResp
{
public string openid { get; set; }
public string nickname { get; set; }
//... 字段省略
public List<int> tagid_list { get; set; }
}
我写了个js页面,快速通过微信文档字段描述生成实体 Gist地址,开源**地址
2.功能实现
public WxOffcialUserInfoResp GetUserInfo(WxOffcialUserInfoReq userReq)
{
var req = new OsHttpRequest();
req.HttpMethod = HttpMethod.Get;
req.AddressUrl = string.Concat(m_ApiUrl,
$"/cgi-bin/user/info?openid={userReq.openid}&lang={userReq.lang}");
// 请求地址中的AccessToken 底层会自动补充
return RestCommonOffcial<WxOffcialUserInfoResp>(req);
}
3.添加单元测试(非必须)
[TestMethod]
public void GetUserInfoTest()
{
var res = m_Api.GetUserInfo(new WxOffcialUserInfoReq()
{openid = "o7gE1s6mygEKgopVWp7BBtEAqT-w" });
Assert.IsTrue(res.IsSuccess());
}
剩下的通过git提交即可。
尽快完善
当前项目依赖于我以前写的开源项目 OSS.Common(全局错误实体,和模块注入) 和 OSS.Http(http请求) 都比较简单小巧,只有几个class,不用担心臃肿