之前我們了解了兩種在Spring Boot中訪問(wèn)關(guān)系型數(shù)據(jù)庫(kù)的方式:
使用JdbcTemplate訪問(wèn)MySQL數(shù)據(jù)庫(kù)
雖然Spring Data JPA在國(guó)外廣泛流行,但是在國(guó)內(nèi)還是MyBatis的天下。所以,今天這篇我們將具體說(shuō)說(shuō)如何在Spring Boot中整合MyBatis完成關(guān)系型數(shù)據(jù)庫(kù)的增刪改查操作。
整合MyBatis
第一步:新建Spring Boot項(xiàng)目,在pom.xml
中引入MyBatis的Starter以及MySQL Connector依賴,具體如下:
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.1</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
關(guān)于mybatis-spring-boot-starter
的版本需要注意:
2.1.x
版本適用于:MyBatis 3.5+、Java 8+、Spring Boot 2.1+2.0.x
版本適用于:MyBatis 3.5+、Java 8+、Spring Boot 2.0/2.11.3.x
版本適用于:MyBatis 3.4+、Java 6+、Spring Boot 1.5
其中,目前還在維護(hù)的是2.1.x
版本和1.3.x
版本。
第二步:同之前介紹的使用jdbc模塊和jpa模塊連接數(shù)據(jù)庫(kù)一樣,在application.properties
中配置mysql的連接配置
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
當(dāng)然,也可以不用默認(rèn)數(shù)據(jù)源,如果要使用Druid作為數(shù)據(jù)庫(kù)連接池的話,可以參見《使用國(guó)產(chǎn)數(shù)據(jù)庫(kù)連接池Druid》一文。
第三步:Mysql中創(chuàng)建一張用來(lái)測(cè)試的表,比如:User表,其中包含id(BIGINT)、age(INT)、name(VARCHAR)字段。
具體創(chuàng)建命令如下:
CREATE TABLE `User` (
`id` bigint NOT NULL AUTO_INCREMENT,
`name` varchar(100) COLLATE utf8mb4_general_ci DEFAULT NULL,
`age` int DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci
第四步:創(chuàng)建User表的映射對(duì)象User:
@Data
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
public User(String name, Integer age) {
this.name = name;
this.age = age;
}
}
第五步:創(chuàng)建User表的操作接口:UserMapper。在接口中定義兩個(gè)數(shù)據(jù)操作,一個(gè)插入,一個(gè)查詢,用于后續(xù)單元測(cè)試驗(yàn)證。
@Mapper
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);
}
第六步:創(chuàng)建Spring Boot主類
@SpringBootApplication
public class Chapter35Application {
public static void main(String[] args) {
SpringApplication.run(Chapter35Application.class, args);
}
}
第七步:創(chuàng)建單元測(cè)試。具體測(cè)試邏輯如下:
- 插入一條name=AAA,age=20的記錄,然后根據(jù)name=AAA查詢,并判斷age是否為20
- 測(cè)試結(jié)束回滾數(shù)據(jù),保證測(cè)試單元每次運(yùn)行的數(shù)據(jù)環(huán)境獨(dú)立
@Slf4j
@RunWith(SpringRunner.class)
@SpringBootTest
public class Chapter35ApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
@Rollback
public void test() throws Exception {
userMapper.insert("AAA", 20);
User u = userMapper.findByName("AAA");
Assert.assertEquals(20, u.getAge().intValue());
}
}
注解配置說(shuō)明
下面通過(guò)幾種不同傳參方式來(lái)實(shí)現(xiàn)前文中實(shí)現(xiàn)的插入操作,來(lái)學(xué)習(xí)一下MyBatis中常用的一些注解。
使用@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)證上面操作的正確性:
@Transactional
@RunWith(SpringRunner.class)
@SpringBootTest
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出的字段名。在該配置中故意沒(méi)有查出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());
}
}
注:本文轉(zhuǎn)載自“程序猿DD”,如有侵權(quán),請(qǐng)聯(lián)系刪除!