[VisualStudio] Paste Special - 將 Json 或 XML 文字轉換為 C# 類別物件 ~ m@rcus 學習筆記

問題
這陣子開發工作上常遇到要與第三方做串接的服務，第三方服務提供的技術文件中格式不外乎以 Json 或是 XML 兩種為主，往往都要針對這些屬性自己建立新的類別 Model 的動作，如果 XML 或 JSON 屬性欄位多的話要花不少時間在處理建立對應類別上，但不用擔心，號稱地表上最強的開發 IDE Visual Studio 從 2012 開始提供 Json 與 XML 轉 Class 類別的功能，操作與使用上相當簡單，這篇就來介紹此功能的使用方式。

使用方式
打開 Visual Studio 點選左上角 Edit > Paste Special，就可以看到可以將剪貼簿內容的文字轉換為 Json 或是 XML 的選項，以下就針對兩個選項做簡單的介紹與 Sample

Json 轉 Class
Json 檔案範例是從 .NET Core 專案的 appsetting.json 抓下來，如下所示

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=aspnet-ASPCoreLab;Trusted_Connection=True;MultipleActiveResultSets=true"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*"
}

Step 1 : 打開 Visual Studio 2017，建立一個新的 Class 類別，接著複製要轉換的 Json 檔案
Step 2 : Edit > Paste Special > Paste Json to Class

public class Rootobject
{
    public Connectionstrings ConnectionStrings { get; set; }
    public Logging Logging { get; set; }
    public string AllowedHosts { get; set; }
}
 
public class Connectionstrings
{
    public string DefaultConnection { get; set; }
}
 
public class Logging
{
    public Loglevel LogLevel { get; set; }
}
 
public class Loglevel
{
    public string Default { get; set; }
}

會產生 RootObject 類別物件，其中包含要轉換 Json 類別的屬性 connectionString、logging、Loglevel 其相對應的 Class 類別

XML 轉 Class
自己定義一個簡單的 XML 檔案，如下所示

<card>
   <name>Marcus Tung</name>
   <title>打雜工程師</title>
   <email>iamnewuser@gmail.com</email>
   <phone>886 82 5252</phone>
   <logo url="widget.gif"/>
 </card>

Step 1 : 打開 Visual Studio 2017，建立一個新的 Class 類別，接著複製要轉換的 XML 檔案
Step 2 : Edit > Paste Special > Paste XML to Class

// NOTE: Generated code may require at least .NET Framework 4.5 or .NET Core/Standard 2.0.
/// <remarks/>
[System.SerializableAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
[System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true)]
[System.Xml.Serialization.XmlRootAttribute(Namespace = "", IsNullable = false)]
public partial class card
{
 
    private string nameField;
 
    private string titleField;
 
    private string emailField;
 
    private string phoneField;
 
    private cardLogo logoField;
 
    /// <remarks/>
    public string name
    {
        get
        {
            return this.nameField;
        }
        set
        {
            this.nameField = value;
        }
    }
 
    /// <remarks/>
    public string title
    {
        get
        {
            return this.titleField;
        }
        set
        {
            this.titleField = value;
        }
    }
 
    /// <remarks/>
    public string email
    {
        get
        {
            return this.emailField;
        }
        set
        {
            this.emailField = value;
        }
    }
 
    /// <remarks/>
    public string phone
    {
        get
        {
            return this.phoneField;
        }
        set
        {
            this.phoneField = value;
        }
    }
 
    /// <remarks/>
    public cardLogo logo
    {
        get
        {
            return this.logoField;
        }
        set
        {
            this.logoField = value;
        }
    }
}
 
/// <remarks/>
[System.SerializableAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
[System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true)]
public partial class cardLogo
{
 
    private string urlField;
 
    /// <remarks/>
    [System.Xml.Serialization.XmlAttributeAttribute()]
    public string url
    {
        get
        {
            return this.urlField;
        }
        set
        {
            this.urlField = value;
        }
    }
}

會產生 Rool XML Card 類別物件，並且會自動幫你預設定義好 attribute，像是 Serializable、XML Type 等相關定義，Card 底下的五個屬性有分別定義相關的 get / set，算是非常實用 !

心得
使用地表上最強 IDE 開發十分方便，連這小細節在早期就開始提供，但知道此功能的人似乎不多有點可惜就是，日後如果有遇到一些不錯的功能在陸續介紹在 Blog 上給需要的朋友，Happy Coding !!

[VS2017] 提升 Resharper 在 Visual Studio IDE 執行速度前言 Visual Studio 是地表上最強的開發工具，最近發現在安裝完 Resharper 後開啟專案時都會遇到載入專案的速度變慢的問題，Visual Studio 會在上方提示 JetBrains ReSharper Ultimate’ likely caused 8 seconds of unresponsiveness. Disabling it may improve your experi… Read More
[UnitTest] Reflect.cs not found in NUnit問題最近在新的專案寫 UnitTest 過程中，執行完後 Visual Studio 卻跳出 Source Not Fount : Reflect.cs not found 錯誤，但單元測試還是可以成功，如下圖且透過 debug UnitTest 時發現測試的值也沒問題，經搜尋後發現是 Visual Studio 2017 IDE 設定問題，將，這篇文章簡單紀錄處理問題過程處理方式釐清問題按下… Read More
[UnitTest] Visual Studio 2017 新增單元測試時沒有 NUnit 選項 ?前言新筆電總是讓人充滿驚喜，在使用上除了要重新安裝常用的開發工具外，像是 Visual Studio & SQL Server..等必須工具，還有些常用的套件與小工具也要一併安裝，NUnit 是蠻常用的 Test Framwroek 之一，在寫測試時在要測試的 method 下按下右鍵 create Unit Tests，選擇要使用測試的 Test Framework 即可，在測試專案中預設只有 MSTest 選項，如果需要 NUnit… Read More
[VS2017] 如何修改 Visual Studio IDE 顯示語系前言目前筆電使用的 Visual Studio 是繁體中文版，在使用上用起來沒英文版那麼順，很多字詞在翻譯上總是讓人覺得驚喜，忍無可忍無須再忍決定改為英文版，過去 VS 可以透過下載的方式安裝語言包，但這招在 Visual Studio 2017 似乎無效(?，這邊簡單紀錄 Visual Studio 如何安裝不同語系的過程設定語系 IDE 語系設定設定方式 : 工具 > 選項 > 環境… Read More
[UnitTest] Visual Studio 2017 按右鍵無法建立單元測試 ? 問題最近心血來潮使用家中舊電腦小白寫 Code，在練習測試中發現竟然有點怪異，在要測試的 method 按下右鍵沒有建立單元測試 Create Unit Test 選項，但相同練習專案拿到公司筆電就是正常的，經比對後發現舊筆電 Visual Studio 版本少安裝測試功能，以下簡單紀錄解決問題的過程解決方案在 Visual Studio 2017 早期版本這是已知問題，有開發者在 vs community 回報給開… Read More

m@rcus 學習筆記

只有累積，沒有奇蹟

2019年2月18日星期一