1.3 模板基础配置

About 1693 wordsAbout 6 min

2025-01-24

1.3 模板基础配置

Beetl提供不但功能齐全，而且还有很多独特功能，通过简单的配置文件，就可以定义众多的功能，默认情况下，Configuration类总是会先加载默认的配置文件（位于/org/beetl/core/beetl-default.properties，作为新手，通常只需要关注3,4,5,6行定界符的配置，以及12行模板字符集的配置就可以了，其他配置会在后面章节陆续提到,同时，对于Spring等框架，有些配置将会被这些框架的配置覆盖，需要参考后面章节）下，beetl-default.properties其内容片断如下：

#默认配置
ENGINE=org.beetl.core.engine.FastRutimeEngine
DELIMITER_PLACEHOLDER_START=${
DELIMITER_PLACEHOLDER_END=}
DELIMITER_STATEMENT_START=<%
DELIMITER_STATEMENT_END=%>
DIRECT_BYTE_OUTPUT = FALSE
HTML_TAG_SUPPORT = true
HTML_TAG_FLAG = #
HTML_TAG_BINDING_ATTRIBUTE = var
#3.17版本以后，默认不再支持Java直接调用
NATIVE_CALL = FALSE 
TEMPLATE_CHARSET = UTF-8
ERROR_HANDLER = org.beetl.core.ConsoleErrorHandler
#3.17版本以后，使用白名单管理Java直接调用
NATIVE_SECUARTY_MANAGER= org.beetl.core.WhiteListNativeSecurityManager 
MVC_STRICT = FALSE

#资源配置，resource后的属性只限于特定ResourceLoader
RESOURCE_LOADER=org.beetl.core.resource.ClasspathResourceLoader
#classpath 根路径
RESOURCE.root= /
#是否检测文件变化,开发用true合适，但线上要改为false
RESOURCE.autoCheck= true
#自定义脚本方法文件的Root目录和后缀
RESOURCE.functionRoot = functions
RESOURCE.functionSuffix = html
#自定义标签文件Root目录和后缀
RESOURCE.tagRoot = htmltag
RESOURCE.tagSuffix = tag
#####  扩展 ##############
## 内置的方法
FN.date = org.beetl.ext.fn.DateFunction
......
##内置的功能包
FNP.strutil = org.beetl.ext.fn.StringUtil
......
##内置的默认格式化函数
FTC.java.util.Date = org.beetl.ext.format.DateFormat
.....
## 标签类
TAG.include= org.beetl.ext.tag.IncludeTag
TAG.html.include= org.beetl.ext.tag.html.IncludeResourceHtmlTag
TAG.html.foreach= org.beetl.ext.tag.html.ForeachHtmlTag

如上配置是系统默认配置

这配置文件整体说明了Beetl提供的功能

第2行配置引擎实现类，默认即可.

第3,4行指定了占位符号，默认是${ }，也可以指定为其他占位符。

第5,6行指定了语句的定界符号，默认是<% %>，也可以指定为其他定界符号

第7行指定IO输出模式，默认是FALSE,即通常的字符输出，在考虑高性能情况下，可以设置成true。详细请参考高级用法

第8,9行指定了支持HTML标签，且符号为#,默认配置下，模板引擎识别<#tag ></#tag>这样的类似html标签，并能调用相应的标签函数或者模板文件。你也可以指定别的符号，如bg: 则识别<bg:

第10行指定如果标签属性有var，则认为是需要绑定变量给模板的标签函数

第11行指定允许本地Class直接调用，默认不允许。在3.17之前默认允许，具体查看https://www.oschina.net/news/306548/beetlsql-3-17-released

第12行指定模板字符集是UTF-8

第13行指定异常的处理类，默认是ConsoleErrorHandler，他将在render发生异常的时候在后台打印出错误信息（System.out)。另外一种更常见的配置是使用ReThrowConsoleErrorHandler，他将在render发生异常的时候在后台打印出错误信息并抛出异常

第14行指定了本地Class调用的安全策略，采用的是白名单管理方式，允许调用java.util下的所有类和方法。在3.·17版本之前

第15行配置了是否进行严格MVC，通常情况下，此处设置为false.

第18行指定了默认使用的模板资源加载器，注意，在beetl与其他MVC框架集成的时候，模板加载器不一定根据这个配置，比如spring，他的RESOURCE_LOADER以spring的配置为准

第20到22行配置了模板资源加载器的一些属性，如设置根路径为/,即Classpath的顶级路径，并且总是检测模板是否更改

第23行配置了自定义的方法所在的目录以及文件名后缀。beetl既支持通过java类定义方法，也支持通过模板文件来定义方法

第26行配置了自定义的html标签所在的目录以及文件名后缀。beetl既支持通过java类定义标签，也支持通过模板文件来定义标签

第31行注册了一个date方法，其实现类是org.beetl.ext.fn.DateFunction

第34行注册了一个方法包strutil，其实现类org.beetl.ext.fn.StringUtil，此类的每个public方法都将注册为beetl的方法

第37行注册了一个日期格式化函数

第40行注册了一个include标签函数

模板开发者不需要关心如上配置，可以创建一个beetl.properties的配置文件，此时，该配置文件将覆盖默认的配置文件属性，比如，你的定界符考虑是 ,则在beetl.properties加入一行即可,并将此配置文件放入Classpath根目录下即可。 Configuration.defaultConfiguration()总是先加载系统默认的，然后再加载Beetl.properties的配置属性，如果有重复，用后者代替前者的配置

 #自定义配置
DELIMITER_STATEMENT_START=<!--:
DELIMITER_STATEMENT_END=-->
DELIMITER_PLACEHOLDER_START=#{
DELIMITER_PLACEHOLDER_END=}

3.0 以后版本支持第二对占位符，定界符

DELIMITER_STATEMENT_START2=@
DELIMITER_STATEMENT_END2=
DELIMITER_PLACEHOLDER_START2=${
DELIMITER_PLACEHOLDER_END2=}

3.5 以后，可以增加一个自定义类来根据模板名称来返回定界符，如.java结尾的模板，和.html的模板，可以使用不同的占位符

DELIMETER_CONFIG=xxx.yourDelimeterConfig

参考单元测试源码org.beetl.core.engine.MyEngineTest.testDelimeter,使用自定义MyDelimeterConfig

3.6以后，增加了对模板缓存的设置

CACHE=org.beetl.core.impl.cache.DefaultBeetlCache

3.13以后，增加了对输出流复用buffer以提高性能，默认不开启

CACHE_OUTPUT_BUFFER=0

如果配置成一个非0的数字，则在String str = template.render() 方法输出string时候，使用内部的长度为此的一个buffer缓存。能显著提高性能。

3.15 后，如果计算需要精度计算，用于脚本引擎，可以设置为true，这样，每个数字，都将是BigDecimal类型

## 如果为true，所有数字表示为BigDecimal，精度计算
BIGDECIMAL=false

3.17后，考虑到国内对安全漏洞的审查严格，如果模板能被用户编辑和执行，那么允许模板Java调用可能产生安全漏洞，因此默认禁止安全调用，即使打开后，安全管理器也使用白名单方式。如果要恢复到3.17之前配置，可以改成如下

NATIVE_CALL = true
NATIVE_SECUARTY_MANAGER= org.beetl.core.DefaultNativeSecurityManager

其他可选有

org.beetl.core.impl.cache.LRUBeetlCache, 可以设置一个最大容量，经常访问的模板保留，超过最大容量，不经常访问的模板自动删除，默认保留256个，如果需要配置个数，可以设置CACHE.SIZE=1024或者更大
org.beetl.core.impl.cache.CaffeineCache ,使用Caffeine库，默认保留256个，且超过30分钟没有再访问的的模板，自动删除
如果需要设置个数，可以设置CACHE.SIZE=1024或者更大，如果需要设置时间，可以设置CACHE.DURATION=10 ，表示10分钟过期
```
<dependency>
  <groupId>com.github.ben-manes.caffeine</groupId>
  <artifactId>caffeine</artifactId>
  <version>2.9.2</version>
 </dependency>
```