之前在Spring Boot中整合MyBatis時(shí),采用了注解的配置方式,相信很多人還是比較喜歡這種優(yōu)雅的方式的,也收到不少讀者朋友的反饋和問題,主要集中于針對(duì)各種場(chǎng)景下注解如何使用,下面就對(duì)幾種常見的情況舉例說(shuō)明用法。
在做下面的示例之前,先準(zhǔn)備一個(gè)整合好MyBatis的工程,可參見Spring Boot整合MyBatis,也可直接使用整合好的樣例:Chapter3-2-7。
傳參方式
下面通過(guò)幾種不同傳參方式來(lái)實(shí)現(xiàn)前文中實(shí)現(xiàn)的插入操作。
使用@Param
在之前的整合示例中我們已經(jīng)使用了這種最簡(jiǎn)單的傳參方式,如下:
@Insert("INSERT INTO USER(NAME, AGE) VALUES(#{name}, #{age})")
int insert(@Param("name") String name, @Param("age") Integer age);
這種方式很好理解,@Param
中定義的name
對(duì)應(yīng)了SQL中的#{name}
,age
對(duì)應(yīng)了SQL中的#{age}
。
使用Map
如下代碼,通過(guò)Map<String, Object>對(duì)象來(lái)作為傳遞參數(shù)的容器:
@Insert("INSERT INTO USER(NAME, AGE) VALUES(#{name,jdbcType=VARCHAR}, #{age,jdbcType=INTEGER})")
int insertByMap(Map<String, Object> map);
對(duì)于Insert語(yǔ)句中需要的參數(shù),我們只需要在map中填入同名的內(nèi)容即可,具體如下面代碼所示:
Map<String, Object> map = new HashMap<>();
map.put("name", "CCC");
map.put("age", 40);
userMapper.insertByMap(map);
使用對(duì)象
除了Map對(duì)象,我們也可直接使用普通的Java對(duì)象來(lái)作為查詢條件的傳參,比如我們可以直接使用User對(duì)象:
@Insert("INSERT INTO USER(NAME, AGE) VALUES(#{name}, #{age})")
int insertByUser(User user);
這樣語(yǔ)句中的#{name}
、#{age}
就分別對(duì)應(yīng)了User對(duì)象中的name
和age
屬性。
增刪改查
MyBatis針對(duì)不同的數(shù)據(jù)庫(kù)操作分別提供了不同的注解來(lái)進(jìn)行配置,在之前的示例中演示了@Insert
,下面針對(duì)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);
}
在完成了一套增刪改查后,不妨我們?cè)囋囅旅娴膯卧獪y(cè)試來(lái)驗(yàn)證上面操作的正確性:
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
@Transactional
public class ApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
@Rollback
public void testUserMapper() throws Exception {
// insert一條數(shù)據(jù),并select出來(lái)驗(yàn)證
userMapper.insert("AAA", 20);
User u = userMapper.findByName("AAA");
Assert.assertEquals(20, u.getAge().intValue());
// update一條數(shù)據(jù),并select出來(lái)驗(yàn)證
u.setAge(30);
userMapper.update(u);
u = userMapper.findByName("AAA");
Assert.assertEquals(30, u.getAge().intValue());
// 刪除這條數(shù)據(jù),并select驗(yàn)證
userMapper.delete(u.getId());
u = userMapper.findByName("AAA");
Assert.assertEquals(null, u);
}
}
返回結(jié)果的綁定
對(duì)于增、刪、改操作相對(duì)變化較小。而對(duì)于“查”操作,我們往往需要進(jìn)行多表關(guān)聯(lián),匯總計(jì)算等操作,那么對(duì)于查詢的結(jié)果往往就不再是簡(jiǎn)單的實(shí)體對(duì)象了,往往需要返回一個(gè)與數(shù)據(jù)庫(kù)實(shí)體不同的包裝類,那么對(duì)于這類情況,就可以通過(guò)@Results
和@Result
注解來(lái)進(jìn)行綁定,具體如下:
@Results({
@Result(property = "name", column = "name"),
@Result(property = "age", column = "age")
})
@Select("SELECT name, age FROM user")
List<User> findAll();
在上面代碼中,@Result中的property屬性對(duì)應(yīng)User對(duì)象中的成員名,column對(duì)應(yīng)SELECT出的字段名。在該配置中故意沒有查出id屬性,只對(duì)User對(duì)應(yīng)中的name和age對(duì)象做了映射配置,這樣可以通過(guò)下面的單元測(cè)試來(lái)驗(yàn)證查出的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
本文示例完整代碼: