C#基于自定义特性的属性格式化扩展方法实现咨询

场景描述 #

我有一个包含int、ulong、string等多种类型属性的Users类，属性仅含默认get和set方法。希望这些属性能返回自定义格式的字符串，计划通过为每个属性添加带格式的自定义特性retFormat实现，示例代码如下：

class Users {
    [retFormat("You traveled {0:#,0}km")]
    public int Traveled { get; set; }
    [retFormat("This name is #")]
    public string Name { get; set; }
}

随后想为对应数据类型添加扩展方法，读取该特性并格式化，示例代码如下：

public static string ToUseFormat(this int self) {
    return string.Format("{0:#,0}", self);
    // 需要读取属性的retFormat特性并使用其格式
}

疑问1：这种实现方式是否最优？我不希望将格式控制权交给类的使用者，要求每个属性既能返回原值，也能返回多种格式化值（如长文本、短文本格式） #

这种基于特性的思路可行但需要调整，核心问题是单个retFormat特性无法支持多格式场景。优化方案如下：

• 修改特性定义，允许同一属性添加多个格式化规则，给特性增加FormatType标识区分格式类型：

  [AttributeUsage(AttributeTargets.Property, AllowMultiple = true)]
  public class retFormatAttribute : Attribute
  {
      public string FormatType { get; }
      public string Format { get; }
  
      public retFormatAttribute(string formatType, string format)
      {
          FormatType = formatType;
          Format = format;
      }
  }
  

  标注属性时可同时指定多套格式：

  [retFormat("Long", "You traveled {0:#,0} kilometers")]
  [retFormat("Short", "{0}km")]
  public int Traveled { get; set; }
  

• 对比其他思路：如果直接在Users类中编写GetTraveledLongFormat()这类方法，虽然直观但会让类变得臃肿，后续新增格式需要修改类，违反开闭原则。特性方式更灵活，格式规则与属性解耦，更适配多格式需求。

疑问2：如何在扩展方法中读取对应属性的自定义特性？ #

这里有个关键痛点：扩展方法的参数是值本身（如int self），它无法知晓自己属于哪个类的哪个属性，所以直接通过值类型实例拿不到特性。解决办法是在调用时传入属性的元数据，推荐用表达式树实现：

1. 先定义正确的特性类：

public class retFormatAttribute : Attribute
{
    public string Format { get; }
    public retFormatAttribute(string format)
    {
        Format = format;
    }
}

2. 编写泛型扩展方法，通过表达式树解析属性信息：

public static string ToUseFormat<T>(this T value, Expression<Func<T>> propertyExpression)
{
    var memberExpr = propertyExpression.Body as MemberExpression;
    if (memberExpr == null)
        throw new ArgumentException("必须传入属性表达式，例如() => user.Traveled");

    var formatAttr = memberExpr.Member.GetCustomAttribute<retFormatAttribute>();
    if (formatAttr == null)
        return value?.ToString() ?? string.Empty;

    // 处理字符串格式中的#占位符，替换为{0}
    var formatString = formatAttr.Format.Replace("#", "{0}");
    return string.Format(formatString, value);
}

3. 调用方式：

var user = new Users { Traveled = 1234, Name = "Alice" };
var formattedTraveled = user.Traveled.ToUseFormat(() => user.Traveled);
var formattedName = user.Name.ToUseFormat(() => user.Name);

疑问3：能否为多种类型创建通用扩展方法，而非为int、ulong、string等每种类型单独创建？ #

完全可以，通过泛型实现通用扩展方法，上面的示例已经是泛型版本，支持所有类型。只需在方法中处理不同类型的格式化逻辑：

• 对于数值类型（int、ulong等），直接用string.Format处理占位符；
• 对于string类型，替换自定义的#占位符；
• 如果需要更复杂的类型适配，可以通过typeof(T)判断类型，添加分支逻辑。

如果要支持多格式场景，只需扩展泛型方法，增加formatType参数读取对应类型的特性：

public static string ToUseFormat<T>(this T value, Expression<Func<T>> propertyExpression, string formatType)
{
    var memberExpr = propertyExpression.Body as MemberExpression;
    if (memberExpr == null)
        throw new ArgumentException("必须传入属性表达式");

    var formatAttr = memberExpr.Member.GetCustomAttributes<retFormatAttribute>()
        .FirstOrDefault(a => a.FormatType.Equals(formatType, StringComparison.OrdinalIgnoreCase));
    
    if (formatAttr == null)
        return value?.ToString() ?? string.Empty;

    var formatString = formatAttr.Format.Replace("#", "{0}");
    return string.Format(formatString, value);
}

调用时指定格式类型：

var longFormat = user.Traveled.ToUseFormat(() => user.Traveled, "Long");
var shortFormat = user.Traveled.ToUseFormat(() => user.Traveled, "Short");

内容的提问来源于stack exchange，提问作者totalZero