NVelocity ASP.NET 示例

Question

我希望在 ASP.NET MVC 应用程序中使用 NVelocity，而不是作为视图引擎，仅用于呈现一些电子邮件模板。

然而，我一生都无法让它发挥作用。我已经从 castle 项目下载了它，并按照 http://www 中的示例进行操作.castleproject.org/others/nvelocity/usingit.html#step1

无论我尝试什么，我似乎都无法加载位于我的网站中的模板。该示例建议使用绝对路径，我已尝试过但无济于事：

Template t = engine.GetTemplate("/Templates/TestEmail.vm");

所以请有人给我两个例子。一是加载位于网站目录中的模板，二是解析字符串变量（因为我的模板可能会存储在数据库中）。

非常感谢 本

Answer 1

我在过去的一个项目中使用过这个类：

public interface ITemplateRepository
{
    string RenderTemplate(string templateName, IDictionary<string, object> data);
    string RenderTemplate(string masterPage, string templateName, IDictionary<string, object> data);
}

public class NVelocityTemplateRepository : ITemplateRepository
{
    private readonly string _templatesPath;

    public NVelocityTemplateRepository(string templatesPath)
    {
        _templatesPath = templatesPath;
    }

    public string RenderTemplate(string templateName, IDictionary<string, object> data)
    {
        return RenderTemplate(null, templateName, data);
    }

    public string RenderTemplate(string masterPage, string templateName, IDictionary<string, object> data)
    {
        if (string.IsNullOrEmpty(templateName))
        {
            throw new ArgumentException("The \"templateName\" parameter must be specified", "templateName");
        }

        var name = !string.IsNullOrEmpty(masterPage)
            ? masterPage : templateName;

        var engine = new VelocityEngine();
        var props = new ExtendedProperties();
        props.AddProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, _templatesPath);
        engine.Init(props);
        var template = engine.GetTemplate(name);
        template.Encoding = Encoding.UTF8.BodyName;
        var context = new VelocityContext();

        var templateData = data ?? new Dictionary<string, object>();
        foreach (var key in templateData.Keys)
        {
            context.Put(key, templateData[key]);
        }

        if (!string.IsNullOrEmpty(masterPage))
        {
            context.Put("childContent", templateName);
        }

        using (var writer = new StringWriter())
        {
            engine.MergeTemplate(name, context, writer);
            return writer.GetStringBuilder().ToString();
        }
    }
}

为了实例化 NVelocityTemplateRepository 类，您需要提供模板根目录所在的绝对路径。然后使用相对路径来引用 vm 文件。

Answer 2

我还添加了以下方法来处理字符串而不是模板文件（例如，如果从数据库检索模板内容）：

        public string RenderTemplateContent(string templateContent, IDictionary<string, object> data)
    {
        if (string.IsNullOrEmpty(templateContent))
            throw new ArgumentException("Template content cannot be null", "templateContent");

        var engine = new VelocityEngine();
        engine.Init();

        var context = GetContext(data);

        using (var writer = new StringWriter()) {
            engine.Evaluate(context, writer, "", templateContent);
            return writer.GetStringBuilder().ToString();
        }
    }

并使用 StructureMap 来初始化服务：

            ForRequestedType<ITemplateService>()
            .TheDefault.Is.ConstructedBy(()=> 
                new NVelocityTemplateService(HttpContext.Current.Server.MapPath("~/Content/Templates/")));

Answer 3

您可能会发现 TemplateEngine 组件很有用。

它是对带有 NVelocity 实现的模板引擎的抽象，类似于 Darin 的回答，但它的性能应该会稍微好一些，因为它使用 VelocityEngine 的单个实例（而不是每次渲染初始化一个实例）并且具有可选的缓存。它还具有其他一些功能，例如日志记录、NVelocity 属性覆盖和从程序集资源加载模板。