5.1. 内置方法

5.1.1. 常用内置方法
  • date 返回一个java.util.Date类型的变量，如 date() 返回一个当前时间(对应java的java.util.Date); ${date( "2011-1-1" , "yyyy-MM-dd" )} 返回指定日期
  • print 打印一个对象 print(user.name);
  • println 打印一个对象以及回车换行符号，回车换号符号使用的是模板本身的，而不是本地系统的.如果仅仅打印一个换行符，则直接调用println() 即可
  • printFile 直接答应文件，文件路径以模板根目录为相对目录，printFile(‘‘/common/header.html’’);
  • nvl 函数nvl，如果对象为null，则返回第二个参数，否则，返回自己 nvl(user,"不存在")
  • isEmpty 判断变量或者表达式是否为空，变量不存在，变量为null，变量是空字符串，变量是空集合，变量是空数组，此函数都将返回true
  • isNotEmpty 同上，判断对象是否不为空
  • has 变量名为参数，判断是否存在此全局变量，如 has(userList),类似于1.x版本的exist("userList"),但不需要输入引号了
  • assert 如果表达式为false，则抛出异常
  • trim 截取数字或者日期，返回字符,如trim(12.456,2)返回"12.45",trim(date,'yyyy')返回"2017"
  • trunc 截取数字，保留指定的小数位，如trunc(12.456,2) 输出是12.45.不推荐使用，因为处理float有问题，兼容原因保留了
  • decode 一个简化的if else 结构，如 ${decode(a,1,"a=1",2,"a=2","不知道了")},如果a是1，这decode输出"a=1",如果a是2，则输出"a==2", 如果是其他值，则输出"不知道了"
  • debug 在控制台输出debug指定的对象以及所在模板文件以及模板中的行数，如debug(1),则输出1 [在3行@/org/beetl/core/lab/hello.txt],也可以输出多个，如debug("hi",a),则输出hi,a=123,[在3行@/org/beetl/core/lab/hello.txt]
  • parseInt 将数字或者字符解析为整形 如 parseInt("123");
  • parseLong 将数字或者字符解析为长整形，parseInt(123.12);
  • parseDouble 将数字或者字符解析为浮点类型 如parseDouble("1.23")
  • range 接收三个参数，初始值，结束值，还有步增（可以不需要，则默认为1），返回一个Iterator，常用于循环中，如for(var i in range(1,5)) {print(i)},将依次打印1234.
  • flush 强制io输出。
  • json，将对象转成json字符串，如 var data = json(userList) 可以跟一个序列化规则 如,var data = json(userList,"[*].id:i"),具体参考 https://git.oschina.net/xiandafu/beetl-json
  • pageCtx ，仅仅在web开发中，设置一个变量，然后可以在页面渲染过程中，调用此api获取，如pageCtx("title","用户添加页面")，在其后任何地方，可以pageCtx("title") 获取该变量
  • type.new 创建一个对象实例，如 var user = type.new("com.xx.User"); 如果配置了IMPORT_PACKAGE，则可以省略包名，type.new("User")
  • type.name 返回一个实例的名字，var userClassName = type.name(user),返回"User"
  • global 返回一个全局变量值，参数是一个字符串，如 var user = global("user_"+i);
  • cookie 返回指定的cookie对象 ，如var userCook = cookie("user"),allCookies = cookie();
5.1.2. 字符串相关方法

strutil方法对参数均不做空指针检测，你可自定义方法来覆盖这些内置的方法

  • strutil.startWith ${ strutil.startWith("hello","he")} 输出是true
  • strutil.endWith ${ strutil.endWith("hello","o")} 输出是true
  • strutil.length ${ strutil. length ("hello")},输出是5
  • strutil.subString ${ strutil.subString ("hello",1)},输出是"ello"
  • strutil.subStringTo ${ strutil.subStringTo ("hello",1,2)},输出是"e"
  • strutil.split ${ strutil.split ("hello,joeli",",")},参数第一个是字符串，第二个是正则表达式。输出是数组：返回第一个是"hello"，第二个是"joelli"
  • strutil.contain ${ strutil.contain ("hello,"el")},输出是true
  • strutil.toUpperCase ${ strutil.toUpperCase ("hello")},输出是HELLO
  • strutil.toLowerCase ${ strutil.toLowerCase ("hello")},输出是hello
  • strutil.replace ${ strutil.replace ("hello","lo","loooo")},输出是helloooo
  • strutil.format ${ strutil.format ("hello,{0}, my age is {1}","joeli",15)},输出是hello,joeli, my age is 15. 具体请参考http://docs.oracle.com/javase/6/docs/api/java/text/MessageFormat.html
  • strutil.trim 去掉字符串的尾部空格
  • strutil.formatDate var a = strutil.formatDate(user.bir,'yyyy-MM-dd')};
  • strutil.index var index = strutil.index("abc","a");返回 索引0
  • strutil.lastIndex var index = strutil.lastIndex("aba","a");返回索引2
5.1.3. 数组相关方法
  • array.range 返回数组或者Collection一部分，接受三个参数，第一个是数组或者Collection子类，第二，三个参数分别是起始位置
  • array.remove 删除某个数组或者Collection的一个元素，并返回该数组或者Collection.第一个是数组或者Collection子类,第二个参数是元素
  • array.add 向数组或者Collection添加一个元素，并返回该数组或者Collection。第一个是数组或者Collection子类,第二个参数是元素
  • array.contain 判断数组或者元素是否包含元素，如果包含，返回true。否则false。第一个是数组或者Collection子类,第二个参数是元素
  • array.toArray 转化成数组,如array.toArray(1,2,"a");
  • array.collection2Array 将java集合转化为数组 array.collection2Array([1,2,''])
5.1.4. 正则表达式相关方法
  • reg.match(str,regex) str为需要处理的字符串，regex是表达式
  • reg.replace(str,regex,replace)，str为需要处理的字符串，regex是表达式，替换的字符串替换字符串
  • reg.find(str,regex) 返回找到的符合表达式的第一个字符串，否则返回空字符串
  • reg.findList(str,regex) 找到所有符合表达式的字符串，否则返回空列表
  • reg.split(str,regex),对字符串进行切分，返回列表
  • reg.split(str,regex,limit) 同上，limit是最多返回个数
5.1.5. Spring 相关函数

Spring函数并没有内置，需要注册，如下

  1. <bean name="beetlGroupUtilConfiguration" class="org.beetl.ext.spring.BeetlGroupUtilConfiguration" init-method="init">
  2.         <property name="functions">
  3.                 <map>
  4.                         <!-- 定义SpEL方法 -->
  5.                         <entry key="spel">
  6.                                 <bean class="org.beetl.ext.spring.SpELFunction"/>
  7.                         </entry>
  8.                 </map>
  9.                 </property>
  10.                  <property name="functionPackages">
  11.                 <map>
  12.                         <entry key="sputil">
  13.                                 <bean class="org.beetl.ext.spring.UtilsFunctionPackage"/>
  14.                         </entry>
  15.                 </map>
  16.         </property>
  17. </bean>

spel(spelString, rootObject) SpEL方法传入一个Spring SpEL表达式以获取表达式结果，方法建议以函数的方式定义在BeetlGroupUtilConfiguration的functions中

spelString: SpEL表达式字符串，必传(否则返回null) rootObject: 作为spel的根对象（对应#root），可以是一个Map或Bean对象，默认取空Map。由于Beetl运行上下文无法直接获取模版局部变量的变量名，建议局部变量采用自定义Map的方式传入

  • 列表筛选（以自定义Map为根对象传入局部变量）
  1. <% var intArray = [12, 1, 2, 3]; %>
  2. ${spel('#root.intArray.?[#this>10]', {intArray: intArray})}
  • 以Bean对象为根对象
  1.   <% var now = date(); %>
  2.   ${spel('#root.year + 1900', now)}
  • 直接new对象
  1.   ${spel('(new java.util.Date()).year + 1900')}
  • 直接引用Spring Bean
  1.           ${spel('@testBean')}

  • 默认变量

  • #root 表示SpEL的根对象, 由spel函数第二参数传入，默认是一个空map

  • #context 表示Beetl执行上下文
  • #global 表示Beetl的共享变量Map，由于Beetl上下文无法获取临时变量名，临时变量建议使用根对象的方式传入
  • #ctxPath 表示Servlet Context Path（由Beetl WebRender提供）
  • #servlet 可以从中获取到Servlet request，response，session原生实例（由Beetl WebRender提供）
  • #parameter 表示请求参数Map（由Beetl WebRender提供）
  • #request 表示请求对象（由Beetl WebRender提供）
  • #session 表示会话域属性Map（由Beetl WebRender提供）

sputil 提供了spring内置的一些功能，如

  1. // 测试source中是否包含了candidates的某个成员(相当于交集非空)
  2. sputil.containsAny(Collection<?> source, Collection<?> candidates)
  3. // 返回在source集合总第一个也属于candidates集的元素
  4. sputil.findFirstMatch(Collection<?> source, Collection<?> candidates)
  5. // 测试指定文本是否匹配指定的Ant表达式(\*表达式), 多个表达式只要一个匹配即可
  6. sputil.antMatch(String input, String... patterns)
  7. // 返回指定路径表示的文件的扩展名(不带点.)
  8. sputil.fileExtension(String path)
  9. // 忽略大小写的endsWith
  10. sputil.endsWithIgnoreCase(String input, String suffix)
  11. // 忽略大小写的startsWith
  12. sputil.startsWithIgnoreCase(String input, String prefix)
  13. // 测试输入值是否为空白, null视为空白, 无视字符串中的空白字符
  14. sputil.isBlank(String input)
  15. // 首字母大写转换
  16. sputil.capitalize(String input)
  17. // 首字母小写转换
  18. sputil.uncapitalize(String input)
  19. // 在集合或数组元素之间拼接指定分隔符返回字符串
  20. // null表示空集, 其他类型表示单元素集合
  21. sputil.join(Object collection, String delim)
  22. // 同上, 只是会在最后结果前后加上前缀和后缀
  23. // 注意这个函数名叫做joinEx
  24. sputil.joinEx(Object collection, String delim, String prefix, String suffix)
  25. // 对文本进行html转义
  26. sputil.html(String input)
  27. // 对文本进行javascript转义
  28. sputil.javaScript(String input)
5.1.6. Spring security

下列三个函数只需以函数的方式定义在BeetlGroupUtilConfiguration的functions中即可，与spel函数一样的，函数名声明在functions中，可以更改

  • auth() 对应类: org.beetl.ext.spring.AuthenticationFunction 方法无参数 返回值: 返回当前安全上下文中的用户认证凭证Authentication实例 如果当前环境不存在Spring Security安全上下文，将返回null值

  • urlIf(\, \) 对应类: org.beetl.ext.spring.AccessUrlIfFunction 参数: url: 字符串表示的测试URL Path，不需要指定Context Path，缺省会直接返回true method: 字符串表示的访问方式, 默认为GET, 建议全大写 返回值: 测试当前登录用户是否能访问指定的URL Path, 返回true or false

    示例:

  1.   urlIf('/system/admin_update.do', 'POST'))

如果当前环境不存在Spring Security安全上下文，将返回true 如果当前环境不存在用户认证凭证，作为匿名登录进行测试

  • expIf(\) 对应类: org.beetl.ext.spring.AccessExpressionIfFunction 参数: exp: Spring Security安全表达式，缺省会直接返回true 返回值: 测试当前登录用户是否满足指定的安全表达式，返回true or false 示例:
  1.   expIf('isAuthenticated()')

如果当前环境不存在Spring Security安全上下文，将返回true 如果当前环境不存在用户认证凭证，作为匿名登录进行测试

注意: 使用此方法，必须开启Spring Security的expression功能(use-expressions="true")：

  1.   <sec:http auto-config="true" use-expressions="true"></sec:http>

Spring Security Expression相关语法，请阅读： http://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#el-access

5.1.7. shiro

参考文档 https://my.oschina.net/xiandafu/blog/143109