MyBatis快速入门（十三）：MyBatis注解开发

MyBatis注解开发

MyBatis中常用的注解

• @Insert:实现插入
• @Update:实现更新
• @Delete:实现删除
• @Select:实现查询
• @Result:实现结果集封装
• @Results:可以与@Result一起使用，封装多个结果集
• @ResultMap:引用@Results定义的封装
• @One:实现一对一结果集封装
• @Many:实现一对多结果集封装
• @SelectProvider: 实现动态SQL映射
• @CacheNamespace:实现注解二级缓存的使用

使用注解实现基本的CRUD

实体类User如下：

package com.zfnotes.beans;

import java.util.Date;

public class User {
    private Integer id;
    private String username;
    private Date birthday;
    private String sex;
    private String address;
    //省略getter和setter方法
}

持久层接口UserDao的内容如下：

注意： 如果使用了注解，就不能再在对应位置编写相应的映射文件了，否则无论是否使用映射文件，mybatis都会报错。

package com.zfnotes.dao;

import com.zfnotes.beans.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;

public interface UserDao {
    /**
     * 查询所有User
     * @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}, address=#{address}, birthday=#{birthday} where id=#{id}")
    void updateUser(User user);

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

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

    /**
     * 根据用户名称模糊查询
     * @param name
     * @return
     */
    @Select("select * from user where username like #{name}")
    List<User> findByName(String name);

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

在主配置文件中配置好mappers标签中内容，也可以使用mapper标签的class属性：

<!--指定带有注解的dao接口所在位置-->
<mappers>
    <package name="com.zfnotes.dao"/>
</mappers>

测试文件和测试方法大家可以参照前面讲过的内容自行编写，这里不再赘述。

使用注解解决字段名和属性名不匹配的问题

将User实体类的内容该如下：

package com.zfnotes.beans;
import java.util.Date;

public class User {
    private Integer userId;
    private String userName;
    private Date userBirthday;
    private String userSex;
    private String userAddress;
    //省略getter和setter方法
}

此时可以使用@Results和@Result注解：

package com.zfnotes.dao;

import com.zfnotes.beans.User;
import org.apache.ibatis.annotations.*;

import java.util.List;

public interface UserDao {
    /**
     * 查询所有User
     * @return
     */
    @Select("select * from user")
    @Results(id = "userMap", value = {
            @Result(id = true, column="id", property = "userId"),
            @Result(column="username", property = "userName"),
            @Result(column="sex", property = "userSex"),
            @Result(column="address", property = "userAddress"),
            @Result(column="birthday", property = "userBirthday")
    })
    List<User> findAll();

    /**
     * 根据id查询
     * @param id
     * @return
     */
    @Select("select * from user where id=#{id}")
    @ResultMap("userMap")
    User findById(int id);
}

详解：

• @Results注解：相当于映射文件中的resultMap标签。
  • id属性：唯一标识，可以供其他方法使用@ResultMap注解引用。
• @Result注解：相当于映射文件中的result标签。
  • id属性：标识是否为主键。

测试文件和其他内容请自行编写。

注解实现一对一查询

这里使用账户(Account)和用户(User)的一对一关系。

修改AccountDao接口中的List<Account> findAll();方法:

@Select("select * from account")
@Results(id="accountMap", value = {
    @Result(id = true, column = "id", property = "id"),
    @Result(column = "uid", property = "uid"),
    @Result(column = "money", property = "money"),
    @Result(property = "user", column = "uid",
            one = @One(select = "com.zfnotes.dao.UserDao.findById", , fetchType = FetchType.EAGER)
           )
})
List<Account> findAll();

详解：

• @One注解：相当于association标签。
  • fetchType属性：会覆盖全局的配置参数lazyLoadingEnabled。FetchType.EAGER表示立即加载。

其他内容请自行配置。

注解实现一对多查询

这里使用用户(User)和账户(Account)的一对多关系。

修改UserDao接口中的List<User> findAll();方法：

@Select({"select * from user"})
@Results(id = "userMap", value = {
    @Result(id = true, column="id", property = "id"),
    @Result(column="username", property = "username"),
    @Result(column="sex", property = "sex"),
    @Result(column="address", property = "address"),
    @Result(column="birthday", property = "birthday"),
    @Result(property = "accounts", column = "id",
            many = @Many(select = "com.zfnotes.dao.AccountDao.findAccountByUid", fetchType = FetchType.LAZY))
})
List<User> findAll();

详解：

• @Many注解：相当于collection标签。
• FetchType.LAZY：表示懒加载。

其他内容请自行配置。

基于注解的二级缓存

在主配置文件中开启二级缓存

因为cacheEnabled的取值默认就为true，所以这一步可以省略不配置。

<settings>
    <!-- 开启二级缓存的支持 -->
    <setting name="cacheEnabled" value="true"/>
</settings>

在在持久层接口中使用注解配置二级缓存

@CacheNamespace(blocking = true)
public interface UserDao {
	...
}