Spring Boot整合MyBatis實現通用Mapper

aoho發表於2018-08-22
Spring BootMyBatisAPP

MyBatis

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

不管是DDD（Domain Driven Design，領域驅動建模）還是分層架構的風格，都會涉及到對資料庫持久層的操作，本文將會講解Spring Boot整合MyBatis如何實現通用Mapper。

Spring Boot整合MyBatis

引入依賴

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <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.3.1</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
        </dependency>
複製程式碼

可以看到如上關於Mybatis引入了mybatis-spring-boot-starter，由Mybatis提供的starter。

資料庫配置

在application.yml中增加如下配置：

spring:
  datasource:
    hikari:
      connection-test-query: SELECT 1
      minimum-idle: 1
      maximum-pool-size: 5
      pool-name: dbcp1
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/test?autoReconnect=true&useSSL=false&useUnicode=true&characterEncoding=utf-8
    username: user
    password: pwd
    type: com.zaxxer.hikari.HikariDataSource
    schema[0]: classpath:/init.sql
    initialize: true
複製程式碼

可以看到，我們配置了hikari和資料庫的基本資訊。在應用服務啟動時，會自動初始化classpath下的sql指令碼。

CREATE TABLE IF NOT EXISTS `test` (
  `id` bigint(20) unsigned NOT NULL,
  `local_name` varchar(128) NOT NULL ,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
複製程式碼

在sql指令碼中，我們建立了一張test表。

到這裡，後面我們一般需要配置Mybatis對映的xml檔案和實體類的路徑。根據mybatis generator 自動生成程式碼。包括XXMapper.java,XXEntity.java, XXMapper.xml。這裡我們就不演示了，直接進入下一步的通用Mapper實現。

通用Mapper的使用

引入依賴

        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>3.4.0</version>
        </dependency>
複製程式碼

通用Mapper的作者abel533，有興趣可閱讀原始碼。

配置通用Mapper

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import tk.mybatis.spring.mapper.MapperScannerConfigurer;

import java.util.Properties;

@Configuration
public class MyBatisMapperScannerConfig {
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory");
        mapperScannerConfigurer.setBasePackage("com.blueskykong.mybatis.dao");//掃描該路徑下的dao
        Properties properties = new Properties();
        properties.setProperty("mappers", "com.blueskykong.mybatis.config.BaseDao");//通用dao
        properties.setProperty("notEmpty", "false");
        properties.setProperty("IDENTITY", "MYSQL");
        mapperScannerConfigurer.setProperties(properties);
        return mapperScannerConfigurer;
    }
}
複製程式碼

在配置中，設定了指定路徑下的dao，並指定了通用dao。需要注意的是，MapperScannerConfigurer來自於tk.mybatis.spring.mapper包下。

BaseDao

import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;

public interface BaseDao<T> extends Mapper<T>,MySqlMapper<T>{

}
複製程式碼

通用Mapper介面，其他介面繼承該介面即可。

建立實體

我們需要新增test表對應的實體。

@Data
@Table(name = "test")
@AllArgsConstructor
@NoArgsConstructor
public class TestModel {

    @Id
    @Column(name = "id")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    private String localName;
}
複製程式碼

其中，@Table(name = "test")註解指定了該實體對應的資料庫表名。

配置檔案

mybatis:
  configuration:
    map-underscore-to-camel-case: true
複製程式碼

為了更好地對映Java實體和資料庫欄位，我們指定下劃線駝峰法的對映配置。

TestDao編寫

public interface TestDao extends BaseDao<TestModel> {


    @Insert("insert into test(id, local_name) values(#{id}, #{localName})")
    Integer insertTestModel(TestModel testModel);
}
複製程式碼

TestDao繼承自BaseDao，並指定了泛型為對應的TestModel。TestDao包含繼承的方法，如：

    int deleteByPrimaryKey(Integer userId);

    int insert(User record);

    int insertSelective(User record);

    User selectByPrimaryKey(Integer userId);

    int updateByPrimaryKeySelective(User record);

    int updateByPrimaryKey(User record);
複製程式碼

還可以自定義一些方法，我們在上面自定義了一個insertTestModel方法。

Service層和控制層

本文略過這兩層，比較簡單，讀者可以參見本文對應的原始碼地址。

結果驗證

我們在插入一條資料之後，查詢對應的實體。對應執行的結果也都是成功，可以看到控制檯的如下日誌資訊：

c.b.mybatis.dao.TestDao.insertTestModel  : ==>  Preparing: insert into test(id, local_name) values(?, ?) 
c.b.mybatis.dao.TestDao.insertTestModel  : ==> Parameters: 5953(Integer), testName(String)
c.b.mybatis.dao.TestDao.insertTestModel  : <==    Updates: 1
c.b.m.dao.TestDao.selectByPrimaryKey     : ==>  Preparing: SELECT id,local_name FROM test WHERE id = ? 
c.b.m.dao.TestDao.selectByPrimaryKey     : ==> Parameters: 5953(Integer)
c.b.m.dao.TestDao.selectByPrimaryKey     : <==      Total: 1
複製程式碼

Spring Boot整合MyBatis實現通用Mapper到此就大功告成。

小結

MyBatis是持久層非常常用的元件，Spring Boot倡導約定優於配置，特別是很多xml的配置。當然還有很多同學使用Spring Data。相比而言，我覺得MyBatis的SQL比Spring Data更加靈活，至於具體比較不在此討論。

本文對應的原始碼地址：
github.com/keets2012/S…

訂閱最新文章，歡迎關注我的公眾號

微信公眾號

參考

  1. abel533/Mapper
  2. 配置Spring Boot整合MyBatis、通用Mapper、Quartz、PageHelper

相關文章