本节学习目标主要是使用JFinal中自带的Template Engin来实现对sql的管理。JFinal中为sql管理提供了3个指令#sql、#para、#namespace,来增强sql功能。
一、兵马未动,粮草先行
1、预定义sql模板
使用#sql指令和#end指令可以完成对sql模板的定义。#sql指令接收一个string类型的参数,用来作为该sql的唯一标识。下面我们来一起写一条简单的sql语句,代码如下。
#sql("findUserList")
select * from t_user where id = ?
#end
在web工程中新建一个sql文件夹,尔后创建一个demo.sql的文件,写入上述代码。当然sql文件的存放位置你可以根据自身工程的实际情况自行调整,这里仅做最简单的演示。
需要注意的地方有两点,第一我们使用#sql指令定义了一条名字(ID)叫findUserList的模板sql;第二在sql中使用了?占位符替代了实际传入参数。
2、验证sql的有效性
根据第一步中的操作,我们已经定义了一个sql模板,接下来看看如何将刚才定义的sql在程序中运行。其实很简单,代码如下:
public void index(){
//获取预定义的sql,这里使用Db.getSql方法
String sql = Db.getSql("findUserList");
//执行查询方法,查找id=3的数据,最后输出到页面
renderJson(Db.find(sql,3));
}
执行查询后的输出结果,如下图:
注意:其实这里还不能正确输出查询结果,因为还有一点配置没处理,别着急接着往下看。
3、欲用sql模板,必要配置
在插件配置这里其实只要关心和sql相关的两行代码就行。第一行代码是:arp.setBaseSqlTemplatePath()用于设置sql文件的存放路径;第二行代码是: arp.addSqlTemplate(),这行代码的作用是添加外部sql模板文件。
/**
* 配置插件
*/
public void configPlugin(Plugins me) {
// 配置数据库连接池插件
DruidPlugin druidPlugin = createDruidPlugin();
me.add(druidPlugin);
// 配置ActiveRecord插件
ActiveRecordPlugin arp = new ActiveRecordPlugin(druidPlugin);
//设置sql文件的路径
arp.setBaseSqlTemplatePath(PathKit.getWebRootPath()+"/sql");
//添加sql模板
arp.addSqlTemplate("/demo.sql");
// 所有映射在 MappingKit 中自动化搞定
_MappingKit.mapping(arp);
me.add(arp);
}
4、遗漏的小尾巴,配置路由
熟悉JFinal的小伙伴其实可以自行开车了,为了照顾新朋友,这里还是重新介绍提一下Demo中的路由配置。
如果不配置路由,会不明白http://localhost:8080/sql
是怎么回事。
//sql管理路由
me.add("/sql",SqlController.class,"/sql");
二、看sql模板参数七十二变
让#para指令嘚瑟起来,在原有的程序上讲做一些修改。让sql根据id和pwd来进行组合查询。
方式一
这样的改造和之前使用?占位符效果是类似的,老司机都懂的这是根据索引去获取参数,缺点就是传递的参数位置不能错乱,否则会造成查询结果的不正确。
#sql("findUserList")
select * from t_user where id = #para(0) and pwd=#para(1)
#end
先来看一下,如何针对第一种方式进行sql模板的调用。
public void index(){
//根据标识将参数封装进sql模板并返回完整的sql
SqlPara sqlpara=Db.getSqlPara("findUserList",3,345678);
//执行查询
Db.find(sqlpara);
//此处用作演示返回查询结果
renderJson(Db.find(sqlpara));
}
方式二
个人也是比较喜欢KV的传参,这样不用在意参数的位置顺序问题。接下来要讲的就是这种方式,是不是很棒?来,走起!
改造sql模板文件,代码如下:
#sql("findUserList")
select * from t_user where id = #para(id) and pwd=#para(pwd)
#end
第二种方式的sql调用方法:
//设置查询参数
Kv cond= Kv.by("id", 1).set("pwd",345678);
//根据标识将参数封装进sql模板并返回完整的sql
SqlPara sqlpara=Db.getSqlPara("findUserList",cond);
//执行查询
Db.find(sqlpara);
//此处用作演示返回查询结果
renderJson(Db.find(sqlpara));
可以从以上使用方式中看出来,第二种方式多了一步单独设置key和value绑定的操作,其他的都一致。小伙伴们可以赶紧动起来,尝尝鲜。
PS:剩下的技能,会在下一节继续介绍,敬请期待。因为水平有限,如有不正之处请指正。