当前位置：日志文章 > 详细内容

C#如何根据Model字段名称自动匹配并替换值

2025年04月02日 • Asp.net •

前言在日常开发中，我们经常遇到需要根据数据模型动态生成文本内容的需求，比如邮件模板、报告生成、消息通知等场景。传统的方式是为每个字段硬编码替换逻辑，但当模板或模型变更时，维护成本很高。本文将介绍如何使

前言

在日常开发中，我们经常遇到需要根据数据模型动态生成文本内容的需求，比如邮件模板、报告生成、消息通知等场景。传统的方式是为每个字段硬编码替换逻辑，但当模板或模型变更时，维护成本很高。本文将介绍如何使用 c# 反射机制实现一个灵活的模板引擎，能够根据 model 字段名称自动匹配并替换模板中的占位符。

一、需求场景分析

假设我们有一个用户信息模型 usermodel：

public class usermodel
{
    public string name { get; set; }
    public int age { get; set; }
    public string email { get; set; }
    public datetime registerdate { get; set; }
}

需要生成如下欢迎邮件：

尊敬的{name}，您好！
您的年龄是{age}岁，邮箱是{email}。
您于{registerdate}注册成为我们的会员。

传统硬编码方式需要手动替换每个字段，而我们要实现的是：只需定义模板和模型，引擎自动完成所有字段的匹配和替换。

二、核心技术：反射（reflection）

c#的反射机制允许我们在运行时：

获取类型信息
动态访问对象属性
调用方法等

关键api：

type.getproperty() - 获取指定名称的属性
propertyinfo.getvalue() - 获取属性值

三、基础实现方案

3.1 核心代码实现

public static string replacetemplateplaceholders(string template, object model)
{
    if (model == null) return template;

    var regex = new regex(@"\{(\w+)\}");
    var matches = regex.matches(template);

    foreach (match match in matches)
    {
        string propertyname = match.groups[1].value;
        propertyinfo property = model.gettype().getproperty(propertyname);
        if (property != null)
        {
            object value = property.getvalue(model);
            template = template.replace(match.value, value?.tostring() ?? "");
        }
    }

    return template;
}

3.2 使用示例

var user = new usermodel
{
    name = "张三",
    age = 30,
    email = "zhangsan@example.com",
    registerdate = datetime.now.adddays(-10)
};

string template = @"尊敬的{name}，您好！
您的年龄是{age}岁，邮箱是{email}。
您于{registerdate}注册成为我们的会员。";

string result = replacetemplateplaceholders(template, user);
console.writeline(result);

3.3 输出结果

尊敬的张三，您好！
您的年龄是30岁，邮箱是zhangsan@example.com。
您于2023/5/20 14:30:00注册成为我们的会员。

四、高级功能扩展

4.1 处理特殊字符和json模板

当模板中包含双引号或 json 格式时：

string template = """
{
    "user": {
        "name": "{name}",
        "age": {age},
        "email": "{email}",
        "note": "这是\"用户数据\""
    }
}
""";

改进正则表达式避免匹配转义字符：

var regex = new regex(@"(?<!\{)\{([a-za-z_][a-za-z0-9_]*)\}(?!\})");

4.2 添加格式控制

支持类似 {registerdate:yyyy-mm-dd} 的格式：

var regex = new regex(@"\{(\w+)(?::([^}]+))?\}");
// ...
if (property != null)
{
    object value = property.getvalue(model);
    string format = match.groups[2].success ? match.groups[2].value : null;
    string stringvalue = format != null && value is iformattable formattable 
        ? formattable.tostring(format, null) 
        : value?.tostring() ?? "";
    // ...
}

4.3 性能优化建议

缓存 propertyinfo：使用 concurrentdictionary 缓存已查找的属性

预编译正则表达式：添加 regexoptions.compiled 选项

使用 stringbuilder ：对于大模板提高替换效率

五、完整解决方案代码

using system;
using system.collections.concurrent;
using system.reflection;
using system.text;
using system.text.regularexpressions;

public class templateengine
{
    private static readonly concurrentdictionary<type, propertyinfo[]> _propertycache = new();
    private static readonly regex _placeholderregex = new(@"(?<!\{)\{([a-za-z_][a-za-z0-9_]*)(?::([^}]+))?\}(?!\})", regexoptions.compiled);

    public static string render(string template, object model)
    {
        if (model == null) return template;
        
        var type = model.gettype();
        if (!_propertycache.trygetvalue(type, out var properties))
        {
            properties = type.getproperties();
            _propertycache.tryadd(type, properties);
        }

        var propertylookup = properties.todictionary(p => p.name, stringcomparer.ordinalignorecase);
        
        return _placeholderregex.replace(template, match =>
        {
            string propname = match.groups[1].value;
            string format = match.groups[2].value;

            if (!propertylookup.trygetvalue(propname, out var property))
                return match.value;

            object value = property.getvalue(model);
            if (value == null) return string.empty;

            return !string.isnullorempty(format) && value is iformattable formattable 
                ? formattable.tostring(format, null) 
                : value.tostring();
        });
    }
}