Ninject之旅之二：開始使用Ninject（附程序下載）

摘要

這篇文章介紹怎樣將Ninject添加到實際的項目中，使用Ninject框架最基本的功能。首先用一個Hello World例子介紹怎么添加和使用Ninject。然后用一個更復雜的例子，介紹Ninject DI容器是怎樣管理依賴的。

下載Demo程序

1、第一個Ninject程序：Hello World

1）創建控制台應用程序Demo.Ninject。

2）使用NuGet Manager向工程添加Ninject。

3）添加SalutationService類。

using System;

namespace Demo.Ninject
{
    public class SalutationService
    {
        public void SayHello()
        {
            Console.WriteLine("Hello Ninject!");
        }
    }
}

4）修改Program.cs文件。

using Ninject;
using System;

namespace Demo.Ninject
{
    class Program
    {
        static void Main(string[] args)
        {
            using (var kernel = new StandardKernel()) 11  { 12                 var service = kernel.Get<SalutationService>(); 13  service.SayHello(); 14                 Console.ReadLine();
 } 16         }
    }
}

• var kernel = new StandardKernel()是使用Ninject框架的第一步，生成StandardKernel實例，一個Kernel DI容器。
• 通過kernel.Get方法，傳入類型作為泛型參數，將調用類的構造函數，得到類型實例。注意這里沒有直接使用new關鍵字調用構造函數。而是由Ninject框架來間接調用類的構造函數。

運行程序，得到結果。

2、一個更復雜的例子：類型綁定

1）在工程中添加引用System.Configuration。修改App.config文件。SenderEmail和SenderPassword請填寫自己的郵箱賬號和密碼。

 

2）添加類MailServerConfig，用來讀取App.config內的信息。

using System;
using System.Configuration;

namespace Demo.Ninject
{
    public class MailServerConfig
    {
        public string SmtpServer
        {
            get
            {
                return ConfigurationManager.AppSettings["SmtpServer"];
            }
        }
        public int SmtpPort
        {
            get
            {
                var port = ConfigurationManager.AppSettings["SmtpPort"];
                return Convert.ToInt32(port);
            }
        }
        public string SenderEmail
        {
            get
            {
                return ConfigurationManager.AppSettings["SenderEmail"];
            }
        }
        public string SenderPassword
        {
            get
            {
                return ConfigurationManager.AppSettings["SenderPassword"];
            }
        }
    }
}

3）添加MailService.cs文件，向里面添加ILogger接口、ConsoleLogger類、EventLogger類和MailService類。

using System;
using System.Net;
using System.Net.Mail;

namespace Demo.Ninject
{
    public interface ILogger
    {
        void Log(string message);
    }


    class ConsoleLogger : ILogger 14     {
        public void Log(string message)
        {
            Console.WriteLine("{0}: {1}", DateTime.Now, message);
        }
    }

    class EventLogger : ILogger 22     {
        public void Log(string message)
        {
            System.Diagnostics.EventLog.WriteEntry("MailService", message);
        }
    }

    public class MailService
    {
        private ILogger logger; 32         private SmtpClient client; 33         private string sender;

        public MailService(MailServerConfig config, ILogger logger)
        {
            this.logger = logger;
            InitializeClient(config);
            sender = config.SenderEmail;
        }

        public void SendMail(string address, string subject, string body)
        {
            logger.Log("Initializing...");
            var mail = new MailMessage(sender, address);
            mail.Subject = subject;
            mail.Body = body;
            logger.Log("Sending message...");
            client.Send(mail);
            logger.Log("Message sent successfully.");
        }

        private void InitializeClient(MailServerConfig config)
        {
            client = new SmtpClient();
            client.Host = config.SmtpServer;
            client.Port = config.SmtpPort;
            client.EnableSsl = true;
            var credentials = new NetworkCredential();
            credentials.UserName = config.SenderEmail;
            credentials.Password = config.SenderPassword;
            client.Credentials = credentials;
        }
    }
}

• ILogger接口、ConsoleLogger類、EventLogger類在上一篇文章的代碼里已經使用過了，這里保持不變。
• MailService數據成員添加了client: SmtpClient成員用來保存發送郵件的SmtpClient對象。sender: string成員保存郵件發送者賬號。
• MailService構造函數添加了MailServerConfig config參數。
• InitializeClient(MailServerConfig config)函數用來根據MailServerConfig對象生成SmtpClient對象。

4）修改Pragram.cs文件。

using Ninject;
using System;

namespace Demo.Ninject
{
    class Program
    {
        static void Main(string[] args)
        {
            using (var kernel = new StandardKernel())
            {
                var service = kernel.Get<SalutationService>();
                service.SayHello();

                kernel.Bind<ILogger>().To<ConsoleLogger>(); 16 
                var mailService = kernel.Get<MailService>(); 18                 mailService.SendMail("[e-mail]", "test email", "it is a test Email"); 19 
                Console.ReadLine();
            }
        }
    }
}

kernel.Bind<ILogger>().To<ConsoleLogger>();用來將接口ILogger綁定到具體類ConsoleLogger，給Ninject DI容器添加依賴映射表。Ninject DI容器在此后看到ILogger接口，則使用ConsoleLogger類實例化對象。

var mailService = kernel.Get<MailService>();用來生成MailService類實例。MailService類構造函數有兩個參數，依賴兩個類MailServerConfig和ILogger，如下圖。

 

Ninject將自動調用構造函數生成MailServerConfig對象和ILogger對象（ConsoleLogger對象），然后將這兩個對象作為構造函數參數，生成MailService對象。這個過程對程序員是透明的。

將上面的“[e-mail]”改成實際使用的郵箱賬號，執行程序，得到結果。成功發送電子郵件。

 

結語

在項目中使用Ninject非常容易，只需要四個步驟：1、需要添加Ninject引用。2、生成StandardKernel對象。3、使用一系列的Bind方法添加依賴映射表。4、調用Get方法得到需要的類型對象。