com.litongjava.db.activerecord.sql.SqlKit Maven / Gradle / Ivy
package com.litongjava.db.activerecord.sql;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.jfinal.kit.StrKit;
import com.jfinal.template.Engine;
import com.jfinal.template.Template;
import com.jfinal.template.source.ISource;
import com.litongjava.db.SqlPara;
/**
* SqlKit
*/
@SuppressWarnings({"unchecked", "rawtypes"})
public class SqlKit {
static final String SQL_TEMPLATE_MAP_KEY = "_SQL_TEMPLATE_MAP_";
static final String SQL_PARA_KEY = "_SQL_PARA_";
static final String PARA_ARRAY_KEY = "_PARA_ARRAY_"; // 此参数保持不动，已被用于模板取值 _PARA_ARRAY_[n]
private String configName;
private boolean devMode;
private Engine engine;
private List sqlSourceList = new ArrayList();
private Map sqlTemplateMap;
public SqlKit(String configName, boolean devMode) {
this.configName = configName;
this.devMode = devMode;
engine = new Engine(configName);
engine.setDevMode(devMode);
engine.setToClassPathSourceFactory();
engine.addDirective("namespace", NameSpaceDirective.class);
engine.addDirective("sql", SqlDirective.class);
engine.addDirective("para", ParaDirective.class, true);
engine.addDirective("p", ParaDirective.class, true); // 配置 #para 指令的别名指令 #p，不建议使用，在此仅为兼容 3.0 版本
}
public SqlKit(String configName) {
this(configName, false);
}
public Engine getEngine() {
return engine;
}
public void setDevMode(boolean devMode) {
this.devMode = devMode;
engine.setDevMode(devMode);
}
public void setBaseSqlTemplatePath(String baseSqlTemplatePath) {
engine.setBaseTemplatePath(baseSqlTemplatePath);
}
public void addSqlTemplate(String sqlTemplate) {
if (StrKit.isBlank(sqlTemplate)) {
throw new IllegalArgumentException("sqlTemplate can not be blank");
}
sqlSourceList.add(new SqlSource(sqlTemplate));
}
public void addSqlTemplate(ISource sqlTemplate) {
if (sqlTemplate == null) {
throw new IllegalArgumentException("sqlTemplate can not be null");
}
sqlSourceList.add(new SqlSource(sqlTemplate));
}
public synchronized void parseSqlTemplate() {
Map sqlTemplateMap = new HashMap(512, 0.5F);
for (SqlSource ss : sqlSourceList) {
Template template = ss.isFile() ? engine.getTemplate(ss.file) : engine.getTemplate(ss.source);
Map data = new HashMap();
data.put(SQL_TEMPLATE_MAP_KEY, sqlTemplateMap);
template.renderToString(data);
}
this.sqlTemplateMap = sqlTemplateMap;
}
private void reloadModifiedSqlTemplate() {
engine.removeAllTemplateCache(); // 去除 Engine 中的缓存，以免 get 出来后重新判断 isModified
parseSqlTemplate();
}
private boolean isSqlTemplateModified() {
for (Template template : sqlTemplateMap.values()) {
if (template.isModified()) {
return true;
}
}
return false;
}
public Template getSqlTemplate(String key) {
Template template = sqlTemplateMap.get(key);
if (template == null) { // 此 if 分支，处理起初没有定义，但后续不断追加 sql 的情况
if ( !devMode ) {
return null;
}
if (isSqlTemplateModified()) {
synchronized (this) {
if (isSqlTemplateModified()) {
reloadModifiedSqlTemplate();
template = sqlTemplateMap.get(key);
}
}
}
return template;
}
if (devMode && template.isModified()) {
synchronized (this) {
template = sqlTemplateMap.get(key);
if (template.isModified()) {
reloadModifiedSqlTemplate();
template = sqlTemplateMap.get(key);
}
}
}
return template;
}
/**
* 通过 key 获取 sql
*/
public String getSql(String key) {
return getSql(key, null);
}
/**
* 通过 key 获取 sql
* 传入变量 Map data 参与 sql 生成
* 警告：变量值如果来自用户输入，需避免被 sql 注入
*/
public String getSql(String key, Map data) {
Template template = getSqlTemplate(key);
return template != null ? template.renderToString(data) : null;
}
/**
* 示例：
* 1：sql 定义
* #sql("key")
* select * from xxx where id = #para(id) and age > #para(age)
* #end
*
* 2：java 代码
* Kv cond = Kv.by("id", 123).set("age", 18);
* getSqlPara("key", cond);
*/
public SqlPara getSqlPara(String key, Map data) {
Template template = getSqlTemplate(key);
if (template == null) {
return null;
}
SqlPara sqlPara = new SqlPara();
data.put(SQL_PARA_KEY, sqlPara);
sqlPara.setSql(template.renderToString(data));
data.remove(SQL_PARA_KEY); // 避免污染传入的 Map
return sqlPara;
}
/**
* 示例：
* 1：sql 定义
* #sql("key")
* select * from xxx where a = #para(0) and b = #para(1)
* #end
*
* 2：java 代码
* getSqlPara("key", 123, 456);
*/
public SqlPara getSqlPara(String key, Object... paras) {
Template template = getSqlTemplate(key);
if (template == null) {
return null;
}
SqlPara sqlPara = new SqlPara();
Map data = new HashMap();
data.put(SQL_PARA_KEY, sqlPara);
data.put(PARA_ARRAY_KEY, paras);
sqlPara.setSql(template.renderToString(data));
// data 为本方法中创建，不会污染用户数据，无需移除 SQL_PARA_KEY、PARA_ARRAY_KEY
return sqlPara;
}
public java.util.Set> getSqlMapEntrySet() {
return sqlTemplateMap.entrySet();
}
public String toString() {
return "SqlKit for config : " + configName;
}
// ---------
/**
* 通过 String 内容获取 SqlPara 对象
*
*
* 例子：
* String content = "select * from user where id = #para(id)";
* SqlPara sqlPara = getSqlParaByString(content, Kv.by("id", 123));
*
* 特别注意：content 参数中不能包含 #sql 指令
*
*/
public SqlPara getSqlParaByString(String content, Map data) {
Template template = engine.getTemplateByString(content);
SqlPara sqlPara = new SqlPara();
data.put(SQL_PARA_KEY, sqlPara);
sqlPara.setSql(template.renderToString(data));
data.remove(SQL_PARA_KEY); // 避免污染传入的 Map
return sqlPara;
}
/**
* 通过 String 内容获取 SqlPara 对象
*
*
* 例子：
* String content = "select * from user where id = #para(0)";
* SqlPara sqlPara = getSqlParaByString(content, 123);
*
* 特别注意：content 参数中不能包含 #sql 指令
*
*/
public SqlPara getSqlParaByString(String content, Object... paras) {
Template template = engine.getTemplateByString(content);
SqlPara sqlPara = new SqlPara();
Map data = new HashMap();
data.put(SQL_PARA_KEY, sqlPara);
data.put(PARA_ARRAY_KEY, paras);
sqlPara.setSql(template.renderToString(data));
// data 为本方法中创建，不会污染用户数据，无需移除 SQL_PARA_KEY、PARA_ARRAY_KEY
return sqlPara;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy