MyBatis 整理（一）关于整合MyBatis

最新推荐文章于 2022-06-06 10:43:04 发布

原创最新推荐文章于 2022-06-06 10:43:04 发布 · 290 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring-mybatis

本文详细介绍了MyBatis与Spring框架的整合方法，包括配置数据源、注册SqlSession工厂类、配置扫描接口类等关键步骤。同时，提供了配置文件式和注解式两种整合方式的具体实现，帮助读者理解如何在实际项目中应用。

技术只是工具，应用才是实际，开片铺垫源码透析什么的，其实都算是跨步了，再者，翻看源码归根是属于应用，毕竟应用才是最为实际。

算起整合方法而言，与spring 异或 spring-boot 脚手架其实都是可以一致配置（如果不觉得浪费预配置的话），有机会的话是可以多读读相关书籍，受益匪浅。

中文官方文档传送门

环境：

工具： IDEA

Java-version : 1.8.0.141

Spring FrameWork :5.x

数据源：(c3p0/dbcp/druid ..）

     <!--   糅合spring除了引入mybatis ，中间不可或缺mybatis-spring -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>1.3.2</version>
        </dependency>


        <!--  数据源建议以最常用高版本，否则会出现一些不兼容的异常  -->
    
       <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.1.7.RELEASE</version>
        </dependency>

MySQL 版本差异：

       <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.11</version>
        </dependency>
        

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.38</version>
        </dependency>

注意：

1、若引用开始较为老旧版本的 Druid 数据源版本则会引发：

Loading class `com.mysql.jdbc.Driver'. This is deprecated. The new driver class is `com.mysql.cj.jdbc.Driver'. The driver is automatically registered via the SPI and manual loading of the driver class is generally unnecessary.

2、Mysql采用 6.0以后与之前的版本驱动器是不一样的：

6.0 + ：com.mysql.cj.jdbc.Driver

6.0 - ：com.mysql.jdbc.Driver

整合流程：

简单说无非三个可见步骤：（其实最为重要的就是完成对Configuration的配置，无论是那种形式）

整合数据源

注册SqlSessiion工厂类

配置扫描接口类

配置文件式整合：

<context:component-scan base-package="com.coffeeandice"/>

    <!-- 根据自己配置文件定义 -->
    <context:property-placeholder location="classpath:jdbc.properties"
                                  ignore-unresolvable="true"/>


    <!--配置数据源-->
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <!--Mysql 配置-->
        <property name="driverClassName" value="${jdbc.driverClassName}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>

    </bean>

    <!-- myBatis文件 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <!-- 配置数据库表对应的java实体类 -->
        <property name="typeAliasesPackage" value="com.coffeeandice.entity"/>
        <!--指定mapper文件所在的位置-->
        <property name="mapperLocations" value="classpath:mapper/*.xml"/>
        <property name="configLocation" value="classpath:mybatisConfig.xml"/>
    </bean>

    <!--扫描注册接口 -->
    <!--作用:从接口的基础包开始递归搜索，并将它们注册为 MapperFactoryBean(只有至少一种方法的接口才会被注册;, 具体类将被忽略)-->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!-- 指定mybatis接口所在的包 -->
        <property name="basePackage" value="com.coffeeandice.mapper"/>
        <!--指定会话工厂 -->
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
    </bean>

    <!--定义事务管理器-->
    <bean id="transactionManager"
          class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource"/>
    </bean>

    <!-- 开启事务注解@Transactional支持 -->
    <tx:annotation-driven/>

测试代码地址

注解式整合：

①配置数据源

@Configuration //不添加无法被扫描
@PropertySource(value = "classpath:jdbc.properties")
public class DataSourceConfig {

    @Value("${jdbc.driverClassName}")
    private String driverClassName;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;
    
    //getting 、setting
}

②注册MyBatis 工厂及启用对应事务管理器

@Configuration
@EnableTransactionManagement // 开启声明式事务处理 等价于xml中<tx:annotation-driven/>
@ComponentScan(basePackages = {"com.coffeeandice.*"})
public class DatabaseConfig {

    /* @Autowired
     * private DataSourceConfig sourceConfig;
     * 不要采用这种方式注入DataSourceConfig,由于类的加载顺序影响会报空指针异常
     * 最好的方式是在DriverManagerDataSource构造中采用参数注入
     */

    /**
     * 配置数据源
     */
    @Bean
    public DriverManagerDataSource dataSource(DataSourceConfig sourceConfig) {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName(sourceConfig.getDriverClassName());
        dataSource.setUrl(sourceConfig.getUrl());
        dataSource.setUsername(sourceConfig.getUsername());
        dataSource.setPassword(sourceConfig.getPassword());
        return dataSource;
    }


    /**
     * 配置mybatis 会话工厂
     *
     * @param dataSource 这个参数的名称需要保持和上面方法名一致 才能自动注入,因为
     *                   采用@Bean注解生成的bean 默认采用方法名为名称，当然也可以在使用@Bean时指定name属性
     */
    @Bean
    public SqlSessionFactoryBean sessionFactoryBean(DriverManagerDataSource dataSource) throws IOException {
        SqlSessionFactoryBean sessionFactoryBean = new SqlSessionFactoryBean();
        sessionFactoryBean.setDataSource(dataSource);
        PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        sessionFactoryBean.setMapperLocations(resolver.getResources("classpath*:/mapper/**/*.xml"));

        //这里可以采取配置文件
        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
        //   sessionFactoryBean.setConfigLocation(resolver.getResource("classpath:mybatisConfig.xml"));
        //开启驼峰命名
        configuration.setMapUnderscoreToCamelCase(true);
        //打印查询
        configuration.setLogImpl(StdOutImpl.class);
        //更多settings配置项可以参考官方文档: http://www.mybatis.org/mybatis-3/zh/configuration.html
        sessionFactoryBean.setConfiguration(configuration);
        sessionFactoryBean.setTypeAliasesPackage("com.coffeeandice.entity");
        return sessionFactoryBean;
    }

    /**
     * 配置mybatis 会话工厂
     */
    @Bean
    public MapperScannerConfigurer MapperScannerConfigurer() {
        MapperScannerConfigurer configurer = new MapperScannerConfigurer();
        //本处指定配置类的名称
        configurer.setSqlSessionFactoryBeanName("sessionFactoryBean");
        configurer.setBasePackage("com.coffeeandice.mapper");
        return configurer;
    }

    /**
     * 定义事务管理器
     */
    @Bean
    public DataSourceTransactionManager transactionManager(DriverManagerDataSource dataSource) {
        DataSourceTransactionManager manager = new DataSourceTransactionManager();
        manager.setDataSource(dataSource);
        return manager;
    }


}

测试代码地址