Як динамічно створити клас?


223

У мене клас виглядає так:

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
Ви хочете використовувати цей клас під час виконання або лише створювати файл?
Damian Leszczyński - Vash

Я хочу, щоб це створювалося під час виконання. Я не хочу, щоб фізичний файл CS знаходився в моїй файловій системі. Вибачте, що не згадували про це раніше.
ashwnacharya

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 ()?
ashwnacharya

4
Ви можете використовувати System.Activator для цього. Я оновлю відповідь прикладом.
danijels

4
Зауважте також, що вам доведеться використовувати відображення для вивчення, читання та оновлення полів у вашому динамічному типі. Якщо ви хочете інтеліссенс та відсутність відображення, у вас повинен бути статичний базовий клас або інтерфейс, від якого ваш динамічний клас успадковується і на який можна звернути увагу. У такому випадку ви можете змінити метод GetTypeBuilder () та змінити виклик moduleBuilder.DefineType, щоб включити статичний тип як останній параметр (зараз недійсне)
danijels

2
хтось може пояснити, як користуватися об’єктом після його створення
HELP_ME

3
@bugz використовуйте наведений вище код для створення класу, тоді в базовий клас ви можете додати цей метод: public void SetValue <T> (ім'я рядка, значення T) {GetType (). GetProperty (ім'я) .SetValue (це, значення ); }
stricq

71

Це займе певну роботу, але це, звичайно, не неможливо.

Що я зробив:

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

Таким чином, ви можете мати справу з кодом C #, який ви вже знаєте, замість того, щоб випромінювати MSIL.

Але це найкраще спрацьовує, якщо ваш клас реалізує якийсь інтерфейс (або походить від якогось базового рівня), інакше як код виклику (читати: компілятор) знати про той клас, який буде генеруватися під час виконання?


7
Можливо, хочете побачити цю дискусію: reflex-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

Я не знаю, яке використання таких динамічних класів планується, і генерація коду, і компіляція часу виконання можуть бути зроблені, але потрібно певних зусиль. Можливо, анонімні типи допоможуть вам, на кшталт:

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

7
Ви не можете жорстко кодувати імена полів. Він забезпечує їх своїм Field.FieldName. Наявність жорсткого коду імена полів перемагає мету. Якщо вам доведеться це зробити, ви можете також створити клас.
toddmo

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


Так, але ви втрачаєте безпеку типу. Чи можемо ми зробити щось подібне, зберігаючи безпеку типу?
жорсткі запитання

9

Ви хочете подивитися на CodeDOM . Це дозволяє визначати елементи коду та компілювати їх. Цитуючи MSDN:

... Цей об'єктний графік може бути представлений у якості вихідного коду за допомогою генератора коду CodeDOM для підтримуваної мови програмування. CodeDOM також може використовуватися для компіляції вихідного коду у двійкову збірку.


Я хочу, щоб це створювалося під час виконання. Я не хочу, щоб фізичний файл CS знаходився в моїй файловій системі. Вибачте, що не згадували про це раніше.
ashwnacharya

1
@ashwnacharya: Ви можете використовувати CodeDOM як для створення вихідного файлу, так і для його компіляції під час виконання!
Хемант

1
Але остерігайтеся, що компілятор CodeDOM займає необмежену рядок, і, таким чином, ви можете розглянути "атаки вставки коду", аналогічні тим, які використовуються в ін'єкції XSS та SQL.
cwap

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
Гленн Слейден

Гленн: швидкий гуглінг виявив робоче посилання: pdfs.semanticscholar.org/326a/…
Andreas Pardeike

@AndreasPardeike Спасибі, я відремонтував це у статті.
Гленн Слейден
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.