mybatis 学习记录（0）——细节注意点

0. 写在前面

主要记录使用 mybatis 开发过程需要注意的一些细节和犯的错误，内容比较广泛零散，仅为学习记录，不定期更新。
最上方的索引内容有点问题，但去掉后又觉得找一些特定内容太麻烦了。所以就保留下来了，知道大概内容，有个提醒和快速访问作用就好了

1. 配置文件

1.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/>

1.2 BeanMapper.xml

该映射文件中的内容是实现 dao 接口的 sql 语句。

1.2.1 MyBatis 中 # 和 $ 的区别：

使用 #{parameterName} 引用参数的时候，Mybatis 会把这个参数认为是一个字符串，例如传入参数是 “Smith”，那么在 SQL（Select from emp where name = #{employeeName}) 使用的时候就会转换为 Select from emp where name = ‘Smith’;

同时在 SQL（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语句

1.2.2 SQL 语句中的列名与关键字冲突解决

比如：name

解决方法：在列名两边加上 “ 即可

DELETE FROM stu WHERE `name` LIKE '%${name}%'

1.2.3 表字段名和 bean 属性名不一样时，导致获取不到返回数据的问题解决

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

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

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

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

2. java 代码

2.2 @Param 参数的作用

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

如下代码：

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 是任意的。

2.2 二级缓存

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不能共享使用，它也是线程不安全的。因此最佳的范围是请求或方法范围(定义局部变量使用)。绝对不能将 SqlSession 实例的引用放在一个类的静态字段或实例字段中。

打开一个 SqlSession；使用完毕就要关闭它。通常把这个关闭操作放到 finally 块中以确保每次都能执行关闭。

因此在设置 usecache 属性时，如果每次查询都需要最新的数据，那么就需要设置 useCache=false，禁用二级缓存，即每次查询都会发出 sql 去查询，默认为 true

<select id="findUser" resultMap="User" useCache="false">

程序在执行查询语句时，MyBatis 会先从二级缓存中取数据，若没有就去一级缓存中获取，再没有才从数据库中查找。

尊重他人劳动成果，转载请注明出处:
http://blog.csdn.net/czd3355/article/details/73478352

参考：
- https://github.com/brianway/springmvc-mybatis-learning/blob/master/sourcecode/mybatis/config/SqlMapConfig.xml
- https://github.com/liyifeng1994/ssm