Mybatis延迟加载的实现以及使用场景

Posted 2022-08-30 hopeofthevillage

　　首先我们先思考一个问题，假设：在一对多中，我们有一个用户，他有100个账户。

　　问题1：在查询用户的时候，要不要把关联的账户查出来？

　　问题2：在查询账户的时候，要不要把关联的用户查出来？

　　解答：在查询用户的时候，用户下的账户信息应该是我们什么时候使用，什么时候去查询。

　　　　　在查询账户的时候，账户的所属用户信息应该是随着账户查询时一起查询出来。

　　搞清楚这两个简单的问题后，我们就可以引出延迟加载和立即加载的特性。

　　延迟加载：在真正使用数据的时候才发起查询，不用的时候不查询关联的数据，延迟加载又叫按需查询（懒加载）

　　立即加载：不管用不用，只要一调用方法，马上发起查询。

　　使用场景：在对应的四种表关系中，一对多、多对多通常情况下采用延迟加载，多对一、一对一通常情况下采用立即加载。

　　理解了延迟加载的特性以后再看Mybatis中如何实现查询方法的延迟加载，在MyBatis 的配置文件中通过设置settings的lazyLoadingEnabled属性为true进行开启全局的延迟加载，通过aggressiveLazyLoading属性开启立即加载。看一下官网的介绍，然后通过一个实例来实现Mybatis的延迟加载，在例子中我们展现一对多表关系情况下，通过实现查询用户信息同时查询出该用户所拥有的账户信息的功能展示一下延迟加载的实现方式以及延迟加载和立即加载的结果的不同之处。

lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。	true | false	false
aggressiveLazyLoading	当开启时，任何方法的调用都会加载该对象的所有属性。 否则，每个属性会按需加载（参考 lazyLoadTriggerMethods)。	true | false	false （在 3.4.1 及之前的版本默认值为 true）

　　

 

　　1.用户类以及账户类

public class User implements Serializable
    private Integer id;
    private String username;
    private Date birthday;
    private String sex;
    private String address;
    private List<Account> accountList;

    get和set方法省略.....      



public class Account implements Serializable
    private Integer id;
    private Integer uid;
    private Double money;

    get和set方法省略.....      

注意因为我们是查找用户的同时查找出其所拥有的账户所以我们需要在用户类中增加账户的集合的属性，用来封装返回的结果。

　　2.在UserDao接口中声明findAll方法

/**
     * 查询所有的用户
     *
     * @return
     */
    List<User> findAll();

　　3.在UserDao.xml中配置findAll方法的映射

<resultMap id="userAccountMap" type="com.example.domain.User">
        <id property="id" column="id"/>
        <result property="username" column="username"/>
        <result property="birthday" column="birthday"/>
        <result property="sex" column="sex"/>
        <result property="address" column="address"/>
        <collection property="accountList" ofType="com.example.domain.Account" column="id"
                    select="com.example.dao.AccountDao.findAllByUid"/>
    </resultMap>
    <select id="findAll" resultMap="userAccountMap">
        SELECT * FROM USER;
    </select>

　　主要的功能实现位于 <collection property="accountList" ofType="com.example.domain.Account" column="id" select="com.example.dao.AccountDao.findAllByUid"/>中，对于账户列表的信息通过collection集合来映射，通过select指定集合中的每个元素如何查询，在本例中select的属性值为AccountDao.xml文件的namespace   com.example.dao.AccountDao路径以及指定该映射文件下的findAllByUid方法，通过这个唯一标识指定集合中元素的查找方式。因为在这里需要用到根据用户ID查找账户，所以需要同时配置一下findAllByUid方法的实现。

　　4.配置collection中select属性所使用的方法 findAllByUid

AccountDao接口中添加
 /**
     * 根据用户ID查询账户信息
     * @return
     */
    List<Account> findAllByUid(Integer uid);

AccountDao.xml文件中配置
<select id="findAllByUid" resultType="com.example.domain.Account">
        SELECT * FROM account WHERE uid = #uid;
    </select>

　　5.在Mybatis的配置文件中开启全局延迟加载

configuration>
    <settings>
        <!--开启全局的懒加载-->
        <setting name="lazyLoadingEnabled" value="true"/>
        <!--关闭立即加载，其实不用配置，默认为false-->
        <setting name="aggressiveLazyLoading" value="false"/>
        <!--开启Mybatis的sql执行相关信息打印-->
        <setting name="logImpl" value="STDOUT_LOGGING" />
    </settings>
    <typeAliases>
        <typeAlias type="com.example.domain.Account" alias="account"/>
        <typeAlias type="com.example.domain.User" alias="user"/>
        <package name="com.example.domain"/>
    </typeAliases>
    <environments default="test">
        <environment id="test">
            <!--配置事务-->
            <transactionManager type="jdbc"></transactionManager>
            <!--配置连接池-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/test1"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <!--配置映射文件的路径-->
    <mappers>
        <mapper resource="com/example/dao/UserDao.xml"/>
        <mapper resource="com/example/dao/AccountDao.xml"/>
    </mappers>
</configuration>

　　6.测试方法

    private InputStream in;
    private SqlSession session;

    private UserDao userDao;
    private AccountDao accountDao;
    private SqlSessionFactory factory;
    @Before
    public void init()throws Exception
        //获取配置文件
        in = Resources.getResourceAsStream("SqlMapConfig.xml");
        //获取工厂
        factory = new SqlSessionFactoryBuilder().build(in);

        session = factory.openSession();

        userDao = session.getMapper(UserDao.class);
        accountDao = session.getMapper(AccountDao.class);
    
    @After
    public void destory()throws Exception
        session.commit();
        session.close();
        in.close();
    
    @Test
    public void findAllTest()
        List<User> userList = userDao.findAll();
//        for (User user: userList)
//            System.out.println("每个用户的信息");
//            System.out.println(user);
//            System.out.println(user.getAccountList());
//        
    

测试说明：当我们注释了findAllTest()方法中的for循环打印的时候，我们将不会需要用户的账户信息，按照延迟加载的特性程序只会查询用户的信息，而不会查询账户的信息。当我我们放开for循环打印的时候我们使用到了用户和账户的信息，程序会同时将用户以及对应的账户信息打印出来。

　　7.测试结果

　　（1）注释for循环，不使用数据，这时候不需要查询账户信息，我们能在控制台中看到sql执行结果是因为在Mybatis配置文件中添加了logImpl的配置，具体参考第5步中的配置信息

　　　　（2）通过for循环打印查询的数据，使用数据，这时候因为使用了数据所以将查询账户信息，我们发现用户和账户查询都进行了执行