MyBatis注解开发

MyBatis注解开发

之前发布的内容都是都是基于xml文件的开发,现在介绍注解的使用
在介绍之前,先来说说xml文件和注解开发各有什么优缺点.
xml : sql语句和dao的内容分开,耦合度更低,但是比较麻烦
注解 : 使用注解开发更加简单,但是由于代码和注解内容在一起,耦合度较高

注解开发配置

注解开发省略了最复杂的sql映射文件,下面以一个简单的查找全部为例子,罗列一下需要的配置

  1. pom.xml文件中加入对应依赖
	<!--打包方式-->
    <packaging>jar</packaging>
	
	<!--配置依赖-->
    <dependencies>
    	<!--MyBatis依赖-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.1</version>
        </dependency>
        <!--MySQL依赖-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.9</version>
        </dependency>
        <!--日志文件的依赖-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.12</version>
        </dependency>
        <!--单元测试的依赖-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
  1. 创建实体类User,实现get,set方法,重写toString方法
public class User implements Serializable {

    private Integer id;
    private String username;
    private String address;
    private String sex;
    private Date birthday;

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

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

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

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

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

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

    public Integer getId() {
        return id;
    }

    public String getUsername() {
        return username;
    }

    public String getAddress() {
        return address;
    }

    public String getSex() {
        return sex;
    }

    public Date getBirthday() {
        return birthday;
    }
}
  1. 创建Dao层接口,作为持久层
package org.zjb.dao;

import org.apache.ibatis.annotations.Select;
import org.zjb.domain.User;

import java.util.List;

/**
 * MyBatis中对CRUD一共有4个注解
 * @Select @Insert @Update @Delete
 */
public interface IUserDao {

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

  1. 配置主配置文件
<?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="org.zjb.domain"/>
    </typeAliases>
    <!--配置环境-->
    <environments default="mysql">
        <environment id="mysql">
            <transactionManager type="JDBC"></transactionManager>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

    <!--指定带有注解的dao的位置-->
    <mappers>
        <package name="org.zjb.dao"/>
    </mappers>
</configuration>
  1. 写test测试类完成测试
public class MyBatisAnnoTest {

    /**
     * 测试基于注解的MyBatis的使用
     * @param args
     */
    public static void main(String[] args) throws IOException {
        // 1.获取字节输入流
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
        // 2.根据字节输入流构建SqlSessionFactory
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
        // 3.根据SqlSessionFactory生产一个SqlSession
        SqlSession session = factory.openSession();
        // 4.使用SqlSession获取dao的代理对象
        IUserDao userDao = session.getMapper(IUserDao.class);
        // 5.执行dao的方法
        List<User> users = userDao.findAll();
        for (User user : users) {
            System.out.println(user);
        }
        // 6.释放资源
        session.close();
        in.close();
    }
}
  1. 查看运行结果
    日志信息

注解开发和XML文件对比

对比
我们发现其实xml文件中的各个部分我们在注解开发中也可以对应的到,而且由于注解就在对应方法的上方,所以我们可以减少很多xml文件中需要特别对应的地方,更加方便快捷.

基于注解实现CRUD

没什么好说的,直接上代码吧
带注解的dao

/**
 * MyBatis中对CRUD一共有4个注解
 * @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);

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

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

    /**
     * 根据id模糊查询,不带占位符
     * @param username
     * @return
     */
    @Select("select * from user where username like #{username}")
    List<User> findUserByName1(String username);

    /**
     * 根据id模糊查询,带占位符, ${}中必须使用value
     * @param username
     * @return
     */
    @Select("select * from user where username like '%${value}%'")
    List<User> findUserByName2(String username);

    /**
     * 查询总用户数量
     * @return
     */
    @Select("select count(*) from user")
    Integer findTotalUser();
}

测试类

public class AnnotationCRUDTest {
    private InputStream in;
    private SqlSessionFactory factory;
    private SqlSession session;
    private IUserDao userDao;

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

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

    @Test
    public void testSave() {
        User user = new User();
        user.setUsername("胡图图");
        user.setAddress("翻斗大街");
        userDao.saveUser(user);
    }

    @Test
    public void testUpdate() {
        User user = new User();
        user.setUsername("胡英俊");
        user.setAddress("翻斗大街");
        user.setId(52);
        user.setSex("男");
        user.setBirthday(new Date());
        userDao.updateUser(user);
    }

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

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

    @Test
    public void testFindUserByName1() {
        List<User> users = userDao.findUserByName1("%王%");
        for (User user : users) {
            System.out.println(user);
        }
    }

    @Test
    public void testFindUserByName2() {
        List<User> users = userDao.findUserByName2("王");
        for (User user : users) {
            System.out.println(user);
        }
    }

    @Test
    public void testFindTotalUser() {
        System.out.println("总用户数量为" + userDao.findTotalUser());
    }
}

注解中的ResultMap

在前面xml配置文件的使用过程中,我们出现过这样的情况
由于查询结果表和实体类属性对应不上,所以我们使用标签ResultMap,在注解开发的过程中,我们也可以使用这个思想,不过这里使用的是注解的方式
我们先看实体类

public class User implements Serializable {

    private Integer userId;
    private String userName;
    private String userAddress;
    private String userSex;
    private Date userBirthday;

}

实体类的属性如上,表的列名为:

+----+--------------+---------------------+------+-----------------+
| id | username     | birthday            | sex  | address         |
+----+--------------+---------------------+------+-----------------+

为了能使他们匹配上,我们使用注解@Results, @Result 和 @ResultMap

  • @Results是一个集合,这个集合包含的元素是@Result,同时它有一个属性为id,表示唯一标识
  • @Result的作用是指定表列名和实体类属性的对应关系,同时id=true表示这个值是否为主键
  • @ResultMap这个注解的作用是引用@Results,它的value是一个字符串数组,数组的每个值就是@Results对应的id

管你听没听懂,看就完了
dao接口

public interface IUserDao {

    /**
     * 查询所有用户, 由于属性和列名不匹配, 使用@Results注解
     * @return
     */
    @Select("select * from user")
    @Results(id="userMap", value = {
            @Result(id=true,column = "id",property = "userId"),
            @Result(column = "username",property = "userName"),
            @Result(column = "address",property = "userAddress"),
            @Result(column = "sex",property = "userSex"),
            @Result(column = "birthday",property = "userBirthday"),
    })
    List<User> findAll();


    /**
     * 根据id查询用户信息
     * @param id
     */
    @Select("select * from user where id=#{id}")
    @ResultMap(value = {"userMap"})
    User findById(Integer id);

    /**
     * 根据id模糊查询,不带占位符
     * @param username
     * @return
     */
    @Select("select * from user where username like #{username}")
    // 当value数组只有一个元素时,可以如下简写
    @ResultMap("userMap")
    List<User> findUserByName(String username);

}

一对一,延迟/立即加载

还是用户和账户的例子,一个账户只能属于一个用户
我们想要在查询所有账户的同时查询出用户的信息,那么就需要一对一,在实体类Account中加入属性User user表示该账户对应的用户,同时立即加载该属性对应的用户信息.
Account实体类:

public class Account implements Serializable {

    private Integer id;
    private Integer uid;
    private Double money;

    // 多对一,实际上是一对一
    private User user;

    @Override
    public String toString() {
        return "Account{" +
                "id=" + id +
                ", uid=" + uid +
                ", money=" + money +
                '}';
    }

    public void setUser(User user) {
        this.user = user;
    }

    public User getUser() {
        return user;
    }

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

    public void setUid(Integer uid) {
        this.uid = uid;
    }

    public void setMoney(Double money) {
        this.money = money;
    }

    public Integer getId() {
        return id;
    }

    public Integer getUid() {
        return uid;
    }

    public Double getMoney() {
        return money;
    }
}

IAccountDao

public interface IAccountDao {

    /**
     * 查询所有账户,并且获取每个账户所属的用户信息
     * @return
     */
    @Select("select * from account")
    @Results(id = "accountMap", value = {
            @Result(id = true,property = "id", column = "id"),
            @Result(property = "uid", column = "uid"),
            @Result(property = "money", column = "money"),
            @Result(property = "user", column = "uid",
                one = @One(select = "org.zjb.dao.IUserDao.findById", fetchType = FetchType.EAGER)
            )
    })
    List<Account> findAll();
}

注解@One表示一对一关系,

  • select表示需要执行的sql语句,上面例子中该值代表的方法就是IUserDao中的findById(Integer id)
  • fetchType表示加载时机,有EAGER(立即), LAZY(延迟),DEFAULT(默认,一对一为立即)三个值
    带有one属性的@Result的column属性值表示执行延迟sql时需要传入的值

测试代码如下:

    @Test
    public void testFindAll() {
        List<Account> accounts = accountDao.findAll();
        for (Account account : accounts) {
            System.out.println("------账户-----");
            System.out.println(account);
            System.out.println(account.getUser());
        }
    }

一对多,延迟/立即加载

一个用户有多个账户,我们希望在查询用户信息的同时可以顺便查询出用户的账户,在来个延迟加载就更好了.
User实体类:

public class User implements Serializable {

    private Integer userId;
    private String userName;
    private String userAddress;
    private String userSex;
    private Date userBirthday;

    // 一对多,一个用户对应多个账户
    private List<Account> accounts;

    public void setAccounts(List<Account> accounts) {
        this.accounts = accounts;
    }

    public List<Account> getAccounts() {
        return accounts;
    }

    @Override
    public String toString() {
        return "User{" +
                "userId=" + userId +
                ", userName='" + userName + '\'' +
                ", userAddress='" + userAddress + '\'' +
                ", userSex='" + userSex + '\'' +
                ", userBirthday=" + userBirthday +
                '}';
    }

    public void setUserId(Integer userId) {
        this.userId = userId;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public void setUserAddress(String userAddress) {
        this.userAddress = userAddress;
    }

    public void setUserSex(String userSex) {
        this.userSex = userSex;
    }

    public void setUserBirthday(Date userBirthday) {
        this.userBirthday = userBirthday;
    }

    public Integer getUserId() {
        return userId;
    }

    public String getUserName() {
        return userName;
    }

    public String getUserAddress() {
        return userAddress;
    }

    public String getUserSex() {
        return userSex;
    }

    public Date getUserBirthday() {
        return userBirthday;
    }
}

IUserDao

    /**
     * 查询所有用户, 由于属性和列名不匹配, 使用@Results注解
     * 同时延迟加载获取用户下的账户信息
     * @return
     */
    @Select("select * from user")
    @Results(id="userMap", value = {
            @Result(id=true,column = "id",property = "userId"),
            @Result(column = "username",property = "userName"),
            @Result(column = "address",property = "userAddress"),
            @Result(column = "sex",property = "userSex"),
            @Result(column = "birthday",property = "userBirthday"),
            @Result(property = "accounts", column = "id",
                many = @Many(select = "org.zjb.dao.IAccountDao.findAccountByUid", fetchType = FetchType.LAZY)
            )
    })
    List<User> findAll();

测试类:

    @Test
    public void testFindAll() {
        List<User> users = userDao.findAll();
        for (User user : users) {
            System.out.println("----用户信息----");
            System.out.println(user);
            System.out.println(user.getAccounts());
        }
    }

MyBatis二级缓存

一级缓存不用开启就可以使用,二级缓存需要开启
现在对二级缓存进行测试:
test测试代码如下(未开启二级缓存):

public class SecondLevelCacheTest {

    private InputStream in;
    private SqlSessionFactory factory;
    private SqlSession session;
    private IUserDao userDao;

    @Before
    public void init() throws IOException {
        in = Resources.getResourceAsStream("SqlMapConfig.xml");
        factory = new SqlSessionFactoryBuilder().build(in);

    }

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

    @Test
    public void testFindById() {
        SqlSession session = factory.openSession();
        IUserDao userDao = session.getMapper(IUserDao.class);
        User user = userDao.findById(52);
        System.out.println(user);
        session.close(); // 释放一级缓存

        SqlSession session1 = factory.openSession(); // 再次打开缓存
        IUserDao userDao1 = session1.getMapper(IUserDao.class);
        User user2 = userDao1.findById(52);
        System.out.println(user2);
        session1.close(); // 释放一级缓存
    }
}

结果如下:
日志文件
相同内容执行两次,可见没有开启二级缓存

现在开启,需要两步

  1. 主配置文件中设置二级缓存的全局开关
    <!--设置开启二级缓存-->
    <settings>
        <setting name="cacheEnabled" value="true"/>
    </settings>
  1. 在对应的dao接口上加入@CacheNamespace(blocking = true)
    这个@CacheNamespace注解的blocking属性默认为false,代表不启用二级缓存
    继续运行上面的测试代码,结果如下:
    日志信息
    可见只查询了一次数据库,走了二级缓存.
  • 2
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值