Spring Boot 揭祕與實戰（二）資料儲存篇 - MyBatis整合

樑桂釗發表於2016-12-20

本文講解Spring Boot基礎下，如何整合MyBatis框架，編寫資料訪問。
原文地址：Spring Boot 揭祕與實戰（二）資料儲存篇 - MyBatis整合
部落格地址：blog.720ui.com/

環境依賴

修改 POM 檔案，新增mybatis-spring-boot-starter依賴。值得注意的是，可以不新增spring-boot-starter-jdbc。因為，mybatis-spring-boot-starter依賴中存在spring-boot-starter-jdbc。

<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>1.1.1</version>
</dependency>複製程式碼

新增mysql依賴。

<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.35</version>
</dependency>
<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>druid</artifactId>
  <version>1.0.14</version>
</dependency>複製程式碼

資料來源

方案一使用 Spring Boot 預設配置

在 src/main/resources/application.properties 中配置資料來源資訊。

spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/springboot_db?useUnicode = true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull
spring.datasource.username=root
spring.datasource.password=root複製程式碼

方案二手動建立

在 src/main/resources/config/source.properties 中配置資料來源資訊。

# mysql
source.driverClassName = com.mysql.jdbc.Driver
source.url = jdbc:mysql://localhost:3306/springboot_db?useUnicode = true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull
source.username = root
source.password = root複製程式碼

通過 Java Config 建立 dataSource 和jdbcTemplate 。

@Configuration
@EnableTransactionManagement
@PropertySource(value = {"classpath:config/source.properties"})
public class BeanConfig {

    @Autowired
    private Environment env;

    @Bean(destroyMethod = "close")
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(env.getProperty("source.driverClassName").trim());
        dataSource.setUrl(env.getProperty("source.url").trim());
        dataSource.setUsername(env.getProperty("source.username").trim());
        dataSource.setPassword(env.getProperty("source.password").trim());
        return dataSource;
    }

@Bean
    public JdbcTemplate jdbcTemplate() {
        JdbcTemplate jdbcTemplate = new JdbcTemplate();
        jdbcTemplate.setDataSource(dataSource());
        return jdbcTemplate;
    }
}複製程式碼

指令碼初始化

先初始化需要用到的SQL指令碼。

CREATE DATABASE /*!32312 IF NOT EXISTS*/`springboot_db` /*!40100 DEFAULT CHARACTER SET utf8 */;

USE `springboot_db`;

DROP TABLE IF EXISTS `t_author`;

CREATE TABLE `t_author` (
  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '使用者ID',
  `real_name` varchar(32) NOT NULL COMMENT '使用者名稱稱',
  `nick_name` varchar(32) NOT NULL COMMENT '使用者匿名',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;複製程式碼

MyBatis整合

方案一通過註解的方式

實體物件

public class Author {
    private Long id;
    @JSONField(name="real_name")
    private String realName;
    @JSONField(name="nick_name")
    private String nickName;

    // SET和GET方法
}複製程式碼

DAO相關

@Mapper
public interface AuthorMapper {

    @Insert("insert into t_author(real_name, nick_name) values(#{real_name}, #{nick_name})")
    int add(@Param("realName") String realName, @Param("nickName") String nickName);

    @Update("update t_author set real_name = #{real_name}, nick_name = #{nick_name} where id = #{id}")
    int update(@Param("real_name") String realName, @Param("nick_name") String nickName, @Param("id") Long id);

    @Delete("delete from t_author where id = #{id}")
    int delete(Long id);

    @Select("select id, real_name as realName, nick_name as nickName from t_author where id = #{id}")
    Author findAuthor(@Param("id") Long id);

    @Select("select id, real_name as realName, nick_name as nickName from t_author")
    List<Author> findAuthorList();
}複製程式碼

Service相關

@Service
public class AuthorService {
    @Autowired
    private AuthorMapper authorMapper;

    public int add(String realName, String nickName) {
        return this.authorMapper.add(realName, nickName);
    }
    public int update(String realName, String nickName, Long id) {
        return this.authorMapper.update(realName, nickName, id);      
    }
    public int delete(Long id) {
        return this.authorMapper.delete(id);
    }
    public Author findAuthor(Long id) {
        return this.authorMapper.findAuthor(id);
    }
    public List<Author> findAuthorList() {
        return this.authorMapper.findAuthorList();
    }
}複製程式碼

Controller相關

為了展現效果，我們先定義一組簡單的　RESTful API 介面進行測試。

@RestController("mybatis.authorController")
@RequestMapping(value="/data/mybatis/author")
@MapperScan("com.lianggzone.springboot.action.data.mybatis.dao")
public class AuthorController {

  @Autowired
  private AuthorService authorService;
  /**
   * 查詢使用者列表
   */
  @RequestMapping(method = RequestMethod.GET)
  public Map<String,Object> getAuthorList(HttpServletRequest request) {        
    List<Author> authorList = this.authorService.findAuthorList();
    Map<String,Object> param = new HashMap<String,Object>();
    param.put("total", authorList.size());
    param.put("rows", authorList);
    return param;
  }
  /**
   * 查詢使用者資訊
   */
  @RequestMapping(value = "/{userId:\\d+}", method = RequestMethod.GET)
  public Author getAuthor(@PathVariable Long userId, HttpServletRequest request) {
    Author author = this.authorService.findAuthor(userId);
    if(author == null){
        throw new RuntimeException("查詢錯誤");
    }
    return author;
  }

  /**
   * 新增方法
   */
  @RequestMapping(method = RequestMethod.POST)
  public void add(@RequestBody JSONObject jsonObject) {
    String userId = jsonObject.getString("user_id");
    String realName = jsonObject.getString("real_name");
    String nickName = jsonObject.getString("nick_name");

    try{
        this.authorService.add(realName, nickName);
    }catch(Exception e){
        e.printStackTrace();
        throw new RuntimeException("新增錯誤");
    }
  }
  /**
   * 更新方法
   */
  @RequestMapping(value = "/{userId:\\d+}", method = RequestMethod.PUT)
    public void update(@PathVariable Long userId, @RequestBody JSONObject jsonObject) {
    Author author = this.authorService.findAuthor(userId);
    String realName = jsonObject.getString("real_name");
    String nickName = jsonObject.getString("nick_name");

    try{
        this.authorService.update(realName, nickName, author.getId());
    }catch(Exception e){
        e.printStackTrace();
        throw new RuntimeException("更新錯誤");
    } 
  }
  /**
   * 刪除方法
   */
  @RequestMapping(value = "/{userId:\\d+}", method = RequestMethod.DELETE)
    public void delete(@PathVariable Long userId) {
    try{
        this.authorService.delete(userId);
    }catch(Exception e){
        throw new RuntimeException("刪除錯誤");
    }
  }
}複製程式碼

方案二通過配置檔案的方式

實體物件

public class Author {
    private Long id;
    @JSONField(name="real_name")
    private String realName;
    @JSONField(name="nick_name")
    private String nickName;

    // SET和GET方法
}複製程式碼

配置相關

在 src/main/resources/mybatis/AuthorMapper.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.lianggzone.springboot.action.data.mybatis.dao.AuthorMapper2">

    <!-- type為實體類Student，包名已經配置，可以直接寫類名 -->
    <resultMap id="authorMap" type="Author">
        <id property="id" column="id" />
        <result property="realName" column="real_name" />
        <result property="nickName" column="nick_name" />
    </resultMap>

    <select id="findAuthor" resultMap="authorMap" resultType="Author">
        select id, real_name, nick_name from t_author where id = #{id}
    </select>
</mapper>複製程式碼

在 src/main/resources/application.properties 中配置資料來源資訊。

mybatis.mapper-locations=classpath*:mybatis/*Mapper.xml
mybatis.type-aliases-package=com.lianggzone.springboot.action.data.mybatis.entity複製程式碼

DAO相關

public interface AuthorMapper2 { 
    Author findAuthor(@Param("id") Long id); 
}複製程式碼

Service相關

@Service
public class AuthorService2 {
    @Autowired
    private AuthorMapper2 authorMapper;

    public Author findAuthor(Long id) {
        return this.authorMapper.findAuthor(id);
    }
}複製程式碼

Controller相關

為了展現效果，我們先定義一組簡單的　RESTful API 介面進行測試。

@RestController("mybatis.authorController2")
@RequestMapping(value="/data/mybatis/author2")
@MapperScan("com.lianggzone.springboot.action.data.mybatis.dao")
public class AuthorController2 { 
  @Autowired
  private AuthorService2 authorService; 
  /**
   * 查詢使用者資訊
   */
  @RequestMapping(value = "/{userId:\\d+}", method = RequestMethod.GET)
  public Author getAuthor(@PathVariable Long userId, HttpServletRequest request) {
    Author author = this.authorService.findAuthor(userId);
    if(author == null){
        throw new RuntimeException("查詢錯誤");
    }
    return author;
  }
}複製程式碼

總結

上面這個簡單的案例，讓我們看到了 Spring Boot 整合 MyBatis 框架的大概流程。那麼，複雜的場景，大家可以參考使用一些比較成熟的外掛，例如com.github.pagehelper、mybatis-generator-maven-plugin等。

原始碼

相關示例完整程式碼： springboot-action

（完）

更多精彩文章，盡在「服務端思維」微信公眾號！

Spring Boot 揭祕與實戰（二）資料儲存篇 – MyBatis整合
2019-03-04
Spring BootMyBatis
Spring Boot 揭祕與實戰（二）資料儲存篇 – MongoDB
2019-03-03
Spring BootMongoDB
Spring Boot 揭祕與實戰（二）資料儲存篇 – MySQL
2019-03-04
Spring BootMySql
Spring Boot 揭祕與實戰（二）資料儲存篇 – 資料訪問與多資料來源配置
2019-03-04
Spring Boot
Spring Boot 揭祕與實戰（六）訊息佇列篇 – RabbitMQ
2019-03-04
Spring Boot佇列MQ
Spring Boot 揭祕與實戰（三）日誌框架篇 – 如何快速整合日誌系統
2019-03-01
Spring Boot框架
Spring Boot 揭祕與實戰（七）實用技術篇 – FreeMarker 模板引擎
2019-02-21
Spring Boot
Spring Boot 揭祕與實戰（四）配置檔案篇 – 有哪些很棒的特性
2019-02-25
Spring Boot
Spring Boot 揭祕與實戰（九）應用監控篇 – 自定義監控端點
2019-03-04
Spring Boot
Spring Boot實戰系列(2)資料儲存之NoSQL資料庫MongoDB
2018-11-06
Spring BootSQL資料庫MongoDB
MyBatis初級實戰之一：Spring Boot整合
2021-01-15
MyBatisSpring Boot
Spring Boot資料儲存最佳實踐 - Ahad
2022-03-21
Spring Boot
持續整合之 Spring Boot 實戰篇
2019-03-11
Spring Boot
揭祕前端儲存
2019-04-09
前端
Spring Boot 整合 MyBatis
2022-05-13
Spring BootMyBatis
Spring Boot整合Spring Cloud Vault進行安全儲存
2024-08-16
Spring BootCloud
Spring Boot整合MyBatis實現通用Mapper
2018-08-22
Spring BootMyBatisAPP
Spring boot入門（二）：Spring boot整合MySql,Mybatis和PageHelper外掛
2019-02-28
Spring BootMySqlMyBatis
Spring Boot 整合 Elasticsearch 實戰
2020-08-07
Spring BootElasticsearch
Spring框架（五）實戰Spring整合Mybatis
2020-12-17
Spring框架MyBatis
Spring boot學習（三） Spring boot整合mybatis
2019-01-17
Spring BootMyBatis
Spring Boot 揭祕與實戰（五）伺服器篇 – 內嵌的伺服器 Tomcat剖析 | 掘金技術徵文
2019-03-04
Spring Boot伺服器Tomcat
Spring Boot 整合 MyBatis和 SQL Server實踐
2018-12-17
Spring BootMyBatisSQLServer
Spring Boot整合Redis實戰操作
2018-11-02
Spring BootRedis
spring4.1.8擴充套件實戰之二：Aware介面揭祕
2022-06-13
Spring套件
Spring Boot —— 整合 MyBatis-Plus
2024-05-20
Spring BootMyBatis
css揭祕實戰技巧 - 形狀 [二]
2019-04-29
CSS
MyBatis和Spring整合的奧祕
2020-07-07
MyBatisSpring
Spring Boot系列（三）：Spring Boot整合Mybatis原始碼解析
2020-08-20
Spring BootMyBatis原始碼
【Spring Boot】快速整合Mybatis-Plus
2023-02-07
Spring BootMyBatis
Spring Boot 整合阿里雲 OSS 進行檔案儲存
2020-09-11
Spring Boot阿里
Mybatis與Spring整合
2018-09-11
MyBatisSpring
快照是什麼？揭祕儲存快照的實現
2019-03-04
Spring boot學習（五）Spring boot整合Mybatis Generator以及PageHelper
2019-01-20
Spring BootMyBatis
Spring 5 中文解析資料儲存篇-理解Spring事物抽象
2021-09-09
Spring抽象
spring：spring與mybatis的整合
2020-10-19
SpringMyBatis
《Elasticsearch技術解析與實戰》Chapter 1.4 Spring Boot整合Elasticsearch
2019-04-16
ElasticsearchAPTSpring Boot
Spring Boot 入門系列（二十三）整合Mybatis，實現多資料來源配置！
2021-09-02
Spring BootMyBatis
小代學Spring Boot之整合MyBatis
2019-07-19
Spring BootMyBatis

Spring Boot 揭祕與實戰（二） 資料儲存篇 - MyBatis整合

環境依賴

資料來源

方案一 使用 Spring Boot 預設配置

方案二 手動建立

指令碼初始化

MyBatis整合

方案一 通過註解的方式

實體物件

DAO相關

Service相關

Controller相關

方案二 通過配置檔案的方式

實體物件

配置相關

DAO相關

Service相關

Controller相關

總結

原始碼

相關文章

Spring Boot 揭祕與實戰（二）資料儲存篇 - MyBatis整合

方案一使用 Spring Boot 預設配置

方案二手動建立

方案一通過註解的方式

方案二通過配置檔案的方式