MyBatis07：使用注解开发

本文为 SSM 框架系列之 MyBatis 第七部分：使用注解开发
其它内容的链接如下：
【1】MyBatis01：初识 MyBatis 与 第一个 MyBaits 程序
【2】MyBatis02：CRUD 操作
【3】MyBatis03：配置解析
【4】MyBatis04：作用域和生命周期
【5】MyBatis05：分页
【6】MyBatis06：日志
【7】MyBatis07：使用注解开发
【8】MyBatis08：ResultMap 的结果集映射
【9】MyBatis09：动态 SQL 与缓存

8 使用注解开发

8.1 为什么使用注解开发

使用注解来映射简单语句会使代码显得更加简洁。除了 MyBatis 使用 XML 配置文件外，其它第三方框架一般都是使用注解来进行开发的。

因为对于 MyBatis，稍微复杂一点的语句，Java 注解不仅力不从心，还会让你本就复杂的 SQL 语句更加混乱不堪。 因此，如果你需要做一些很复杂的操作，最好用 XML 来映射语句。

选择何种方式来配置映射，以及认为是否应该要统一映射语句定义的形式，完全取决于你和你的团队。

8.2 使用注解进行 CRUD 操作

8.2.1 操作步骤

1. 在 MyBatis 配置文件中配置映射器（mappers）；
2. 先在 Mapper 接口中写入约束的方法名；
3. 再在约束的方法上写入对应的注解；
4. 写一个测试类进行测试。

8.2.2 查（Retrieve）

（1） 查询对应表中的所有用户

1）在 MyBatis 配置文件中配置映射器（mappers）；

<!--主程序中每一个 Mapper.xml 都必须写一个标签，否则会报错。因为使用注解
开发是没有 Mapper.xml 的，所以这里需要使用映射器接口实现类的完全限定类名的形式-->
<mappers>
    <mapper class="sharm.dao.UserMapper"/>
</mappers>

2）先在 Mapper 接口中写入约束的方法名，并在约束的方法上写入对应的注解；

/**
* 查询对应表中的所有对象
* @return 所有对象
*/
@Select("select * from mybatis.user")
List<User> selectUser();

3）写一个测试类进行测试。

@Test
public void testSelectUser(){
    SqlSession session = MyBatisUtils.getSession();
    UserMapper mapper = session.getMapper(UserMapper.class);
    List<User> users = mapper.selectUser();

    for (User user: users){
        System.out.println(user);
    }
    session.close();
}

（2） 分页查询表中的对象

1）在 MyBatis 配置文件中配置映射器（mappers）；

<!--主程序中每一个 Mapper.xml 都必须写一个标签，否则会报错。因为使用注解
开发是没有 Mapper.xml 的，所以这里需要使用映射器接口实现类的完全限定类名的形式-->
<mappers>
    <mapper class="sharm.dao.UserMapper"/>
</mappers>

2）先在 Mapper 接口中写入约束的方法名，并在约束的方法上写入对应的注解；

/**
 * 分页查询表中的对象
 * 其中#{startIndex},#{pageSize} 中的参数名一定要和导入进去的 Map 的键相同
 * 引用类型不需要写 @Param
 * @return 所有对象
 */
@Select("select * from mybatis.user limit #{startIndex},#{pageSize}")
List<User> selectUserByPage(Map<String,Integer> map);

3）写一个测试类进行测试。

@Test
public void testSelectUserByPage(){
    SqlSession session = MyBatisUtils.getSession();
    UserMapper mapper = session.getMapper(UserMapper.class);

    HashMap<String, Integer> hashMap = new HashMap<>();
    hashMap.put("startIndex",0);
    hashMap.put("pageSize",1);

    List<User> users = mapper.selectUserByPage(hashMap);

    for (User user: users){
        System.out.println(user);
    }
    session.close();
}

（3） 根据指定 id 号查询对象

1）在 MyBatis 配置文件中配置映射器（mappers）；

<!--主程序中每一个 Mapper.xml 都必须写一个标签，否则会报错。因为使用注解
开发是没有 Mapper.xml 的，所以这里需要使用映射器接口实现类的完全限定类名的形式-->
<mappers>
    <mapper class="sharm.dao.UserMapper"/>
</mappers>

2）先在 Mapper 接口中写入约束的方法名，并在约束的方法上写入对应的注解；

/**
 *  根据指定 id 号查询对象
 */
@Select("select * from mybatis.user where id = #{id}")
User selectUserById(@Param("id") int id);

3）写一个测试类进行测试。

@Test
public void testSelectUserById (){
    // 这里测试的方法的步骤也是死的
    // 1 首先得到利用工具类得到 session 对象
    SqlSession session = MyBatisUtils.getSession();
    // 2 然后利用该方法得到对应的 mapper 对象
    UserMapper mapper = session.getMapper(UserMapper.class);

    // 3 直接利用 mapper 的方法
    User user = mapper.selectUserById(1);
    System.out.println(user);
    session.close();
}

8.2.3 增（Create）

1）在 MyBatis 配置文件中配置映射器（mappers），同时设置事务自动提交；

<mappers>
    <mapper class="sharm.dao.UserMapper"/>
</mappers>

//2 获取SqlSession连接
public static SqlSession getSession(){
    return sqlSessionFactory.openSession(true);
}

2）先在 Mapper 接口中写入约束的方法名，并在约束的方法上写入对应的注解；

/**
 *  在表中插入一个数据
 */
@Insert("insert into mybatis.user(id, name, password) values(#{id}, #{name}, #{password})")
void addUser(User user);

3）写一个测试类进行测试。

@Test
public void testAddUser(){
    SqlSession session = MyBatisUtils.getSession();
    UserMapper sessionMapper = session.getMapper(UserMapper.class);

    User jack = new User(4, "jack", "123456");
    sessionMapper.addUser(jack);

    session.close();
}

8.2.4 改（Update）

1）在 MyBatis 配置文件中配置映射器（mappers），同时设置事务自动提交；

<mappers>
    <mapper class="sharm.dao.UserMapper"/>
</mappers>

//2 获取SqlSession连接
public static SqlSession getSession(){
    return sqlSessionFactory.openSession(true);
}

2）先在 Mapper 接口中写入约束的方法名，并在约束的方法上写入对应的注解；

/**
 * 更新表中的某一个对象
 */
@Update("update mybatis.user set name = #{name}, password = #{password} where id = #{id}")
void updateUser(User user);

3）写一个测试类进行测试。

@Test
public void testUpdateUser(){
    SqlSession session = MyBatisUtils.getSession();
    UserMapper sessionMapper = session.getMapper(UserMapper.class);

    User jula = new User(4, "luma", "123456");
    sessionMapper.updateUser(jula);

    session.close();
}

8.2.5 删（Delete）

1）在 MyBatis 配置文件中配置映射器（mappers），同时设置事务自动提交；

<mappers>
    <mapper class="sharm.dao.UserMapper"/>
</mappers>

 //2 获取SqlSession连接
 public static SqlSession getSession(){
     return sqlSessionFactory.openSession(true);
 }

2）先在 Mapper 接口中写入约束的方法名，并在约束的方法上写入对应的注解；

 /**
  * 删除表中的某一个用户
  */
 @Delete("delete from mybatis.user where id = #{id}")
 void deleteUser(int id);

3）写一个测试类进行测试。

@Test
public void testDeleteUser(){
    SqlSession session = MyBatisUtils.getSession();
    UserMapper sessionMapper = session.getMapper(UserMapper.class);

    sessionMapper.deleteUser(2);

    session.close();
}

8.3 总结

1. 当在方法只接受一个参数的情况下，可以不使用@Param；当在方法接受多个参数的情况下，建议一定要使用@Param注解给参数命名；
2. 如果参数是 JavaBean 或者包装类 ， 则不能使用@Param；