詳解Spring Boot集成MyBatis（注解方式）

更新時(shí)間：2017年05月12日 16:43:53 作者：xuyuzhuang1991

本篇文章主要介紹了詳解Spring Boot集成MyBatis（注解方式），小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

MyBatis是支持定制化SQL、存儲(chǔ)過(guò)程以及高級(jí)映射的優(yōu)秀的持久層框架，避免了幾乎所有的JDBC代碼和手動(dòng)設(shè)置參數(shù)以及獲取結(jié)果集。spring Boot是能支持快速創(chuàng)建Spring應(yīng)用的Java框架。本文通過(guò)一個(gè)例子來(lái)學(xué)習(xí)Spring Boot如何集成MyBatis，而且過(guò)程中不需要XML配置。

創(chuàng)建數(shù)據(jù)庫(kù)

本文的例子使用MySQL數(shù)據(jù)庫(kù)，首先創(chuàng)建一個(gè)用戶表，執(zhí)行sql語(yǔ)句如下：

CREATE TABLE IF NOT EXISTS user (
 `id` INT(10) NOT NULL AUTO_INCREMENT,
 `name` VARCHAR(50) NULL DEFAULT NULL ,
 `age` INT(2) NOT NULL ,
 PRIMARY KEY (id)
)

工程目錄結(jié)構(gòu)與依賴配置

首先新建一個(gè)Maven工程，并配置Pom依賴，本例中所用到的依賴如下：

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>1.4.2.RELEASE</version>
  <relativePath />
</parent>

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.1.1</version>
  </dependency>
  <dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.40</version>
  </dependency>
</dependencies>

<build>
  <plugins>
    <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
    </plugin>
  </plugins>
</build>

然后創(chuàng)建一下工程目錄結(jié)構(gòu)，如下圖所示：

project-structure

代碼文件內(nèi)容

0. 創(chuàng)建配置文件——application.properties

寫入一下內(nèi)容：

spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test?useSSL=false&useUnicode=true&characterEncoding=UTF-8
spring.datasource.username=root
spring.datasource.password=123456

1. 創(chuàng)建POJO——entity/User.java

這是一個(gè)POJO，包含了id, name, age三個(gè)屬性，代碼如下：

package com.xyz.dbtest.entity;
public class User {
  private int id;
  private String name;
  private int age;

  public int getId() {  return id;  }

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

  public String getName() {  return name;  }

  public void setName(String name) { this.name = name;  }

  public int getAge() {  return age;  }

  public void setAge(int age) {  this.age = age;  }
}

2. 創(chuàng)建一個(gè)數(shù)據(jù)層接口——service/UserService.java

這是一個(gè)Mapper類，代碼如下：

package com.xyz.dbtest.dao;

import com.xyz.dbtest.entity.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Result;
import org.apache.ibatis.annotations.Results;
import org.apache.ibatis.annotations.Select;
import java.util.List;

@Mapper //1
public interface UserDao {
  @Results({ //2
      @Result(property = "id", column = "id"), //2
      @Result(property = "name", column = "name"),
      @Result(property = "age", column = "age")
  })
  @Select("SELECT * FROM user WHERE age = #{age}") //3
  List<User> get(int age);

  @Insert("INSERT INTO user(name, age) VALUES (#{name}, #{age})") //3
  void insert(User user);
}

//1 @Mapper將UserDao聲明為一個(gè)Mapper接口
//2 @Results是結(jié)果映射列表，@Result中property是User類的屬性名，colomn是數(shù)據(jù)庫(kù)表的字段名
//3 @Select, @Insert 分別代表了執(zhí)行的真實(shí)SQL

3. 創(chuàng)建一個(gè)用戶服務(wù)——service/UserService.java

這是一個(gè)服務(wù)類Bean，提供三個(gè)函數(shù)功能，代碼如下：

package com.xyz.dbtest.service;

import com.xyz.dbtest.dao.UserDao;
import com.xyz.dbtest.entity.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;

@Service //聲明成一個(gè)spring bean
public class UserService {

  @Autowired //連接到UserDao Bean
  private UserDao userDao;

  public String show() {
    return "Hello World!";
  }

  public List<User> showDao(int age) {
    return userDao.get(age);
  }

  public String insert(String name, int age) { //插入一條記錄
    User user = new User();
    user.setName(name);
    user.setAge(age);
    userDao.insert(user);
    return "Insert ( \""+name+"\", age"+age+") OK!";
  }
}

4. 常見一個(gè)Web Controller——controller/UserController.java

這是一個(gè)Spring Web的Controller類，引入了spring-boot-starter-web依賴，代碼如下：

package com.xyz.dbtest.controller;

import com.xyz.dbtest.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

@RestController //聲明為一個(gè)Restful的Controller
public class UserController {
  @Autowired //自動(dòng)連接到UserService Bean
  private UserService userService;

  @RequestMapping(value = "/show")
  public String show() {
    return userService.show();
  }

  @RequestMapping(value = "/showDao")
  public Object showDao(int age) {
    return userService.showDao(age);
  }

  @RequestMapping(value="/insert")
  public String insert(String name, int age) {
    return userService.insert(name, age);
  }
}

5. 創(chuàng)建啟動(dòng)類——main/StartApp.java

這是一個(gè)spring boot啟動(dòng)類。代碼如下：

package com.xyz.dbtest.main;

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

@SpringBootApplication(scanBasePackages = "com.xyz.dbtest") //1
@MapperScan(basePackages = "com.xyz.dbtest.dao") //2
public class StartApp {
  public static void main(String[] args) {
    SpringApplication.run(StartApp.class, args);
  }
}

//1 由于StartApp類位于基礎(chǔ)包的自包中，因此需要設(shè)置scanBasePackage
//2 設(shè)置Mapper接口所在的包

運(yùn)行結(jié)果

運(yùn)行Sql語(yǔ)句創(chuàng)建數(shù)據(jù)庫(kù)表后，運(yùn)行StartApp類。啟動(dòng)成功如下圖所示

run-success