Spring Boot教程(六)：Spring Boot集成mybatis

一、前置條件

先創建好一個最簡單的spring boot項目，可參考之前章節的源代碼或直接自己創建一個。

二、創建數據庫

創建數據庫

create database springboot;

創建用戶表tbl_user並插入測試數據

CREATE TABLE `tbl_user` (
  `user_id` bigint(20) NOT NULL,
  `user_name` varchar(50) DEFAULT NULL,
  `user_age` int(11) DEFAULT NULL,
  PRIMARY KEY (`user_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO `tbl_user` VALUES (1, '張三', 27);
INSERT INTO `tbl_user` VALUES (2, '李四', 30);
INSERT INTO `tbl_user` VALUES (3, '王五', 20);

腳本sql在源碼的db文件夾中。

三、引入mybatis依賴

<!-- mybatis -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.2</version>
</dependency>

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

四、編寫代碼

1、創建實體

package com.songguoliang.mybatis.entity;

/**
 * @Description
 * @Author sgl
 * @Date 2018-05-02 14:59
 */
public class User {
    private Long userId;
    private String userName;
    private Integer userAge;

    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        this.userId = userId;
    }

    public String getUserName() {
        return userName;
    }

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

    public Integer getUserAge() {
        return userAge;
    }

    public void setUserAge(Integer userAge) {
        this.userAge = userAge;
    }
}

2、創建Mapper文件

在resources文件夾下創建mapper文件夾，然後在mapper文件夾裏創建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.songguoliang.mybatis.mapper.UserMapper">

    <select id="getUsers" resultType="User">
        SELECT * FROM tbl_user
    </select>

</mapper>

3、創建Mapper(Dao)接口

package com.songguoliang.mybatis.mapper;

import com.songguoliang.mybatis.entity.User;

import java.util.List;

/**
 * @Description
 * @Author sgl
 * @Date 2018-05-02 15:02
 */
public interface UserMapper {

    List<User> getUsers();
}

4、創建Service

package com.songguoliang.mybatis.service;

import com.songguoliang.mybatis.entity.User;
import com.songguoliang.mybatis.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

/**
 * @Description
 * @Author sgl
 * @Date 2018-05-02 15:01
 */
@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public List<User> getUsers() {
        return userMapper.getUsers();
    }
}

5、創建controller

package com.songguoliang.mybatis.controller;

import com.songguoliang.mybatis.entity.User;
import com.songguoliang.mybatis.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**
 * @Description
 * @Author sgl
 * @Date 2018-05-02 14:59
 */
@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/users")
    public List<User> lists() {
        return userService.getUsers();
    }

}

五、配置mybatis

1、配置數據源

在application.properties配置文件中添加如下代碼：

## 數據源配置
spring.datasource.url=jdbc:mysql://localhost:3306/springboot?useUnicode=true&characterEncoding=utf-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

2、添加mybatis配置

在application.properties配置文件中添加mybatis的配置，如下代碼：

# mybatis
mybatis.type-aliases-package=com.songguoliang.mybatis.entity
mybatis.mapper-locations=classpath:mapper/*.xml
mybatis.configuration.map-underscore-to-camel-case=true

• mybatis.type-aliases-package：別名類(實體類)所在包
• mybatis.mapper-locations：mapper文件所在文件夾
• mybatis.configuration.map-underscore-to-camel-case：採用駝峯命名方式轉換

3、掃描Mapper接口

在啓動類上添加註解@MapperScan("com.songguoliang.mybatis.mapper") ，注意MapperScan的包路徑(org.mybatis.spring.annotation.MapperScan)，後面章節和Mapper4集成時會修改導入的包。

package com.songguoliang.mybatis;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @Description
 * @Author sgl
 * @Date 2018-05-02 14:51
 */
@SpringBootApplication
@MapperScan("com.songguoliang.mybatis.mapper")
public class MybatisApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisApplication.class, args);
    }
}

六、測試

啓動服務，瀏覽器輸入http://localhost:8080/users ,可看到如下內容：

源碼：
github
碼雲