在上一篇博文發了一天左右的時間，就收到了博客園許多讀者的評論和推薦，非常感謝，我也會及時回復讀者的評論。之後我也將繼續撰寫博文，梳理相關.NET的知識，希望.NET的圈子能越來越大，開發者能了解/深入.NET的本質，將工作做的簡單又高效，拒絕重複勞動，拒絕CRUD。

　　ok,咱們開始繼續Emit的探索。在這之前，我先放一下我往期關於Emit的文章，方便讀者閱讀。

　　《》

一、基礎知識

　　既然C#作為一門面向對象的語言，所以首當其沖的我們需要讓Emit為我們動態構建類。

　　廢話不多說，首先，我們先來回顧一下C#類的內部由什麼東西組成：

　　(1) 字段-C#類中保存數據的地方，由訪問修飾符、類型和名稱組成；

　　(2) 屬性-C#類中特有的東西，由訪問修飾符、類型、名稱和get/set訪問器組成，屬性的是用來控制類中字段數據的訪問，以實現類的封裝性；在Java當中寫作getXXX()和setXXX(val),C#當中將其變成了屬性這種語法糖；

　　(3) 方法-C#類中對邏輯進行操作的基本單元,由訪問修飾符、方法名、泛型參數、入參、出參構成；

　　(4) 構造器-C#類中一種特殊的方法，該方法是專門用來創建對象的方法，由訪問修飾符、與類名相同的方法名、入參構成。

　　接着，我們再觀察C#類本身又具備哪些東西：

　　(1) 訪問修飾符-實現對C#類的訪問控制

　　(2) 繼承-C#類可以繼承一個父類，並需要實現父類當中所有抽象的方法以及選擇實現父類的虛方法，還有就是子類需要調用父類的構造器以實現對象的創建

　　(3) 實現-C#類可以實現多個接口，並實現接口中的所有方法

　　(4) 泛型-C#類可以包含泛型參數，此外，類還可以對泛型實現約束

　　以上就是C#類所具備的一些元素，以下為樣例：

public abstract class Bar
{
    public abstract void PrintName();
}

public interface IFoo<T>
{
    public T Name { get; set; }
}
//繼承Bar基類，實現IFoo接口,泛型參數T
public class Foo<T> : Bar, IFoo<T>
　　//泛型約束
　　where T : struct
{
    //構造器
    public Foo(T name):base()
    {
        _name = name;
    }

    //字段
    private T _name;
    //屬性
    public T Name { get => _name; set => _name = value; }
    //方法
    public override void PrintName()
    {
　　　　Console.WriteLine(_name.ToString());
    }
}

　　在探索完了C#類及其定義后，我們要來了解C#的項目結構組成。我們知道C#的一個csproj項目最終會對應生成一個dll文件或者exe文件，這一個文件我們稱之為程序集Assembly；而在一個程序集中，我們內部包含和定義了許多命名空間，這些命令空間在C#當中被稱為模塊Module，而模塊正是由一個一個的C#類Type組成。

 　　所以，當我們需要定義C#類時，就必須首先定義Assembly以及Module，如此才能進行下一步工作。

二、IL概覽

 　　由於Emit實質是通過IL來生成C#代碼，故我們可以反向生成，先將寫好的目標代碼寫成cs文件，通過編譯器生成dll，再通過ildasm查看IL代碼，即可依葫蘆畫瓢的編寫出Emit代碼。所以我們來查看以下上節Foo所生成的IL代碼。

 　　從上圖我們可以很清晰的看到.NET的層級結構，位於樹頂層淺藍色圓點表示一個程序集Assembly，第二層藍色表示模塊Module，在模塊下的均為我們所定義的類，類中包含類的泛型參數、繼承類信息、實現接口信息，類的內部包含構造器、方法、字段、屬性以及它的get/set方法，由此，我們可以開始編寫Emit代碼了

三、Emit編寫

　　有了以上的對C#類的解讀和IL的解讀，我們知道了C#類本身所需要哪些元素，我們就開始根據這些元素來開始編寫Emit代碼了。這裏的代碼量會比較大，請讀者慢慢閱讀，也可以參照以上我寫的類生成il代碼進行比對。

　　在Emit當中所有創建類型的幫助類均以Builder結尾，從下錶中我們可以看的非常清楚

　　由於創建類需要從Assembly開始創建，所以我們的入口是AssemblyBuilder

　　(1) 首先，我們先引入命名空間，我們以上節Foo類為樣例進行編寫

using System.Reflection.Emit;

　　(2) 獲取基類和接口的類型

var barType = typeof(Bar);
var interfaceType = typeof(IFoo<>);

　　(3) 定義Foo類型，我們可以看到在定義類之前我們需要創建Assembly和Module

//定義類
var assemblyBuilder = AssemblyBuilder.DefineDynamicAssembly(new AssemblyName("Edwin.Blog.Emit"), AssemblyBuilderAccess.Run);
var moduleBuilder = assemblyBuilder.DefineDynamicModule("Edwin.Blog.Emit");
var typeBuilder = moduleBuilder.DefineType("Foo", TypeAttributes.Public | TypeAttributes.Class | TypeAttributes.AutoClass | TypeAttributes.AnsiClass | TypeAttributes.BeforeFieldInit);

　　(4) 定義泛型參數T,並添加約束

//定義泛型參數
var genericTypeBuilder = typeBuilder.DefineGenericParameters("T")[0];
//設置泛型約束
genericTypeBuilder.SetGenericParameterAttributes(GenericParameterAttributes.NotNullableValueTypeConstraint);

　　(5) 繼承和實現接口，注意當實現類的泛型參數需傳遞給接口時，需要將泛型接口添加泛型參數后再調用AddInterfaceImplementation方法

//繼承基類
typeBuilder.SetParent(barType);
//實現接口
typeBuilder.AddInterfaceImplementation(interfaceType.MakeGenericType(genericTypeBuilder));

　　(6) 定義字段，因為字段在構造器值需要使用，故先創建

//定義字段
var fieldBuilder = typeBuilder.DefineField("_name", genericTypeBuilder, FieldAttributes.Private);

　　(7) 定義構造器，並編寫內部邏輯

//定義構造器
var ctorBuilder = typeBuilder.DefineConstructor(MethodAttributes.Public | MethodAttributes.HideBySig | MethodAttributes.SpecialName | MethodAttributes.RTSpecialName, CallingConventions.Standard, new Type[] { genericTypeBuilder });
var ctorIL = ctorBuilder.GetILGenerator();
//Ldarg_0在實例方法中表示this，在靜態方法中表示第一個參數
ctorIL.Emit(OpCodes.Ldarg_0);
ctorIL.Emit(OpCodes.Ldarg_1);
//為field賦值
ctorIL.Emit(OpCodes.Stfld, fieldBuilder);
ctorIL.Emit(OpCodes.Ret);

　　(8) 定義Name屬性

//定義屬性
var propertyBuilder = typeBuilder.DefineProperty("Name", PropertyAttributes.None, genericTypeBuilder, Type.EmptyTypes);

　　(9) 編寫Name屬性的get/set訪問器

//定義get方法
var getMethodBuilder = typeBuilder.DefineMethod("get_Name", MethodAttributes.Public | MethodAttributes.HideBySig | MethodAttributes.NewSlot | MethodAttributes.SpecialName | MethodAttributes.Virtual, CallingConventions.Standard, genericTypeBuilder, Type.EmptyTypes);
var getIL = getMethodBuilder.GetILGenerator();
getIL.Emit(OpCodes.Ldarg_0);
getIL.Emit(OpCodes.Ldfld, fieldBuilder);
getIL.Emit(OpCodes.Ret);
typeBuilder.DefineMethodOverride(getMethodBuilder, interfaceType.GetProperty("Name").GetGetMethod()); //實現對接口方法的重載
propertyBuilder.SetGetMethod(getMethodBuilder); //設置為屬性的get方法
//定義set方法
var setMethodBuilder = typeBuilder.DefineMethod("set_Name", MethodAttributes.Public | MethodAttributes.HideBySig | MethodAttributes.NewSlot | MethodAttributes.SpecialName | MethodAttributes.Virtual, CallingConventions.Standard, null, new Type[] { genericTypeBuilder });
var setIL = setMethodBuilder.GetILGenerator();
setIL.Emit(OpCodes.Ldarg_0);
setIL.Emit(OpCodes.Ldarg_1);
setIL.Emit(OpCodes.Stfld, fieldBuilder);
setIL.Emit(OpCodes.Ret);
typeBuilder.DefineMethodOverride(setMethodBuilder, interfaceType.GetProperty("Name").GetSetMethod()); //實現對接口方法的重載
propertyBuilder.SetSetMethod(setMethodBuilder); //設置為屬性的set方法

 　　(10) 定義並實現PrintName方法

//定義方法
var printMethodBuilder = typeBuilder.DefineMethod("PrintName", MethodAttributes.Public | MethodAttributes.HideBySig | MethodAttributes.Virtual, CallingConventions.Standard, null, Type.EmptyTypes);
var printIL = printMethodBuilder.GetILGenerator();
printIL.Emit(OpCodes.Ldarg_0);
printIL.Emit(OpCodes.Ldflda, fieldBuilder);
printIL.Emit(OpCodes.Constrained, genericTypeBuilder);
printIL.Emit(OpCodes.Callvirt, typeof(object).GetMethod("ToString", Type.EmptyTypes));
printIL.Emit(OpCodes.Call, typeof(Console).GetMethod("WriteLine", new Type[] { typeof(string) }));
printIL.Emit(OpCodes.Ret);
//實現對基類方法的重載
typeBuilder.DefineMethodOverride(printMethodBuilder, barType.GetMethod("PrintName", Type.EmptyTypes));

　　(11) 創建類

var type = typeBuilder.CreateType(); //netstandard中請使用CreateTypeInfo().AsType()

　　(12) 調用

var obj = Activator.CreateInstance(type.MakeGenericType(typeof(DateTime)), DateTime.Now);
(obj as Bar).PrintName();
Console.WriteLine((obj as IFoo<DateTime>).Name);

四、應用

　　上面的樣例僅供學習只用，無法運用在實際項目當中，那麼，Emit構建類在實際項目中我們可以有什麼應用，提高我們的編碼效率

　　(1) 動態DTO-當我們需要將實體映射到某個DTO時，可以用動態DTO來代替你手寫的DTO，選擇你需要的字段回傳給前端，或者前端把他想要的字段傳給後端

　　(2) DynamicLinq-我的第一篇博文有個讀者提到了表達式樹，而linq使用的正是表達式樹，當表達式樹+Emit時，我們就可以用像SQL或者GraphQL那樣的查詢語句實現動態查詢

　　(3) 對象合併-我們可以編寫實現一個像js當中Object.assign()一樣的方法，實現對兩個實體的合併

　　(4) AOP動態代理-AOP的核心就是代理模式，但是與其對應的是需要手寫代理類，而Emit就可以幫你動態創建代理類，實現切面編程

　　(5) …

五、小結

　　對於Emit，確實初學者會對其感到複雜和難以學習，但是只要搞懂其中的原理，其實最終就是C#和.NET語言的本質所在，在學習Emit的同時，也是在鍛煉你的基本功是否紮實，你是否對這門語言精通，是否有各種簡化代碼的應用。

　　保持學習，勇於實踐；Write Less，Do More；作者之後還會繼續.NET高級特性系列，感謝閱讀!

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理【其他文章推薦】

※網頁設計公司推薦更多不同的設計風格，搶佔消費者視覺第一線

※廣告預算用在刀口上，網站設計公司幫您達到更多曝光效益

※自行創業 缺乏曝光? 下一步"網站設計"幫您第一時間規劃公司的門面形象

　　幾乎是一夜之間，區塊鏈就成了更熱門的話題，此前，如果我們還在說“物聯網、大數據、雲計算、人工智能和 5G”，那麼，以後這一長串的背後可能就要加上“區塊鏈”。

　　誠然，國家將區塊鏈當成戰略來發展，並“要把區塊鏈作為核心技術自主創新的重要突破口，明確主攻方向，加大投入力度，着力攻克一批關鍵核心技術，加快推動區塊鏈技術和產業創新發展”，這對整個區塊鏈產業都是巨大的利好，但是，這種利好卻實實在在與現在網絡上那些頂着區塊鏈帽子實際卻是在搞傳銷的“幣”們，毫無關係。如果有關係，那也一定是負面。

　　在國內，區塊鏈技術佔據優勢的公司依然是 BAT，特別是阿里巴巴和螞蟻金服。在 2018 年的世界互聯網大會上，螞蟻金服“自主可控金融級商用區塊鏈平台”與“阿里雲 supET 工業互聯網平台”同時入選 15 項世界互聯網領先科技成果之列。前者的區塊鏈因素顯而易見，後者實際上也在由區塊鏈提供製造生產質量追溯和供應鏈管理服務。

　　據全球知名智能信息服務機構科睿唯安公布信息，截至 2019 年 4 月 30 日，阿里巴巴以 290 件區塊鏈專利方案數量穩居全球第一。結合權威知識產權產業媒體 IPRdaily 過去兩年發布的“全球區塊鏈專利企業排行榜”显示，阿里巴巴申請的區塊鏈專利數量已經連續三年全球第一。2019 上半年全球區塊鏈企業發明專利排行榜(TOP100) 中，阿里巴巴以 322 件專利位列第一，中國平安以 274 件專利排名第二，Nchain 以 241 件專利排名第三。此外，百度( 7 名)、騰訊( 13 名)、京東( 14 名)、華為( 28 名)、獵豹( 40 名)、中國移動( 44 名)等均榜上有名。

　　從上面的數據可以看出來，真正在區塊鏈的研究上佔據優勢且不斷應用的，沒有一個是“發幣”的，都是實實在在的在落地。

　　當然了，也許與幣有關。此前有消息傳言，央行可能將在未來幾個月內正式推出國家支持的数字貨幣“DCEP”，初期將向中國工商銀行、中國建設銀行、中國銀行、中國農業銀行、阿里巴巴、騰訊以及銀聯七家機構發行。如果成行，那將是世界上是首個法定数字貨幣，意義深遠。

　　在官方發布的新聞中，將區塊鏈發展方向定位為四個方面：

　　1、要探索“區塊鏈+”在民生領域的運用，积極推動區塊鏈技術在教育、就業、養老、精準脫貧、醫療健康、商品防偽、食品安全、公益、社會救助等領域的應用，為人民群眾提供更加智能、更加便捷、更加優質的公共服務。

　　2016 年，螞蟻金服聯合中國紅十字基金會等公益機構上線區塊鏈試驗項目，使捐款人可以追蹤善款的完整流轉情況。2017 年 3 月，支付寶愛心捐贈平台全面引入區塊鏈技術，所有捐贈數據上鏈。實現了實時賬目公示，有助於解決公益財務透明的“痛點”。螞蟻金服公益運用區塊鏈技術追蹤籌款，建立起第三方公示體系區塊鏈資金流公示，為公益機構進行數據統計、項目執行跟蹤提供便利。區塊鏈具有不可篡改的特性，任何寫入區塊鏈的記錄均不能更改，可以供公眾監督及審計。而“區塊鏈+公益”正是利用這一特性，發揮公眾賬本的價值，不論用戶是捐十塊、二十塊還是幾百塊，讓用戶所獻出的每一筆都記錄在區塊鏈上，有跡可循，持續追溯。

　　2016 年 10 月，阿里與微軟、小蟻、法大大等合作開發“法鏈”，推出基於阿里雲平台的郵箱存證產品，通過法鏈上備份的电子郵件和雲服務，阿里將使中國法院能大規模採用数字證據郵件。

　　2017 年 3 月，阿里巴巴與普華永道合作，打造可追溯的跨境食品供應鏈，用於跟蹤產品從生產者到消費者之間的整個流程。

　　2017 年 8 月，阿里健康與江蘇常州市合作推出我國首個基於醫療場景的區塊鏈應用――“醫聯體+區塊鏈”試點項目。

　　2017 年 10 月 11 日，螞蟻金服 CTO 程立在螞蟻金服金融科技開放峰會上首度披露未來的技術布局――“BASIC”戰略，其中的B對應的就是區塊鏈(Blockchain)，同時，技術實驗室宣布開放區塊鏈技術，支持進口食品安全溯源、商品正品溯源等，第一個落地場景將是海外奶粉品牌的追蹤，先是產自澳洲、新西蘭的 26 個品牌的奶粉。2017 年 11 月 24 日，天貓國際宣布升級全球原產地溯源計劃，未來將覆蓋全球 63 個國家和地區，3700 個品類，14500 個海外品牌，也將向全行業開放，賦能整個行業。2018 年 2 月，菜鳥與天貓國際官方消息，已啟用區塊鏈技術跟蹤、上傳、查證跨境進口商品的物流全鏈路信息，涵蓋生產、運輸、通關、報檢、第三方檢驗等商品進口全流程，為每個跨境進口商品打上獨一無二的“身份證”，供消費者查詢驗證。

　　騰訊旗下的微眾銀行於 2016 年 6 月開發出面向金融業的聯盟鏈雲服務 BaaS，並在 2017 年 1 月落地了第一個商業場景，即微黃金項目。微黃金是騰訊的一項在線黃金交易服務，用戶可以在微信低門檻靈活購買黃金，其背後正是由騰訊開發底層基礎架構的聯盟鏈。騰訊、工商銀行等多個節點共同參与記帳。2018 年 4 月底，騰訊發布第一款區塊鏈遊戲《一起來捉妖》，試圖通過區塊鏈技術保障了遊戲稀有內容投放的公開公平性，同時用戶可以將稀有妖怪上鏈永久保存。

　　2017 年 12 月，沃爾瑪、京東、IBM、清華大學电子商務交易技術國家工程實驗室共同宣布成立安全食品區塊鏈溯源聯盟，運用區塊鏈技術搭建“京東區塊鏈防偽追溯開放平台”。該平台推出之後，用戶只需打開京東 APP 找到購物訂單，通過“一鍵溯源”或直接掃描產品溯源碼，即可獲取溯源信息。

　　2018 年 10 月，百度正式發布自主研發的區塊鏈網絡系統——超級鏈。同時，宣布與海南省政府合作，區塊鏈實驗室及度鏈公司落戶海南，並推出“區塊鏈+大閘蟹溯源”應用。

　　2、要推動區塊鏈底層技術服務和新型智慧城市建設相結合，探索在信息基礎設施、智慧交通、能源電力等領域的推廣應用，提升城市管理的智能化、精準化水平。

　　5 月 22 日，上海、浙江、江蘇、安徽 4 地法院成立全國首個區域司法鏈，實現從起訴到執行全程上鏈，極大提高了訴訟效率和法院公信力，降低訴訟成本。最早引入區塊鏈技術的杭州互聯網法院，上鏈半年，其知識產權糾紛案件的調撤率上升至 95.3%。

　　2017 年 5 月，阿里投資 Symbiont，該公司致力於利用區塊鏈技術打造一個發行和交易智能證券的平台。此外，深圳財富文化集團已經打造了一個文化產權交易的區塊鏈平台，並與螞蟻雙鏈打通，解決文化藝術品流通、交易和一系列金融服務。

　　2017 年 11 月 8 日，阿里巴巴集團、螞蟻金服集團與雄安新區簽署了戰略合作協議，阿里巴巴與螞蟻金服將承建数字雄安區塊鏈實施平台。

　　另外，國網電商公司已建成國家電網公司系統內首個司法級可信區塊鏈公共服務平台，作為唯一央企與北京互聯網法院“天平鏈”互信互通，掛牌工信部區塊鏈重點實驗室電力應用實驗基地，參与首個區塊鏈國家標準制定，實現了區塊鏈技術在電力積分通兌、光伏簽約、票據繳費、电子發票等多場景落地應用。

　　3、要利用區塊鏈技術促進城市間在信息、資金、人才、徵信等方面更大規模的互聯互通，保障生產要素在區域內有序高效流動。

　　在 9 月末舉行的雲棲大會·螞蟻區塊鏈生態峰會上，螞蟻金服集團副總裁蔣國飛透露，螞蟻區塊鏈已落地 40 多個應用。含括跨境支付、供應鏈金融、通用溯源、电子票據等多個行業領域。並於同期宣布了與全球最大的種子和農藥公司拜耳合作，應用方向進一步擴展。

　　螞蟻金服 8 月份宣布，基於區塊鏈技術的供應鏈協作網絡——螞蟻區塊鏈“雙鏈通”全面升級開放。這一服務運用區塊鏈技術可解決供應鏈金融中的信任難題，同時讓小微商家也能享受高效便捷的金融服務。目前，這一模式已在成都率先應用。通過與成都商業銀行、成都中小企業融資擔保公司的合作，“雙鏈通”完成了供應鏈金融的全鏈路覆蓋。上鏈后，整個融資流轉過程清晰留痕、不可篡改，所有參与方都要通過“雙鏈通”進行身份核實和意願確認，数字簽名實時上鏈，杜絕了資金挪用等風險。

　　4、要探索利用區塊鏈數據共享模式，實現政務數據跨部門、跨區域共同維護和利用，促進業務協同辦理，深化“最多跑一次”改革，為人民群眾帶來更好的政務服務體驗。

　　3 月，杭州地鐵聯合支付寶、螞蟻區塊鏈推出了區塊鏈电子發票。全程手機操作，耗時不到 10 秒，上班族再也不用前往窗口排隊取票了。支付寶聯合雲南省相關部門，在醫療、教育等多個民生服務場景落地區塊鏈电子票據。從地鐵电子發票到法院訴訟案件，再到电子票據平台，螞蟻區塊鏈在過去近 3 年時間里，相繼落地了 40 多個場景。其中長三角佔比超過一半。“上鏈”后長三角人辦事效率大大提升，不少事項可享受“秒級”服務。

　　我們看到，在 5G 時代，無差別計算能力的流通成本會大幅下降，無差別計算能力是 AI 最重要的勞動要素，而區塊鏈就是 AI 最重要的勞動要素。阿里巴巴達摩院在《2019 十大科技趨勢》中提到，5G 和區塊鏈是未來十年的發展方向。《福布斯》發布的《2020 十大科技趨勢》也提到，5G 和區塊鏈都將於 2020 年崛起，未來與人們日常生活相關的每一個行業都會被變革。還是那句話，“誰能把當前的技術和資源用到最充分，誰就是這個時代的最強者”，也許 5G 的流量充沛，正是區塊鏈的黃金歲月。

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理【其他文章推薦】

※網頁設計公司推薦更多不同的設計風格，搶佔消費者視覺第一線

※廣告預算用在刀口上，網站設計公司幫您達到更多曝光效益

※自行創業 缺乏曝光? 下一步"網站設計"幫您第一時間規劃公司的門面形象

作者：HelloGitHub-Prodesire

HelloGitHub 的《講解開源項目》系列，項目地址：https://github.com/HelloGitHub-Team/Article

一、前言

在上兩篇文章中，我們介紹了 click 中的”參數“和“選項”，本文將繼續深入了解 click，着重講解它的“命令”和”組“。

本系列文章默認使用 Python 3 作為解釋器進行講解。
若你仍在使用 Python 2，請注意兩者之間語法和庫的使用差異哦~

二、命令和組

Click 中非常重要的特性就是任意嵌套命令行工具的概念，通過 和 （實際上是 ）來實現。

所謂命令組就是若干個命令（或叫子命令）的集合，也成為多命令。

2.1 回調調用

對於一個普通的命令來說，回調發生在命令被執行的時候。如果這個程序的實現中只有命令，那麼回調總是會被觸發，就像我們在上一篇文章中舉出的所有示例一樣。不過像 --help 這類選項則會阻止進入回調。

對於組和多個子命令來說，情況略有不同。回調通常發生在子命令被執行的時候：

@click.group()
@click.option('--debug/--no-debug', default=False)
def cli(debug):
    click.echo('Debug mode is %s' % ('on' if debug else 'off'))

@cli.command()  # @cli, not @click!
def sync():
    click.echo('Syncing')

執行效果如下：

Usage: tool.py [OPTIONS] COMMAND [ARGS]...

Options:
  --debug / --no-debug
  --help                Show this message and exit.

Commands:
  sync

$ tool.py --debug sync
Debug mode is on
Syncing

在上面的示例中，我們將函數 cli 定義為一個組，把函數 sync 定義為這個組內的子命令。當我們調用 tool.py --debug sync 命令時，會依次觸發 cli 和 sync 的處理邏輯（也就是命令的回調）。

2.2 嵌套處理和上下文

從上面的例子可以看到，命令組 cli 接收的參數和子命令 sync 彼此獨立。但是有時我們希望在子命令中能獲取到命令組的參數，這就可以用 來實現。

每當命令被調用時，click 會創建新的上下文，並鏈接到父上下文。通常，我們是看不到上下文信息的。但我們可以通過 裝飾器來顯式讓 click 傳遞上下文，此變量會作為第一個參數進行傳遞。

@click.group()
@click.option('--debug/--no-debug', default=False)
@click.pass_context
def cli(ctx, debug):
    # 確保 ctx.obj 存在並且是個 dict。 (以防 `cli()` 指定 obj 為其他類型
    ctx.ensure_object(dict)

    ctx.obj['DEBUG'] = debug

@cli.command()
@click.pass_context
def sync(ctx):
    click.echo('Debug is %s' % (ctx.obj['DEBUG'] and 'on' or 'off'))

if __name__ == '__main__':
    cli(obj={})

在上面的示例中：

• 通過為命令組 cli 和子命令 sync 指定裝飾器 click.pass_context，兩個函數的第一個參數都是 ctx 上下文
• 在命令組 cli 中，給上下文的 obj 變量（字典）賦值
• 在子命令 sync 中通過 ctx.obj['DEBUG'] 獲得上一步的參數
• 通過這種方式完成了從命令組到子命令的參數傳遞

2.3 不使用命令來調用命令組

默認情況下，調用子命令的時候才會調用命令組。而有時你可能想直接調用命令組，通過指定 click.group 的 invoke_without_command=True 來實現：

@click.group(invoke_without_command=True)
@click.pass_context
def cli(ctx):
    if ctx.invoked_subcommand is None:
        click.echo('I was invoked without subcommand')
    else:
        click.echo('I am about to invoke %s' % ctx.invoked_subcommand)

@cli.command()
def sync():
    click.echo('The subcommand')

調用命令有：

$ tool
I was invoked without subcommand
$ tool sync
I am about to invoke sync
The subcommand

在上面的示例中，通過 ctx.invoked_subcommand 來判斷是否由子命令觸發，針對兩種情況打印日誌。

2.4 自定義命令組/多命令

除了使用 來定義命令組外，你還可以自定義命令組（也就是多命令），這樣你就可以延遲加載子命令，這會很有用。

自定義多命令需要實現 list_commands 和 get_command 方法：

import click
import os

plugin_folder = os.path.join(os.path.dirname(__file__), 'commands')

class MyCLI(click.MultiCommand):

    def list_commands(self, ctx):
        rv = []  # 命令名稱列表
        for filename in os.listdir(plugin_folder):
            if filename.endswith('.py'):
                rv.append(filename[:-3])
        rv.sort()
        return rv

    def get_command(self, ctx, name):
        ns = {}
        fn = os.path.join(plugin_folder, name + '.py')  # 命令對應的 Python 文件
        with open(fn) as f:
            code = compile(f.read(), fn, 'exec')
            eval(code, ns, ns)
        return ns['cli']

cli = MyCLI(help='This tool\'s subcommands are loaded from a '
            'plugin folder dynamically.')

# 等價方式是通過 click.command 裝飾器，指定 cls=MyCLI
# @click.command(cls=MyCLI)
# def cli():
#     pass

if __name__ == '__main__':
    cli()

2.5 合併命令組/多命令

當有多個命令組，每個命令組中有一些命令，你想把所有的命令合併在一個集合中時，click.CommandCollection 就派上了用場：

@click.group()
def cli1():
    pass

@cli1.command()
def cmd1():
    """Command on cli1"""

@click.group()
def cli2():
    pass

@cli2.command()
def cmd2():
    """Command on cli2"""

cli = click.CommandCollection(sources=[cli1, cli2])

if __name__ == '__main__':
    cli()

調用命令有：

$ cli --help
Usage: cli [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  cmd1  Command on cli1
  cmd2  Command on cli2

從上面的示例可以看出，cmd1 和 cmd2 分別屬於 cli1 和 cli2，通過 click.CommandCollection 可以將這些子命令合併在一起，將其能力提供個同一個命令程序。

Tips：如果多個命令組中定義了同樣的子命令，那麼取第一個命令組中的子命令。

2.6 鏈式命令組/多命令

有時單級子命令可能滿足不了你的需求，你甚至希望能有多級子命令。典型地，setuptools 包中就支持多級/鏈式子命令： setup.py sdist bdist_wheel upload。在 click 3.0 之後，實現鏈式命令組變得非常簡單，只需在 click.group 中指定 chain=True：

@click.group(chain=True)
def cli():
    pass


@cli.command('sdist')
def sdist():
    click.echo('sdist called')


@cli.command('bdist_wheel')
def bdist_wheel():
    click.echo('bdist_wheel called')

調用命令則有：

$ setup.py sdist bdist_wheel
sdist called
bdist_wheel called

2.7 命令組/多命令管道

鏈式命令組中一個常見的場景就是實現管道，這樣在上一個命令處理好后，可將結果傳給下一個命令處理。

實現命令組管道的要點是讓每個命令返回一個處理函數，然後編寫一個總的管道調度函數（並由 MultiCommand.resultcallback() 裝飾）：

@click.group(chain=True, invoke_without_command=True)
@click.option('-i', '--input', type=click.File('r'))
def cli(input):
    pass

@cli.resultcallback()
def process_pipeline(processors, input):
    iterator = (x.rstrip('\r\n') for x in input)
    for processor in processors:
        iterator = processor(iterator)
    for item in iterator:
        click.echo(item)

@cli.command('uppercase')
def make_uppercase():
    def processor(iterator):
        for line in iterator:
            yield line.upper()
    return processor

@cli.command('lowercase')
def make_lowercase():
    def processor(iterator):
        for line in iterator:
            yield line.lower()
    return processor

@cli.command('strip')
def make_strip():
    def processor(iterator):
        for line in iterator:
            yield line.strip()
    return processor

在上面的示例中：

• 將 cli 定義為了鏈式命令組，並且指定 invoke_without_command=True，也就意味着可以不傳子命令來觸發命令組
• 定義了三個命令處理函數，分別對應 uppercase、lowercase 和 strip 命令
• 在管道調度函數 process_pipeline 中，將輸入 input 變成生成器，然後調用處理函數（實際輸入幾個命令，就有幾個處理函數）進行處理

2.8 覆蓋默認值

默認情況下，參數的默認值是從通過裝飾器參數 default 定義。我們還可以通過 Context.default_map 上下文字典來覆蓋默認值：

@click.group()
def cli():
    pass

@cli.command()
@click.option('--port', default=8000)
def runserver(port):
    click.echo('Serving on http://127.0.0.1:%d/' % port)

if __name__ == '__main__':
    cli(default_map={
        'runserver': {
            'port': 5000
        }
    })

在上面的示例中，通過在 cli 中指定 default_map 變可覆蓋命令（一級鍵）的選項（二級鍵）默認值（二級鍵的值）。

我們還可以在 click.group 中指定 context_settings 來達到同樣的目的：

CONTEXT_SETTINGS = dict(
    default_map={'runserver': {'port': 5000}}
)

@click.group(context_settings=CONTEXT_SETTINGS)
def cli():
    pass

@cli.command()
@click.option('--port', default=8000)
def runserver(port):
    click.echo('Serving on http://127.0.0.1:%d/' % port)

if __name__ == '__main__':
    cli()

調用命令則有：

$ cli runserver
Serving on http://127.0.0.1:5000/

三、總結

本文首先介紹了命令的回調調用、上下文，再進一步介紹命令組的自定義、合併、鏈接、管道等功能，了解到了 click 的強大。而命令組中更加高階的能力（）則可看官方文檔進一步了解。

我們通過介紹 click 的參數、選項和命令已經能夠完全實現命令行程序的所有功能。而 click 還為我們提供了許多錦上添花的功能，比如實用工具、參數自動補全等，我們將在下節詳細介紹。

『講解開源項目系列』——讓對開源項目感興趣的人不再畏懼、讓開源項目的發起者不再孤單。跟着我們的文章，你會發現編程的樂趣、使用和發現參与開源項目如此簡單。歡迎留言聯繫我們、加入我們，讓更多人愛上開源、貢獻開源～

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理【其他文章推薦】

※如何讓商品強力曝光呢? 網頁設計公司幫您建置最吸引人的網站，提高曝光率!!

※網頁設計一頭霧水??該從何著手呢? 找到專業技術的網頁設計公司，幫您輕鬆架站!

※想知道最厲害的台北網頁設計公司推薦、台中網頁設計公司推薦專業設計師”嚨底家”!!