Spring整合MyBatis详解

前言

XML配置文件方式使用MyBatis，其实是比较繁琐的，虽然可以将SqlSessionFactory对象的创建写到工具类中来实现可以减少一部分的代码量，但是还有相当量的代码要写。
使用Spring整合MyBatis可以来完美解决这个问题。

整合MyBatis

1. XML配置文件方式使用MyBatis

1.1 XML文件配置

MyBatis的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文件 -->
    <properties resource="jdbc.properties"></properties>
    <!-- 类型别名 可以直接用包名 -->
    <typeAliases>
        <package name="com.hao.domain"/>
    </typeAliases>
    <!--
        environments：配置数据库连接环境信息，可以配置多个environment，通过default属性切换不同的environment
    -->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <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>
    <mappers>
        <!-- 加载SQL映射配置 -->
        <package name="com.hao.dao"/>
    </mappers>
</configuration>

1.2 MyBatis核心分析

1.2.1 初始化sqlSessionFactory

/* 1. 获取sqlSessionFactoryBuilder对象 */
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
/* 2. 加载mybatis-config.xml配置文件 */
InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
/* 3. 创建sqlSessionFactory对象 */
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);

1.2.2 获取连接和实现

/* 4. 获取sqlSession */
SqlSession sqlSession = sqlSessionFactory.openSession();
/* 5. 执行sqlSession对象执行查询，获取结果Account */
AccountDao accountDao = sqlSession.getMapper(AccountDao.class);

1.2.3 获取数据层接口

Account account = accountDao.selectById(1);
System.out.println(account);

1.2.4 关闭连接

/* 6. 释放资源 */
sqlSession.close();

2. Spring整合MyBatis

Spring整合MyBatis就是将MyBatis的配置文件使用Java类替换掉，并且简化MyBatis的核心代码。

2.1 MyBatis配置文件分析

image.png

2.1.1 初始化属性数据替换

在Spring的Java配置类中添加properties文件加载路径。

@Configuration
@PropertySource("classpath:jdbc.properties")
public class SpringConfig {
}

2.1.2 初始化DataSource

创建JDBC的Java配置类，来创建DataSource的bean。

public class JdbcConfig {
    @Value("${jdbc.driver}")
    private String driver;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;
    @Bean
    public DataSource dataSource() {
        DruidDataSource ds = new DruidDataSource();
        ds.setDriverClassName(driver);
        ds.setUrl(url);
        ds.setUsername(username);
        ds.setPassword(password);
        return ds;
    }
}

2.1.3 类型别名和DataSource替换

创建MyBatis的Java配置类，来创建SqlSessionFactory的bean。

public class MyBatisConfig {
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) {
        SqlSessionFactoryBean ssfb = new SqlSessionFactoryBean();
        ssfb.setTypeAliasesPackage("com.hao.domain");
        ssfb.setDataSource(dataSource);
        return ssfb;
    }
}

可以看到这里返回的是SqlSessionFactoryBean，SqlSessionFactoryBean实现了FactoryBean<SqlSessionFactory>的接口。

设置类型别名：

ssfb.setTypeAliasesPackage("com.hao.domain");

设置DataSource：

ssfb.setDataSource(dataSource);

2.1.4 映射配置替换

在MyBatis的Java配置类中创建MapperScannerConfigurer的bean。

public class MyBatisConfig {
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) {
        SqlSessionFactoryBean ssfb = new SqlSessionFactoryBean();
        ssfb.setTypeAliasesPackage("com.hao.domain");
        ssfb.setDataSource(dataSource);
        return ssfb;
    }
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {
        MapperScannerConfigurer msc = new MapperScannerConfigurer();
        msc.setBasePackage("com.hao.dao");
        return msc;
    }
}

2.2 整合之后的使用

首先将JDBC和MyBatis的Java配置类通过@Import导入Spring的Java配置类中。

@Configuration
@ComponentScan({"com.hao.service", "com.hao.dao"})
@PropertySource("classpath:jdbc.properties")
@Import({JdbcConfig.class, MyBatisConfig.class})
public class SpringConfig {
}

整合之后sqlSessionFactory被自动管理，同时不需要sqlSession来获取Dao，只需将Dao自动注入Service即可。

@Service
public class AccountServiceImpl implements AccountService {
    @Autowired
    private AccountDao accountDao;

    @Override
    public void save(Account account) {
        accountDao.save(account);
    }

    @Override
    public void deleteById(int id) {
        accountDao.deleteById(id);
    }

    @Override
    public void update(Account account) {
        accountDao.update(account);
    }

    @Override
    public List<Account> selectAll() {
        return accountDao.selectAll();
    }

    @Override
    public Account selectById(int id) {
        return accountDao.selectById(id);
    }
}

整合之前的代码优化之后如下：

public class App {
    public static void main(String[] args) {
        ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);

        AccountService accountService = ctx.getBean(AccountService.class);

        Account account = accountService.selectById(1);
        System.out.println(account);
    }
}

总结

以上就是关于Spring整合MyBatis的全部内容。
其实主要的核心就是将MyBatis的配置类通过Java配置类的形式来替换。