当前位置:澳门新葡亰网站所有平台 > www.7415.com > DotLiquid模板引擎简介

DotLiquid模板引擎简介

文章作者:www.7415.com 上传时间:2019-09-15

DotLiquid是二个在.Net Framework上运维的模版引擎,选拔Ruby的Liquid语法,这么些语法遍布的用在Ruby on rails和Django等网页框架中。
DotLiquid相比较于Mvc私下认可模板引擎Razor的好处有:

  • 因为无需编写翻译到程序集再载入
    • 第三遍渲染速度飞快
    • 不会导致内部存款和储蓄器泄漏
  • 能够在其他地点使用
    • 无需先准备WebViewPage,ViewContext等繁杂的上下文对象

DotLiquid的官方网址是,开源协商是特别宽松的MS-PL。

以身作则代码

自个儿创立一个应用了DotLiquid的示例Mvc项目,完整代码能够查看这里。
以下的示范将以Mvc中的Action为单位,都存放在HomeController下。

最基础的选取

Template.Parse能够把字符串分析为模板对象,再使用Render把模版对象渲染为字符串。
开荒页面能够望见Hello, World!

public ActionResult HelloWorld()
{
    var template = Template.Parse("Hello, {{ name }}!");
    var result = template.Render(Hash.FromAnonymousObject(new { name = "World" }));
    return Content(result);
}

使用过滤器

|末端的便是过滤器,过滤器能够连锁起来使用。
escape过滤器用于做html编码,制止name中的"<"当成是html标签描画。
upcase过滤器把字符串中的字母全体转换为大写。
开采页面能够看见Hello, <WORLD>!

public ActionResult HelloFilter()
{
    var template = Template.Parse("Hello, {{ name | escape | upcase }}!");
    var result = template.Render(Hash.FromAnonymousObject(new { name = "<World>" }));
    return Content(result);
}

概念过滤器

DotLiquid扶助自定义过滤器,首先必要三个过滤器类型,当中的函数名称就是过滤器名称。
过滤器援助多个参数和暗许参数。

public class DotliquidCustomFilter
{
    public static string Substr(string value, int startIndex, int length = -1)
    {
        if (length >= 0)
            return value.Substring(startIndex, length);
        return value.Substring(startIndex);
    }
}

在网址运行的时候把那些过滤器注册到DotLiquid

public class MvcApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        // 在原有的代码下添加
        Template.RegisterFilter(typeof(DotliquidCustomFilter));
    }
}

以那件事例会来得Hello, orl!

public ActionResult CustomFilter()
{
    var template = Template.Parse("Hello, {{ name | substr: 1, 3 }}!");
    var result = template.Render(Hash.FromAnonymousObject(new { name = "World" }));
    return Content(result);
}

选拔标签

DotLiquid中有三种标签,一种是平凡标签(Block),一种是自闭合标签(Tag)。
此地的assign是自闭合标签,if是普通标签,普通标签需求用end+标具名闭合。
展现内容是Hello, World!

public ActionResult HelloTag()
{
    var template = Template.Parse(@"
        {% assign name = 'World' %}
        {% if visible %}
        Hello, {{ name }}!
        {% endif %}
    ");
    var result = template.Render(Hash.FromAnonymousObject(new { visible = true }));
    return Content(result);
}

自定义标签

此处本人将概念三个自闭合标签conditional,那些标签有几个参数,假设第七个参数创造则描画第三个不然描画第四个参数。

public class ConditionalTag : Tag
{
    public string ConditionExpression { get; set; }
    public string TrueExpression { get; set; }
    public string FalseExpression { get; set; }

    public override void Initialize(string tagName, string markup, List<string> tokens)
    {
        base.Initialize(tagName, markup, tokens);
        var expressions = markup.Trim().Split(' ');
        ConditionExpression = expressions[0];
        TrueExpression = expressions[1];
        FalseExpression = expressions.Length >= 3 ? expressions[2] : "";
    }

    public override void Render(Context context, TextWriter result)
    {
        var condition = context[ConditionExpression];
        if (!(condition == null || condition.Equals(false) || condition.Equals("")))
            result.Write(context[TrueExpression]);
        else
            result.Write(context[FalseExpression]);
    }
}

在网址运维时把那么些标签注册到DotLiquid

public class MvcApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        // 在原有的代码下添加
        Template.RegisterTag<ConditionalTag>("conditional");
    }
}

那么些事例会显得Bar

public ActionResult CustomTag()
{
    var template = Template.Parse("{% conditional cond foo bar %}");
    var result = template.Render(Hash.FromAnonymousObject(new { cond = false, foo = "Foo", bar = "Bar" }));
    return Content(result);
}

模板文件

DotLiquid也扶助从文件读取模板,须求先定义三个TemplateFileSystem

public class DotliquidTemplateFileSystem : IFileSystem
{
    public string ReadTemplateFile(Context context, string templateName)
    {
        var path = context[templateName] as string;
        if (string.IsNullOrEmpty(path))
            return path;
        var fullPath = HttpContext.Current.Server.MapPath(path);
        return File.ReadAllText(fullPath);
    }
}

设置DotLiquid使用自定义的文件系统

public class MvcApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        // 在原有的代码下添加
        Template.FileSystem = new DotliquidTemplateFileSystem();
    }
}

再定义三个调节器基类

public abstract class DotliquidController : Controller
{
    public ContentResult DotliquidView(string path = null, object parameters = null)
    {
        // 路径为空时根据当前的Action决定
        if (string.IsNullOrEmpty(path))
        {
            var controller = RouteData.Values["controller"];
            var action = RouteData.Values["action"];
            path = $"~/DotliquidViews/{controller}/{action}.html";
        }
        // 根据路径读取模板内容
        var templateStr = Template.FileSystem.ReadTemplateFile(new Context(), "'" + path + "'");
        // 解析模板,这里可以缓存Parse出来的对象,但是为了简单这里就略去了
        var template = Template.Parse(templateStr);
        // 描画模板
        Hash templateParameters;
        if (parameters is IDictionary<string, object>)
            templateParameters = Hash.FromDictionary((IDictionary<string, object>)parameters);
        else
            templateParameters = Hash.FromAnonymousObject(parameters ?? new { });
        var result = template.Render(templateParameters);
        // 返回描画出来的内容
        return Content(result, "text/html");
    }
}

今后能够在调节器中使用基于DotLiquid的模版了

public ActionResult HelloTemplateFile()
{
    return DotliquidView();
}

上边会回到文件~/DotliquidViews/Home/HelloTemplateFile.html的内容

Hello, Template!

嵌入子模板

为了落到实处代码的选定,DotLiquid的模版还是能够放置别的子模板,嵌入需求利用include标签。
以下例子会议及展览示Hello, Include!

public ActionResult HelloInclude()
{
    return DotliquidView();
}

文件~/DotliquidViews/Home/HelloInclude.html的内容

Hello, {% include "~/DotliquidViews/Home/HelloIncludeContents.html" %}!

文件~/DotliquidViews/Home/HelloIncludeContents.html的内容

Include

持续父模板

除去嵌入子模版,仍是可以够促成布局(Layout)格局的存在延续父模板,承接必要使用extends和block标签。
以下例子会回到Html<div class="layout"><h1>Here is title</h1><p>Here is body</p></div>

public ActionResult HelloExtends()
{
    return DotliquidView();
}

文件~/DotliquidViews/Home/HelloExtendsLayout.html的内容

<div class="layout">
    <h1>
        {% block title %}
        Default title
        {% endblock %}
    </h1>
    <p>
        {% block body %}
        Default body
        {% endblock %}
    </p>
</div>

文件~/DotliquidViews/Home/HelloExtends.html的内容

{% extends "~/DotliquidViews/Home/HelloExtendLayout.html" %}

{% block title %}
Here is title
{% endblock %}

{% block body %}
Here is body
{% endblock %}

描绘自定义对象

请先看之下的事例

public class ExampleViewModel
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public ActionResult CustomObject()
{
    var template = Template.Parse("Name: {{ model.Name }}, Age: {{ model.Age }}");
    var model = new ExampleViewModel() { Name = "john", Age = 35 };
    var result = template.Render(Hash.FromAnonymousObject(new { model }));
    return Content(result);
}

您可能预料那几个事例会来得Name: john, Age: 35,但实际上运营时会给出以下错误

Name: Liquid syntax error: Object 'Dotliquid.Example.Dotliquid.ExampleViewModel' is invalid because it is neither a built-in type nor implements ILiquidizable, Age: Liquid syntax error: Object 'Dotliquid.Example.Dotliquid.ExampleViewModel' is invalid because it is neither a built-in type nor implements ILiquidizable

那是因为DotLiquid为了安全性,默许不允许描画未经登记的目的,那样就算模板由前端使用者提供也不会促成新闻走漏。
为了缓和地点的不当,必要把ExampleViewModel注册为可描画的靶子。
除此而外行使RegisterSafeType挂号,你也能够让ExampleViewModel继承ILiquidizable,在有的气象下会更切合。

public class MvcApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        // 在原有的代码下添加
        Template.RegisterSafeType(typeof(ExampleViewModel), Hash.FromAnonymousObject);
    }
}

写在结尾

DotLiquid是叁个见风使舵异常高而且依赖很少的模版引擎,纵然并未有Razor流行,但大气的单元测验保险它能够经得起实际的行使。
日前利用了DotLiquid的门类有

  • Pretzel静态网址生成工具
  • 南希网页框架
  • ZKWeb网页框架

当前DotLiquid希图进级2.0本子,小编正在召集PLAND,若是你故意向能够到DotLiquid的github看看。

本文由澳门新葡亰网站所有平台发布于www.7415.com,转载请注明出处:DotLiquid模板引擎简介

关键词: