在很多情況下,我們利用IOC控制反轉(zhuǎn)可以很方便實(shí)現(xiàn)一些接口的適配處理,可以在需要的時(shí)候切換不同的接口實(shí)現(xiàn),使用這種方式在調(diào)用的時(shí)候,只需要知道相應(yīng)的接口接口,具體調(diào)用哪個(gè)實(shí)現(xiàn)類,可以在配置文件中動(dòng)態(tài)指定,本篇主要介紹AutoFac的IOC組件的使用,用來(lái)實(shí)現(xiàn)微信接口處理的控制反轉(zhuǎn)功能。
我們知道,實(shí)現(xiàn)IOC的方式有很多,如Unity、AutoFac、Ninject、Castle Windsor、Spring.NET等等,每種IOC組件均有自己的一些特點(diǎn),我在之前的實(shí)體框架隨筆系列介紹過Unity的使用《Entity Framework 實(shí)體框架的形成之旅--利用Unity對(duì)象依賴注入優(yōu)化實(shí)體框架(2)》,本來(lái)也想用這個(gè)來(lái)實(shí)現(xiàn)微信的接口調(diào)用處理,不過由于其版本以及一些其他問題,總是沒有那么方便,最后決定使用也比較流行,應(yīng)用較多的的AutoFac組件來(lái)實(shí)現(xiàn)。
1、微信接口的處理需求
我們?cè)谑褂梦⑿殴娞?hào)實(shí)現(xiàn)一些業(yè)務(wù)處理的時(shí)候,往往需要根據(jù)不同的條件進(jìn)行不同的接口調(diào)用。
如通過二維碼掃碼的結(jié)果處理,然后呈現(xiàn)給微信用戶的相關(guān)信息,有下面兩種方式。
根據(jù)用戶的掃碼結(jié)果,我們可以自定義自己的業(yè)務(wù)處理,然后呈現(xiàn)給用戶,那么這里使用IOC來(lái)實(shí)現(xiàn)具體的業(yè)務(wù)是比較好的,我們?cè)诰唧w的業(yè)務(wù)實(shí)現(xiàn)里面,可以根據(jù)不同的條件實(shí)現(xiàn)所需要的復(fù)雜處理。
當(dāng)然我們還可以擴(kuò)展到很多的業(yè)務(wù)接口里面,如百度的地理位置解析接口、電影院信息查詢、天氣信息查詢、交通信息查詢、旅游信息查詢等,還有短信、郵件發(fā)送等常規(guī)接口,都可以使用這種方式進(jìn)行處理。
接口的效果展示如下所示。
這些給其他項(xiàng)目模塊使用的時(shí)候,我們可以在配置文件里面指定具體的接口實(shí)現(xiàn)信息,這種可以具體指定所需的實(shí)現(xiàn)。
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="autofac" type="Autofac.Configuration.SectionHandler, Autofac.Configuration"/>
</configSections>
<autofac defaultAssembly="WHC.Common.Handler">
<components>
<component type="WHC.Common.Handler.TestHandler, WHC.Common.Handler" service="WHC.Common.Handler.ITestHandler" />
<component type="WHC.Common.Handler.QRCodeHandler, WHC.Common.Handler" service="WHC.Common.Handler.IQRCodeHandler" />
<!--郵件短信-->
<component type="WHC.Common.Handler.SmsSendHandler, WHC.Common.Handler" service="WHC.Common.Handler.ISmsHandler" />
<component type="WHC.Common.Handler.MailSendHandler, WHC.Common.Handler" service="WHC.Common.Handler.IMailHandler" />
</components>
</autofac>
</configuration>
直接使用AutoFac的操作應(yīng)該是比較方便,使用接口獲取方式獲取具體實(shí)現(xiàn)就可以了。
2、使用Autofac實(shí)現(xiàn)
為了方便使用Autofac,我們可以先在項(xiàng)目上的Nuget包管理,引用相關(guān)的DLL,其中包括核心的Autofac類庫(kù),以及讀取配置文件的Autofac Configuration,后者為方便讀取XML配置信息所必須。
引入這兩個(gè)DLL就可以使用Autofac的功能了。
一般通過配置文件,初始化的Autofac組件的代碼如下所示
instance = new AutoFactory();
//初始化相關(guān)的注冊(cè)接口
var builder = new ContainerBuilder();
//從配置文件注冊(cè)相關(guān)的接口處理
builder.RegisterModule(new ConfigurationSettingsReader("autofac", configurationFile));
container = builder.Build();
而我們使用Autofac的接口也是很容易的,常規(guī)的使用代碼如下所示。
var handler = container.Resolve<ITestHandler>();
handler.Test("測(cè)試");
當(dāng)然,為了方便,我們可以使用一個(gè)輔助類來(lái)簡(jiǎn)化這個(gè)接口的調(diào)用:在輔助類初始化的時(shí)候,我們從配置文件加載對(duì)應(yīng)的組件接口實(shí)現(xiàn),當(dāng)我們需要解析具體接口的時(shí)候,就可以直接從Container容器里面胡獲取了,輔助類代碼如下所示。
/// <summary>
/// 使用AutoFac的工廠類,通過配置
/// </summary>
public class AutoFactory
{
//普通局部變量
private static object syncRoot = new Object();
//工廠類的單例
private static AutoFactory instance = null;
//配置文件
private const string configurationFile = "autofac.config";
/// <summary>
/// IOC的容器,可調(diào)用來(lái)獲取對(duì)應(yīng)接口實(shí)例。
/// </summary>
public IContainer Container { get; set; }
/// <summary>
/// IOC容器工廠類的單例
/// </summary>
public static AutoFactory Instatnce
{
get
{
if (instance == null)
{
lock (syncRoot)
{
if (instance == null)
{
instance = new AutoFactory();
//初始化相關(guān)的注冊(cè)接口
var builder = new ContainerBuilder();
//從配置文件注冊(cè)相關(guān)的接口處理
builder.RegisterModule(new ConfigurationSettingsReader("autofac", configurationFile));
instance.Container = builder.Build();
}
}
}
return instance;
}
}
/// <summary>
/// 測(cè)試的接口
/// </summary>
public void Test()
{
var handler = AutoFactory.Instatnce.Container.Resolve<ITestHandler>();
handler.Test("測(cè)試");
}
}
3、外部接口實(shí)現(xiàn)及調(diào)用
這樣我們所有的接口都定義好,并給每個(gè)定義的接口相應(yīng)個(gè)實(shí)現(xiàn)就可以使用這個(gè)Autofac組件進(jìn)行調(diào)用了。
/// <summary>
/// 短信發(fā)送接口
/// </summary>
public interface ISmsHandler
{
/// <summary>
/// 發(fā)送短信
/// </summary>
/// <param name="content">短信內(nèi)容</param>
/// <param name="mobiles">手機(jī)號(hào)碼(多個(gè)號(hào)碼用”,”分隔)</param>
/// <param name="sendTime">預(yù)約發(fā)送時(shí)間</param>
/// <returns></returns>
CommonResult Send(string content, string mobiles, DateTime? sendTime = null);
/// <summary>
/// 查詢剩余條數(shù)
/// </summary>
/// <returns></returns>
CommonResult GetLeftCount();
}
/// <summary>
/// 郵件發(fā)送接口
/// </summary>
public interface IMailHandler
{
/// <summary>
/// 發(fā)送外部郵件(自定義郵件配置,如個(gè)人郵件)
/// </summary>
/// <param name="mailInfo">發(fā)送郵件信息</param>
/// <param name="settingInfo">SMTP協(xié)議設(shè)置信息</param>
/// <returns></returns>
CommonResult Send(MailInfo mailInfo, SmtpSettingInfo settingInfo);
/// <summary>
/// 發(fā)送外部郵件(系統(tǒng)配置,系統(tǒng)郵件)
/// </summary>
/// <param name="mailInfo">發(fā)送郵件信息</param>
/// <returns></returns>
CommonResult Send(MailInfo mailInfo);
}
例如,測(cè)試發(fā)送短信和郵件的IOC調(diào)用代碼如下所示
//使用IOC模塊發(fā)送
var sms = AutoFactory.Instatnce.Container.Resolve<ISmsHandler>();
var smsTemplate = string.Format("驗(yàn)證碼:{0}。尊敬的會(huì)員,您好,您正在注冊(cè)會(huì)員,驗(yàn)證碼2分鐘內(nèi)有效,感謝您的支持。", new Random().Next(100000));
var result = sms.Send(smsTemplate, "18620292076");
Console.WriteLine(result.Success ? "發(fā)送短信成功" : "發(fā)送短信失敗:" + result.ErrorMessage);
MailInfo info = new MailInfo();
info.ToEmail = "wuhuacong@163.com";
info.FromEmail = "wuhuacong@163.com";
info.Subject = "這是一份來(lái)自我自己的測(cè)試郵件";
info.Body = info.Subject + ",這是內(nèi)容部分。<a ;
var mail = AutoFactory.Instatnce.Container.Resolve<IMailHandler>();
var mailResult = mail.Send(info);
Console.WriteLine(mailResult.Success ? "發(fā)送郵件成功" : "發(fā)送郵件失敗:" + mailResult.ErrorMessage);
測(cè)試后得到的結(jié)果如下:
郵件結(jié)果一樣可以收到。
我們回到上面介紹的二維碼掃描的業(yè)務(wù)實(shí)現(xiàn)效果,上面提到了,一個(gè)二維碼事件可以派生出不同的接口實(shí)現(xiàn),從而給不同的響應(yīng)信息。
/// <summary>
/// 掃碼進(jìn)行的處理
/// </summary>
public interface IQRCodeHandler
{
/// <summary>
/// 處理ScancodePush的事件
/// </summary>
/// <param name="info">掃描信息</param>
/// <param name="accountInfo">賬號(hào)信息</param>
/// <returns></returns>
string HandleScancodePush(RequestEventScancodePush info, AccountInfo accountInfo);
/// <summary>
/// 處理ScancodeWaitmsg的事件
/// </summary>
/// <param name="info">掃描信息</param>
/// <param name="accountInfo">賬號(hào)信息</param>
/// <returns></returns>
string HandleScancodeWaitmsg(RequestEventScancodeWaitmsg info, AccountInfo accountInfo);
}
我們可以定義兩個(gè)簡(jiǎn)單的接口處理,用來(lái)承接微信二維碼掃描接口的處理操作。
這樣我們?cè)谔幚矶S碼掃描事件的時(shí)候,我們就可以把它分配到接口里面進(jìn)行處理即可。
/// <summary>
/// 掃碼推事件的事件推送處理
/// </summary>
/// <param name="info">掃描信息</param>
/// <returns></returns>
public string HandleEventScancodePush(RequestEventScancodePush info, AccountInfo accountInfo)
{
string result = "";
var handler = AutoFactory.Instatnce.Container.Resolve<IQRCodeHandler>();
if(handler != null)
{
result = handler.HandleScancodePush(info, accountInfo);
}
return result;
}
/// <summary>
/// 掃碼推事件且彈出“消息接收中”提示框的事件推送的處理
/// </summary>
/// <param name="info">掃描信息</param>
/// <returns></returns>
public string HandleEventScancodeWaitmsg(RequestEventScancodeWaitmsg info, AccountInfo accountInfo)
{
string result = "";
try
{
var handler = AutoFactory.Instatnce.Container.Resolve<IQRCodeHandler>();
if (handler != null)
{
result = handler.HandleScancodeWaitmsg(info, accountInfo);
}
}
catch(Exception ex)
{
LogHelper.Error(ex);
}
return result;
}
對(duì)于其中之一的接口處理,我們都可以把它分拆,根據(jù)掃描的事件鍵值Key進(jìn)行不同的信息相應(yīng)。
/// <summary>
/// 掃描后,會(huì)等待事件處理結(jié)果返回給用戶
/// </summary>
public string HandleScancodeWaitmsg(RequestEventScancodeWaitmsg info, AccountInfo accountInfo)
{
ResponseText response = new ResponseText(info);
response.Content = string.Format("您的信息為:{0},可以結(jié)合后臺(tái)進(jìn)行數(shù)據(jù)查詢。", info.ScanCodeInfo.ScanResult);
var result = response.ToXml();
string devicecode = GetParam(info.ScanCodeInfo, "devicecode");//參數(shù)名為小寫
if (!string.IsNullOrEmpty(devicecode))
{
switch(info.EventKey.ToLower())
{
case "device_view"://設(shè)備查看
{
var deviceinfo = BLLFactory<Device>.Instance.FindByCode(devicecode);
response.Content = ConvertDeviceInfo(deviceinfo);
result = response.ToXml();
}
break;
case "measure"://設(shè)備計(jì)量
{
var deviceinfo = BLLFactory<Device>.Instance.FindByCode(devicecode);
response.Content = ConvertMeasure(deviceinfo);
result = response.ToXml();
}
break;
case "repair"://設(shè)備報(bào)修,返回報(bào)修單號(hào)
{
var content = ConvertRepaire(info, accountInfo, devicecode);
response.Content = content;
result = response.ToXml();
}
break;
case "inventory"://設(shè)備盤點(diǎn),轉(zhuǎn)到盤點(diǎn)界面
{
var content = ConvertInventory(info, accountInfo, devicecode);
response.Content = content;
result = response.ToXml();
}
break;
case "maintain":
break;
case "check":
break;
case "device_add":
break;
}
}
return result;
}
以上就是關(guān)于使用Autofac實(shí)現(xiàn)一些常規(guī)接口處理的實(shí)現(xiàn),這種控制反轉(zhuǎn)的方式,可以便于我們項(xiàng)目的開發(fā)效率,可以根據(jù)需要指定一些特定的實(shí)現(xiàn)處理即可,而且通過配置文件的方式加載,可以很方便的進(jìn)行配置。