Mybatis注解开发（超详细）

Mybatis注解开发

• mybatis的常用注解
• 使用 Mybatis 注解实现基本 CRUD
• • 项目目录结构
  • 编写实体类
  • 使用注解方式开发持久层接口
  • 编写 SqlMapConfig.xml 配置文件
  • 编写测试代码
• 使用注解实现复杂关系映射开发
• • 复杂关系映射的注解说明
  • 项目目录
  • 使用注解实现一对一复杂关系映射及立即加载
  • • 添加 User 实体类及 Account 实体类
    • 添加账户的持久层接口并使用注解配置
    • 添加用户的持久层接口并使用注解配置
    • 测试一对一关联及立即加载
  • 使用注解实现一对多复杂关系映射及延迟加载
  • • User 实体类加入 List``
    • 编写用户的持久层接口并使用注解配置
    • 编写账户的持久层接口并使用注解配置
    • 编写测试代码
• 回顾下一级缓存
• mybatis 基于注解的二级缓存
• • 在 SqlMapConfig.xml 中开启二级缓存支持
  • 在持久层接口中使用注解配置二级缓存
  • 编写测试二级缓存的测试类

mybatis的常用注解

注解

说明

@Insert

实现新增

@Delete

实现删除

@Update

实现更新

@Select

实现查询

@Result

实现结果集封装

@Results

可以与@Result 一起使用，封装多个结果集

@ResultMap

实现引用@Results 定义的封装

@One

实现一对一结果集封装

@Many

实现一对多结果集封装

@SelectProvider

实现动态 SQL 映射

@CacheNamespace

实现注解二级缓存的使用

使用 Mybatis 注解实现基本 CRUD

项目目录结构

编写实体类

User：

package com.keafmd.domain;

import java.io.Serializable;
import java.util.Date;

/**
 * Keafmd
 *
 * @ClassName: User
 * @Description: User实体类
 * @author: 
 * @date: 2021-02-16 20:28
 */
public class User implements Serializable {
    private Integer id;
    private String username;
    private String address;
    private String sex;
    private Date birthday;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + ''' +
                ", address='" + address + ''' +
                ", sex='" + sex + ''' +
                ", birthday=" + birthday +
                '}';
    }
}

使用注解方式开发持久层接口

IUserDao：

package com.keafmd.dao;

import com.keafmd.domain.User;
import org.apache.ibatis.annotations.Delete;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;

import java.util.List;

/**
 * Keafmd
 *
 * @ClassName: IUserDao
 * @Description:
 * @author: 
 * @date: 2021-02-16 20:30
 */

/**
 * 在mybatis中针对CRUD一共有四个注解
 * @Select @Insert @Update @Delete
 */
public interface IUserDao {

    /**
     * 查询所有用户
     * @return
     */
    @Select("select * from user")
    List<User> findAll();

    /**
     * 保存用户
     * @param user
     */
    @Insert("insert into user(username,address,sex,birthday)values(#{username},#{address},#{sex},#{birthday})")
    void saveUser(User user);

    /**
     * 更新用户
     * @param user
     */
    @Update("update user set username=#{username},sex=#{sex},birthday=#{birthday},address=#{address} where id=#{id}")
    void updateUser(User user);

    /**
     * 删除用户
     * @param userId
     */
    @Delete("delete from user where id=#{id}")
    void deleteUser(Integer userId);

    /**
     * 根据id查询用户
     * @param userId
     * @return
     */
    @Select("select * from user where id=#{id}")
    User findById(Integer userId);

    /**
     * 根据用户名称模糊查询
     * @param username
     * @return
     */
    //@Select("select * from user where username like #{username}") //占位符
    @Select("select * from user where username like '%${value}%'")  //字符串拼接
    List<User> findByName(String username);

    /**
     * 查询总数量
     * @return
     */
    @Select("select count(*) from user")
    int findTotal();

}

通过注解方式，就不需要再去编写 UserDao.xml 映射文件了。

编写 SqlMapConfig.xml 配置文件

SqlMapConfig.xml：

<?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>
    <!--引入外部配置文件-->
    <properties resource="jdbcConfig.properties"></properties>
    <!--配置别名-->
    <typeAliases>
        <package name="com.keafmd.domain"/>
    </typeAliases>
    <!--配置环境-->
    <environments default="mysql">
        <environment id="mysql">
            <transactionManager type="JDBC"></transactionManager>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"></property>
                <property name="url" value="${jdbc.url}"></property>
                <property name="username" value="${jdbc.username}"></property>
                <property name="password" value="${jdbc.password}"></property>
            </dataSource>
        </environment>
    </environments>
    <!--指定带有注解的dao接口所在位置-->
    <mappers>
        <package name="com.keafmd.dao"></package>
    </mappers>
</configuration>

编写测试代码

AnnotationCRUDTest：

package com.keafmd.test;

import com.keafmd.dao.IUserDao;
import com.keafmd.domain.User;
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.InputStream;
import java.util.Date;
import java.util.List;

/**
 * Keafmd
 *
 * @ClassName: AnnotationCRUDTest
 * @Description: 注解开发CRUD测试
 * @author: 
 * @date: 2021-02-16 21:05
 */
public class AnnotationCRUDTest {
    private InputStream in;
    private SqlSessionFactory factory;
    private SqlSession session;
    private IUserDao userDao;

    @Before
    public void init() throws Exception{
        in = Resources.getResourceAsStream("SqlMapConfig.xml");
        factory = new SqlSessionFactoryBuilder().build(in);
        session = factory.openSession();
        userDao = session.getMapper(IUserDao.class);
    }

    @After
    public void destory() throws Exception{
        session.commit();
        session.close();
        in.close();
    }

    @Test
    public void testSave(){
        User user = new User();
        user.setUsername("mybatis annotation");
        user.setAddress("北京");

        userDao.saveUser(user);
    }

    @Test
    public void testUpdate(){
        User user = new User();
        user.setId(55);
        user.setUsername("mybatis annotation");
        user.setAddress("北京");
        user.setSex("男");
        user.setBirthday(new Date());

        userDao.updateUser(user);
    }

    @Test
    public void testDelete(){
        userDao.deleteUser(54);
    }

    @Test
    public void testFindOne(){
        User user = userDao.findById(55);
        System.out.println(user);
    }

    @Test
    public void testFindByName(){
        //List<User> users = userDao.findByName("%Keafmd%");
        List<User> users = userDao.findByName("Keafmd");
        for (User user : users) {
            System.out.println(user);
        }
    }

    @Test
    public void testFindTotal(){
       int tota