如何编写 T4 模板以从实体框架 6 创建 DTO

本文关键字：框架 实体 创建 DTO 何编写 T4 | 更新日期: 2023-09-27 18:35:16

我有一个大型数据库，我在Entityframework中使用数据库优先模型。它位于互联网服务器上，并通过 WCF 进行通信。域模型使用全部小写字母作为实体、存储过程和列/属性的名称。

在我的客户端应用程序中，我希望使用标准的 PascalCase 进行命名约定。

T4 模板是否可以使用正确的命名约定从实体框架创建数据传输对象？

如果是这样，有人可以给我一个如何写它的起点吗？

需要明确的是，我不想更改 Entityframework 生成的任何代码，而是使用实体框架模型作为另一个文件的输入来添加具有适当 CamelCase 命名的简单 POCO 类，然后可以由 WCF 服务引用，也许还可以由 Automapper（或类似的东西）引用。

感谢您的任何建议。

  • 数据库：PostgreSQL 9.5
  • 数据库接口：Npgsql 3.0.5
  • .NET 4.5
  • 实体框架 6.0

如何编写 T4 模板以从实体框架 6 创建 DTO

代替任何人回答这个问题并希望帮助像我这样的任何其他新手，这是我为创建 T4 转换所做的，DTOclasses.tt 只产生简单的类定义。

注意：这不是替换 .edmx 的 .tt 文件，而是在 .edmx 模板生成 .edmx 文件后运行。（我不想更改用于生成域模型的任何代码）。

Visual Studio 2015实体框架 6.0.NET Framework 4.6.1

♦ Notes on Creating DTOclassess.tt
        This T4 transform was created by first copying the working transform used to build the entity model, MedicalOfficeModel.tt.
        Then, parts of it that were not needed for creation of POCO classes to be used for DTO's (data transfer objects) were removed.
    ♦ Changes made to DTOclassses.tt
        •   Adding "DTO" to namespace.
                public void BeginNamespace(CodeGenerationTools code)
                {
                    var codeNamespace = String.Format("{0}.{1}",code.VsNamespaceSuggestion(), "DTO");
                    if (!String.IsNullOrEmpty(codeNamespace))
                    {
                #>
                namespace <#=code.EscapeNamespace(codeNamespace)#>
                {
                <#+
                        PushIndent("    ");
                    }
                }
        •  Put all POCO classes in single file DTOclasses.cs
                <#
                EndNamespace(code);
            }
            fileManager.Process(false);             <--**False stops the splitting of classes into different files. Default is true.
            #>
        •  Change the property naming code:
                    public string Property(EdmProperty edmProperty)
                    {
                        return string.Format(
                            CultureInfo.InvariantCulture,
                            "{0} {1} {2} {{ {3}get; {4}set; }}",
                            Accessibility.ForProperty(edmProperty),
                            _typeMapper.GetTypeName(edmProperty.TypeUsage),
                            GetPascalCase(_code.Escape(edmProperty)),
                            _code.SpaceAfter(Accessibility.ForGetter(edmProperty)),
                            _code.SpaceAfter(Accessibility.ForSetter(edmProperty)));
                    }
        •  Change the class naming code:
                    public string EntityClassOpening(EntityType entity)
                    {
                        return string.Format(
                            CultureInfo.InvariantCulture,
                            "{0} {1}partial class {2}{3}",
                            Accessibility.ForType(entity),
                            _code.SpaceAfter(_code.AbstractOption(entity)),
                            GetPascalCase(_code.Escape(entity)),
                            _code.StringBefore(" : ", _typeMapper.GetTypeName(entity.BaseType)));
                    }
        •  Removed all the navigational stuff. Replaced everything above the helper functions (i.e., above <#+) with:
                            <#@ template debug="false" hostspecific="true" language="C#" #>
                            <#@ assembly name="System.Core" #>
                            <#@ import namespace="System.Linq" #>
                            <#@ import namespace="System.Text" #>
                            <#@ import namespace="System.Collections.Generic" #>
                            <#@ import namespace="System.Text.RegularExpressions" #>
                            <#@ include file="EF6.Utility.CS.ttinclude" #>
                            <#@ output extension=".cs" #>
                            <#
                            const string inputFile = @"MedicalOfficeModel.edmx";
                            var textTransform = DynamicTextTransformation.Create(this);
                            var code = new CodeGenerationTools(this);
                            var ef = new MetadataTools(this);
                            var typeMapper = new TypeMapper(code, ef, textTransform.Errors);
                            var fileManager = EntityFrameworkTemplateFileManager.Create(this);
                            var itemCollection = new EdmMetadataLoader(textTransform.Host, textTransform.Errors).CreateEdmItemCollection(inputFile);
                            var codeStringGenerator = new CodeStringGenerator(code, typeMapper, ef);
                            if (!typeMapper.VerifyCaseInsensitiveTypeUniqueness(typeMapper.GetAllGlobalItems(itemCollection), inputFile))
                            {
                                return string.Empty;
                            }
                            WriteHeader(codeStringGenerator, fileManager);
                            foreach (var entity in typeMapper.GetItemsToGenerate<EntityType>(itemCollection))
                            {
                                fileManager.StartNewFile(entity.Name + ".cs");
                                BeginNamespace(code);
                            #>
                            <#=codeStringGenerator.UsingDirectives(inHeader: false)#>
                            <#=codeStringGenerator.EntityClassOpening(entity)#>
                            {
                            <#
                                var simpleProperties = typeMapper.GetSimpleProperties(entity);
                                if (simpleProperties.Any())
                                {
                                    foreach (var edmProperty in simpleProperties)
                                    {
                            #>
                                <#=codeStringGenerator.Property(edmProperty)#>
                            <#
                                    }
                                }
                            #>
                            }
                            <#
                                EndNamespace(code);
                            }
                            fileManager.Process(false);
                            #>
        ♦  Added my helper function:
                    <#+
                        public static string GetPascalCase(string name)
                        {
                            return Regex.Replace(name, @"^'w|_'w",
                                (match) => match.Value.Replace("_", "").ToUpper());
                        }
                    #>

当一切都完成后，这将完美运行（在VS2015中），以完全满足我的需要。 :)

相关文章：