SQL语句支持{xxx}替换，从参数、常量、属性拿值替换

Author: Qieqie

paoding-rose-jade/src/main/java/net/paoding/rose/jade/statement/DAOMetaData.java

@@ -40,8 +40,11 @@ public class DAOMetaData {
     /**
      * 定义在DAO接口上的常量（包含父接口的）
      */
-    private final Map<String, ?> constants;
+    private final Map<String, Object> constants;
 
+    /**
+     * DAO类上的属性
+     */
     private final Map<String, Object> attributes;
 
     /**
@@ -50,9 +53,9 @@ public class DAOMetaData {
      */
     public DAOMetaData(Class<?> daoClass, DAOConfig config) {
         this.daoClass = daoClass;
-        this.constants = Collections.unmodifiableMap(//
-            GenericUtils.getConstantFrom(daoClass, true, true));
         this.config = config;
+        this.constants = Collections
+            .unmodifiableMap(GenericUtils.getConstantFrom(daoClass, true, true));
         this.attributes = new ConcurrentHashMap<String, Object>(4);
     }
 
@@ -80,7 +83,7 @@ public Class resolveTypeVariable(Class<?> declaringClass, String typeVarName) {
         return GenericUtils.resolveTypeVariable(daoClass, declaringClass, typeVarName);
     }
 
-    public Map<String, ?> getConstants() {
+    public Map<String, Object> getConstants() {
         return constants;
     }
 

paoding-rose-jade/src/main/java/net/paoding/rose/jade/statement/GenericUtils.java

@@ -158,7 +158,7 @@ public static final Class resolveTypeVariable(Class invocationClass, Type target
      * 
      * @return {@link Map} 包含类的所有常量
      */
-    public static Map<String, ?> getConstantFrom(Class clazz, // NL
+    public static Map<String, Object> getConstantFrom(Class clazz, // NL
                                                  boolean findAncestor, boolean findInterfaces) {
 
         HashMap<String, Object> map = new HashMap<String, Object>();

paoding-rose-jade/src/main/java/net/paoding/rose/jade/statement/Interpreter.java

@@ -22,11 +22,13 @@
  * <p>
  * 如果没有标注 {@link Order} 使用默认值0。
  * 
+ * 从实践看，jade插件的解析器一般应该设置为负数，以优先于系统解析器。
+ * 
  * @author 王志亮 [qieqie.wang@gmail.com]
  * @author 廖涵 [in355hz@gmail.com]
  * 
  */
-//按Spring语义规定，Order值越高该解释器越后执行
+//按Spring语义规定，根据 {@link Order} 语义，值越小越优先，值越大越后；
 @Order(0)
 public interface Interpreter {
 

paoding-rose-jade/src/main/java/net/paoding/rose/jade/statement/StatementRuntime.java

@@ -34,7 +34,7 @@ public interface StatementRuntime {
     StatementMetaData getMetaData();
 
     /**
-     * @return 返回调用DAO方法传入的参数，key为":1"、":2"以及 {@link SQLParam} 注解指定的名称
+     * @return 返回调用DAO方法传入的参数，key为":1"、":2"，以及 {@link SQLParam} 注解指定的名称(不含冒号)
      */
     Map<String, Object> getParameters();
 

paoding-rose-jade/src/main/java/net/paoding/rose/jade/statement/SystemInterpreter.java

@@ -18,51 +18,188 @@
 import java.sql.SQLSyntaxErrorException;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import org.springframework.jdbc.BadSqlGrammarException;
 
 import net.paoding.rose.jade.statement.expression.ExqlPattern;
 import net.paoding.rose.jade.statement.expression.impl.ExqlContextImpl;
 import net.paoding.rose.jade.statement.expression.impl.ExqlPatternImpl;
 
-import org.springframework.jdbc.BadSqlGrammarException;
-
 /**
  * 
  * @author 廖涵 [in355hz@gmail.com]
  */
 public class SystemInterpreter implements Interpreter {
 
+    private ReplacementInterpreter     replacementInterpreter     = new ReplacementInterpreter();
+    private PreparestatmentInterpreter preparestatmentInterpreter = new PreparestatmentInterpreter();
+
     @Override
     public void interpret(StatementRuntime runtime) {
-        // 转换语句中的表达式
-        ExqlPattern pattern = ExqlPatternImpl.compile(runtime.getSQL());
-        ExqlContextImpl context = new ExqlContextImpl(runtime.getSQL().length() + 32);
-
-        try {
-            pattern.execute(context, runtime.getParameters(), runtime.getMetaData()
-                    .getDAOMetaData().getConstants());
-            runtime.setArgs(context.getParams());
-            runtime.setSQL(context.flushOut());
-        } catch (Exception e) {
-            String daoInfo = runtime.getMetaData().toString();
-            throw new BadSqlGrammarException(daoInfo, runtime.getSQL(),
+        replacementInterpreter.interpret(runtime);
+        preparestatmentInterpreter.interpret(runtime);
+    }
+
+    /**
+     * 使用方法参数、常量替换{xxxx}、{:xxxx}、##(:xxx)、##(xxx)等位置；
+     * <p>
+     * 
+     * select form ##(:table) {name} where {id}='{1}'
+     * @author zlw
+     *
+     */
+    static class ReplacementInterpreter implements Interpreter {
+
+        final Pattern PATTERN = Pattern.compile("\\{([a-zA-Z0-9_\\.\\:]+)\\}|##\\((.+)\\)");
+
+        @Override
+        public void interpret(StatementRuntime runtime) {// ##(:xxx)
+            String sql = runtime.getSQL();
+            StringBuilder sb = new StringBuilder(sql.length() + 200);
+            Matcher matcher = PATTERN.matcher(sql);
+            int start = 0;
+            while (matcher.find(start)) {
+                sb.append(sql.substring(start, matcher.start()));
+                String group = matcher.group(); 
+                String key = null;
+                if (group.startsWith("{")) {
+                    key = matcher.group(1);
+                } else if (group.startsWith("##(")) {
+                    key = matcher.group(2);
+                }
+                // get value from parameters
+                Object value = runtime.getParameters().get(key); // 针对{paramName}、{:1}两种情况
+                if (value == null) {
+                    if (key.startsWith(":") || key.startsWith("$")) {
+                        value = runtime.getParameters().get(key.substring(1)); // 针对{:paramName}的情况
+                    } else {
+                        char ch = key.charAt(0);// 由正则表达式知道key长度必定大于0
+                        if (ch >= '0' && ch <= '9') {
+                            value = runtime.getParameters().get(":" + key); // 针对{1}两种情况
+                        }
+                    }
+                }
+                // get value from constants
+                if (value == null) {
+                    value = runtime.getMetaData().getDAOMetaData().getConstants().get(key); // 针对常量的情况
+                }
+                // get value from attributes
+                if (value == null) {
+                    String attributeKey = group;
+                    if (!attributeKey.startsWith("{")) {
+                        attributeKey = "{" + key + "}";
+                    }
+                    value = runtime.getMetaData().getDAOMetaData().getAttribute(attributeKey); // 针对插件设置进来的属性的情况
+                }
+                // replace it
+                if (value != null) {
+                    sb.append(value);
+                } else {
+                    sb.append(group);
+                }
+                start = matcher.end();
+            }
+            sb.append(sql.substring(start));
+
+            runtime.setSQL(sb.toString());
+
+        }
+    }
+
+    // 动态参数
+    static class PreparestatmentInterpreter implements Interpreter {
+
+        @Override
+        public void interpret(StatementRuntime runtime) {
+            // 转换语句中的表达式
+            ExqlPattern pattern = ExqlPatternImpl.compile(runtime.getSQL());
+            ExqlContextImpl context = new ExqlContextImpl(runtime.getSQL().length() + 32);
+
+            try {
+                Map<String, Object> constants = runtime.getMetaData().getDAOMetaData()
+                    .getConstants();
+                pattern.execute(context, runtime.getParameters(), constants);
+                runtime.setArgs(context.getArgs());
+                runtime.setSQL(context.flushOut());
+            } catch (Exception e) {
+                String daoInfo = runtime.getMetaData().toString();
+                throw new BadSqlGrammarException(daoInfo, runtime.getSQL(),
                     new SQLSyntaxErrorException(daoInfo + " @SQL('" + runtime.getSQL() + "')", e));
+            }
         }
 
     }
 
+    // ReplacementInterpreter
     public static void main(String[] args) throws Exception {
+        Map<String, Object> parameters = new HashMap<String, Object>();
+        parameters.put("table", "my_table_name");
+        parameters.put("id", "my_id");
+        parameters.put(":1", "first_param");
+
+        final Pattern PATTERN = Pattern.compile("\\{([a-zA-Z0-9_\\.\\:]+)\\}|##\\((.+)\\)");
+
+        String sql = "select form ##(:table) {name} where {id}='{1}'";
+
+        StringBuilder sb = new StringBuilder(sql.length() + 200);
+        Matcher matcher = PATTERN.matcher(sql);
+        int start = 0;
+        while (matcher.find(start)) {
+            sb.append(sql.substring(start, matcher.start()));
+            String group = matcher.group();
+            String key = null;
+            if (group.startsWith("{")) {
+                key = matcher.group(1);
+            } else if (group.startsWith("##(")) {
+                key = matcher.group(2);
+            }
+            System.out.println(key);
+            if (key == null || key.length() == 0) {
+                continue;
+            }
+            Object value = parameters.get(key); // 针对{paramName}、{:1}两种情况
+            if (value == null) {
+                if (key.startsWith(":") || key.startsWith("$")) {
+                    value = parameters.get(key.substring(1)); // 针对{:paramName}的情况
+                } else {
+                    char ch = key.charAt(0);
+                    if (ch >= '0' && ch <= '9') {
+                        value = parameters.get(":" + key); // 针对{1}两种情况
+                    }
+                }
+            }
+            if (value == null) {
+                value = parameters.get(key); // 针对常量的情况
+            }
+            if (value != null) {
+                sb.append(value);
+            } else {
+                sb.append(group);
+            }
+            start = matcher.end();
+        }
+        sb.append(sql.substring(start));
+        System.out.println(sb);
+
+    }
+
+    // ExqlInterpreter
+    public static void main0(String[] args) throws Exception {
         // 转换语句中的表达式
         String sql = "insert ignore into table_name "
-                + "(`id`,`uid`,`favable_id`,`addtime`,`ranking`) "//
-                + "values (:1,:2,now(),0)";
+                     + "(`id`,`uid`,`favable_id`,`addtime`,`ranking`) "//
+                     + "values (:1,:2,now(),0)";
         ExqlPattern pattern = ExqlPatternImpl.compile(sql);
         ExqlContextImpl context = new ExqlContextImpl(sql.length() + 32);
 
         Map<String, Object> parametersAsMap = new HashMap<String, Object>();
         parametersAsMap.put(":1", "p1");
         parametersAsMap.put(":2", "p2");
 
-        String result = pattern.execute(context, parametersAsMap);
+        pattern.execute(context, parametersAsMap);
+        String result = context.flushOut();
         System.out.println(result);
     }
 

paoding-rose-jade/src/main/java/net/paoding/rose/jade/statement/expression/ExqlContext.java

@@ -33,7 +33,7 @@ public interface ExqlContext {
      * 
      * @return 所有参数的数组
      */
-    Object[] getParams();
+    Object[] getArgs();
 
     /**
      * 得到输出的语句内容。

paoding-rose-jade/src/main/java/net/paoding/rose/jade/statement/expression/ExqlPattern.java

@@ -16,11 +16,9 @@ public interface ExqlPattern {
      * 
      * @param map - 参数表
      * 
-     * @return 语句内容
-     * 
      * @throws Exception
      */
-    String execute(ExqlContext context, Map<String, ?> map) throws Exception;
+    void execute(ExqlContext context, Map<String, ?> map) throws Exception;
 
     /**
      * 输出全部的语句内容。
@@ -30,10 +28,8 @@ public interface ExqlPattern {
      * @param mapVars - 参数表
      * @param mapConsts - 常量表
      * 
-     * @return 语句内容
-     * 
      * @throws Exception
      */
-    String execute(ExqlContext context, Map<String, ?> mapVars, // NL
+    void execute(ExqlContext context, Map<String, ?> mapVars, // NL
             Map<String, ?> mapConsts) throws Exception;
 }

paoding-rose-jade/src/main/java/net/paoding/rose/jade/statement/expression/impl/ExprResolverImpl.java

@@ -52,7 +52,7 @@ public class ExprResolverImpl implements ExprResolver {
     /**
      * 构造表达式处理器。
      */
-    @SuppressWarnings("unchecked")
+    @SuppressWarnings({ "unchecked", "rawtypes" })
     public ExprResolverImpl() {
         Map map = context.getVars();
         map.put(VAR_PREFIX, mapVars);

paoding-rose-jade/src/main/java/net/paoding/rose/jade/statement/expression/impl/ExprUnit.java

@@ -38,10 +38,6 @@ public void fill(ExqlContext exqlContext, ExprResolver exprResolver) throws Exce
 
         // 解释表达式内容
         Object value = exprResolver.executeExpr(expr);
-
-        if (value instanceof Enum) {
-            value = ((Enum<?>) value).name();
-        }
 
         // 输出转义的对象内容
         exqlContext.fillValue(value);

paoding-rose-jade/src/main/java/net/paoding/rose/jade/statement/expression/impl/ExqlCompiler.java

@@ -37,8 +37,12 @@ public class ExqlCompiler {
     private static final String SHARP_ELSE = "#else";
 
     // 正则表达式
+//    private static final Pattern PATTERN_KEYWORD = Pattern.compile( // NL
+//            "\\:\\:|([\\:\\$]{1}[a-zA-Z0-9_\\-\\.]+)|\\{([^\\{\\}]+)\\}\\?|#(#|!|if|for)?");
+    
+    // 正则表达式（##(:xxx)已经由ReplacementInterpreter实现，不在Exql中处理)
     private static final Pattern PATTERN_KEYWORD = Pattern.compile( // NL
-            "\\:\\:|([\\:\\$]{1}[a-zA-Z0-9_\\.]+)|\\{([^\\{\\}]+)\\}\\?|#(#|!|if|for)?");
+            "\\:\\:|([\\:\\$]{1}[a-zA-Z0-9_\\-\\.]+)|\\{([^\\{\\}]+)\\}\\?|#(!|if|for)?");
 
     private static final Pattern PATTERN_IN = Pattern.compile(// NL
             "([a-zA-Z0-9_]*)\\s+in\\s+(.+)");
@@ -130,6 +134,7 @@ protected ExqlUnit compileUnit() {
 
                 // 编译  {...} 内部的子句
                 ExqlCompiler compiler = new ExqlCompiler(group);
+                System.out.println("DELETE>>>group=" + group);
                 ExqlUnit unit = compiler.compileUnit();
 
                 // 创建   {...}? 形式的子句
@@ -437,12 +442,13 @@ private boolean match(String keyword, int fromIndex) {
     }
 
     // 进行简单测试
+    // 贴士：##(:xxx) 已经被ReplacementInterpreter实现，
     public static void main(String... args) throws Exception {
 
         String string = "SELECT :expr1, #($expr2.class),"
                 + " WHERE #if(:expr3) {e = $expr3} #else {e IS NULL}"
                 + "#for(variant in $expr4.bytes) { AND c = :variant}" // NL
-                + " {AND d = :expr5}? {AND f = $expr6}?" // NL
+                + " {AND d = :expr-5}? {AND f = $expr6}?" // NL
                 + " BY #!(:expr7) ASC";
 
         // 在输入中查找  PREFIX 字符
@@ -487,7 +493,8 @@ public static void main(String... args) throws Exception {
         // map.put("expr6", "expr6");
         map.put("expr7", "expr7");
 
-        System.out.println(pattern.execute(context, map, map));
-        System.out.println(Arrays.toString(context.getParams()));
+        pattern.execute(context, map, map);
+        System.out.println(context.flushOut());
+        System.out.println(Arrays.toString(context.getArgs()));
     }
 }