如何将 MyBatis 配置到 Spring MVC 中

MyBatis 是一款非常流行的 ORM 框架，它可以帮助我们简化数据库操作。在 Spring MVC 中，我们可以将 MyBatis 配置到项目中，以便更方便地使用 MyBatis。本文将详细讲解如何将 MyBatis 配置到 Spring MVC 中，并提供两个示例说明。

配置 MyBatis

在 Spring MVC 中，我们可以使用 MyBatis 来访问数据库。下面是一个示例代码，演示如何配置 MyBatis：

1. 在 pom.xml 文件中添加以下依赖：

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>3.5.7</version>
</dependency>
<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis-spring</artifactId>
  <version>2.0.7</version>
</dependency>

在上面的代码中，我们添加了 MyBatis 和 MyBatis-Spring 的依赖。

1. 在 Spring MVC 的配置文件中添加以下代码：

<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/test"/>
  <property name="username" value="root"/>
  <property name="password" value="root"/>
</bean>

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

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

在上面的代码中，我们使用 DriverManagerDataSource 类来配置数据源，使用 SqlSessionFactoryBean 类来配置 SqlSessionFactory，使用 MapperScannerConfigurer 类来配置 MapperScanner。

1. 在 MyBatis 的配置文件中添加以下代码：

<configuration>
  <settings>
    <setting name="cacheEnabled" value="true"/>
  </settings>
  <typeAliases>
    <package name="com.example.entity"/>
  </typeAliases>
  <mappers>
    <mapper resource="mapper/UserMapper.xml"/>
  </mappers>
</configuration>

在上面的代码中，我们配置了缓存、类型别名和映射器。

示例说明

示例1：使用 MyBatis 访问数据库

在 Spring MVC 中使用 MyBatis 访问数据库非常简单。下面是一个示例代码，演示如何使用 MyBatis 访问数据库：

1. 创建一个 User 实体类：

public class User {
  private Long id;
  private String name;
  private Integer age;
  // 省略 getter 和 setter 方法
}

1. 创建一个 UserMapper 接口：

public interface UserMapper {
  User getUserById(Long id);
}

1. 创建一个 UserMapper.xml 文件：

<mapper namespace="com.example.mapper.UserMapper">
  <select id="getUserById" resultType="com.example.entity.User">
    select * from user where id = #{id}
  </select>
</mapper>

在上面的代码中，我们定义了一个 getUserById 方法，用于根据 id 获取用户信息。

1. 在 Controller 中使用 UserMapper：

@RestController
@RequestMapping("/users")
public class UserController {
  @Autowired
  private UserMapper userMapper;

  @GetMapping("/{id}")
  public User getUserById(@PathVariable("id") Long id) {
    return userMapper.getUserById(id);
  }
}

在上面的代码中，我们使用 @Autowired 注解将 UserMapper 注入到 Controller 中，并在 getUserById 方法中使用 UserMapper 获取用户信息。

示例2：使用 MyBatis 分页查询

在 Spring MVC 中使用 MyBatis 分页查询非常简单。下面是一个示例代码，演示如何使用 MyBatis 分页查询：

1. 创建一个 Page 实体类：

public class Page {
  private Integer pageNum;
  private Integer pageSize;
  // 省略 getter 和 setter 方法
}

1. 创建一个 UserMapper 接口：

public interface UserMapper {
  List<User> getUserListByPage(Page page);
  Integer getUserCount();
}

1. 创建一个 UserMapper.xml 文件：

<mapper namespace="com.example.mapper.UserMapper">
  <select id="getUserListByPage" resultType="com.example.entity.User">
    select * from user limit #{pageNum}, #{pageSize}
  </select>
  <select id="getUserCount" resultType="java.lang.Integer">
    select count(*) from user
  </select>
</mapper>

在上面的代码中，我们定义了一个 getUserListByPage 方法，用于分页查询用户信息，定义了一个 getUserCount 方法，用于获取用户总数。

1. 在 Controller 中使用 UserMapper：

@RestController
@RequestMapping("/users")
public class UserController {
  @Autowired
  private UserMapper userMapper;

  @GetMapping
  public Map<String, Object> getUserListByPage(Page page) {
    Map<String, Object> result = new HashMap<>();
    List<User> userList = userMapper.getUserListByPage(page);
    Integer userCount = userMapper.getUserCount();
    result.put("userList", userList);
    result.put("userCount", userCount);
    return result;
  }
}

在上面的代码中，我们使用 @Autowired 注解将 UserMapper 注入到 Controller 中，并在 getUserListByPage 方法中使用 UserMapper 分页查询用户信息和获取用户总数。

结论

在本文中，我们详细讲解了如何将 MyBatis 配置到 Spring MVC 中，并提供了两个示例说明。无论是访问数据库还是分页查询，MyBatis 都提供了很多方便的功能来帮助我们开发 Spring MVC 项目。