Spring Boot整合Mybatis並完成CRUD操作

本文轉載自查看原文 2018-12-17 21:38 1370 Spring Boot/ 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這些在這里就不啰嗦了，不會的可以查看只需兩步！Eclipse+Maven快速構建第一個Spring Boot項目。

1. pom.xml添加依賴

Spring Boot整合Mybatis需要引入 mybatis-spring-boot-starter；我使用的是MySQL數據庫，需要引入mysql-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 Config  3.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, String  passWord);

}

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, String  passWord) {
        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, String  passWord) {
        userService.updateUser(id, userName, passWord);
    }
}