Как динамически создать класс?


222

У меня есть класс, который выглядит так:

public class Field
{
    public string FieldName;
    public string FieldType;
}

И объект List<Field> со значениями:

{"EmployeeID","int"},
{"EmployeeName","String"},
{"Designation","String"}

Я хочу создать класс, который выглядит следующим образом:

Class DynamicClass
{
    int EmployeeID,
    String EmployeeName,
    String Designation
}

Есть какой-либо способ сделать это?

Я хочу, чтобы это генерировалось во время выполнения. Я не хочу, чтобы физический файл CS находился в моей файловой системе.


4
Вы хотите использовать этот класс во время выполнения или только генерировать файл?
Дамиан Лещинский - Ваш

Я хочу, чтобы это генерировалось во время выполнения. Я не хочу, чтобы физический файл CS находился в моей файловой системе. Извините, что не упомянул это ранее.
ашнукачаря

16
Можете ли вы дать нам общее представление о том, что вы собираетесь делать с этим классом?
Джастин

3
Например, @Justin реализует интерфейсы с разрешением во время выполнения.
AgentFire

Можно было бы его накормитьSystem.ServiceModel.ChannelFactory<MyDynamicInterface>
Илья Семенов

Ответы:


298

Да, вы можете использовать System.Reflection.Emitпространство имен для этого. Это не так просто, если у вас нет опыта, но это, безусловно, возможно.

Изменить: Этот код может быть ошибочным, но он даст вам общую идею и, надеюсь, хорошее начало для достижения цели.

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

namespace TypeBuilderNamespace
{
    public static class MyTypeBuilder
    {
        public static void CreateNewObject()
        {
            var myType = CompileResultType();
            var myObject = Activator.CreateInstance(myType);
        }
        public static Type CompileResultType()
        {
            TypeBuilder tb = GetTypeBuilder();
            ConstructorBuilder constructor = tb.DefineDefaultConstructor(MethodAttributes.Public | MethodAttributes.SpecialName | MethodAttributes.RTSpecialName);

            // NOTE: assuming your list contains Field objects with fields FieldName(string) and FieldType(Type)
            foreach (var field in yourListOfFields)
                CreateProperty(tb, field.FieldName, field.FieldType);

            Type objectType = tb.CreateType();
            return objectType;
        }

        private static TypeBuilder GetTypeBuilder()
        {
            var typeSignature = "MyDynamicType";
            var an = new AssemblyName(typeSignature);
            AssemblyBuilder assemblyBuilder = AppDomain.CurrentDomain.DefineDynamicAssembly(an, AssemblyBuilderAccess.Run);
            ModuleBuilder moduleBuilder = assemblyBuilder.DefineDynamicModule("MainModule");
            TypeBuilder tb = moduleBuilder.DefineType(typeSignature,
                    TypeAttributes.Public |
                    TypeAttributes.Class |
                    TypeAttributes.AutoClass |
                    TypeAttributes.AnsiClass |
                    TypeAttributes.BeforeFieldInit |
                    TypeAttributes.AutoLayout,
                    null);
            return tb;
        }

        private static void CreateProperty(TypeBuilder tb, string propertyName, Type propertyType)
        {
            FieldBuilder fieldBuilder = tb.DefineField("_" + propertyName, propertyType, FieldAttributes.Private);

            PropertyBuilder propertyBuilder = tb.DefineProperty(propertyName, PropertyAttributes.HasDefault, propertyType, null);
            MethodBuilder getPropMthdBldr = tb.DefineMethod("get_" + propertyName, MethodAttributes.Public | MethodAttributes.SpecialName | MethodAttributes.HideBySig, propertyType, Type.EmptyTypes);
            ILGenerator getIl = getPropMthdBldr.GetILGenerator();

            getIl.Emit(OpCodes.Ldarg_0);
            getIl.Emit(OpCodes.Ldfld, fieldBuilder);
            getIl.Emit(OpCodes.Ret);

            MethodBuilder setPropMthdBldr =
                tb.DefineMethod("set_" + propertyName,
                  MethodAttributes.Public |
                  MethodAttributes.SpecialName |
                  MethodAttributes.HideBySig,
                  null, new[] { propertyType });

            ILGenerator setIl = setPropMthdBldr.GetILGenerator();
            Label modifyProperty = setIl.DefineLabel();
            Label exitSet = setIl.DefineLabel();

            setIl.MarkLabel(modifyProperty);
            setIl.Emit(OpCodes.Ldarg_0);
            setIl.Emit(OpCodes.Ldarg_1);
            setIl.Emit(OpCodes.Stfld, fieldBuilder);

            setIl.Emit(OpCodes.Nop);
            setIl.MarkLabel(exitSet);
            setIl.Emit(OpCodes.Ret);

            propertyBuilder.SetGetMethod(getPropMthdBldr);
            propertyBuilder.SetSetMethod(setPropMthdBldr);
        }
    }
}

2
Потрясающие!! Можете ли вы также рассказать мне, как создать объект типа, возвращаемого методом CompileResultType ()?
ашнукачарья

4
Вы можете использовать System.Activator для этого. Я обновлю ответ с примером.
Даниелс

4
Также обратите внимание, что вам придется использовать рефлексию для изучения, чтения и обновления полей в вашем динамическом типе. Если вам нужен intellisense, а не рефлексия, у вас должен быть статический базовый класс или интерфейс, от которого наследуется и может быть преобразован ваш динамический класс. В этом случае вы можете модифицировать метод GetTypeBuilder () и изменить вызов moduleBuilder.DefineType, чтобы включить статический тип в качестве последнего параметра (теперь он нулевой)
danijels

2
может кто-нибудь объяснить, как использовать объект после его создания
HELP_ME

3
@bugz используйте приведенный выше код для создания класса, затем в базовый класс вы можете добавить этот метод: public void SetValue <T> (имя строки, значение T) {GetType (). GetProperty (name) .SetValue (this, value ); }
Stricq

71

Это займет некоторую работу, но, конечно, не невозможно.

Что я сделал, это:

  • Создать источник C # в строке (не нужно записывать в файл),
  • Запустите его через Microsoft.CSharp.CSharpCodeProvider (CompileAssemblyFromSource)
  • Найти сгенерированный тип
  • И создать экземпляр этого типа ( Activator.CreateInstance)

Таким образом, вы можете работать с уже известным вам кодом C # вместо того, чтобы испускать MSIL.

Но это работает лучше всего, если ваш класс реализует некоторый интерфейс (или является производным от некоторого базового класса), иначе как вызывающий код (читай: компилятор) узнает об этом классе, который будет сгенерирован во время выполнения?


7
Возможно, хотелось бы увидеть это обсуждение: mirror-emit-vs-codedom
nawfal

1
@nawfal, ashwnacharya, хотел динамически генерировать во время выполнения свой класс, члены которого изначально содержались в списке. Я не думаю, что поместить его в файл, даже сгенерированный во время выполнения, было бы хорошим решением для повышения производительности.
sodjsn26fr

39

Вы также можете динамически создать класс с помощью DynamicObject .

public class DynamicClass : DynamicObject
{
    private Dictionary<string, KeyValuePair<Type, object>> _fields;

    public DynamicClass(List<Field> fields)
    {
        _fields = new Dictionary<string, KeyValuePair<Type, object>>();
        fields.ForEach(x => _fields.Add(x.FieldName,
            new KeyValuePair<Type, object>(x.FieldType, null)));
    }

    public override bool TrySetMember(SetMemberBinder binder, object value)
    {
        if (_fields.ContainsKey(binder.Name))
        {
            var type = _fields[binder.Name].Key;
            if (value.GetType() == type)
            {
                _fields[binder.Name] = new KeyValuePair<Type, object>(type, value);
                return true;
            }
            else throw new Exception("Value " + value + " is not of type " + type.Name);
        }
        return false;
    }

    public override bool TryGetMember(GetMemberBinder binder, out object result)
    {
        result = _fields[binder.Name].Value;
        return true;
    }
}

Я храню все поля классов в словаре _fieldsвместе с их типами и значениями. Оба метода должны получить или установить значение для некоторых свойств. Вы должны использовать dynamicключевое слово для создания экземпляра этого класса.

Использование с вашим примером:

var fields = new List<Field>() { 
    new Field("EmployeeID", typeof(int)),
    new Field("EmployeeName", typeof(string)),
    new Field("Designation", typeof(string)) 
};

dynamic obj = new DynamicClass(fields);

//set
obj.EmployeeID = 123456;
obj.EmployeeName = "John";
obj.Designation = "Tech Lead";

obj.Age = 25;             //Exception: DynamicClass does not contain a definition for 'Age'
obj.EmployeeName = 666;   //Exception: Value 666 is not of type String

//get
Console.WriteLine(obj.EmployeeID);     //123456
Console.WriteLine(obj.EmployeeName);   //John
Console.WriteLine(obj.Designation);    //Tech Lead

Редактировать: А вот как выглядит мой класс Field:

public class Field
{
    public Field(string name, Type type)
    {
        this.FieldName = name;
        this.FieldType = type;
    }

    public string FieldName;

    public Type FieldType;
}

1
Мне понравился этот подход, пока мне не понадобилось инициализировать поля конструктором. то есть dynamic obj = new DynamicClass(fields){EmployeeId=123456;EmployeeName = "John"; Designation = "Tech Lead";}было бы здорово сделать это.
rey_coder

14

Я не знаю предполагаемого использования таких динамических классов, и генерация кода и компиляция во время выполнения могут быть выполнены, но это требует определенных усилий. Может быть , вам помогут Anonymous Types , например:

var v = new { EmployeeID = 108, EmployeeName = "John Doe" };

7
Вы не можете жестко закодировать имена полей. Он обеспечивает их своим Field.FieldName. Необходимость жесткого кодирования имен полей побеждает цель. Если вам нужно сделать это, вы можете создать класс.
2016 г.

14

Я знаю, что снова открываю эту старую задачу, но с c # 4.0 эта задача абсолютно безболезненная.

dynamic expando = new ExpandoObject();
expando.EmployeeID=42;
expando.Designation="unknown";
expando.EmployeeName="curt"

//or more dynamic
AddProperty(expando, "Language", "English");

для получения дополнительной информации см. https://www.oreilly.com/learning/building-c-objects-dynamically


Да, но вы теряете безопасность типов здесь. Можем ли мы сделать нечто подобное, сохранив безопасность типов?
ToughQuestions

9

Вы хотите посмотреть на CodeDOM . Это позволяет определять элементы кода и компилировать их. Цитирование MSDN:

... Этот граф объектов может быть представлен как исходный код с использованием генератора кода CodeDOM для поддерживаемого языка программирования. CodeDOM также можно использовать для компиляции исходного кода в двоичную сборку.


Я хочу, чтобы это генерировалось во время выполнения. Я не хочу, чтобы физический файл CS находился в моей файловой системе. Извините, что не упомянул это ранее.
ашнукачаря

1
@ashwnacharya: Вы можете использовать CodeDOM для генерации исходного файла и его компиляции во время выполнения!
Hemant

1
Однако следует помнить, что компилятор CodeDOM принимает необработанную строку, и поэтому вы можете рассмотреть «атаки вставки кода», аналогичные тем, которые используются в XSS и SQL-инъекциях.
Смешение

6

Основываясь на ответе @ danijels, динамически создайте класс в VB.NET:

Imports System.Reflection
Imports System.Reflection.Emit

Public Class ObjectBuilder

Public Property myType As Object
Public Property myObject As Object

Public Sub New(fields As List(Of Field))
    myType = CompileResultType(fields)
    myObject = Activator.CreateInstance(myType)
End Sub

Public Shared Function CompileResultType(fields As List(Of Field)) As Type
    Dim tb As TypeBuilder = GetTypeBuilder()
    Dim constructor As ConstructorBuilder = tb.DefineDefaultConstructor(MethodAttributes.[Public] Or MethodAttributes.SpecialName Or MethodAttributes.RTSpecialName)

    For Each field In fields
        CreateProperty(tb, field.Name, field.Type)
    Next

    Dim objectType As Type = tb.CreateType()
    Return objectType
End Function

Private Shared Function GetTypeBuilder() As TypeBuilder
    Dim typeSignature = "MyDynamicType"
    Dim an = New AssemblyName(typeSignature)
    Dim assemblyBuilder As AssemblyBuilder = AppDomain.CurrentDomain.DefineDynamicAssembly(an, AssemblyBuilderAccess.Run)
    Dim moduleBuilder As ModuleBuilder = assemblyBuilder.DefineDynamicModule("MainModule")
    Dim tb As TypeBuilder = moduleBuilder.DefineType(typeSignature, TypeAttributes.[Public] Or TypeAttributes.[Class] Or TypeAttributes.AutoClass Or TypeAttributes.AnsiClass Or TypeAttributes.BeforeFieldInit Or TypeAttributes.AutoLayout, Nothing)
    Return tb
End Function

Private Shared Sub CreateProperty(tb As TypeBuilder, propertyName As String, propertyType As Type)
    Dim fieldBuilder As FieldBuilder = tb.DefineField("_" & propertyName, propertyType, FieldAttributes.[Private])

    Dim propertyBuilder As PropertyBuilder = tb.DefineProperty(propertyName, PropertyAttributes.HasDefault, propertyType, Nothing)
    Dim getPropMthdBldr As MethodBuilder = tb.DefineMethod("get_" & propertyName, MethodAttributes.[Public] Or MethodAttributes.SpecialName Or MethodAttributes.HideBySig, propertyType, Type.EmptyTypes)
    Dim getIl As ILGenerator = getPropMthdBldr.GetILGenerator()

    getIl.Emit(OpCodes.Ldarg_0)
    getIl.Emit(OpCodes.Ldfld, fieldBuilder)
    getIl.Emit(OpCodes.Ret)

    Dim setPropMthdBldr As MethodBuilder = tb.DefineMethod("set_" & propertyName, MethodAttributes.[Public] Or MethodAttributes.SpecialName Or MethodAttributes.HideBySig, Nothing, {propertyType})

    Dim setIl As ILGenerator = setPropMthdBldr.GetILGenerator()
    Dim modifyProperty As Label = setIl.DefineLabel()
    Dim exitSet As Label = setIl.DefineLabel()

    setIl.MarkLabel(modifyProperty)
    setIl.Emit(OpCodes.Ldarg_0)
    setIl.Emit(OpCodes.Ldarg_1)
    setIl.Emit(OpCodes.Stfld, fieldBuilder)

    setIl.Emit(OpCodes.Nop)
    setIl.MarkLabel(exitSet)
    setIl.Emit(OpCodes.Ret)

    propertyBuilder.SetGetMethod(getPropMthdBldr)
    propertyBuilder.SetSetMethod(setPropMthdBldr)
End Sub

End Class

6

Вы также можете динамически создать класс с помощью DynamicExpressions .

Так как словарь имеет компактные инициализаторы и обрабатывает столкновения клавиш, вы захотите сделать что-то подобное.

  var list = new Dictionary<string, string> {
    {
      "EmployeeID",
      "int"
    }, {
      "EmployeeName",
      "String"
    }, {
      "Birthday",
      "DateTime"
    }
  };

Или вы можете использовать JSON-конвертер, чтобы превратить ваш сериализованный строковый объект в нечто управляемое.

Затем с помощью System.Linq.Dynamic;

  IEnumerable<DynamicProperty> props = list.Select(property => new DynamicProperty(property.Key, Type.GetType(property.Value))).ToList();

  Type t = DynamicExpression.CreateClass(props);

Остальное только с помощью System.Reflection.

  object obj = Activator.CreateInstance(t);
  t.GetProperty("EmployeeID").SetValue(obj, 34, null);
  t.GetProperty("EmployeeName").SetValue(obj, "Albert", null);
  t.GetProperty("Birthday").SetValue(obj, new DateTime(1976, 3, 14), null);
}  

4

Для тех, кто хочет создать динамический класс просто свойства (то есть POCO), и создать список этого класса. Используя код, предоставленный позже, это создаст динамический класс и создаст список этого.

var properties = new List<DynamicTypeProperty>()
{
    new DynamicTypeProperty("doubleProperty", typeof(double)),
    new DynamicTypeProperty("stringProperty", typeof(string))
};

// create the new type
var dynamicType = DynamicType.CreateDynamicType(properties);
// create a list of the new type
var dynamicList = DynamicType.CreateDynamicList(dynamicType);

// get an action that will add to the list
var addAction = DynamicType.GetAddAction(dynamicList);

// call the action, with an object[] containing parameters in exact order added
addAction.Invoke(new object[] {1.1, "item1"});
addAction.Invoke(new object[] {2.1, "item2"});
addAction.Invoke(new object[] {3.1, "item3"});

Вот классы, которые использует предыдущий код.

Примечание. Вам также необходимо обратиться к библиотеке Microsoft.CodeAnalysis.CSharp.

       /// <summary>
    /// A property name, and type used to generate a property in the dynamic class.
    /// </summary>
    public class DynamicTypeProperty
    {
        public DynamicTypeProperty(string name, Type type)
        {
            Name = name;
            Type = type;
        }
        public string Name { get; set; }
        public Type Type { get; set; }
    }

   public static class DynamicType
    {
        /// <summary>
        /// Creates a list of the specified type
        /// </summary>
        /// <param name="type"></param>
        /// <returns></returns>
        public static IEnumerable<object> CreateDynamicList(Type type)
        {
            var listType = typeof(List<>);
            var dynamicListType = listType.MakeGenericType(type);
            return (IEnumerable<object>) Activator.CreateInstance(dynamicListType);
        }

        /// <summary>
        /// creates an action which can be used to add items to the list
        /// </summary>
        /// <param name="listType"></param>
        /// <returns></returns>
        public static Action<object[]> GetAddAction(IEnumerable<object> list)
        {
            var listType = list.GetType();
            var addMethod = listType.GetMethod("Add");
            var itemType = listType.GenericTypeArguments[0];
            var itemProperties = itemType.GetProperties();

            var action = new Action<object[]>((values) =>
            {
                var item = Activator.CreateInstance(itemType);

                for(var i = 0; i < values.Length; i++)
                {
                    itemProperties[i].SetValue(item, values[i]);
                }

                addMethod.Invoke(list, new []{item});
            });

            return action;
        }

        /// <summary>
        /// Creates a type based on the property/type values specified in the properties
        /// </summary>
        /// <param name="properties"></param>
        /// <returns></returns>
        /// <exception cref="Exception"></exception>
        public static Type CreateDynamicType(IEnumerable<DynamicTypeProperty> properties)
        {
            StringBuilder classCode = new StringBuilder();

            // Generate the class code
            classCode.AppendLine("using System;");
            classCode.AppendLine("namespace Dexih {");
            classCode.AppendLine("public class DynamicClass {");

            foreach (var property in properties)
            {
                classCode.AppendLine($"public {property.Type.Name} {property.Name} {{get; set; }}");
            }
            classCode.AppendLine("}");
            classCode.AppendLine("}");

            var syntaxTree = CSharpSyntaxTree.ParseText(classCode.ToString());

            var references = new MetadataReference[]
            {
                MetadataReference.CreateFromFile(typeof(object).GetTypeInfo().Assembly.Location),
                MetadataReference.CreateFromFile(typeof(DictionaryBase).GetTypeInfo().Assembly.Location)
            };

            var compilation = CSharpCompilation.Create("DynamicClass" + Guid.NewGuid() + ".dll",
                syntaxTrees: new[] {syntaxTree},
                references: references,
                options: new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary));

            using (var ms = new MemoryStream())
            {
                var result = compilation.Emit(ms);

                if (!result.Success)
                {
                    var failures = result.Diagnostics.Where(diagnostic =>
                        diagnostic.IsWarningAsError ||
                        diagnostic.Severity == DiagnosticSeverity.Error);

                    var message = new StringBuilder();

                    foreach (var diagnostic in failures)
                    {
                        message.AppendFormat("{0}: {1}", diagnostic.Id, diagnostic.GetMessage());
                    }

                    throw new Exception($"Invalid property definition: {message}.");
                }
                else
                {

                    ms.Seek(0, SeekOrigin.Begin);
                    var assembly = System.Runtime.Loader.AssemblyLoadContext.Default.LoadFromStream(ms);
                    var dynamicType = assembly.GetType("Dexih.DynamicClass");
                    return dynamicType;
                }
            }
        }
    }

Отличный кусок кода. Можно ли использовать также AddRange в динамическом списке, чтобы в конечном итоге добавить несколько записей одновременно?
RickyTad

2

Вы можете посмотреть на использование динамических модулей и классов, которые могут выполнять эту работу. Единственным недостатком является то, что он остается загруженным в домене приложения. Но с использованием версии .NET Framework это может измениться. .NET 4.0 поддерживает коллекционные динамические сборки и, следовательно, вы можете динамически воссоздавать классы / типы.


2

Вот Это Да! Спасибо за этот ответ! Я добавил некоторые функции для создания конвертера datatable to json, которым я с вами поделюсь.

    Public Shared Sub dt2json(ByVal _dt As DataTable, ByVal _sb As StringBuilder)
    Dim t As System.Type

    Dim oList(_dt.Rows.Count - 1) As Object
    Dim jss As New JavaScriptSerializer()
    Dim i As Integer = 0

    t = CompileResultType(_dt)

    For Each dr As DataRow In _dt.Rows
        Dim o As Object = Activator.CreateInstance(t)

        For Each col As DataColumn In _dt.Columns
            setvalue(o, col.ColumnName, dr.Item(col.ColumnName))
        Next

        oList(i) = o
        i += 1
    Next

    jss = New JavaScriptSerializer()
    jss.Serialize(oList, _sb)


End Sub

И в подпункте "compileresulttype" я изменил это:

    For Each column As DataColumn In _dt.Columns
        CreateProperty(tb, column.ColumnName, column.DataType)
    Next


Private Shared Sub setvalue(ByVal _obj As Object, ByVal _propName As String, ByVal _propValue As Object)
    Dim pi As PropertyInfo
    pi = _obj.GetType.GetProperty(_propName)
    If pi IsNot Nothing AndAlso pi.CanWrite Then
        If _propValue IsNot DBNull.Value Then
            pi.SetValue(_obj, _propValue, Nothing)

        Else
            Select Case pi.PropertyType.ToString
                Case "System.String"
                    pi.SetValue(_obj, String.Empty, Nothing)
                Case Else
                    'let the serialiser use javascript "null" value.
            End Select

        End If
    End If

End Sub


-1

Runtime Code Generation with JVM and CLR - Питер Сестофт

Работа для людей, которые действительно заинтересованы в этом типе программирования.

Мой совет для вас: если вы объявляете что-то, старайтесь избегать строки, поэтому, если у вас есть класс Field, лучше использовать класс System.Type для хранения типа поля, а не строки. И ради лучших решений вместо создания новых классов попробуйте использовать те, что были созданы FiledInfo вместо создания новых.


2
Ссылка мертва: -1
Гленн

Гленн: быстрый поиск в Google показал работающую ссылку: pdfs.semanticscholar.org/326a/…
Andreas Pardeike

@AndreasPardeike Спасибо, я исправил это в статье.
Гленн
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.