mybatis

"mybatis # 与 $ 区别"

Posted by Mr Chang on November 2, 2017

区别

动态 SQL 是 mybatis 的强大特性之一,也是它优于其他 ORM 框架的一个重要原因。mybatis 在对 sql 语句进行预编译之前,会对 sql 进行动态解析,解析为一个 BoundSql 对象,也是在此处对动态 SQL 进行处理的。

#{}

在动态 SQL 解析阶段, #{ } 和 ${ } 会有不同的表现:

#{ } 解析为一个 JDBC 预编译语句(prepared statement)的参数标记符。

例如,sqlMap 中如下的 sql 语句

select * from user where name = #{name};

解析为:

select * from user where name = ?;

一个 #{ } 被解析为一个参数占位符 ? 。

${}

${ } 仅仅为一个纯碎的 string 替换,在动态 SQL 解析阶段将会进行变量替换

例如,sqlMap 中如下的 sql

select * from user where name = '${name}';

当我们传递的参数为 “ruhua” 时,上述 sql 的解析为:

select * from user where name = "ruhua";

预编译之前的 SQL 语句已经不包含变量 name 了。

综上所得, ${ } 的变量的替换阶段是在动态 SQL 解析阶段,而 #{ }的变量的替换是在 DBMS 中。

用法

能使用 #{ } 的地方就用 #{ }

首先这是为了性能考虑的,相同的预编译 sql 可以重复利用。

其次,${ } 在预编译之前已经被变量替换了,这会存在 sql 注入问题。例如,如下的 sql,

select * from ${tableName} where name = #{name}

假如,我们的参数 tableName 为 user; delete user; --,那么 SQL 动态解析阶段之后,预编译之前的 sql 将变为

select * from user; delete user; -- where name = ?;

– 之后的语句将作为注释,不起作用,因此本来的一条查询语句偷偷的包含了一个删除表数据的 SQL!

表名作为变量时,必须使用 ${ }

这是因为,表名是字符串,使用 sql 占位符替换字符串时会带上单引号 ‘‘,这会导致 sql 语法错误,例如:

select * from #{tableName} where name = #{name};

预编译之后的sql 变为:

select * from ? where name = ?;

假设我们传入的参数为 tableName = “user” , name = “ruhua”,那么在占位符进行变量替换后,sql 语句变为

select * from 'user' where name='ruhua';

上述 sql 语句是存在语法错误的,表名不能加单引号 ‘‘(注意,反引号 ``是可以的)。

总结

默认情况下,使用#{}格式的语法会导致MyBatis创建预处理语句属性并以它为背景设置安全的值(比如?)。这样做很安全,很迅速也是首选做法,有时你只是想直接在SQL语句中插入一个不改变的字符串。比如,像ORDER BY,你可以这样来使用: ORDER BY ${columnName}

这里MyBatis不会修改或转义字符串。

重要:接受从用户输出的内容并提供给语句中不变的字符串,这样做是不安全的。这会导致潜在的SQL注入攻击,因此你不应该允许用户输入这些字段,或者通常自行转义并检查。

总的来说,就是 直接对接 列 表名 的 不对接 值的时候要用$符号,用#不生效(尽管你在控制台看到的生成语句是正确的,但是结果就是不对!!^_^,这个记住就好了。