/
CSharpEntityTypeGenerator.cs
488 lines (406 loc) · 20.6 KB
/
CSharpEntityTypeGenerator.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq;
using JetBrains.Annotations;
using Microsoft.EntityFrameworkCore.Design;
using Microsoft.EntityFrameworkCore.Design.Internal;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Metadata;
using Microsoft.EntityFrameworkCore.Metadata.Internal;
using Microsoft.EntityFrameworkCore.Utilities;
namespace Microsoft.EntityFrameworkCore.Scaffolding.Internal
{
/// <summary>
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
/// any release. You should only use it directly in your code with extreme caution and knowing that
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
public class CSharpEntityTypeGenerator : ICSharpEntityTypeGenerator
{
private readonly IAnnotationCodeGenerator _annotationCodeGenerator;
private readonly ICSharpHelper _code;
private IndentedStringBuilder _sb = null!;
private bool _useDataAnnotations;
/// <summary>
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
/// any release. You should only use it directly in your code with extreme caution and knowing that
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
public CSharpEntityTypeGenerator(
[NotNull] IAnnotationCodeGenerator annotationCodeGenerator,
[NotNull] ICSharpHelper cSharpHelper)
{
Check.NotNull(cSharpHelper, nameof(cSharpHelper));
_annotationCodeGenerator = annotationCodeGenerator;
_code = cSharpHelper;
}
/// <summary>
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
/// any release. You should only use it directly in your code with extreme caution and knowing that
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
public virtual string WriteCode(IEntityType entityType, string @namespace, bool useDataAnnotations)
{
Check.NotNull(entityType, nameof(entityType));
Check.NotNull(@namespace, nameof(@namespace));
_sb = new IndentedStringBuilder();
_useDataAnnotations = useDataAnnotations;
_sb.AppendLine("using System;");
_sb.AppendLine("using System.Collections.Generic;");
if (_useDataAnnotations)
{
_sb.AppendLine("using System.ComponentModel.DataAnnotations;");
_sb.AppendLine("using System.ComponentModel.DataAnnotations.Schema;");
_sb.AppendLine("using Microsoft.EntityFrameworkCore;"); // For attributes coming out of Abstractions
}
foreach (var ns in entityType.GetProperties()
.SelectMany(p => p.ClrType.GetNamespaces())
.Where(ns => ns != "System" && ns != "System.Collections.Generic")
.Distinct()
.OrderBy(x => x, new NamespaceComparer()))
{
_sb.AppendLine($"using {ns};");
}
_sb.AppendLine();
_sb.AppendLine("#nullable disable");
_sb.AppendLine();
_sb.AppendLine($"namespace {@namespace}");
_sb.AppendLine("{");
using (_sb.Indent())
{
GenerateClass(entityType);
}
_sb.AppendLine("}");
return _sb.ToString();
}
/// <summary>
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
/// any release. You should only use it directly in your code with extreme caution and knowing that
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
protected virtual void GenerateClass([NotNull] IEntityType entityType)
{
Check.NotNull(entityType, nameof(entityType));
if (_useDataAnnotations)
{
GenerateEntityTypeDataAnnotations(entityType);
}
_sb.AppendLine($"public partial class {entityType.Name}");
_sb.AppendLine("{");
using (_sb.Indent())
{
GenerateConstructor(entityType);
GenerateProperties(entityType);
GenerateNavigationProperties(entityType);
}
_sb.AppendLine("}");
}
/// <summary>
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
/// any release. You should only use it directly in your code with extreme caution and knowing that
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
protected virtual void GenerateEntityTypeDataAnnotations([NotNull] IEntityType entityType)
{
Check.NotNull(entityType, nameof(entityType));
GenerateKeylessAttribute(entityType);
GenerateTableAttribute(entityType);
GenerateIndexAttributes(entityType);
var annotations = _annotationCodeGenerator
.FilterIgnoredAnnotations(entityType.GetAnnotations())
.ToDictionary(a => a.Name, a => a);
_annotationCodeGenerator.RemoveAnnotationsHandledByConventions(entityType, annotations);
foreach (var attribute in _annotationCodeGenerator.GenerateDataAnnotationAttributes(entityType, annotations))
{
var attributeWriter = new AttributeWriter(attribute.Type.Name);
foreach (var argument in attribute.Arguments)
{
attributeWriter.AddParameter(_code.UnknownLiteral(argument));
}
_sb.AppendLine(attributeWriter.ToString());
}
}
private void GenerateKeylessAttribute(IEntityType entityType)
{
if (entityType.FindPrimaryKey() == null)
{
_sb.AppendLine(new AttributeWriter(nameof(KeylessAttribute)).ToString());
}
}
private void GenerateTableAttribute(IEntityType entityType)
{
var tableName = entityType.GetTableName();
var schema = entityType.GetSchema();
var defaultSchema = entityType.Model.GetDefaultSchema();
var schemaParameterNeeded = schema != null && schema != defaultSchema;
var isView = entityType.GetViewName() != null;
var tableAttributeNeeded = !isView && (schemaParameterNeeded || tableName != null && tableName != entityType.GetDbSetName());
if (tableAttributeNeeded)
{
var tableAttribute = new AttributeWriter(nameof(TableAttribute));
tableAttribute.AddParameter(_code.Literal(tableName));
if (schemaParameterNeeded)
{
tableAttribute.AddParameter($"{nameof(TableAttribute.Schema)} = {_code.Literal(schema)}");
}
_sb.AppendLine(tableAttribute.ToString());
}
}
private void GenerateIndexAttributes(IEntityType entityType)
{
// Do not generate IndexAttributes for indexes which
// would be generated anyway by convention.
foreach (var index in entityType.GetIndexes().Where(
i => ConfigurationSource.Convention != ((IConventionIndex)i).GetConfigurationSource()))
{
// If there are annotations that cannot be represented using an IndexAttribute then use fluent API instead.
var annotations = _annotationCodeGenerator
.FilterIgnoredAnnotations(index.GetAnnotations())
.ToDictionary(a => a.Name, a => a);
_annotationCodeGenerator.RemoveAnnotationsHandledByConventions(index, annotations);
if (annotations.Count == 0)
{
var indexAttribute = new AttributeWriter(nameof(IndexAttribute));
foreach (var property in index.Properties)
{
indexAttribute.AddParameter($"nameof({property.Name})");
}
if (index.Name != null)
{
indexAttribute.AddParameter($"{nameof(IndexAttribute.Name)} = {_code.Literal(index.Name)}");
}
if (index.IsUnique)
{
indexAttribute.AddParameter($"{nameof(IndexAttribute.IsUnique)} = {_code.Literal(index.IsUnique)}");
}
_sb.AppendLine(indexAttribute.ToString());
}
}
}
/// <summary>
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
/// any release. You should only use it directly in your code with extreme caution and knowing that
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
protected virtual void GenerateConstructor([NotNull] IEntityType entityType)
{
Check.NotNull(entityType, nameof(entityType));
var collectionNavigations = entityType.GetNavigations().Where(n => n.IsCollection).ToList();
if (collectionNavigations.Count > 0)
{
_sb.AppendLine($"public {entityType.Name}()");
_sb.AppendLine("{");
using (_sb.Indent())
{
foreach (var navigation in collectionNavigations)
{
_sb.AppendLine($"{navigation.Name} = new HashSet<{navigation.TargetEntityType.Name}>();");
}
}
_sb.AppendLine("}");
_sb.AppendLine();
}
}
/// <summary>
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
/// any release. You should only use it directly in your code with extreme caution and knowing that
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
protected virtual void GenerateProperties([NotNull] IEntityType entityType)
{
Check.NotNull(entityType, nameof(entityType));
foreach (var property in entityType.GetProperties().OrderBy(p => p.GetColumnOrdinal()))
{
if (_useDataAnnotations)
{
GeneratePropertyDataAnnotations(property);
}
_sb.AppendLine($"public {_code.Reference(property.ClrType)} {property.Name} {{ get; set; }}");
}
}
/// <summary>
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
/// any release. You should only use it directly in your code with extreme caution and knowing that
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
protected virtual void GeneratePropertyDataAnnotations([NotNull] IProperty property)
{
Check.NotNull(property, nameof(property));
GenerateKeyAttribute(property);
GenerateRequiredAttribute(property);
GenerateColumnAttribute(property);
GenerateMaxLengthAttribute(property);
var annotations = _annotationCodeGenerator
.FilterIgnoredAnnotations(property.GetAnnotations())
.ToDictionary(a => a.Name, a => a);
_annotationCodeGenerator.RemoveAnnotationsHandledByConventions(property, annotations);
foreach (var attribute in _annotationCodeGenerator.GenerateDataAnnotationAttributes(property, annotations))
{
var attributeWriter = new AttributeWriter(attribute.Type.Name);
foreach (var argument in attribute.Arguments)
{
attributeWriter.AddParameter(_code.UnknownLiteral(argument));
}
_sb.AppendLine(attributeWriter.ToString());
}
}
private void GenerateKeyAttribute(IProperty property)
{
var key = property.FindContainingPrimaryKey();
if (key != null)
{
_sb.AppendLine(new AttributeWriter(nameof(KeyAttribute)).ToString());
}
}
private void GenerateColumnAttribute(IProperty property)
{
var columnName = property.GetColumnBaseName();
var columnType = property.GetConfiguredColumnType();
var delimitedColumnName = columnName != null && columnName != property.Name ? _code.Literal(columnName) : null;
var delimitedColumnType = columnType != null ? _code.Literal(columnType) : null;
if ((delimitedColumnName ?? delimitedColumnType) != null)
{
var columnAttribute = new AttributeWriter(nameof(ColumnAttribute));
if (delimitedColumnName != null)
{
columnAttribute.AddParameter(delimitedColumnName);
}
if (delimitedColumnType != null)
{
columnAttribute.AddParameter($"{nameof(ColumnAttribute.TypeName)} = {delimitedColumnType}");
}
_sb.AppendLine(columnAttribute.ToString());
}
}
private void GenerateRequiredAttribute(IProperty property)
{
if (!property.IsNullable
&& property.ClrType.IsNullableType()
&& !property.IsPrimaryKey())
{
_sb.AppendLine(new AttributeWriter(nameof(RequiredAttribute)).ToString());
}
}
private void GenerateMaxLengthAttribute(IProperty property)
{
var maxLength = property.GetMaxLength();
if (maxLength.HasValue)
{
var lengthAttribute = new AttributeWriter(
property.ClrType == typeof(string)
? nameof(StringLengthAttribute)
: nameof(MaxLengthAttribute));
lengthAttribute.AddParameter(_code.Literal(maxLength.Value));
_sb.AppendLine(lengthAttribute.ToString());
}
}
/// <summary>
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
/// any release. You should only use it directly in your code with extreme caution and knowing that
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
protected virtual void GenerateNavigationProperties([NotNull] IEntityType entityType)
{
Check.NotNull(entityType, nameof(entityType));
var sortedNavigations = entityType.GetNavigations()
.OrderBy(n => n.IsOnDependent ? 0 : 1)
.ThenBy(n => n.IsCollection ? 1 : 0)
.ToList();
if (sortedNavigations.Any())
{
_sb.AppendLine();
foreach (var navigation in sortedNavigations)
{
if (_useDataAnnotations)
{
GenerateNavigationDataAnnotations(navigation);
}
var referencedTypeName = navigation.TargetEntityType.Name;
var navigationType = navigation.IsCollection ? $"ICollection<{referencedTypeName}>" : referencedTypeName;
_sb.AppendLine($"public virtual {navigationType} {navigation.Name} {{ get; set; }}");
}
}
}
private void GenerateNavigationDataAnnotations(INavigation navigation)
{
GenerateForeignKeyAttribute(navigation);
GenerateInversePropertyAttribute(navigation);
}
private void GenerateForeignKeyAttribute(INavigation navigation)
{
if (navigation.IsOnDependent)
{
if (navigation.ForeignKey.PrincipalKey.IsPrimaryKey())
{
var foreignKeyAttribute = new AttributeWriter(nameof(ForeignKeyAttribute));
if (navigation.ForeignKey.Properties.Count > 1)
{
foreignKeyAttribute.AddParameter(
_code.Literal(
string.Join(",", navigation.ForeignKey.Properties.Select(p => p.Name))));
}
else
{
foreignKeyAttribute.AddParameter($"nameof({navigation.ForeignKey.Properties.First().Name})");
}
_sb.AppendLine(foreignKeyAttribute.ToString());
}
}
}
private void GenerateInversePropertyAttribute(INavigation navigation)
{
if (navigation.ForeignKey.PrincipalKey.IsPrimaryKey())
{
var inverseNavigation = navigation.Inverse;
if (inverseNavigation != null)
{
var inversePropertyAttribute = new AttributeWriter(nameof(InversePropertyAttribute));
inversePropertyAttribute.AddParameter(
!navigation.DeclaringEntityType.GetPropertiesAndNavigations().Any(
m => m.Name == inverseNavigation.DeclaringEntityType.Name)
? $"nameof({inverseNavigation.DeclaringEntityType.Name}.{inverseNavigation.Name})"
: _code.Literal(inverseNavigation.Name));
_sb.AppendLine(inversePropertyAttribute.ToString());
}
}
}
private sealed class AttributeWriter
{
private readonly string _attributeName;
private readonly List<string> _parameters = new List<string>();
public AttributeWriter([NotNull] string attributeName)
{
Check.NotEmpty(attributeName, nameof(attributeName));
_attributeName = attributeName;
}
public void AddParameter([NotNull] string parameter)
{
Check.NotEmpty(parameter, nameof(parameter));
_parameters.Add(parameter);
}
public override string ToString()
=> "["
+ (_parameters.Count == 0
? StripAttribute(_attributeName)
: StripAttribute(_attributeName) + "(" + string.Join(", ", _parameters) + ")")
+ "]";
private static string StripAttribute([NotNull] string attributeName)
=> attributeName.EndsWith("Attribute", StringComparison.Ordinal)
? attributeName[..^9]
: attributeName;
}
}
}