Spring框架整合MyBatis框架是一个常见的需求,特别是在Java企业级应用中。这种整合可以充分利用Spring的依赖注入(IoC)和面向切面编程(AOP)功能,以及MyBatis在数据持久化方面的优势。以下是Spring框架整合MyBatis框架的详细步骤和要点:
一、整合背景与目的
整合Spring和MyBatis的主要目的是将MyBatis的数据访问层交给Spring管理,实现更高效的依赖注入和事务管理。整合后,开发者可以更加专注于业务逻辑的实现,而不需要过多地关注数据访问层的配置和管理。
二、整合步骤
1. 引入依赖
首先,需要在项目的pom.xml
文件中引入Spring和MyBatis的相关依赖,以及数据库驱动和连接池等依赖。确保MyBatis和Spring的版本兼容,以及数据库驱动与数据库版本匹配。
xml复制代码
dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
<version>5.3.4</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>5.3.4</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.3.4</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>5.3.4</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-expression</artifactId>
<version>5.3.4</version>
</dependency>
<dependency>
<groupId>aopalliance</groupId>
<artifactId>aopalliance</artifactId>
<version>1.0</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.6</version>
</dependency>
<dependency>
<groupId>org.hamcrest</groupId>
<artifactId>hamcrest-core</artifactId>
<version>2.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.18</version>
</dependency>
<!-- Spring整合MyBatis所需要的包 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>2.0.6</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.3.4</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>5.3.4</version>
</dependency>
<dependency>
<groupId>commons-dbcp</groupId>
<artifactId>commons-dbcp</artifactId>
<version>1.4</version>
</dependency>
<dependency>
<groupId>commons-pool</groupId>
<artifactId>commons-pool</artifactId>
<version>1.6</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>RELEASE</version>
<scope>compile</scope>
</dependency>
</dependencies>
2. 配置数据源
在Spring的配置文件中配置数据源(DataSource),通常使用连接池来管理数据库连接。配置信息可以放在XML配置文件中,也可以使用Java配置类。
xml复制代码
<!-- XML配置示例 -->
<bean id="dataSource" class="com.zaxxer.hikari.HikariDataSource">
<property name="driverClassName" value="com.mysql.cj.jdbc.Driver"/>
<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/yourdb?serverTimezone=UTC"/>
<property name="username" value="root"/>
<property name="password" value="password"/>
<!-- 其他连接池配置 -->
</bean>
3. 配置SqlSessionFactory
在Spring配置文件中配置SqlSessionFactory
,它是MyBatis的核心接口,用于创建SqlSession
。通过SqlSessionFactoryBean
可以将数据源和MyBatis的配置文件(如mybatis-config.xml
)注入到SqlSessionFactory
中。
xml复制代码
<!-- XML配置示例 -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
<property name="configLocation" value="classpath:mybatis-config.xml"/>
</bean>
如果没有mybatis-config.xml
配置文件,也可以将所有配置都放在Spring配置文件中。
4. 配置Mapper接口
MyBatis通过Mapper接口来定义数据访问操作。在Spring配置文件中,可以使用MapperScannerConfigurer
来批量扫描Mapper接口,并自动将它们注册为Spring的Bean。
xml复制代码
<!-- XML配置示例 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.example.mapper"/>
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
</bean>
或者,可以使用@Mapper
注解在每个Mapper接口上,并通过组件扫描来自动注册它们。
5. 配置事务管理器
在Spring配置文件中配置事务管理器(DataSourceTransactionManager
),并将其与数据源关联起来。然后,可以使用Spring的声明式事务管理来管理数据库事务。
xml复制代码
<!-- XML配置示例 -->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref