您现在的位置是：首页 >技术教程 >你知道Spring是如何整合MyBatis的吗？网站首页技术教程

Spring 和 MyBatis 是两个在 Java 开发中广泛应用的优秀框架。Spring 提供了强大的容器和一系列的特性，可以方便地进行依赖注入、AOP 编程等操作。MyBatis 是一个轻量级的持久层框架，它提供了灵活的 SQL 映射和数据库访问功能。在实际项目中，将 Spring 和 MyBatis 整合在一起使用，可以发挥它们各自的优势，简化开发流程，提高系统的可维护性和扩展性。本文将介绍如何使用 Spring 整合 MyBatis，以及一些实践中的技巧和注意事项。

前置条件

在开始本文之前，需要老铁们具备以下基础知识：

• Java 开发基础，如面向对象编程、Java 类库等。
• Spring 框架的基本概念，包括 IoC（控制反转）和 DI（依赖注入）等。
• MyBatis 框架的基本概念，包括 XML 配置文件、Mapper 接口和 SQL 映射等。

整合 Spring 和 MyBatis

整合 Spring 和 MyBatis 可以通过两种方式实现：使用 Spring Boot 或者手动配置。下面将分别介绍这两种方式的具体实现方法。

使用 Spring Boot 整合

Spring Boot 提供了快速构建应用的能力，并且默认集成了 MyBatis。通过使用 Spring Boot，我们可以简化整合的过程，并且减少大量的配置。下面是使用 Spring Boot 整合的步骤：

1. 创建 Spring Boot 项目。

   可以使用 Spring Initializr（https://start.spring.io/）来创建一个新的 Spring Boot 项目。在创建项目时，选择适当的依赖，包括 Spring Web、Spring Data JDBC 和 MyBatis 等。

2. 配置数据库连接。

   在 application.properties 或 application.yml 文件中配置数据库连接信息，包括数据库 URL、用户名、密码等。

   spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
   spring.datasource.username=root
   spring.datasource.password=123456
   
   

3. 创建实体类和 Mapper 接口。

   创建与数据库表对应的实体类，并使用注解 @Table 和 @Column 来定义表名和字段名。同时，创建对应的 Mapper 接口，并使用注解 @Mapper 来标识该接口。

   @Table("user")
   public class User {
       @Column("id")
       private Long id;
   
       @Column("name")
       private String name;
   
       // getter and setter
   }
   
   @Mapper
   public interface UserMapper {
       User selectById(Long id);
       void insert(User user);
       void update(User user);
       void delete(Long id);
   }
   
   

4. 编写 MyBatis 的 XML 配置文件。

在资源目录下创建 mybatis-config.xml 文件，用于配置 MyBatis 的一些全局属性和设置。

<?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>
    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>
</configuration>

在配置文件中，可以设置一些全局属性，如日志实现类等。

1. 编写 SQL 映射文件。

   在资源目录下创建 UserMapper.xml 文件，用于编写 SQL 映射语句。

   <?xml version="1.0" encoding="UTF-8"?>
   <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
   <mapper namespace="com.example.mapper.UserMapper">
       <select id="selectById" resultType="com.example.entity.User">
           SELECT * FROM user WHERE id = #{id}
       </select>
       <insert id="insert" parameterType="com.example.entity.User">
           INSERT INTO user(name, age) VALUES (#{name}, #{age})
       </insert>
       <update id="update" parameterType="com.example.entity.User">
           UPDATE user SET name = #{name}, age = #{age} WHERE id = #{id}
       </update>
       <delete id="delete" parameterType="java.lang.Long">
           DELETE FROM user WHERE id = #{id}
       </delete>
   </mapper>
   
   

   在 SQL 映射文件中，通过 <mapper> 标签指定了对应的 Mapper 接口，并编写了各种 SQL 语句。

2. 配置 Spring Boot 应用。

   在 Spring Boot 项目的主类上使用注解 @MapperScan 来扫描 Mapper 接口所在的包，并将其注册为 Spring 的 Bean。

   @SpringBootApplication
   @MapperScan("com.example.mapper")
   public class MyApplication {
       public static void main(String[] args) {
           SpringApplication.run(MyApplication.class, args);
       }
   }
   
   

   在上述示例中，使用了 @MapperScan 注解来指定 Mapper 接口所在的包。

3. 使用 MyBatis。

   在 Service 层或 Controller 层中注入 Mapper 接口，并直接使用其方法进行数据库操作。

   @Service
   public class UserService {
       @Autowired
       private UserMapper userMapper;
   
       public User getUserById(Long id) {
           return userMapper.selectById(id);
       }
   
       public void addUser(User user) {
           userMapper.insert(user);
       }
   
       public void updateUser(User user) {
           userMapper.update(user);
       }
   
       public void deleteUser(Long id) {
           userMapper.delete(id);
       }
   }
   
   

   在上述示例中，通过 @Autowired 注解将 UserMapper 接口注入到 UserService 中，然后在方法中直接调用 Mapper 的方法进行数据库操作。

手动配置整合

如果不使用 Spring Boot，也可以手动配置 Spring 和 MyBatis 的整合。下面是手动配置的步骤：

1. 导入依赖

   在项目的构建文件中，添加 Spring 和 MyBatis 的依赖。可以使用 Maven 或 Gradle 等构建工具进行依赖管理。

2. 配置数据源

   在 Spring 配置文件中，配置数据库连接信息和数据源。可以使用 Spring 提供的数据源，如 org.springframework.jdbc.datasource.DriverManagerDataSource。

   <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
       <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
       <property name="url" value="jdbc:mysql://localhost:3306/mydatabase"/>
       <property name="username" value="root"/>
       <property name="password" value="123456"/>
   </bean>
   
   

3. 配置事务管理器

   在 Spring 配置文件中，配置事务管理器，用于管理数据库事务。可以使用 Spring 提供的事务管理器，如 org.springframework.jdbc.datasource.DataSourceTransactionManager。

   <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
       <property name="dataSource" ref="dataSource"/>
   </bean>
   
   

4. 配置 MyBatis 的 SqlSessionFactory

   在 Spring 配置文件中，配置 MyBatis 的 SqlSessionFactory。可以使用 Spring 提供的 org.mybatis.spring.SqlSessionFactoryBean。

   <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
       <property name="dataSource" ref="dataSource"/>
       <property name="configLocation" value="classpath:mybatis-config.xml"/>
       <property name="mapperLocations" value="classpath*:mapper/*.xml"/>
   </bean>
   
   

   在上述配置中，dataSource 属性指定了数据源，configLocation 属性指定了 MyBatis 的配置文件路径，mapperLocations 属性指定了 Mapper 接口的 XML 配置文件路径。

5. 配置 MapperScannerConfigurer

   在 Spring 配置文件中，配置 MapperScannerConfigurer，用于扫描 Mapper 接口并将其注册为 Spring 的 Bean。

   <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
       <property name="basePackage" value="com.example.mapper"/>
   </bean>
   
   

   在上述配置中，basePackage 属性指定了 Mapper 接口所在的包路径。

6. 编写 Mapper 接口和 SQL 语句

   编写 Mapper 接口，该接口需要继承 MyBatis 的 Mapper 接口，并定义对应的 SQL 语句和参数。

   public interface UserMapper extends Mapper<User> {
       @Select("SELECT * FROM user WHERE id = #{id}")
       User selectById(@Param("id") Long id);
   
       @Insert("INSERT INTO user(name, age) VALUES (#{name}, #{age})")
       @Options(useGeneratedKeys = true, keyProperty = "id")
       void insert(User user);
   
       @Update("UPDATE user SET name = #{name}, age = #{age} WHERE id = #{id}")
       void update(User user);
   
       @Delete("DELETE FROM user WHERE id= #{id}")
   		void delete(@Param("id") Long id);
   	}
   
   

   在上述示例中，使用了 MyBatis 的注解来定义 SQL 语句，并使用 @Param 注解指定参数的名称。

   1. 配置事务

   在需要进行事务管理的方法上添加 @Transactional 注解，以实现事务的控制。

   @Service
   public class UserService {
       @Autowired
       private UserMapper userMapper;
   
       @Transactional
       public User getUserById(Long id) {
           return userMapper.selectById(id);
       }
   
       @Transactional
       public void addUser(User user) {
           userMapper.insert(user);
       }
   
       @Transactional
       public void updateUser(User user) {
           userMapper.update(user);
       }
   
       @Transactional
       public void deleteUser(Long id) {
           userMapper.delete(id);
       }
   }
   

   在上述示例中，使用了 @Transactional 注解来标识需要进行事务管理的方法。

   1. 使用 Spring 容器

      在应用启动时，通过加载 Spring 配置文件，初始化 Spring 容器，并从容器中获取相应的 Bean 进行操作。

      public class Application {
          public static void main(String[] args) {
              ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
              UserService userService = context.getBean(UserService.class);
      
              // 使用 userService 进行数据库操作
          }
      }
      
      

      在上述示例中，通过加载 Spring 配置文件 applicationContext.xml 初始化 Spring 容器，并从容器中获取 UserService 的实例进行数据库操作。

   总结

   本文介绍了如何使用 Spring 整合 MyBatis，并提供了两种方法：使用 Spring Boot 和手动配置。使用 Spring Boot 可以快速搭建整合环境，减少配置工作；而手动配置则更加灵活，适用于一些特殊需求的场景。通过整合 Spring 和 MyBatis，我们可以充分发挥它们的优势，提高开发效率和系统的可维护性。希望本文对于读者在实践中整合 Spring 和 MyBatis 有所帮助。