Mybatis注解开发

Mybatis注解开发

这几年来注解开发越来越流行，Mybatis也可以使用注解开发方式，这样我们就可以减少编写Mapper映射文件了。本次我们先围绕一些基本的 CRUD来学习，再学习复杂映射关系及延迟加载。

工程目录结构如下：

3.1 使用Mybatis注解实现基本CRUD

单表的CRUD操作是最基本的操作，前面我们的学习都是基于Mybaits的映射文件来实现的。

3.1.1 Mybatis的注解说明

@Insert:实现新增
@Update:实现更新
@Delete:实现删除
@Select:实现查询
@Result:实现结果集封装
@Results:可以与@Result一起使用，封装多个结果集
@One:实现一对一结果集封装
@Many:实现一对多结果集封装
@SelectProvider: 实现动态SQL映射

我们也通过查看Mybatis官方文档来学习Mybatis注解开发

3.1.2 使用注解方式开发UserMapper接口实现增删改查

在原有的项目中，把UserMapper接口中添加CRUD方法，并带上基本的注解。

public interface UserMapper {

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

    /***
     * 根据名字模糊查询
     * @param name
     * @return
     * @Select(value = "select * from user where username like#{name}")
     */
    @Select(value = "select * from user where username like '%${value}%'")
    List<User> findUserListByName(String name);

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

    /***
     * 根据ID修改用户信息
     * @param user
     * @return
     */
    @Update(value = "update user set username=#{username},sex=#{sex} where id=#{id}")
    int updateUserByUserId(User user);

    /***
     * 根据ID删除
     * @param i
     * @return
     */
    @Delete(value = "delete from user where id=#{id}")
    int deleteByUserId(int i);

    /****
     * 查询数据条数
     * @return
     */
    @Select("select count(*) from user")
    int findCount();
}

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

修改SqlMapConfig 配置文件

因为不存在UserMapper.xml文件了，这样我们就不需要在Mybatis配置文件中加载UserMapper.xml映射文件了。此时我们只需要Mybatis 的配置文件能够加载我们的UserMapper接口就可以了。

<!--映射文件指定-->
<mappers>
    <package name="com.itheima.mapper" />
</mappers>

编写测试方法

public class MyBatisTest {

    private UserMapper userMapper;
    private SqlSession session;
    private SqlSessionFactory sqlSessionFactory;
    private InputStream is;

    @Before
    public void init() throws IOException {
        //读取配置文件
        is = Resources.getResourceAsStream("SqlMapConfig.xml");

        //创建SqlSessionFactoryBuilder对象
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        //通过SqlSessionBuilder对象构建一个SqlSessionFactory
        sqlSessionFactory = builder.build(is);

        //通过SqlSessionFactory构建一个SqlSession接口的代理实现类
        session = sqlSessionFactory.openSession();

        //通过SqlSession实现增删改查
        userMapper = session.getMapper(UserMapper.class);
    }

    /***
     * 根据用户名模糊查询
     */
    @Test
    public void testFindUserListByName(){
        //List<User> users = userMapper.findUserListByName("%王%");
        List<User> users = userMapper.findUserListByName("王");
    }

    /***
     * 查询所有用户
     */
    @Test
    public void testFindAll(){
        List<User> users = userMapper.findAll();
    }

    /***
     * 根据ID修改用户
     */
    @Test
    public void testUpdateUserByUserId(){
        User user = new User();
        user.setUsername("张三");
        user.setSex("女");
        user.setId(42);
        int mcount = userMapper.updateUserByUserId(user);
    }


    /***
     * 根据ID删除
     */
    @Test
    public void testDeleteByUserId(){
        int dcount = userMapper.deleteByUserId(49);
    }


    /*****
     * 查询总数据条数
     */
    @Test
    public void testFundCount(){
        int count = userMapper.findCount();
    }

    @After
    public void destroy() throws IOException {
        //提交事务
        session.commit();
        //关闭资源
        session.close();
        is.close();
    }
}

3.2 使用注解实现数据库表列名和JavaBean属性名不一致

在现实开发中，经常会有数据库表列名和JavaBean的属性名不一致，针对这种情况，我们可以用@Results注解来解决。

@Results注解
代替的是标签<resultMap> 
该注解中可以使用单个@Result注解，也可以使用@Result集合
@Results（{@Result（），@Result（）}）或@Results（@Result（））

@Resutl注解
代替了 <id>标签和<result>标签
@Result 中 属性介绍：
column 数据库的列名
Property需要装配的属性名
one  需要使用的@One注解（@Result（one=@One）（）））
many  需要使用的@Many注解（@Result（many=@many）（）））

在UserMapper接口的getAll方法上加上注解映射即可实现映射转换

@Select(value = "select * from user")
@Results(id="UserResultMap",value={
        @Result(id = true,column ="id",property ="userId"),
        @Result(column ="id",property ="userId"),
        @Result(column ="userName",property ="userName"),
        @Result(column ="birthday",property ="userBirthday"),
        @Result(column ="sex",property ="userSex"),
        @Result(column ="address",property ="userAddress")
})
List<User> findAll();

• @Results的id表示唯一标识，其他地方可以直接引用。
• @Result注解的id属性表示主键列，其他的表示非主键列。
• @Result注解中的column和查询的SQL语句中的列名保持一致，代表列名。
• @Result注解中的property和JavaBean中的属性名保持一致。

3.3 使用注解实现复杂关系映射开发

实现复杂关系映射之前我们可以在映射文件中通过配置 来实现，但通过后我们发现并没有@ResultMap这个注解。下面我们一起来学习@Results注解，@Result注解，@One注解，@Many注解。

实现后的工程结构如下：

复杂关系映射的注解说明

@One注解（一对一）
代替了<assocation>标签，是多表查询的关键，在注解中用来指定子查询返回单一对象。
@One注解属性介绍：
select  指定用来多表查询的sqlmapper
fetchType会覆盖全局的配置参数lazyLoadingEnabled。。
使用格式：
@Result(column=" ",property="",one=@One(select=""))

@Many注解（多对一）
           代替了<Collection>标签,是是多表查询的关键，在注解中用来指定子查询返回对象集合。
注意：聚集元素用来处理“一对多”的关系。需要指定映射的Java实体类的属性，属性的javaType（一般为ArrayList）但是注解中可以不定义；
使用格式：
@Result(property="",column="",many=@Many(select=""))

3.3.1 使用注解实现一对一复杂关系映射及延迟加载

需求：加载账户信息时并且加载该账户的用户信息，根据情况可实现延迟加载。（注解方式实现）

添加User实体类及Account实体类

public class Account {
    private Integer id;
    private Integer uid;
    private Double money;

    //加上一个用户对象，has a的关系
    private User user;
    //get...set...toStrirng...
}

User实体类

public class User implements Serializable {
    private Integer id;           //主键ID
    private String username;     //用户名
    private Date birthday;       //用户生日
    private String sex;          //用户性别
    private String address;      //用户住址
    //get...set...toString...
}

添加UserMapper接口及AccountMapper接口

public interface UserMapper {
    @Select("select * from user where id=#{userid}")
    User findByUserId(Integer userid);
}

public interface AccountMapper {
    /**
     * 查询所有账户
     * 实现一对一查询
     * @return
     */
    @Select(value = "select * from account")
    @Results({
            @Result(property ="user" ,column ="uid" ,
                    one = @One(select = "com.itheima.mapper.UserMapper.findByUserId",
                            fetchType = FetchType.EAGER))
    })
    List<Account> findAll();
}

测试一对一关联及延迟加载

/***
 * 查询所有账户信息
 * 实现一对一查询
 */
@Test
public void testFindAllAccounts(){
    List<Account> accounts = accountMapper.findAll();
    for (Account account : accounts) {
        System.out.println("-----账户信息----------");
        System.out.println(account);
        System.out.println(account.getUser());
    }
}

3.3.2 使用注解实现一对多复杂关系映射

需求：查询用户信息时，也要查询他的账户列表。使用注解方式实现。

分析：一个用户具有多个账户信息，所以形成了用户(User)与账户(Account)之间的一对多关系。

User实体类及Account实体类

public class User implements Serializable {
    private Integer id;           //主键ID
    private String username;     //用户名
    private Date birthday;       //用户生日
    private String sex;          //用户性别
    private String address;      //用户住址

    //用于保存用户多个账号信息
    private List<Account> accList;
    //get...set...toString...
}

public class Account {
    private Integer id;
    private Integer uid;
    private Double money;

    //get...set...toStrirng...
}

UserMapper接口及AccountMapper接口

//根据uid查询账户信息
public interface AccountMapper {

    /***
     * 根据ID查询用户
     * @param uid
     * @return
     */
    @Select("select * from account where uid=#{uid}")
    List<Account> findAccountListByUid(Integer uid);
}


//实现查询用户信息时，关联加载他的账户列表，并且要求使用延迟加载
public interface UserMapper {

    /***
     * 查询所有
     * 一对多
     * @return
     */
    @Select(value = "select * from user")
    @Results(
            @Result(column = "id",property ="accList",
                    many = @Many(select = "com.itheima.mapper.AccountMapper.findAccountListByUid",
                            fetchType = FetchType.LAZY))
    )
    List<User> findAll();
}

• @Many:相当于 的配置
• select属性：代表将要执行的sql语句
• fetchType属性：代表加载方式，一般如果要延迟加载都设置为LAZY的值

添加测试方法

/***
 * 查询所有用户
 * 实现一对多查询
 */
@Test
public void testFindAllUsers(){
    List<User> users = userMapper.findAll();
    for (User user : users) {
        System.out.println(user);
        System.out.println(user.getAccList());
    }
}

3.4 使用注解实现缓存

首先我们需要开启缓存，然后加上缓存注解

修改SqlMapConfig.xml

<settings>
    <!--开启缓存-->
    <setting name="cacheEnabled" value="true" />
</settings>

在对应Mapper接口中加入如下注解即可实现二级缓存

@CacheNamespace(blocking = true)