[.NET] 使用Json.NET提供依賴注入功能(Dependence Injection)

前言

在一些小型項目的開發情景里，系統不需要大型DI Framework所提供的：單一對象生成、生命周期管理...等等延伸功能，只需要，單純使用反射生成功能，從配置文件取得功能對象來注入到系統。在這樣的開發情景中，如果選擇Spring .NET、Unity來做為系統的依賴注入模塊，無形中就增加了系統的技術門坎、增加了開發人員的知識負擔。

本篇文章介紹如何使用Json.NET來反射生成JSON配置文件中所定義的功能對象，讓開發人員能夠透過設定簡單的JSON檔案、簡潔易懂的指令，來提供系統使用依賴注入的功能。主要為自己留個紀錄，也希望能幫助到有需要的開發人員。

• Json.NET官網

開發

加入Json.NET

使用Visual Studio開啟項目之后，開發人員可以透過內建的NuGet封裝管理員來安裝Json.NET套件。

建立依賴注入的接口與實作

建立項目並且加入Json.NET套件之后，就可以先着手在項目內，建立系統所需要依賴注入的接口與實作。

public interface IAnimal
{
    // Methods
    void Hit();
}

public class Dog : IAnimal
{
    // Methods
    public void Hit()
    {
        Console.WriteLine("Dog : " + "Running");
    }
}

public class Cat : IAnimal
{
    // Fields
    private readonly string _cry = null;


    // Constructors
    public Cat(string cry)
    {
        // Default
        _cry = cry;
    }


    // Methods
    public void Hit()
    {
        Console.WriteLine("Cat : "+ _cry);
    }
}

建立反射生成的配置文件

接着使用Json.NET所定義的格式，來建立對象反射生成所需要的JSON配置文件。在這份配置文件中，每個對象的「$type」屬性使用逗號來切割內容。逗號前的內容，代表了這個對象的命名空間+類別名稱；逗號后的內容代表了這個對象的組件名稱。而其他「$type」之外的屬性，則是會被剖析為對象的建構參數、對象屬性。

[
  {
    "$type": "JsonDISample.Dog, JsonDISample"
  },

  {
    "$type": "JsonDISample.Cat, JsonDISample",
    "cry": "Meow"
  },

  {
    "$type": "JsonDISample.Cat, JsonDISample",
    "cry": "Purr"
  }
]

使用Json.NET注入物件

最后使用下列程序代碼，從檔案中讀取JSON配置文件內容，再使用JsonConvert.DeserializeObject反射生成對象，就可以將Json.NET生成的接口與實作，注入系統來使用。另外，在這段程序代碼中，要特別注意「JsonSerializerSettings.TypeNameHandling」這個屬性必須要設定為All，這樣Json.NET才會特別去處理$type屬性來反射生成指定對象。

static void Main(string[] args)
{
    // ConfigJson
    string configJson = System.IO.File.ReadAllText("animals.json");
    if (configJson == null) throw new InvalidOperationException();

    // SerializerSettings
    var serializerSettings = new JsonSerializerSettings();
    serializerSettings.TypeNameHandling = TypeNameHandling.All;

    // Animal
    var animalList = JsonConvert.DeserializeObject<List<IAnimal>>(configJson, serializerSettings);
    if (animalList == null) throw new InvalidOperationException();

    // Hit
    foreach (var animal in animalList)
    {
        animal.Hit();
    }

    // End
    Console.ReadLine();
}

執行

完成開發步驟后，就可以按下Visual Studio的執行按鈕來檢視成果。接着觀察程序執行的結果，可以發現系統的確依照JSON配置文件的內容，動態生成對象、並且提供這些對象給系統使用。

范例下載

范例程序：點此下載