MyBatis注解开发详解

MyBatis注解开发详解

一、前言

MyBatis是一个优秀的持久层框架，它支持定制化SQL、存储过程以及高级映射。MyBatis免除了几乎所有的JDBC代码和手动设置参数以及获取结果集。MyBatis可以使用简单的XML或注解来配置和映射原始类型、接口和Java POJO（Plain Old Java Objects，普通的Java对象）为数据库中的记录。

在MyBatis中，注解提供了一种更加简洁和直观的方式来配置SQL语句，而无需编写大量的XML配置文件。本文将详细介绍MyBatis的注解开发方式，并通过Java代码示例来展示其用法。

二、环境准备

在开始之前，请确保你的项目中已经引入了MyBatis的依赖。如果你使用Maven，可以在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>org.mybatisgroupId>
    <artifactId>mybatisartifactId>
    <version>你的MyBatis版本号version>
dependency>

同时，你也需要一个支持MyBatis的数据库环境，并在项目中配置好数据库连接信息。

三、MyBatis注解基础

MyBatis提供了多种注解来简化SQL映射的配置，常用的注解包括：

• @Select：用于执行查询操作。
• @Insert：用于执行插入操作。
• @Update：用于执行更新操作。
• @Delete：用于执行删除操作。
• @Results：用于配置结果集的映射。
• @Result：用于配置单个结果映射。
• @Param：用于传递参数。

四、使用注解配置Mapper接口

假设我们有一个User实体类和一个对应的user表，现在我们要使用注解来配置一个UserMapper接口。

User实体类

public class User {
    private Integer id;
    private String username;
    private String password;
    // 省略getter和setter方法
}

UserMapper接口

import org.apache.ibatis.annotations.*;

@Mapper
public interface UserMapper {

    // 查询用户列表
    @Select("SELECT * FROM user")
    @Results({
        @Result(column="id", property="id"),
        @Result(column="username", property="username"),
        @Result(column="password", property="password")
    })
    List<User> selectAll();

    // 根据ID查询用户
    @Select("SELECT * FROM user WHERE id = #{id}")
    User selectById(@Param("id") Integer id);

    // 插入用户
    @Insert("INSERT INTO user(username, password) VALUES(#{username}, #{password})")
    int insertUser(@Param("username") String username, @Param("password") String password);

    // 更新用户
    @Update("UPDATE user SET username=#{username}, password=#{password} WHERE id=#{id}")
    int updateUser(@Param("id") Integer id, @Param("username") String username, @Param("password") String password);

    // 删除用户
    @Delete("DELETE FROM user WHERE id = #{id}")
    int deleteUser(@Param("id") Integer id);
}

在上面的代码中，我们使用了@Mapper注解来标记UserMapper接口，这样MyBatis就能扫描到这个接口并创建相应的代理实现类。然后，我们在接口的方法上使用了@Select、@Insert、@Update和@Delete注解来分别指定SQL查询、插入、更新和删除语句。

注意，在@Select注解中，我们使用了@Results和@Result注解来配置结果集的映射关系。这是因为我们的查询语句返回了多个字段，需要将这些字段映射到User对象的属性上。

在需要传递参数的方法中，我们使用了@Param注解来指定参数的名称，这样在SQL语句中就可以通过#{参数名}的方式来引用这些参数了。

五、在Spring Boot中使用MyBatis注解

如果你使用的是Spring Boot框架，那么集成MyBatis注解开发将变得更加简单。Spring Boot提供了自动配置的功能，你只需要添加相应的依赖和配置，Spring Boot就会为你自动配置好MyBatis。

首先，在pom.xml中添加Spring Boot的MyBatis Starter依赖：

<dependency>
    <groupId>org.mybatis.spring.bootgroupId>
    <artifactId>mybatis-spring-boot-starterartifactId>
    <version>你的MyBatis Spring Boot Starter版本号version>
dependency>

然后，在application.properties或application.yml中配置MyBatis和数据库连接信息：

application.properties 示例

# 数据库连接信息
spring.datasource.url=jdbc:mysql://localhost:3306/your_database?useSSL=false&serverTimezone=UTC
spring.datasource.username=your_username
spring.datasource.password=your_password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# MyBatis配置
mybatis.type-aliases-package=com.example.model # 实体类所在的包路径
mybatis.mapper-locations=classpath:mapper/*.xml # 如果使用XML配置，指定映射文件位置

application.yml 示例

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/your_database?useSSL=false&serverTimezone=UTC
    username: your_username
    password: your_password
    driver-class-name: com.mysql.cj.jdbc.Driver
  mybatis:
    type-aliases-package: com.example.model # 实体类所在的包路径
    mapper-locations: classpath:mapper/*.xml # 如果使用XML配置，指定映射文件位置

在Spring Boot中，你通常不需要显式地配置SqlSessionFactory或SqlSessionTemplate，因为Spring Boot的自动配置会为你处理这些。你只需要在Mapper接口上使用@Mapper注解，Spring Boot就会创建代理实现类并注入到需要的地方。

六、使用MyBatis注解进行CRUD操作

现在，你可以在Service层或者Controller层中直接调用Mapper接口的方法进行CRUD操作了。Spring Boot会自动注入Mapper接口的实例。

UserService 示例

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    private final UserMapper userMapper;

    @Autowired
    public UserService(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    public List<User> getAllUsers() {
        return userMapper.selectAll();
    }

    public User getUserById(Integer id) {
        return userMapper.selectById(id);
    }

    public int insertUser(User user) {
        return userMapper.insertUser(user.getUsername(), user.getPassword());
    }

    public int updateUser(User user) {
        return userMapper.updateUser(user.getId(), user.getUsername(), user.getPassword());
    }

    public int deleteUser(Integer id) {
        return userMapper.deleteUser(id);
    }
}

在上面的UserService中，我们通过构造器注入的方式将UserMapper注入到UserService中，然后就可以在UserService的方法中调用UserMapper的方法来进行数据库操作了。

七、总结

MyBatis的注解开发方式提供了一种简洁、直观的方式来配置SQL语句和映射关系，减少了XML配置文件的编写量。在Spring Boot中，结合自动配置功能，可以更加便捷地使用MyBatis注解进行数据库操作。当然，注解方式并不完全替代XML配置方式，两者可以混合使用，根据项目的实际情况选择最适合的配置方式。