JFinal SQL模板引擎-实例篇

1. 简介

JFinal 是基于 Java 语言的极速 WEB + ORM + AOP + Template Engine 框架，其核心设计目标是开发迅速、代码量少、学习简单、功能强大、轻量级、易扩展、Restful。在拥有Java语言所有优势的同时再拥有ruby、python、php等动态语言的开发效率！为您节约更多时间，去陪恋人、家人和朋友 😃

JFinal利用自带的 Enjoy Template Engine 极为简洁的实现了 Sql 模板管理功能。一如既往的极简设计，仅有 #sql、#para、#namespace 三个指令，学习成本依然低到极致。

在学习另一个框架时用到了模板引擎，想着很久没看JFinal了，今天就学一下这个模板引擎，为快速开发、下一步的项目做准备。

2. 应用场景

IDE：idea2019
JFinal版本：4.9

3. SQL模板

3.1 添加插件

在ActiveRecordPlugin中添加SQL模板插件

all.sql文件的默认加载路径是src/main/resources，编译器会自动将其编译至class path下。

3.2 #sql 指令

在all.sql文件中添加指令

#sql("findCity")
select * from city where province_id = 1
#end

调用方式：

String sql = Db.getSql("findCity");
System.out.println("sql = " + sql);
List<Record> list = Db.find(sql, 1);
String content = StringUtils.join(list, ", ");
System.out.println("content = " + content);

输出结果：

sql = select * from city where province_id = ?
content = {province_id:1, name:济南, id:1}, {province_id:1, name:青岛, id:2}, {province_id:1, name:德州, id:3}

3.3 #para 指令

#para 指令用于生成 sql 模板中的问号占位符以及问号占位符所对应的参数值，两者分别保存在 SqlPara对象的 sql 和 paraList 属性之中。

3.3.1 使用 int 常量 #para(int)

模板内容：

#sql("findCity2")
select * from city where id > #para(1) and id < #para(0)
#end

调用方式：

System.out.println("content = " + StringUtils.join(Db.template("findCity2", 3, 0).find(), ", "));

输出结果：

content = {province_id:1, name:济南, id:1}, {province_id:1, name:青岛, id:2}

3.3.2 使用非 int 常量 #para(expr)

注意：两种用法处在同一个 #sql 模板之中时只能选择其中一种。
模板内容：

#sql("findCity3")
  select * from city where id > #para(id) and province_id < #para(province_id)
#end

调用方式：

// 构造参数
Kv cond = Kv.by("id", 1).set("province_id", 2);
// 使用 Db 的 template 方法
System.out.println("content = " + StringUtils.join(Db.template("findCity3", cond).find(), ", "));

输出结果：

content = {province_id:1, name:青岛, id:2}, {province_id:1, name:德州, id:3}

sql中带有like字句的用法：
模板内容：

#sql("findCity4")
  select * from city where id > #para(id) and name like concat('%', #para(name), '%')
#end

调用方式：

// 构造参数
Kv cond = Kv.by("id", 0).set("name", "济南");
// 使用 Db 的 template 方法
System.out.println("content = " + StringUtils.join(Db.template("findCity4", cond).find(), ", "));

输出结果：

content = {province_id:1, name:济南, id:1}

3.4 #namespace 指令

#namespace 指令为 sql 语句指定命名空间，不同的命名空间可以让#sql指令使用相同的key值去定义sql，有利于模块化管理，如下所示：
模板内容：

#namespace("city")
    #sql("findCity4")
      select * from city where id > #para(id) and name like concat('%', #para(name), '%')
    #end
#end

调用方式：

// 构造参数
Kv cond = Kv.by("id", 0).set("name", "济南");
// 使用 Db 的 template 方法
System.out.println("content = " + StringUtils.join(Db.template("city.findCity4", cond).find(), ", "));

输出结果：

content = {province_id:1, name:济南, id:1}

3.5 templateByString()

如果希望将 sql 模板放在 String 变量之中而不是放在外部的文件之中，可以使用 templateByString 方法，例如：
代码实现：

String sql123 = "select * from city where id > #para(0) and province_id < #para(1)";
List<Record> list5 = Db.templateByString(sql123, 1, 2).find();
System.out.println("content = " + StringUtils.join(list5, ", "));

输出结果：

content = {province_id:1, name:青岛, id:2}, {province_id:1, name:德州, id:3}

3.6 分页用法

Sql 管理实现分页功能，在使用 #sql 定义 sql 时，与普通查询完全一样，不需要使用额外的指令，以下是代码示例：
模板内容：

#sql("findCity6")
select * from city where id > #para(id)
#end

调用方法：

// 构造参数
Kv cond = Kv.by("id", 1);
// 使用 Db 的 template 方法
System.out.println("content = " + StringUtils.join(Db.template("findCity6", cond).paginate(1, 3), ", "));

输出结果：

content = pageNumber : 1
pageSize : 3
totalPage : 2
totalRow : 4, 

其中，还有高级用法，等看完JFinal模板引擎再回来补充。

本文完。