.NET高级特性-Emit(2.1)字段

时间:2019-11-30 BillMing 人气:0

　　在上篇blog写完的几天后，有读者反映写的过于复杂，导致无法有效的进行实践；博主在考虑到园子里程序员水平高低不一致的情况，所以打算放慢脚步，对类的一些内容进行详细的讲解，顺带的会写一些笔者所遇到过的Emit的坑以及如何使用Emit来为我们的工作减负，毕竟，知识用到实践当中才有其因有的价值。博主在文末也会将样例上传github，方便大家实践。

　　首先，照例我先把我之前写的博文链接上来，方便大家阅读

　　《.NET高级特性-Emit(1)》

　　《.NET高级特性-Emit(2)类的定义》

一、什么是字段

　　有很多读者会说，我在项目当中基本上没怎么用到字段啊，基本上都是用C#的属性居多，两者不是都能存储数据吗，你看我只要写以下代码就可以完成使用或存储对象的信息。

public class User
{
    public string Id { get; set; }

    public string UserName { get; set; }

    public string PasswordHash { get; private set; }

    public void SetPassword(string password)
    {
        PasswordHash = password;
    }
}

　　你看，我上面的实体一个字段都没用到，全部都是属性，字段有什么作用啊。

　　其实，这就是典型的因为C#的语法糖带来的误解，C#中存储数据的地方只可能是字段，这在所有面向对象的语言当中都是一致的，C++也好，Java也罢，都是相同的，那是什么导致了C#当中会有这种误解存在呢；没错，就是属性这种C#特有的东西存在，以及在C#5.0之后出现的自动属性让程序员对字段与属性产生了误解，在C#5.0之前，也就是没有自动属性之前，以上实体定义是这样编写的：

public class User2
{
    private string _id;
    public string Id { get => _id; set => _id = value; }

    private string _userName;
    public string UserName { get => _userName; set => _userName = value; }

    private string _passwordHash;
    public string PasswordHash { get => _passwordHash; private set => _passwordHash = value; }

    public void SetPassword(string password)
    {
        PasswordHash = password;
    }
}

　　当我写了以上代码的时候，Visual Studio也提示我，希望我使用自动属性对字段进行隐藏：

　　当我点击黄色感叹号时，它就出现对应的修改方案

　　点击使用自动属性时，就变成了只有属性，没有字段的形式了

　　所以，C#类当中可以保存数据的有且只可能有字段，.NET开发者不要因为C#丰富的语法糖而产生误解，要看透这些语法糖中的C#本质，此外你也可以使用Emit查看刚才User的IL代码，自动属性最终还是会生成一个私有字段和一个该字段对应的属性

二、字段的定义

　　讲完了什么是字段，以及一些容易掉入的C#概念误区，我没开始来使用Emit创建字段定义，由于字段只可能是类的一部分，故所以需要使用TypeBuilder来创建字段，对Emit不熟悉的读者可以查看博主的前两篇文章，里面概述了Emit所使用的一些类的定义。

　　好，咱们开始写代码，首先，我们先给出我们要最终生成的结果：

    public class UserField
    {
        public static readonly string TokenPrefix = "Bearer";
        public UserField()
        {
            id = Guid.NewGuid().ToString("N");
        }

        public readonly string id;

        public string userName;

        private string passwordHash = "123456";

        public string GetPasswodHash()
        {
            return passwordHash;
        }

        public void SetPassword(string password)
        {
            passwordHash = password;
        }
    }

　　我们首先忽略掉类的构造器与方法，我们当前只关注字段的定义，我们可以看到，字段可以由四部分组成:

　　　　（1）字段的修饰符-访问修饰符定义了字段的一些特性，如public/private/protected表示访问级别；readonly表示了字段是否可以被外部写入；static表示该字段的归属，是属于对象还是属于类。

　　　　（2）字段的类型-字段的类型定义了该字段是由什么数据类型，由此计算机才可以确定该字段在计算机中所使用的内存空间，进而知晓一个对象需要分配多少内存空间才能将数据装入

　　　　（3）字段的名称-字段的名称用来表述该字段在该对象/类中所表达的含义，让程序员能理解该字段所存储的数据在现实世界的表述

　　　　（4）字段的默认值-字段在类初始化后一定会拥有一个默认值，除了在构造器中或者字段后给予的默认值之外，其它未赋值的字段均使用default填充该字段，当然，不同的字段类型default给予的值也会不一样，对于引用类型会给予null值，对于结构体类型会使用默认构造器，对于基本值类型，会赋予0值，对于枚举，也会赋予0值；这个博主会在之后讲解Emit变量与常量当中会讲解到

　　好，开始撸代码，第一步当然是要引入我们的主角-Emit类库，而且由于一些枚举特性存放在反射类库中，我们也要将其引入

using System.Reflection.Emit;
using System.Reflection;

　　第二步，创建类，若对创建类的过程不清楚可以阅读我的博文《.NET高级特性-Emit(2)类的定义》,里面详细介绍了类的定义及项目的结构组成

            var asmBuilder = AssemblyBuilder.DefineDynamicAssembly(new AssemblyName("Edwin.Blog.Emit"), AssemblyBuilderAccess.Run);
            var moduleBuilder = asmBuilder.DefineDynamicModule("Edwin.Blog.Emit");
            var typeBuilder = moduleBuilder.DefineType("UserField", TypeAttributes.Public | TypeAttributes.Class | TypeAttributes.AutoClass | TypeAttributes.BeforeFieldInit);

　　第三步，首先创建静态字段TokenPrefix

            //第一个变量表示字段名称，第二个变量表示字段的类型，第三个变量表示字段的特性(修饰符)为public readonly static
            var tokenPrefixBuilder = typeBuilder.DefineField("TokenPrefix", typeof(string), FieldAttributes.Public | FieldAttributes.InitOnly | FieldAttributes.Static);

　　第四步，同第三步，创建其余非静态字段

            var idBuilder = typeBuilder.DefineField("id", typeof(string), FieldAttributes.Public | FieldAttributes.InitOnly);
            var userNameBuilder = typeBuilder.DefineField("userName", typeof(string), FieldAttributes.Public);
            var passwordHashBuilder = typeBuilder.DefineField("passwordHash", typeof(string), FieldAttributes.Private);

　　这样我们的字段就定义好了。

　　ok，相信很多读者都有疑问，我这怎么没写默认值啊，你看字段TokenPrefix都有字段携带着啊，你怎么就把它丢掉了呢？别急，其实在字段后面写默认值也是C#语言的语法糖，我会在下一节进行讲述。

三、字段的操作

　　上一节的代码当中只有字段的定义而少了字段的默认值和对字段的对于的方法，那么我们就来开始解决以上问题吧。

　　首先，在字段后面写默认值的方法是C#的语法糖，其实其真正的写法是将默认值在构造器中进行赋值，静态字段在静态构造器中赋值，对象字段在构造器中赋值，那么在IL中，UserField类生成的源代码应该是这样的

    public class UserField
    {
        public static readonly string TokenPrefix;
        static UserField()
        {
            TokenPrefix = "Bearer";
        }
        public UserField()
        {
            id = Guid.NewGuid().ToString("N");
            passwordHash = "123456";
        }

        public readonly string id;

        public string userName;

        private string passwordHash;

        public string GetPasswodHash()
        {
            return passwordHash;
        }

        public void SetPassword(string password)
        {
            passwordHash = password;
        }
    }

　　也就是说，C#只允许在构造器中对字段可以进行赋初值，所以在Emit中，我们也只能通过构造器来对字段进行默认值赋值，那么问题来了，如何对字段进行操作，字段又有哪些操作呢？这一节博主就来聊一聊字段的操作。

　　其实，在Emit当中，对字段的操作只有两种:

　　（1）入栈(取值)-将字段的值取出放入到栈顶，入栈的Emit操作码都是以Ld作为开头，而字段在Emit操作码均以fld(field)出现，所以字段入栈的Emit操作码为OpCodes.Ldfld以及OpCodes.Ldsfld,前者表示入栈对象字段，后者表示入栈静态字段;

　　（2）保存-将栈顶的值保存到字段，由于保存的Emit操作码以St(Store)作为开头,所以字段有两个保存操作码OpCodes.Stfld和OpCodes.Stsfld,各自的含义请各位联想。

　　如果需要更为详细的操作码信息，各位读者请阅读微软API浏览器了解详细信息:《MS DOTNET API浏览器》

　　好，说完了字段的操作类型，我们开始编写对字段的操作。

首先我们从静态构造器开始，创建静态构造器并编写Emit代码：

            //创建静态构造器(第一个参数表示为私有静态，第三个参数表示入参数量和类型)
            var staticCtorBuilder = typeBuilder.DefineConstructor(MethodAttributes.Private | MethodAttributes.Static | MethodAttributes.SpecialName | MethodAttributes.HideBySig, CallingConventions.Standard, Type.EmptyTypes);
            var staticCtorIL = staticCtorBuilder.GetILGenerator();

编写Emit代码

            //将常量字符串"Bearer"放入栈顶
            staticCtorIL.Emit(OpCodes.Ldstr, "Bearer");
            //取出栈顶元素赋值给字段TokenPrefix
            staticCtorIL.Emit(OpCodes.Stsfld, tokenPrefixBuilder);
            //返回
            staticCtorIL.Emit(OpCodes.Ret);

静态构造器编写完成，我们开始编写实例构造器，与上边静态构造器同理，唯一的区别是，对象字段都是对象的成员，所以需要找到this成员才能获得字段(即this.field)

            var ctorBuilder = typeBuilder.DefineConstructor(MethodAttributes.Public | MethodAttributes.SpecialName | MethodAttributes.HideBySig, CallingConventions.Standard, Type.EmptyTypes);
            var ctorIL = ctorBuilder.GetILGenerator();
            //将this压入栈中(与上面静态构造器的区别)
            ctorIL.Emit(OpCodes.Ldarg_0);
            //将常量字符串"123456"放入栈顶
            ctorIL.Emit(OpCodes.Ldstr, "123456");
            //取出栈顶元素赋值给字段
            ctorIL.Emit(OpCodes.Stfld, passwordHashBuilder);
            //返回
            ctorIL.Emit(OpCodes.Ret);

最后，我们编写一个GetPasswordHash方法，实现字段的取值并返回

            var getPasswordHashMethodBuilder = typeBuilder.DefineMethod("GetPasswordHash", MethodAttributes.Public | MethodAttributes.HideBySig, CallingConventions.Standard, typeof(string), Type.EmptyTypes);
            var getPasswordHashIL = getPasswordHashMethodBuilder.GetILGenerator();
            //将this压入栈中
            getPasswordHashIL.Emit(OpCodes.Ldarg_0);
            //将字段值压入到栈中
            getPasswordHashIL.Emit(OpCodes.Ldfld, passwordHashBuilder);
            //返回
            getPasswordHashIL.Emit(OpCodes.Ret);

最后的最后，不要忘记创建类型哦

　　　　　　　typeBuilder.CreateTypeInfo().AsType();

　　使用类型创建对象，并调用即可看到效果

            dynamic user = Activator.CreateInstance(type);
            Console.WriteLine(user.GetPasswordHash());

一、小结

　　在编写C#时，一定要小心C#自带的语法糖产生错误认知，看穿语法糖的本质，你对这门语言的理解就更加深入，对你了解其它语言也有类似的帮助，毕竟即使编程语言在不断的涌现和发展，你也能把握其最本质的、不变的东西，就像算法与数据结构一样是软件的灵魂一样。

　　下一篇，博主将详细介绍C#中最特殊的东西-属性，感谢阅读，以下为github样例地址

　　https://github.com/MJEdwin/edwin-blog-sample/blob/master/Edwin.Blog.Sample/Field/UserEmit.cs

加载全部内容