在实际开发中,大多数情况下都需要对 SQL 传入参数以获得想要的结果集,传入的情况分为两种情况:
- SQL语句的拼接,比如表名、like 条件等;在 mybatis 中使用
${}
包裹参数,mybati 直接对其进行字符串替换 - SQL 中作为条件输入的参数,这种情况下,SQL 允许使用
?
作为占位符来代替参数,在 mybatis 中使用#{}
包裹参数,使用占位符有以下几点好处:- mybatis 会对包裹的变量进行转义和类型检查,避免以 SQL 注入的方式攻击数据库
- 默认情况下,mybatis 采用的是预编译的方式,对于数据库而言 SQL 本身没有变化,变化的是传入的参数,数据库只会编译一次,而不会因为作为条件的参数变化而重新编译,节约了 SQL 执行总时间
对于开发人员而言,能够使用 #{} 传入参数的情况都应该采用这种形式。
传入参数
接口 Mapper 传入参数
在 xml 中写 SQL 的时候注意到 parameterType
参数,刚接触的时候就有疑惑,如果有多个参数该如何指定。原来这是一个可选参数,Mybatis 本身就可以通过 TypeHandler 推断出具体传入语句的参数。
总结通过接口方法传入参数的情况:
- 参数使用添加
@Param
注解,或者使用 '-parameters' 编译选项并启用 useActualParamName 选项(默认开启)来编译项目 - 特别的,如果参数是
Javabean
,在SQL中引用参数的时候可以直接使用属性访问符,而无需通过 get 方法。eg:#{Javabean.id}
配置文件传入参数
有时候为了将表名或者 schema 可配置化,将变量写到配置文件中,避免未来表名变化造成大的改动。
全局变量
首先如果是作为全局的参数,可以将配置文件中的参数都写入到 Javabean 中,使用的时候通过接口 Mapper 传入即可。在 Spring 中
- 在 Spring 配置文件中,使用
PropertiesFactoryBean
指定配置文件路径,指定 id - 在 Javabean 文件中使用通过 @Value("#{id['name']}") 设置变量,并使用 @Component 注解该Javabean
- 在接口 Mapper 中传入该 Javabean
- applicationContext.xml
复制代码 classpath: .properties
- ExampleProperty.java
@Component("exampleProperty") public class ExampleProperty { @Value("#{exampleid['name']}") public String name; ... }复制代码
- 引用
@Resource private ExampleProperty exampleProperty;复制代码
只在 mybatis SQL 中引用
如果不是作为全局参数,而只是在 SQL 中使用,则可以通过 mybatis 的配置文件 mybatis-config.xml 引入,这里引入的变量所有 SQL 的 xml 中都可以通过 ${} 的方式引入。
- mybatis-config.xml
复制代码 ...
参数加载的顺序如下
- 首先包裹的参数作为默认值(推荐引入配置文件的同时也设定默认参数)
- 加载 resource 中指定的配置文件,如果已指定了该参数则覆盖
- 如果通过接口 Mapper 传入了同名参数,接口 Mapper 传入的参数覆盖原有参数值
另外需要注意的是通过 mybatis-config.xml 设定的参数,在 SQL 中无法直接使用 #{} 的方式引入,而有时候又想要用占位符的方式进行预编译,除了使用接口 Mapper 传入参数外,还可以使用<bind>
bind 元素可以从 OGNL 表达式中创建一个变量并将其绑定到上下文
- ExampleSQL.xml
复制代码