org.cauli.server.handler

接口 TemplateEngine

所有已知实现类:

StaticFile

public interface TemplateEngine

Abstract interface for template engines. It can be passed as an argument to the constructors of StaticFileHandler and EmbeddedResourceHandler.

Webbit itself doesn't provide any template engines. Look at Webbit-REST for implementations.

字段概要

字段

限定符和类型	字段和说明
static String	TEMPLATE_CONTEXT

方法概要

方法

限定符和类型	方法和说明
byte[]	process(byte[] template, String templatePath, Object templateContext) Renders a template.

字段详细资料

TEMPLATE_CONTEXT

static final String TEMPLATE_CONTEXT

另请参阅:

常量字段值

方法详细资料

process

byte[] process(byte[] template,
             String templatePath,
             Object templateContext)
               throws RuntimeException

Renders a template.

Most template engines merge a templateContext with a template to produce output. What constitutes a valid context is template-engine specific.

Rendering happens on your main thread, so it is important that this method is not IO-bound. For example, rendering a template using a context that is some sort of active record that makes trips to the database will block Webbit preventing it from handling other requests. It's important to make sure any remote data is pre-fetched.

Webbit will pass the request data value keyed with TEMPLATE_CONTEXT as the templateContext argument. It's the programmer's responsibility to make sure the data value is set before the template is rendered, i.e. before the StaticFileHandler or EmbeddedResourceHandler handler instance handles a request.

参数:

length - number of bytes in the template

template - the template source

templatePath - the path the template is read from. Allows implementations to cache compiled templates.

templateContext - object to merge into the template

返回:

a rendered template

抛出:

RuntimeException

另请参阅:

DataHolder.data(String), HttpRequest.data(String, Object)