MyBatis 注解开发详解

MyBatis 注解开发详解

MyBatis 支持使用注解来进行数据库操作。注解方式将 SQL 语句直接写在 Java 接口中，通过注解来完成 CRUD（增删改查）操作，省去了使用 XML 配置的繁琐步骤。这种方式适合简单项目或快速原型开发，因为它更直观，可以直接在代码中查看和修改 SQL 语句。

然而，在实际开发中，更推荐使用 XML 配置的方式进行 MyBatis 开发。这样做的主要好处是，当需要修改 SQL 语句时，不需要更改 Java 代码，避免频繁修改源代码带来的风险。此外，XML 配置文件的形式更有利于 SQL 语句的管理和维护，尤其是在项目复杂度较高、SQL 语句较多的情况下。

以下是使用注解方式进行 MyBatis 开发的详细说明。

---

一、使用注解完成 CRUD 操作

1. 配置文件 SqlMapConfig.xml

在 SqlMapConfig.xml 中注册 Mapper 接口有两种常见方式：

• 第一种方式：直接引入单个 Mapper 接口类。这种方式适用于小型项目或接口数量较少的情况。
• 第二种方式：引入整个包下的所有接口。这种方式更为灵活，可以自动扫描指定包中的所有接口，适用于较大项目。

<mappers>
    <!-- 第一种方式：class 引入单个接口 -->
    <mapper class="com.qcby.dao.UserAnnoDao"/>

    <!-- 第二种方式：引入整个包下的所有接口 -->
    <package name="com.qcby.dao"/>
</mappers>

2. UserDao 接口及注解

在 UserDao 接口中，通过注解实现对数据库的增删改查操作。常用注解包括：

• @Select：用于查询操作。
• @Insert：用于插入数据。
• @Update：用于更新数据。
• @Delete：用于删除数据。
• @Results 和 @Result：用于映射查询结果到 Java 对象属性。

import com.qcby.entity.User;
import org.apache.ibatis.annotations.*;

import java.util.List;

public interface UserDao {

    // 查询所有用户
    @Select("SELECT * FROM user")
    @Results(id = "userMap", value = {
        @Result(property = "id", column = "id"),
        @Result(property = "username", column = "username"),
        @Result(property = "birthday", column = "birthday"),
        @Result(property = "sex", column = "sex"),
        @Result(property = "address", column = "address")
    })
    List<User> findAll();

    // 根据 ID 查询用户
    @Select("SELECT * FROM user WHERE id = #{id}")
    @ResultMap("userMap")
    User findById(int id);

    // 插入新用户
    @Insert("INSERT INTO user(username, birthday, sex, address) VALUES(#{username}, #{birthday}, #{sex}, #{address})")
    @SelectKey(statement = "SELECT last_insert_id()", keyProperty = "id", before = false, resultType = Integer.class)
    int insert(User user);

    // 更新用户
    @Update("UPDATE user SET username = #{username}, birthday = #{birthday}, sex = #{sex}, address = #{address} WHERE id = #{id}")
    int update(User user);

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

    // 查询用户数量
    @Select("SELECT COUNT(*) FROM user")
    int findCount();

    // 模糊查询
    @Select("SELECT * FROM user WHERE username LIKE #{username}")
    List<User> findByName(String username);
}

3. UserTest 测试方法

为了验证 UserDao 接口的正确性，可以通过单元测试进行测试。在测试类 UserTest 中，主要步骤包括：

• 初始化 MyBatis 配置，创建 SqlSession。
• 通过 SqlSession 获取 UserDao 接口的代理对象。
• 使用代理对象调用接口方法，执行数据库操作。
• 在测试方法执行前后，分别进行资源的初始化和销毁。

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
import java.util.List;

public class UserTest {

    private InputStream in;
    private SqlSession session;
    private UserDao mapper;

    @Before
    public void init() throws IOException {
        in = Resources.getResourceAsStream("SqlMapConfig.xml");
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
        session = factory.openSession();
        mapper = session.getMapper(UserDao.class);
    }

    @After
    public void destroy() throws IOException {
        session.close();
        in.close();
    }

    @Test
    public void findAll() {
        List<User> users = mapper.findAll();
        users.forEach(System.out::println);
    }

    @Test
    public void findById() {
        User user = mapper.findById(4);
        System.out.println(user);
    }

    @Test
    public void insert() {
        User user = new User();
        user.setUsername("小美");
        user.setSex("女");
        user.setBirthday(new Date());
        user.setAddress("保定");
        mapper.insert(user);
        session.commit();
    }

    @Test
    public void update() {
        User user = new User();
        user.setId(22);
        user.setUsername("小美");
        user.setSex("女");
        user.setBirthday(new Date());
        user.setAddress("上海");
        mapper.update(user);
        session.commit();
    }

    @Test
    public void delete() {
        mapper.delete(22);
        session.commit();
    }

    @Test
    public void findCount() {
        int count = mapper.findCount();
        System.out.println(count);
    }

    @Test
    public void findByName() {
        List<User> users = mapper.findByName("%a%");
        users.forEach(System.out::println);
    }
}

---

二、使用注解完成多对一查询

在多对一的关系中，可以通过注解配置查询结果的映射关系，直接将查询结果映射到关联的 Java 对象中。

1. 多对一立即加载

立即加载的方式在查询主表数据时，会同时加载关联表的数据，适合数据量较小的情况。

StudentDao 接口

@Select("SELECT student.*, teacher.Tname FROM student LEFT JOIN teacher ON student.t_id = teacher.id")
@Results(value = {
    @Result(property = "id", column = "id"),
    @Result(property = "Sname", column = "Sname"),
    @Result(property = "sex", column = "sex"),
    @Result(property = "age", column = "age"),
    @Result(property = "t_id", column = "t_id"),
    @Result(property = "teacher.Tname", column = "Tname")
})
List<Student> getStudent();

2. 多对一延迟加载

延迟加载的方式只有在需要访问关联数据时才会查询关联表的数据，适合数据量较大的情况，可以提高查询性能。

StudentDao 接口

@Select("SELECT * FROM student")
@Results(value = {
    @Result(property = "id", column = "id"),
    @Result(property = "Sname", column = "Sname"),
    @Result(property = "sex", column = "sex"),
    @Result(property = "age", column = "age"),
    @Result(property = "teacher", column = "t_id", one = @One(select = "com.qcby.dao.TeacherDao.getTeacher", fetchType = FetchType.LAZY))
})
List<Student> getStudent();

TeacherDao 接口

@Select("SELECT * FROM teacher WHERE id = #{t_id}")
Teacher getTeacher(Integer id);

---

三、使用注解完成一对多查询

在一对多的关系中，可以通过注解配置关联表的数据映射，直接将关联的数据映射到集合属性中。

TeacherDao 接口

@Select("SELECT * FROM Teacher")
@Results(value = {
    @Result(property = "id", column = "id"),
    @Result(property = "Tname", column = "Tname"),
    @Result(property = "students", column = "id", many = @Many(select = "com.qcby.dao.StudentDao.findByUid", fetchType = FetchType.LAZY))
})
List<Teacher> findAllLazy();

StudentDao 接口

@Select("SELECT * FROM student WHERE t_id = #{t_id}")
Student findByUid(int uid);

---

总结

MyBatis 注解开发的方式通过将 SQL 语句直接嵌入到 Java 代码中，省去了 XML 配置的繁琐步骤，适合快速开发和简单项目。然而，对于复杂项目，建议使用 XML 配置的方式进行 SQL 语句的管理，以提高代码的可维护性和可扩展性。