一、前言
      特别不喜欢麻烦的一个人，最近碰到了微信开发。下载下来了一些其他人写的微信开发“框架”，但是被恶心到了，实现的太臃肿啦。
      最不喜欢的就是把微信返回的xml消息在组装成实体类，所以会比较臃肿，现在都提倡轻量级，所以有什么办法可以避免大量实体类的存在呢。
      当然，还有包装的比较繁杂，看完官方api后，再看框架，让人感觉一头雾水，不够清晰、明了。
二、我的实现思路
      我的微信sdk（不敢自称框架），最重要的实现2个目标：
      1.轻量级，就是要摒弃实体类，尽量少的申明entity，减少sdk的体量；
      2.简单、明了，就是sdk类的划分和官方api保持一致，让人一看就懂你的用意。
      用户发送请是首先post到微信服务器的，然后微信服务器在post到我的服务器，这个接受的消息是xml,我猜测为什么是xml,而不是更轻量级的json，是为了更好的兼容性，毕竟xml更通用一些（说错了，请指出来）。而我们主动调用微信的一些api时，它返回的是json格式，我靠，要死啊，高大上啊。你们的副总裁张小龙不知道这事吗？好吧，这样其实也可以的。
       其实，调用微信的工作原理很简单，没有必要上来就框架什么的，我相信是个合格的程序员都能做出来。
       我们的服务器只需要一个get,和一个post就可以和微信通信了，从这一点来看，设计的还是比较人性化的，赞一个。get用于接通微信服务的校验，验证；post用于接收微信服务器过来的消息，然后将response组装好返回即可。
三、上代码
       好了，废话不多说了。
       由于微信服务器post给我们的是xml消息，返回的是json,所以需要互转。这样就存在3种类型的format,这也是大量的框架定义实体类导致框架不够轻量级的的原因之所在。
       实现第一个目标，我主要用到了.net framework4.0的dynamic特性，和一个将xml字符串自动转换成dynamic object的dynamicxml.cs类，还有一个将json字符串自动转换成dynamic object的dynamicjson.cs类。
       苦苦寻觅，终于让我找到了我想要的。
       1.以下是dynamicxml.cs类，文件头有原作者的版权信息。
/*-------------------------------------------------------------------------- * https://www.captechconsulting.com/blog/kevin-hazzard/fluent-xml-parsing-using-cs-dynamic-type-part-1 * 博客园网友 夜の魔王 友情借用此代码，用于微信开发。 * http://www.cnblogs.com/deepleo/*--------------------------------------------------------------------------*/using system;using system.collections.generic;using system.linq;using system.dynamic;using system.xml.linq;using system.collections;public class dynamicxml : dynamicobject, ienumerable { private readonly list<xelement> _elements; public dynamicxml(string text) { var doc = xdocument.parse(text); _elements = new list<xelement> { doc.root }; } protected dynamicxml(xelement element) { _elements = new list<xelement> { element }; } protected dynamicxml(ienumerable<xelement> elements) { _elements = new list<xelement>(elements); } public override bool trygetmember(getmemberbinder binder, out object result) { result = null; if (binder.name == "value") result = _elements[0].value; else if (binder.name == "count") result = _elements.count; else { var attr = _elements[0].attribute(xname.get(binder.name)); if (attr != null) result = attr; else { var items = _elements.descendants(xname.get(binder.name)); if (items == null || items.count() == 0) return false; result = new dynamicxml(items); } } return true; } public override bool trygetindex(getindexbinder binder, object[] indexes, out object result) { int ndx = (int)indexes[0]; result = new dynamicxml(_elements[ndx]); return true; } public ienumerator getenumerator() { foreach (var element in _elements) yield return new dynamicxml(element); } }
view code
这个代码我也没仔细看，反正能用，没出过差错。
2.以下是dynamicjson.cs类，文件头有原作者的版权信息
/*-------------------------------------------------------------------------- * dynamicjson * ver 1.2.0.0 (may. 21th, 2010) * * created and maintained by neuecc <ils@neue.cc> * licensed under microsoft public license(ms-pl) * http://neue.cc/* http://dynamicjson.codeplex.com/ * 博客园网友 夜の魔王 友情借用此代码，用于微信开发。 * http://www.cnblogs.com/deepleo/*--------------------------------------------------------------------------*/using system;using system.collections;using system.collections.generic;using system.diagnostics;using system.dynamic;using system.io;using system.linq;using system.reflection;using system.runtime.serialization.json;using system.text;using system.xml;using system.xml.linq;namespace codeplex.data { public class dynamicjson : dynamicobject { private enum jsontype { @string, number, boolean, @object, array, @null } // public static methods /// <summary>from jsonsring to dynamicjson</summary> public static dynamic parse(string json) { return parse(json, encoding.unicode); } /// <summary>from jsonsring to dynamicjson</summary> public static dynamic parse(string json, encoding encoding) { using (var reader = jsonreaderwriterfactory.createjsonreader(encoding.getbytes(json), xmldictionaryreaderquotas.max)) { return tovalue(xelement.load(reader)); } } /// <summary>from jsonsringstream to dynamicjson</summary> public static dynamic parse(stream stream) { using (var reader = jsonreaderwriterfactory.createjsonreader(stream, xmldictionaryreaderquotas.max)) { return tovalue(xelement.load(reader)); } } /// <summary>from jsonsringstream to dynamicjson</summary> public static dynamic parse(stream stream, encoding encoding) { using (var reader = jsonreaderwriterfactory.createjsonreader(stream, encoding, xmldictionaryreaderquotas.max, _ => { })) { return tovalue(xelement.load(reader)); } } /// <summary>create jsonsring from primitive or ienumerable or object({public property name:property value})</summary> public static string serialize(object obj) { return createjsonstring(new xstreamingelement("root", createtypeattr(getjsontype(obj)), createjsonnode(obj))); } // private static methods private static dynamic tovalue(xelement element) { var type = (jsontype)enum.parse(typeof(jsontype), element.attribute("type").value); switch (type) { case jsontype.boolean: return (bool)element; case jsontype.number: return (double)element; case jsontype.@string: return (string)element; case jsontype.@object: case jsontype.array: return new dynamicjson(element, type); case jsontype.@null: default: return null; } } private static jsontype getjsontype(object obj) { if (obj == null) return jsontype.@null; switch (type.gettypecode(obj.gettype())) { case typecode.boolean: return jsontype.boolean; case typecode.string: case typecode.char: case typecode.datetime: return jsontype.@string; case typecode.int16: case typecode.int32: case typecode.int64: case typecode.uint16: case typecode.uint32: case typecode.uint64: case typecode.single: case typecode.double: case typecode.decimal: case typecode.sbyte: case typecode.byte: return jsontype.number; case typecode.object: return (obj is ienumerable) ? jsontype.array : jsontype.@object; case typecode.dbnull: case typecode.empty: default: return jsontype.@null; } } private static xattribute createtypeattr(jsontype type) { return new xattribute("type", type.tostring()); } private static object createjsonnode(object obj) { var type = getjsontype(obj); switch (type) { case jsontype.@string: case jsontype.number: return obj; case jsontype.boolean: return obj.tostring().tolower(); case jsontype.@object: return createxobject(obj); case jsontype.array: return createxarray(obj as ienumerable); case jsontype.@null: default: return null; } } private static ienumerable<xstreamingelement> createxarray<t>(t obj) where t : ienumerable { return obj.cast<object>() .select(o => new xstreamingelement("item", createtypeattr(getjsontype(o)), createjsonnode(o))); } private static ienumerable<xstreamingelement> createxobject(object obj) { return obj.gettype() .getproperties(bindingflags.public | bindingflags.instance) .select(pi => new { name = pi.name, value = pi.getvalue(obj, null) }) .select(a => new xstreamingelement(a.name, createtypeattr(getjsontype(a.value)), createjsonnode(a.value))); } private static string createjsonstring(xstreamingelement element) { using (var ms = new memorystream()) using (var writer = jsonreaderwriterfactory.createjsonwriter(ms, encoding.unicode)) { element.writeto(writer); writer.flush(); return encoding.unicode.getstring(ms.toarray()); } } // dynamic structure represents javascript object/array readonly xelement xml; readonly jsontype jsontype; /// <summary>create blank jsobject</summary> public dynamicjson() { xml = new xelement("root", createtypeattr(jsontype.@object)); jsontype = jsontype.@object; } private dynamicjson(xelement element, jsontype type) { debug.assert(type == jsontype.array || type == jsontype.@object); xml = element; jsontype = type; } public bool isobject { get { return jsontype == jsontype.@object; } } public bool isarray { get { return jsontype == jsontype.array; } } /// <summary>has property or not</summary> public bool isdefined(string name) { return isobject && (xml.element(name) != null); } /// <summary>has property or not</summary> public bool isdefined(int index) { return isarray && (xml.elements().elementatordefault(index) != null); } /// <summary>delete property</summary> public bool delete(string name) { var elem = xml.element(name); if (elem != null) { elem.remove(); return true; } else return false; } /// <summary>delete property</summary> public bool delete(int index) { var elem = xml.elements().elementatordefault(index); if (elem != null) { elem.remove(); return true; } else return false; } /// <summary>mapping to array or class by public propertyname</summary> public t deserialize<t>() { return (t)deserialize(typeof(t)); } private object deserialize(type type) { return (isarray) ? deserializearray(type) : deserializeobject(type); } private dynamic deserializevalue(xelement element, type elementtype) { var value = tovalue(element); if (value is dynamicjson) { value = ((dynamicjson)value).deserialize(elementtype); } return convert.changetype(value, elementtype); } private object deserializeobject(type targettype) { var result = activator.createinstance(targettype); var dict = targettype.getproperties(bindingflags.public | bindingflags.instance) .where(p => p.canwrite) .todictionary(pi => pi.name, pi => pi); foreach (var item in xml.elements()) { propertyinfo propertyinfo; if (!dict.trygetvalue(item.name.localname, out propertyinfo)) continue; var value = deserializevalue(item, propertyinfo.propertytype); propertyinfo.setvalue(result, value, null); } return result; } private object deserializearray(type targettype) { if (targettype.isarray) // foo[] { var elemtype = targettype.getelementtype(); dynamic array = array.createinstance(elemtype, xml.elements().count()); var index = 0; foreach (var item in xml.elements()) { array[index++] = deserializevalue(item, elemtype); } return array; } else // list<foo> { var elemtype = targettype.getgenericarguments()[0]; dynamic list = activator.createinstance(targettype); foreach (var item in xml.elements()) { list.add(deserializevalue(item, elemtype)); } return list; } } // delete public override bool tryinvoke(invokebinder binder, object[] args, out object result) { result = (isarray) ? delete((int)args[0]) : delete((string)args[0]); return true; } // isdefined, if has args then trygetmember public override bool tryinvokemember(invokememberbinder binder, object[] args, out object result) { if (args.length > 0) { result = null; return false; } result = isdefined(binder.name); return true; } // deserialize or foreach(ienumerable) public override bool tryconvert(convertbinder binder, out object result) { if (binder.type == typeof(ienumerable) || binder.type == typeof(object[])) { var ie = (isarray) ? xml.elements().select(x => tovalue(x)) : xml.elements().select(x => (dynamic)new keyvaluepair<string, object>(x.name.localname, tovalue(x))); result = (binder.type == typeof(object[])) ? ie.toarray() : ie; } else { result = deserialize(binder.type); } return true; } private bool tryget(xelement element, out object result) { if (element == null) { result = null; return false; } result = tovalue(element); return true; } public override bool trygetindex(getindexbinder binder, object[] indexes, out object result) { return (isarray) ? tryget(xml.elements().elementatordefault((int)indexes[0]), out result) : tryget(xml.element((string)indexes[0]), out result); } public override bool trygetmember(getmemberbinder binder, out object result) { return (isarray) ? tryget(xml.elements().elementatordefault(int.parse(binder.name)), out result) : tryget(xml.element(binder.name), out result); } private bool tryset(string name, object value) { var type = getjsontype(value); var element = xml.element(name); if (element == null) { xml.add(new xelement(name, createtypeattr(type), createjsonnode(value))); } else { element.attribute("type").value = type.tostring(); element.replacenodes(createjsonnode(value)); } return true; } private bool tryset(int index, object value) { var type = getjsontype(value); var e = xml.elements().elementatordefault(index); if (e == null) { xml.add(new xelement("item", createtypeattr(type), createjsonnode(value))); } else { e.attribute("type").value = type.tostring(); e.replacenodes(createjsonnode(value)); } return true; } public override bool trysetindex(setindexbinder binder, object[] indexes, object value) { return (isarray) ? tryset((int)indexes[0], value) : tryset((string)indexes[0], value); } public override bool trysetmember(setmemberbinder binder, object value) { return (isarray) ? tryset(int.parse(binder.name), value) : tryset(binder.name, value); } public override ienumerable<string> getdynamicmembernames() { return (isarray) ? xml.elements().select((x, i) => i.tostring()) : xml.elements().select(x => x.name.localname); } /// <summary>serialize to jsonstring</summary> public override string tostring() { // <foo type="null"></foo> is can't serialize. replace to <foo type="null" /> foreach (var elem in xml.descendants().where(x => x.attribute("type").value == "null")) { elem.removenodes(); } return createjsonstring(new xstreamingelement("root", createtypeattr(jsontype), xml.elements())); } } }
view code
这个代码我也依旧没仔细看，反正也能用，没出过差错。
这个最核心的拦路虎解决了，后面的事情就顺理成章的进行啦。
3.基础支持api包装
/*-------------------------------------------------------------------------- * basicapi.cs *auth:deepleo * date:2013.12.31 * email:2586662969@qq.com *--------------------------------------------------------------------------*/using system;using system.collections.generic;using system.linq;using system.text;using system.net.http;using codeplex.data;using system.io;namespace deepleo.weixin.sdk { /// <summary> /// 对应微信api的 "基础支持" /// </summary> public class basicapi { /// <summary> /// 检查签名是否正确: /// http://mp.weixin.qq.com/wiki/index.php?title=%e6%8e%a5%e5%85%a5%e6%8c%87%e5%8d%97 /// </summary> /// <param name="signature"></param> /// <param name="timestamp"></param> /// <param name="nonce"></param> /// <param name="token">accesstoken</param> /// <returns> /// true: check signature success /// false: check failed, 非微信官方调用! /// </returns> public static bool checksignature(string signature, string timestamp, string nonce, string token, out string ent) { var arr = new[] { token, timestamp, nonce }.orderby(z => z).toarray(); var arrstring = string.join("", arr); var sha1 = system.security.cryptography.sha1.create(); var sha1arr = sha1.computehash(encoding.utf8.getbytes(arrstring)); stringbuilder entext = new stringbuilder(); foreach (var b in sha1arr) { entext.appendformat("{0:x2}", b); } ent = entext.tostring(); return signature == entext.tostring(); } /// <summary> /// 获取accesstoken /// http://mp.weixin.qq.com/wiki/index.php?title=%e8%8e%b7%e5%8f%96access_token /// </summary> /// <param name="grant_type"></param> /// <param name="appid"></param> /// <param name="secrect"></param> /// <returns>access_toke</returns> public static dynamic getaccesstoken( string appid, string secrect) { var url = string.format("https://api.weixin.qq.com/cgi-bin/token?grant_type={0}&appid={1}&secret={2}", "client_credential", appid, secrect); var client = new httpclient(); var result = client.getasync(url).result; if (!result.issuccessstatuscode) return string.empty; var token = dynamicjson.parse(result.content.readasstringasync().result); return token; } /// <summary> /// 上传多媒体文件 /// http://mp.weixin.qq.com/wiki/index.php?title=%e4%b8%8a%e4%bc%a0%e4%b8%8b%e8%bd%bd%e5%a4%9a%e5%aa%92%e4%bd%93%e6%96%87%e4%bb%b6 /// 1.上传的媒体文件限制： ///图片（image) : 1mb，支持jpg格式 ///语音（voice）：1mb，播放长度不超过60s，支持mp4格式 ///视频（video）：10mb，支持mp4格式 ///缩略图（thumb)：64kb，支持jpg格式 ///2.媒体文件在后台保存时间为3天，即3天后media_id失效 /// </summary> /// <param name="token"></param> /// <param name="type"></param> /// <param name="file"></param> /// <returns>media_id</returns> public static string uploadmedia(string token, string type, string file) { var url = string.format("http://api.weixin.qq.com/cgi-bin/media/upload?access_token={0}&type={1}&filename={2}", token, type, path.getfilename(file)); var client = new httpclient(); var result = client.postasync(url, new streamcontent(new filestream(file, filemode.open, fileaccess.read))); if (!result.result.issuccessstatuscode) return string.empty; var media = dynamicjson.parse(result.result.content.readasstringasync().result); return media.media_id; } } }
view code
4.发送消息包装
/*-------------------------------------------------------------------------- * sendmessageapi.cs *auth:deepleo * date:2013.12.31 * email:2586662969@qq.com *--------------------------------------------------------------------------*/using system;using system.collections.generic;using system.linq;using system.text;using codeplex.data;using system.net;using system.net.http;namespace deepleo.weixin.sdk { /// <summary> /// 对应微信api的 "发送消息” /// </summary> public class sendmessageapi { /// <summary> /// 被动回复消息 /// </summary> /// <param name="message">微信服务器推送的消息</param> /// <param name="executor">用户自定义的消息执行者</param> /// <returns></returns> public static string relay(weixinmessage message, iweixinexecutor executor) { return executor.execute(message); } /// <summary> /// 主动发送客服消息 /// http://mp.weixin.qq.com/wiki/index.php?title=%e5%8f%91%e9%80%81%e5%ae%a2%e6%9c%8d%e6%b6%88%e6%81%af /// 当用户主动发消息给公众号的时候 /// 开发者在一段时间内（目前为24小时）可以调用客服消息接口，在24小时内不限制发送次数。 /// </summary> /// <param name="token"></param> /// <param name="msg">json格式的消息，具体格式请参考微信官方api</param> /// <returns></returns> public static bool send(string token, string msg) { var client = new httpclient(); var task = client.postasync(string.format("https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token={0}", token), new stringcontent(msg)).result; return task.issuccessstatuscode; } } }
view code
5.其他代码就不一一贴出来了。可以在文章最后自行下载完整代码查阅。
6.处理与微信服务器通信的weixincontroller.cs,weixinexecutor.cs
using system;using system.collections.generic;using system.io;using system.linq;using system.text;using system.web;using system.web.mvc;using system.xml.linq;using deepleo.weixin.sdk;using deepleo.newton.web.services;using system.xml;using deepleo.newton.framework.services.admin;using deepleo.log;namespace deepleo.newton.web.controllers { public class weixincontroller : controller { public weixincontroller() { } /// <summary> /// 微信后台验证地址（使用get），微信后台的“接口配置信息”的url /// </summary> [httpget] [actionname("index")] public actionresult get(string signature, string timestamp, string nonce, string echostr) { var token = new settingsservice().get().token; if (string.isnullorempty(_token)) return content("请先设置token！"); var ent = ""; if (!basicapi.checksignature(signature, timestamp, nonce, _token, out ent)) { new weixinlogservice().create(new framework.entities.weixinlog("get(failed)", string.format("(get weixin)signature:{0},timestamp:{1},nonce:{2},echostr:{3},ent:{4},token:{5}", signature, timestamp, nonce, echostr, ent, _token))); return content("参数错误！"); } return content(echostr); //返回随机字符串则表示验证通过 } /// <summary> /// 用户发送消息后，微信平台自动post一个请求到这里，并等待响应xml。 /// </summary> [httppost] [actionname("index")] public actionresult post(string signature, string timestamp, string nonce, string echostr) { weixinmessage message = null; using (var streamreader = new streamreader(request.inputstream)) { message = acceptmessageapi.parse(streamreader.readtoend()); } var response = new weixinexecutor().execute(message); return new contentresult { content = response, contenttype = "text/xml", contentencoding = system.text.utf8encoding.utf8 }; } } }
view code
/*-------------------------------------------------------------------------- * weixinexecutor.cs *auth:deepleo * date:2013.12.31 * email:2586662969@qq.com *--------------------------------------------------------------------------*/using system;using system.collections.generic;using system.linq;using system.web;using deepleo.weixin.sdk;using system.text;using system.text.regularexpressions;namespace deepleo.weixin { public class weixinexecutor : iweixinexecutor { public weixinexecutor() { } public string execute(weixinmessage message) { var result = ""; string openid = message.body.fromusername.value; var myusername = message.body.tousername.value; switch (message.type) { case weixinmessagetype.text: string usermessage = message.body.content.value; result = repaytext(openid, myusername, "欢迎使用"); break; case weixinmessagetype.event: string eventtype = message.body.event.value.tolower(); string eventkey = message.body.eventkey.value; switch (eventtype) { case "subscribe": result = repaytext(openid, myusername, "欢迎订阅"); break; case "unsubscribe": result = repaytext(openid, myusername, "欢迎再来"); break; case "scan": result = repaytext(openid, myusername, "欢迎使用"); break; case "location"://用户进入应用时记录用户地理位置 #region location var lat = message.body.latitude.value.tostring(); var lng = message.body.longitude.value.tostring(); var pcn = message.body.precision.value.tostring(); #endregion break; case "click": switch (eventkey)//refer to： recources/menu.json { case "myaccount": #region 我的账户 result = repaytext(openid, myusername, "我的账户."); #endregion break; default: result = string.format("<xml><tousername><![cdata[{0}]]></tousername>" + "<fromusername><![cdata[{1}]]></fromusername>" + "<createtime>{2}</createtime>" + "<msgtype><![cdata[text]]></msgtype>" + "<content><![cdata[{3}]]></content>" + "</xml>", openid, myusername, datetime.now.tobinary(), "没有响应菜单事件"); break; } break; } break; default: result = string.format("<xml><tousername><![cdata[{0}]]></tousername>" + "<fromusername><![cdata[{1}]]></fromusername>" + "<createtime>{2}</createtime>" + "<msgtype><![cdata[text]]></msgtype>" + "<content><![cdata[{3}]]></content>" + "</xml>", openid, myusername, datetime.now.tobinary(), string.format("未处理消息类型:{0}", message.type)); break; } return result; } private string repaytext(string tousername, string fromusername, string content) { return string.format("<xml><tousername><![cdata[{0}]]></tousername>" + "<fromusername><![cdata[{1}]]></fromusername>" + "<createtime>{2}</createtime>" + "<msgtype><![cdata[text]]></msgtype>" + "<content><![cdata[{3}]]></content>" + "</xml>", tousername, fromusername, datetime.now.tobinary(), content); } private string repaynews(string tousername, string fromusername, list<weixinnews> news) { var couponesbuilder = new stringbuilder(); couponesbuilder.append(string.format("<xml><tousername><![cdata[{0}]]></tousername>" + "<fromusername><![cdata[{1}]]></fromusername>" + "<createtime>{2}</createtime>" + "<msgtype><![cdata[news]]></msgtype>" + "<articlecount>{3}</articlecount><articles>", tousername, fromusername, datetime.now.tobinary(), news.count )); foreach (var c in news) { couponesbuilder.append(string.format("<item><title><![cdata[{0}]]></title>" + "<description><![cdata[{1}]]></description>" + "<picurl><![cdata[{2}]]></picurl>" + "<url><![cdata[{3}]]></url>" + "</item>", c.title, c.description, c.picurl, c.url )); } couponesbuilder.append("</articles></xml>"); return couponesbuilder.tostring(); } } public class weixinnews { public string title { set; get; } public string description { set; get; } public string picurl { set; get; } public string url { set; get; } } }
以上就是分享一篇基于.net的微信sdk的详细内容。