# 与 $ 区别以及 sql 预编译

深碍√TFBOYSˉ_ 2022-06-05 12:25 230阅读 0赞

## 与 $ 区别以及 sql 预编译 ##

### 前言 ###

MyBatis中使用parameterType向SQL语句动态传参，parameterType后的类型可以是基本类型int,String,HashMap和java自定义类型。在SQL中引用这些参数的时候，可以使用两种方式**\#\{parameterName\}**或者**$\{parameterName\}**

例如我们需要根据用户的姓名来筛选用户时，sql 如下：

select * from user where name = "ruhua";

上述 sql 中，我们希望 name 后的参数 “ruhua” 是动态可变的，即不同的时刻根据不同的姓名来查询用户。在 sqlMap 的 xml 文件中使用如下的 sql 可以实现动态传递参数 name：

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

或者

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

对于上述这种查询情况来说，使用 \#\{ \} 和 $\{ \} 的结果是相同的，但是在某些情况下，我们只能使用二者其一。

### ‘\#’ 与 ‘$’ ###

#### **区别** ####

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

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

> **\#\{ \} 解析为一个 JDBC 预编译语句（prepared statement）的参数标记符。**
> 
> **$\{ \} 仅仅为一个纯碎的 string 替换，在动态 SQL 解析阶段将会进行变量替换**

“\#\{ \}”解析，例如，sqlMap 中如下的 sql 语句

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

解析为：

select * from user where name = ?;

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

“$\{ \}”解析，例如，sqlMap 中如下的 sql 语句

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

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

select * from user where name = "ruhua";

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

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

#### **用法 tips** ####

**1、能使用 \#\{ \} 的地方就用 \#\{ \}**  
首先这是为了性能考虑的，相同的预编译 sql 可以重复利用。  
其次，**$\{ \} 在预编译之前已经被变量替换了，这会存在 sql 注入问题。**例如，如下的 sql，

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

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

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

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

**2、表名作为变量时，必须使用 $\{ \}**  
这是因为，表名是字符串，使用 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 语句是存在语法错误的，表名不能加单引号 ”（注意，反引号 “是可以的）。

### sql预编译 ###

#### 定义 ####

> sql 预编译指的是数据库驱动在发送 sql 语句和参数给 DBMS 之前对 sql 语句进行编译，这样 DBMS 执行 sql时，就不需要重新编译。

**为什么需要预编译**

JDBC 中使用对象 PreparedStatement 来抽象预编译语句，使用预编译的优点：  
   **1、预编译阶段可以优化 sql 的执行。**  
      预编译之后的 sql 多数情况下可以直接执行，DBMS 不需要再次编译，越复杂的sql，编译的复杂度将越大，预编译阶段可以合并多次操作为一个操作。  
   **2、预编译语句对象可以重复利用。**  
      把一个 sql 预编译后产生的 PreparedStatement 对象缓存下来，下次对于同一个sql，可以直接使用这个缓存的 PreparedState 对象。  
  
mybatis 默认情况下，将对所有的 sql 进行预编译。

mysql预编译源码解析  
mysql 的预编译源码在 com.mysql.jdbc.ConnectionImpl 类中。

> 代码太多，不知如何引入……

流程图如下所示：  
![流程图][SouthEast]

#### **mybatis sql 动态解析** ####

mybatis 在调用 connection 进行 sql 预编译之前，会对sql语句进行动态解析，动态解析主要包含如下的功能：

*  占位符的处理
 *  动态sql的处理
 *  参数类型校验

mybatis强大的动态SQL功能的具体实现就在此。动态解析涉及的东西太多，以后再讨论。

### 总结 ###

1.  在动态 SQL 解析阶段，\#\{ \} 解析为一个 JDBC 预编译语句（prepared statement）的参数标记符；$\{ \}在动态 SQL 解析阶段将会进行纯碎的 string 替换变量替换。
2.  \#\{ \} 将传入的数据都当成一个字符串，会对自动传入的数据加一个双引号； $\{\}将传入的数据直接显示生成在sql中。
3.  \#\{ \} 能够很大程度防止sql注入；$\{\}无法防止Sql注入。
4.  $\{\}一般用于传入数据库对象，例如传入表名。
5.  一般能用\#的就别用$。

参考资料：  
[http://www.mybatis.org/mybatis-3/zh/dynamic-sql.html][http_www.mybatis.org_mybatis-3_zh_dynamic-sql.html]  
[https://segmentfault.com/a/1190000004617028][https_segmentfault.com_a_1190000004617028]

[SouthEast]: /images/20220605/1327f9c55ad842a6a5b58c000c130f62.png
[http_www.mybatis.org_mybatis-3_zh_dynamic-sql.html]: http://www.mybatis.org/mybatis-3/zh/dynamic-sql.html
[https_segmentfault.com_a_1190000004617028]: https://segmentfault.com/a/1190000004617028