VopSdk一个高逼格微信公众号开发SDK

2017-05-04 20:37

 一、我们的目标

       分离基础参数和业务参数。

       具有高重用和扩展性。

       轻量级。

二、实现目标

      (一)分离基础参数和业务参数

               仔细分析所有接口,抽离出每个模块接口的公共参数。

               A、针对微信公众号所有接口分析(不包括微信支付)

                   a、获取基础Access_Token使用的是AppId和AppSecret。

                   b、网页授权相对独立,但也会使用到AppId和AppSecret。

                   c、其他接口,皆是通过基础Access_Token来获取数据的。

               根据a、b、c得出公共或者说SDK保留参数即为SDK的基础参数有AppId、AppSecret、基础Access_Token。

 

             B、微信支付接口分析

                  分析所得,都有appid、mch_id、nonce_str、sign_type、sign参数,即为SDK基础参数。

                  针对退款还有两个特殊参数,证书路径以及证书密码。

 

             根据A、B所得,我们抽离出了基础参数,基础参数不能和业务参数只能通过初始化或者调用单独方法复制,业务参数用于调固定方法一次性传入。

 

      (二)具有高重用和扩展性

              普通接口有两种调用方法GET和POST,针对GET就是参数就在地址上,地址上的参数既包括基础参数也包含了业务参数;POST的情况业务参数是json格式;出参都是json。

              支付接口入参和出参都是xml。

 

              设计之处就得考虑到上面不同场景,每个接口对象可设置自己请求方式(GET或者POST);每个接口可设置自己格式化方式(json或者xml)。

              针对退款还可设置是否需要证书以及设置证书路径和证书密码等公共方法。

 

       (三)轻量级

               不引用第三方组件。

 

 

下面是测试样例:

a、删除菜单

        public static void Test()
        {
            Vop.Api.Request.VopMobilePublicMenuDeleteRequest request = new Vop.Api.Request.VopMobilePublicMenuDeleteRequest();
            Vop.Api.IVopClient client = new Vop.Api.DefaultVopClient(Config.AppId, Config.AppSecret);
            string accessToken = Vop.Api.Util.AccessTokenContainer.GetAccessToken(Config.AppId, Config.AppSecret);
            var result = client.Execute(request, accessToken);
        }

 

b、创建菜单

        public static void Test()
        {
             string menuStr = "{\"button\":[{\"name\":\"医疗业务\",\"sub_button\":[{\"type\":\"view\",\"name\":\"主页\",\"url\":\"http://m.baidu.com\"}]}]}";

            Vop.Api.Request.VopMobilePublicMenuCreateRequest request = new Vop.Api.Request.VopMobilePublicMenuCreateRequest();
            request.SetBizModel(menuStr);
            Vop.Api.IVopClient client = new Vop.Api.DefaultVopClient(Config.AppId, Config.AppSecret);
            string accessToken = Vop.Api.Util.AccessTokenContainer.GetAccessToken(Config.AppId, Config.AppSecret);
            var result = client.Execute(request, accessToken);
        }

c、发送消息

        public static void Test()
        {
            Vop.Api.Request.VopMobilePublicMessageCustomSendRequest request = new Vop.Api.Request.VopMobilePublicMessageCustomSendRequest();
            request.SetBizModel("{\"touser\":\"osDGfuNaaSJ1LbScpzpeRXF107L4\",\"msgtype\":\"text\",\"text\":{\"content\":\"你好\"}}");
            Vop.Api.IVopClient client = new Vop.Api.DefaultVopClient(Config.AppId, Config.AppSecret);
            string accessToken = Vop.Api.Util.AccessTokenContainer.GetAccessToken(Config.AppId, Config.AppSecret);
            var result = client.Execute(request, accessToken);
        }

 

d、获取用户信息

        public static void Test()
        {
            Vop.Api.Request.VopMobilePublicUserInfoRequest request = new Vop.Api.Request.VopMobilePublicUserInfoRequest();
            request.SetBizModel("openid=osDGfuNaaSJ1LbScpzpeRXF107L4&lang=zh_CN");
            Vop.Api.IVopClient client = new Vop.Api.DefaultVopClient(Config.AppId, Config.AppSecret);
            string accessToken = Vop.Api.Util.AccessTokenContainer.GetAccessToken(Config.AppId, Config.AppSecret);
            var result = client.Execute(request, accessToken);
        }

 

e、支付接口

        public static void Test()
        {
            Vop.Api.IVopClient client = new Vop.Api.DefaultVopClient(Config.AppId, Config.AppSecret, "utf-8", Config.MchId, Config.MchSecret);
            Vop.Api.Request.VopTradeWapPayRequest request = new Vop.Api.Request.VopTradeWapPayRequest();
            request.SetBizModel(string.Format("<body>{0}</body><out_trade_no>{1}</out_trade_no><total_fee>{2}</total_fee><spbill_create_ip>{3}</spbill_create_ip><notify_url>{4}</notify_url><trade_type>{5}</trade_type><openid>{6}</openid>", "test", CreateOrderNo(), 1, "8.8.8.8", "http://wxcp.zlsoft.com/open/check", "JSAPI", "oskHZwpNB6K4eaGkL3m7bPdAZQ0Y"));
            var r1 = client.PayExecute(request);
        }
        private static string CreateOrderNo()
        {
            return string.Format("{0}{1:D4}", DateTime.Now.ToString("yyyyMMddHHmmss"), Math.Abs(BitConverter.ToInt32(Guid.NewGuid().ToByteArray(), 0)));
        }

 

 

。。。。。。。

 

是不是很简单啊,如果我要新增一个接口怎么弄呢,So Easy.

比如新增一个发送模板消息的接口,你只需创建两个类即可完成:

接口请求对象: VopMobilePublicMessageTemplateSendRequest.cs 

接口返回实体: VopMobilePublicMessageTemplateSendResponse.cs 

 

VopMobilePublicMessageTemplateSendRequest.cs

namespace Vop.Api.Request
{
    public class VopMobilePublicMessageTemplateSendRequest : VopPublicRequest<VopMobilePublicMessageTemplateSendResponse>, IVopRequest<VopMobilePublicMessageTemplateSendResponse>
    {
        public override string GetApiUrl()
        {
            this.apiUrl = "https://api.weixin.qq.com/cgi-bin/message/template/send?access_token={0}";
            return string.Format(this.apiUrl, GetAccessToken());
        }

        public override string GetApiMethod()
        {
            this.apiMethod = "POST";
            return this.apiMethod;
        }
    }
}

 

VopMobilePublicMessageTemplateSendResponse.cs

  [DataContract] public class VopMobilePublicMessageTemplateSendResponse : VopPublicResponse { } 

 

好了,新增的发送模板消息就算完成了,下面是该接口的测试

        public static void Test()
        {
            Vop.Api.Request.VopMobilePublicMessageTemplateSendRequest request = new Vop.Api.Request.VopMobilePublicMessageTemplateSendRequest();
            request.SetBizModel(Config.GetTestData("VopMobilePublicMessageTemplateSendTest"));
            Vop.Api.IVopClient client = new Vop.Api.DefaultVopClient(Config.AppId, Config.AppSecret);
            string accessToken = Vop.Api.Util.AccessTokenContainer.GetAccessToken(Config.AppId, Config.AppSecret);
            var result = client.Execute(request, accessToken);
        }

 

 

想知道怎么实现的吗?获取源码我不给,你打我呀,啊哈哈哈哈。。。

项目截图

VopSdk一个高逼格微信公众号开发SDK0

VopSdk一个高逼格微信公众号开发SDK1

 

源码地址:回复邮箱,我统一发。