Spring Boot整合Mybatis並完成CRUD操作

SpringBoot MyBatis · 發表 2018-12-17 21:38:00

摘要： MyBatis 是一款優秀的持久層框架，被各大網際網路公司使用，本文使用Spring Boot整合Mybatis，並完成CRUD操作。為什麼要使用Mybatis？我們需要掌握Mybatis嗎？說的官方一點： MyBatis 是一款優秀的持久層框架，它支援定製化 ...

MyBatis 是一款優秀的持久層框架，被各大網際網路公司使用，本文使用Spring Boot整合Mybatis，並完成CRUD操作。

為什麼要使用Mybatis？我們需要掌握Mybatis嗎？

說的官方一點：

MyBatis 是一款優秀的持久層框架，它支援定製化 SQL、儲存過程以及高階對映。MyBatis 避免了幾乎所有的 JDBC 程式碼和手動設定引數以及獲取結果集。MyBatis 可以使用簡單的 XML 或註解來配置和對映原生資訊，將介面和 Java 的 POJOs(Plain Ordinary Java Object,普通的 Java物件)對映成資料庫中的記錄。

說的功利一點：

據說目前各大網際網路公司通常使用Mybatis，還不趕快學習一下嗎？

怎麼使用？

這才是本文的重點。

新建Spring Boot工程和匯入Eclipse這些在這裡就不囉嗦了，不會的可以檢視 ofollow,noindex">只需兩步！Eclipse+Maven快速構建第一個Spring Boot專案。

1. pom.xml新增依賴

Spring Boot整合Mybatis需要引入 mybatis-spring-boot-starter；我使用的是MySQL資料庫，需要引入ysql-connector-java。

<!-- mysql驅動 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>

<!-- spring-boot整合mybatis -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.1.1</version>
</dependency>

2. application.property配置Mybatis和資料來源

mybatis.config-location=classpath:mapper/mybatis_config.xml
mybatis.mapper-locations=classpath:mapper/*Mapper.xml
mybatis.type-aliases-package=com.shangguan.mybatis.entity

spring.datasource.driverClassName = com.mysql.cj.jdbc.Driver
spring.datasource.url =jdbc:mysql://localhost:3306/spring_boot?serverTimezone=GMT%2B8
spring.datasource.username = root
spring.datasource.password = 123456

例如我的mybatis_config.xml的路徑為/mybatis/src/main/resources/mapper/mybatis_config.xml（下面是目錄結構圖），那麼我的mybatis.config-location配置為classpath:mapper/mybatis_config.xml，請注意一定要根據自己專案的目錄結構進行配置Mybatis。資料庫也一樣。

mapper包裡面是Mybatis的對映類。

interceptor包是攔截器，如果還有疑問請參考之前的博文： Spring Boot配置攔截器及實現跨域訪問

3. Mybatis全域性配置檔案

MyBatis 的配置檔案包含了會深深影響 MyBatis 行為的設定（settings）和屬性（properties）資訊。關於配置檔案的詳解請看 xml對映配置檔案。

mybatis_config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

</configuration>

4. 實體類User

User使用的和之前使用的一樣，沒有修改。

User：

public class User implements Serializable {

private static final long serialVersionUID = 1L;
private Long id;
private String userName;
private String passWord;

public User() {
super();
}

public User(String userName, String passWord) {
super();
this.userName = userName;
this.passWord = passWord;
}

public Long getId() {
return id;
}

public void setId(Long id) {
this.id = id;
}

public String getUserName() {
return userName;
}

public void setUserName(String userName) {
this.userName = userName;
}

public String getPassWord() {
return passWord;
}

public void setPassWord(String passWord) {
this.passWord = passWord;
}

@Override
public String toString() {
return "userName " + this.userName + ", pasword " +this.passWord;
}
}

5. 新增User的對映檔案和對映類

SQL 對映檔案有很少的幾個頂級元素（按照它們應該被定義的順序）：

cache – 給定名稱空間的快取配置。
cache-ref – 其他名稱空間快取配置的引用。
resultMap – 是最複雜也是最強大的元素，用來描述如何從資料庫結果集中來載入物件。
parameterMap – 已廢棄！老式風格的引數對映。內聯引數是首選,這個元素可能在將來被移除，這裡不會記錄。
sql – 可被其他語句引用的可重用語句塊。
insert – 對映插入語句
update – 對映更新語句
delete – 對映刪除語句
select – 對映查詢語句

更多資訊請參考 xml對映檔案。

增刪改查的SQL語句在UserMapper.xml裡面書寫，具體的看程式碼，裡面有註釋。

有幾點需要注意的地方：

①<select id="getAll" resultType="user">，這裡的id的名字是自己取的，但是要和UserMapper.java裡面的名字相同public List<User> getAll();

②當SQL語句中有多個引數的時候，需要在對映類方法裡面加@Param的註解，不然會丟擲異常說找不到引數。例如：

public void updateUser(@Param("id") Long id, @Param("userName")String userName,
@Param("passWord") String passWord);

③主鍵自增，需要設定useGeneratedKeys="true" keyProperty="id"

UserMapper.xml:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.shangguan.mybatis.mapper.UserMapper">
<resultMap id="BaseResultMap"type="com.shangguan.mybatis.mapper.UserMapper" >
<id column="id" property="id" jdbcType="BIGINT" />
<result column="userName" property="userName"jdbcType="VARCHAR" />
<result column="passWord" property="passWord"jdbcType="VARCHAR" />
</resultMap>

<!--查詢所有-->
<select id="getAll" resultType="user">
select * from user
</select>

<!--儲存使用者-->
<insert id="saveUser"useGeneratedKeys="true" keyProperty="id">
insert into user(username,password)values(#{userName},#{passWord})
</insert>

<!--通過Id刪除使用者-->
<delete id="deleteUserById">
delete from user where id =#{id}
</delete>

<!--更新該使用者資訊-->
<update id="updateUser">
update user set userName = #{userName},passWord =#{passWord}
where id = #{id}
</update>

</mapper>

對映類UserMapper.java：

@Mapper
public interface UserMapper {
public List<User> getAll();
public void saveUser(User user);
public void deleteUserById(Long id);
public void updateUser(@Param("id") Long id,@Param("userName") String userName,
@Param("passWord") String passWord);
}

6. Service層實現

UserService裡面有四個方法：增刪改查。查詢所有的使用者，儲存使用者，通過id刪除使用者，更新使用者資訊。

UserService：

public interface UserService {

public List<User> getAllUser();
public void saveUser(User user);
public void deleteUserById(Long id);
public void updateUser(Long id, String userName, StringpassWord);

}

UserServiceImpl：

@Service
public class UserServiceImpl implements UserService {

@Autowired
private UserMapper userMapper;

@Override
public List<User> getAllUser() {
List<User> list = userMapper.getAll();
return list;
}

@Override
public void saveUser(User user) {
userMapper.saveUser(user);
}

@Override
public void deleteUserById(Long id) {
userMapper.deleteUserById(id);
}

@Override
public void updateUser(Long id, String userName, StringpassWord) {
userMapper.updateUser(id, userName, passWord);
}
}

7. Controller層實現

UserController裡面對介面進行封裝：

@RestController
@SpringBootApplication
@RequestMapping("/mybatis")
public class UserController {

@Autowired
private UserService userService;

@RequestMapping("/getAllUser")
public List<User> getAllUser() {
List<User> list = userService.getAllUser();
return list;
}

@RequestMapping("/saveUser")
public void saveUser(User user) {
userService.saveUser(user);
}

@RequestMapping("/deleteUserById")
public void deleteUserById(Long id) {
userService.deleteUserById(id);
}

@RequestMapping("/updateUser")
public void updateUser(Long id, String userName, StringpassWord) {
userService.updateUser(id, userName, passWord);
}
}