DotLiquid模板引擎简介

2019-10-08 13:50 来源:未知

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版本,小编正在召集P奥迪Q5,假诺您有意向能够到DotLiquid的github看看。

TAG标签:
版权声明:本文由银河国际点击登录发布于www.3868.com,转载请注明出处:DotLiquid模板引擎简介