这也许是你不曾留意过的 Mybatis 细节

Mybatis 可以说是 Java 后端的必备技能，可能你和我一样经常使用到它。但有时 cv 多了，会忘记了一些细节处理，比如为什么要加上这个注解？它的作用是什么等等。

这篇文章是我以前写的一些关于 Mybatis 细节，希望对各位有起到查漏补缺的作用。

1. 配置文件

SqlMapConfig.xml 文件各参数介绍：

?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!-- 加载属性文件 -->
    <properties resource="jdbc.properties">
        <!--properties中还可以配置一些属性名和属性值  -->
        <!-- <property name="jdbc.driver" value=""/> -->
    </properties>

    <!-- 全局配置参数，需要时再设置 -->
    <settings>
        <!-- 打开延迟加载的开关，默认为false -->
        <setting name="lazyLoadingEnabled" value="true"/>
        <!-- 将积极加载改为消极加载即按需要加载，默认为true -->
        <setting name="aggressiveLazyLoading" value="false"/>
        <!-- 开启二级缓存，默认为true -->
        <setting name="cacheEnabled" value="true"/>
        <!-- 使用jdbc的getGeneratedKeys获取数据库自增主键值 -->
        <setting name="useGeneratedKeys" value="true"/>
    </settings>

    <!-- 别名定义 -->
    <typeAliases>

        <!-- 针对单个别名定义
        type：类型的路径
        alias：别名
         -->
        <!-- <typeAlias type="com.iot.mybatis.po.User" alias="user"/> -->
        <!-- 批量别名定义
        指定包名，mybatis自动扫描包中的po类，自动定义别名，别名就是类名（首字母大写或小写都可以）
        -->
        <package name="com.iot.mybatis.po"/>

    </typeAliases>

    <!-- 和spring整合后 environments配置将废除-->
    <environments default="development">
        <environment id="development">
            <!-- 使用jdbc事务管理，事务控制由mybatis-->
            <transactionManager type="JDBC"/>
            <!-- 数据库连接池,由mybatis管理-->
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

<!--加载映射文件有 3 种方法，如下所示-->
<mappers> 
<mapper resource="sqlmap/User.xml"/>
        <!--1. 通过 resource 方法一次加载一个映射文件 -->
        <!-- <mapper resource="mapper/UserMapper.xml"/> -->

        <!-- 2. 通过 mapper 接口加载单个映射文件
        遵循一些规范：需要将 mapper 接口类名和 mapper.xml 映射文件名称保持一致，且在一个目录中
         -->
        <!-- <mapper class="com.iot.mybatis.mapper.UserMapper"/> -->

        <!-- 3. 批量加载 mapper
        指定 mapper 接口的包名，mybatis 自动扫描包下边所有 mapper 接口进行加载
        遵循一些规范：需要将 mapper 接口类名和 mapper.xml映射文件名称保持一致，且在一个目录中
         -->
        <package name="com.iot.mybatis.mapper"/>

<mappers/>

2. # 和 $ 的区别

使用 #{parameterName} 引用参数的时候，Mybatis 会把这个参数认为是一个字符串，例如在下面的 sql 传入参数 “Smith”，
Select from emp where name = #{employeeName}

就会被转换为：
Select from emp where name = ‘Smith’;

同理在下面 sql 传入参数 “Smith”：
Select from emp where name = ${employeeName}

使用的时候就会被转换为 ：
Select from emp where name = Smith;

简单来说， #{} 是经过预编译的,是安全的,而 ${} 是未经过预编译的,仅仅是取变量的值,是非安全的,存在 sql 注入的危险。# 将传入的数据都当成一个字符串，会对自动传入的数据加一个双引号。

使用 ${} 的情况，order by、like 语句只能用 ${} 了,用 #{} 会多个 ’ ’ 导致 sql 语句失效.此外动态拼接 sql，模糊查询时也要用 ${}。

举个栗子，假如 name=陈,那么该 sql 就是 ... LiKE '%陈%'，
DELETE FROM stu WHERE name LIKE '%${name}%'

上面话有点长，这里小小总结下：
\#{} :编译好 SQL 语句再取值
${} :取值以后再去编译SQL语句

3. SQL 语句中的列名与关键字冲突时怎么办

比如：name 字段。

解决方法：在列名两边加上两个 ` 即可，如下：
DELETE FROM stu WHERE name LIKE '%${name}%'

4. 列名和 bean 属性名不一样，导致获取不到数据时怎么办

那么为什么会导致查询的 SQL 语句无法得到正确结果呢？

因为 mybatis 会通过反射得到 bean ，由于字段名和属性名不一样，导致无法将查询到的表字段数据 set 到 bean 属性中。

解决方法： 
【不推荐】修改表字段名称或 bean 属性名称，使它们同名即可

【推荐】修改 标签中的相应内容，如下图所示 

5. @Param 参数的作用

作用：相当于给其修饰的参数指定一个别名。

若接口只有一个参数则可以不用指定别名，List 参数除外。当有多个参数时一定要指定，否则 mybatis 映射不到对应的字段。

如下代码：
List<Book> queryAll(@Param("offset")int offset, @Param("limit")int limit);

该接口方法对应的 mapper 实现如下：

<select id="queryAll" resultType="Book">
       SELECT
           book_id,
           `name`,
           `number`
       FROM
           book
       ORDER BY
           book_id
       LIMIT #{offset}, #{limit}
</select>

可以看到 #{} 里面的值是和 @Param("value") 保持一致的，也一定要一致，否则 mybatis 会找不到这个值而导致报错。另外，@Param("value") 中的 value 可以是任意的。

参考：

• https://github.com/liyifeng19...
• https://github.com/brianway/s...

如果觉得文章不错，希望能得到你的关注：七淅在学Java