DynamicMaxLengthAttribute 黑科技内核原理

下面来逐行、深入讲解 DynamicMaxLengthAttribute 的真实工作机制，非常值得理解。

---

✅ 整体作用（一句话）

ABP 用 反射修改 MaxLengthAttribute 的私有字段 <Length>k__BackingField，从而动态设置最大长度。

---

✅ 代码逐行深度解析

public class DynamicMaxLengthAttribute : MaxLengthAttribute

继承自 MaxLengthAttribute —— .NET 自带的 DataAnnotation，用于做最大长度验证。

---

⭐ 静态字段部分

private static readonly FieldInfo? MaximumLengthField;

static DynamicMaxLengthAttribute()
{
    MaximumLengthField = typeof(MaxLengthAttribute)
        .GetField("<Length>k__BackingField", BindingFlags.Instance | BindingFlags.NonPublic);
}

📌 这是核心关键：反射拿到 MaxLengthAttribute 的私有字段

MaxLengthAttribute 的核心属性是：

public int Length { get; }

但它没有 public setter，长度是写死的，你无法运行时改变。

它内部其实有一个 backing field：

<Length>k__BackingField

但这是 私有字段、内部生成的字段。

ABP 在静态构造里做了：

• 用反射找这个字段
• 保存 FieldInfo，后面用于 SetValue 修改它

➡ 这是“动态设置 MaxLengthAttribute 长度”的核心黑科技。

---

⭐ 构造函数部分

public DynamicMaxLengthAttribute(Type sourceType, string? maximumLengthPropertyName)
{
    Check.NotNull(sourceType, "sourceType");

    if (maximumLengthPropertyName != null)
    {
        PropertyInfo property = sourceType.GetProperty(
            maximumLengthPropertyName,
            BindingFlags.Static | BindingFlags.Public
        );
        
        MaximumLengthField?.SetValue(this, (int)property?.GetValue(null));
    }
}

① sourceType 就是 Consts 类

例如：

typeof(PaymentRequestConsts)

② maximumLengthPropertyName 就是静态属性名

例如：

nameof(PaymentRequestConsts.MaxCustomerIdLength)

③ 动态读取属性值

PropertyInfo property = sourceType.GetProperty(...);
property.GetValue(null); // static 属性

例如得到：

128

④ 修改 MaxLengthAttribute 的内部字段

MaximumLengthField?.SetValue(this, (int)property?.GetValue(null));

相当于：

this.Length = 128;   // 但实际上是反射改的 backing field

✨ 这里就是完成动态最大长度修改的地方。

---

🔥 为什么 这么搞？（普通人想到 StringLength 就够了啊）

因为：

需求	靠 StringLength 无法满足
保证 Entity → DB → DTO → Validation 最大长度完全一致	❌ 不行
想统一修改长度，只改 Consts 就能全系统生效	❌ 不行
让同一个长度值在迁移、实体、DTO 都用同一份常量	❌ 不行
动态读取配置或模块常量	❌ 不行

所以 ABP 才用反射 hack 私有字段，解决以下问题：
✔ 一处定义、多处自动生效
✔ 避免写死魔法数字
✔ 避免 DTO 与实体长度不一致导致异常
✔ 在全系统保持统一的长度规范

---

🧠 图示：DynamicMaxLength 工作流程

PaymentRequestConsts.MaxCustomerIdLength → DynamicMaxLengthAttribute → MaxLengthAttribute.<Length>k__BackingField

效果：

👉 DTO 会自动使用这个长度
👉 ModelState 检查自动使用这个长度
👉 Entity 也用这个长度
👉 EF Core Migration 也同步用这个长度

全链路一致。

---

🟦 最终总结（能记住这几点即可）

1. DynamicMaxLength 是 MaxLengthAttribute 的增强版
2. 它通过反射修改 MaxLength.PrivateField 来动态设置长度
3. 长度来自于你指定的静态常量类
4. 是为保持系统中所有层的一致性而设计的

⭐ 贴出的代码就是 ABP Dynamic 系列属性的核心原理。

---