Spring Boot中使用MyBatis注解配置详解
TroyEaster
8年前
<p>之前在Spring Boot中整合MyBatis时，采用了注解的配置方式，相信很多人还是比较喜欢这种优雅的方式的，也收到不少读者朋友的反馈和问题，主要集中于针对各种场景下注解如何使用，下面就对几种常见的情况举例说明用法。</p> <p>在做下面的示例之前，先准备一个整合好MyBatis的工程，可参见 <a href="/misc/goto?guid=4959677037263765739" rel="nofollow,noindex">Spring Boot整合MyBatis</a> ，也可直接使用整合好的样例： <a href="/misc/goto?guid=4959677037351453773" rel="nofollow,noindex">Chapter3-2-7</a> 。</p> <h2>传参方式</h2> <p>下面通过几种不同传参方式来实现前文中实现的插入操作。</p> <p>使用@Param</p> <p>在之前的整合示例中我们已经使用了这种最简单的传参方式，如下：</p> <pre> <code class="language-java">@Insert("INSERT INTO USER(NAME, AGE) VALUES(#{name}, #{age})") int insert(@Param("name") String name, @Param("age") Integer age);</code></pre> <p>这种方式很好理解， @Param 中定义的 name 对应了SQL中的 #{name} ， age 对应了SQL中的 #{age} 。</p> <p>使用Map</p> <p>如下代码，通过Map 对象来作为传递参数的容器：</p> <pre> <code class="language-java">@Insert("INSERT INTO USER(NAME, AGE) VALUES(#{name,jdbcType=VARCHAR}, #{age,jdbcType=INTEGER})") int insertByMap(Map<String, Object> map);</code></pre> <p>对于Insert语句中需要的参数，我们只需要在map中填入同名的内容即可，具体如下面代码所示：</p> <pre> <code class="language-java">Map<String, Object> map = new HashMap<>(); map.put("name", "CCC"); map.put("age", 40); userMapper.insertByMap(map);</code></pre> <p>使用对象</p> <p>除了Map对象，我们也可直接使用普通的Java对象来作为查询条件的传参，比如我们可以直接使用User对象:</p> <pre> <code class="language-java">@Insert("INSERT INTO USER(NAME, AGE) VALUES(#{name}, #{age})") int insertByUser(User user);</code></pre> <p>这样语句中的 #{name} 、 #{age} 就分别对应了User对象中的 name 和 age 属性。</p> <h2>增删改查</h2> <p>MyBatis针对不同的数据库操作分别提供了不同的注解来进行配置，在之前的示例中演示了 @Insert ，下面针对User表做一组最基本的增删改查作为示例：</p> <pre> <code class="language-java">public interface UserMapper { @Select("SELECT * FROM user WHERE name = #{name}") User findByName(@Param("name") String name); @Insert("INSERT INTO user(name, age) VALUES(#{name}, #{age})") int insert(@Param("name") String name, @Param("age") Integer age); @Update("UPDATE user SET age=#{age} WHERE name=#{name}") void update(User user); @Delete("DELETE FROM user WHERE id =#{id}") void delete(Long id); }</code></pre> <p>在完成了一套增删改查后，不妨我们试试下面的单元测试来验证上面操作的正确性：</p> <pre> <code class="language-java">@RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration(classes = Application.class) @Transactional public class ApplicationTests { @Autowired private UserMapper userMapper; @Test @Rollback public void testUserMapper() throws Exception { // insert一条数据，并select出来验证 userMapper.insert("AAA", 20); User u = userMapper.findByName("AAA"); Assert.assertEquals(20, u.getAge().intValue()); // update一条数据，并select出来验证 u.setAge(30); userMapper.update(u); u = userMapper.findByName("AAA"); Assert.assertEquals(30, u.getAge().intValue()); // 删除这条数据，并select验证 userMapper.delete(u.getId()); u = userMapper.findByName("AAA"); Assert.assertEquals(null, u); } }</code></pre> <h2>返回结果的绑定</h2> <p>对于增、删、改操作相对变化较小。而对于“查”操作，我们往往需要进行多表关联，汇总计算等操作，那么对于查询的结果往往就不再是简单的实体对象了，往往需要返回一个与数据库实体不同的包装类，那么对于这类情况，就可以通过 @Results 和 @Result 注解来进行绑定，具体如下：</p> <pre> <code class="language-java">@Results({ @Result(property = "name", column = "name"), @Result(property = "age", column = "age") }) @Select("SELECT name, age FROM user") List<User> findAll();</code></pre> <p>在上面代码中，@Result中的property属性对应User对象中的成员名，column对应SELECT出的字段名。在该配置中故意没有查出id属性，只对User对应中的name和age对象做了映射配置，这样可以通过下面的单元测试来验证查出的id为null，而其他属性不为null：</p> <pre> <code class="language-java">@Test @Rollback public void testUserMapper() throws Exception { List<User> userList = userMapper.findAll(); for(User user : userList) { Assert.assertEquals(null, user.getId()); Assert.assertNotEquals(null, user.getName()); } }</code></pre> <h2>后记</h2> <p>本文主要介绍几种最为常用的方式，更多其他注解的使用可参见文档： <a href="/misc/goto?guid=4959677037420789163" rel="nofollow,noindex">http://www.mybatis.org/mybatis-3/zh/java-api.html</a></p> <p>本文示例完整代码： <a href="/misc/goto?guid=4959677037499766733" rel="nofollow,noindex">Chapter3-2-8</a></p> <p> </p> <p>来自：http://blog.didispace.com/mybatisinfo/</p> <p> </p>