Spring Boot中使用MyBatis註解配置詳解(1)
之前在Spring Boot中整合MyBatis時,采用了註解的配置方式,相信很多人還是比較喜歡這種優雅的方式的,也收到不少讀者朋友的反饋和問題,主要集中於針對各種場景下註解如何使用,下面就對幾種常見的情況舉例說明用法。
在做下面的示例之前,先準備一個整合好MyBatis的工程,可參見Spring Boot整合MyBatis,也可直接使用整合好的樣例:Chapter3-2-7。
傳參方式
下面通過幾種不同傳參方式來實現前文中實現的插入操作。
@Insert("INSERT INTO USER(NAME, AGE) VALUES(#{name}, #{age})") int insert(@Param("name") String name, @Param("age") Integer age); 這種方式很好理解,@Param中定義的name對應了SQL中的#{name},age對應了SQL中的#{age}
使用Map
如下代碼,通過Map對象來作為傳遞參數的容器: @Insert("INSERT INTO USER(NAME, AGE) VALUES(#{name,jdbcType=VARCHAR}, #{age,jdbcType=INTEGER})") int insertByMap(Map<String, Object> map);
對於Insert語句中需要的參數,我們只需要在map中填入同名的內容即可,具體如下面代碼所示:
Map<String, Object> map = new HashMap<>(); map.put("name", "CCC"); map.put("age", 40); userMapper.insertByMap(map);
使用對象
除了Map對象,我們也可直接使用普通的Java對象來作為查詢條件的傳參,比如我們可以直接使用User對象:
@Insert("INSERT INTO USER(NAME, AGE) VALUES(#{name}, #{age})") int insertByUser(User user);
這樣語句中的#{name}
、#{age}
name
和age
屬性。
增刪改查
MyBatis針對不同的數據庫操作分別提供了不同的註解來進行配置,在之前的示例中演示了@Insert
,下面針對User表做一組最基本的增刪改查作為示例:
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); }
在完成了一套增刪改查後,不妨我們試試下面的單元測試來驗證上面操作的正確性:
@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); } }
返回結果的綁定
對於增、刪、改操作相對變化較小。而對於“查”操作,我們往往需要進行多表關聯,匯總計算等操作,那麽對於查詢的結果往往就不再是簡單的實體對象了,往往需要返回一個與數據庫實體不同的包裝類,那麽對於這類情況,就可以通過@Results
和@Result
註解來進行綁定,具體如下:
@Results({ @Result(property = "name", column = "name"), @Result(property = "age", column = "age") }) @Select("SELECT name, age FROM user") List<User> findAll();
在上面代碼中,@Result中的property屬性對應User對象中的成員名,column對應SELECT出的字段名。在該配置中故意沒有查出id屬性,只對User對應中的name和age對象做了映射配置,這樣可以通過下面的單元測試來驗證查出的id為null,而其他屬性不為null:
@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()); } }
後記
本文主要介紹幾種最為常用的方式,更多其他註解的使用可參見文檔:http://www.mybatis.org/mybatis-3/zh/java-api.html
本文示例完整代碼:Chapter3-2-8
Spring Boot中使用MyBatis註解配置詳解(1)