MyBatis Mapper是一個(gè)不需要任何配置就可以直接使用的通用 Mapper，通過簡(jiǎn)單的學(xué)習(xí)就可以直接在項(xiàng)目中使用。 

功能特點(diǎn)：

開箱即用，無需任何配置，繼承基類 Mapper 即可獲得大量通用方法;

隨心所欲，通過復(fù)制粘貼的方式可以組建自己的基類 Mapper;

全面貼心，提供 Service 層的封裝方便業(yè)務(wù)使用和理解 Mapper;

簡(jiǎn)單直觀，提供 ActiveRecord 模式，結(jié)合 Spring Boot 自動(dòng)配置直接上手用;

自定義方法，簡(jiǎn)單幾行代碼即可實(shí)現(xiàn)自定義通用方法;

輕松擴(kuò)展，通過 Java SPI 輕松擴(kuò)展。

系統(tǒng)要求

MyBatis Mapper 要求 MyBatis 最低版本為 3.5.1，推薦使用最新版本。

和 MyBatis 框架一樣，最低需要 Java 8。

安裝

<dependencies>
<dependency>
<groupId>io.mybatis</groupId>
<artifactId>mybatis-mapper</artifactId>
<version>1.2.2</version>
</dependency>
<!-- 使用 Service 層封裝時(shí) -->
<dependency>
<groupId>io.mybatis</groupId>
<artifactId>mybatis-service</artifactId>
<version>1.2.2</version>
</dependency>
<!-- 使用 ActiveRecord 模式時(shí) -->
<dependency>
<groupId>io.mybatis</groupId>
<artifactId>mybatis-activerecord</artifactId>
<version>1.2.2</version>
</dependency>
</dependencies>
dependencies {
compile("io.mybatis:mybatis-mapper:1.2.2")
// 使用 Service 層封裝時(shí)
compile("io.mybatis:mybatis-service:1.2.2")
// 使用 ActiveRecord 模式時(shí)
compile("io.mybatis:mybatis-activerecord:1.2.2")
}

快速設(shè)置

MyBatis Mapper 的基本原理是將實(shí)體類映射為數(shù)據(jù)庫中的表和字段信息，因此實(shí)體類需要通過注解配置基本的元數(shù)據(jù)，配置好實(shí)體后， 只需要?jiǎng)?chuàng)建一個(gè)繼承基礎(chǔ)接口的 Mapper 接口就可以開始使用了。

一、實(shí)體類配置

假設(shè)有一個(gè)表：

create table user
(
id INTEGER GENERATED BY DEFAULT AS IDENTITY (START WITH 1) PRIMARY KEY,
name VARCHAR(32) DEFAULT 'DEFAULT',
sex VARCHAR(2)
);

對(duì)應(yīng)的實(shí)體類：

import io.mybatis.provider.Entity;

@Entity.Table("user")
public class User {
@Entity.Column(id = true)
private Long id;
@Entity.Column("name")
private String username;
@Entity.Column
private String sex;

//省略set和get方法
}

實(shí)體類上 必須添加 @Entity.Table 注解指定實(shí)體類對(duì)應(yīng)的表名，建議明確指定表名，不提供表名的時(shí)候，使用類名作為表名。 所有屬于表中列的字段，必須添加 @Entity.Column 注解，不指定列名時(shí)，使用字段名(不做任何轉(zhuǎn)換)，通過 id=true 可以標(biāo)記字段為主鍵。

@Entity 中包含的這兩個(gè)注解提供了大量的配置屬性，想要使用更多的配置，參考下面 3. @Entity 注解 的內(nèi)容， 下面是一個(gè)簡(jiǎn)單示例：

@Entity.Table(value = "sys_user", remark = "系統(tǒng)用戶", autoResultMap = true)
public class User {
@Entity.Column(id = true, remark = "主鍵", updatable = false, insertable = false)
private Long id;
@Entity.Column(value = "name", remark = "帳號(hào)")
private String userName;
//省略其他
}

二、Mapper接口定義

有了 User 實(shí)體后，直接創(chuàng)建一個(gè)繼承了 Mapper 的接口即可：

//io.mybatis.mapper.Mapper
public interface UserMapper extends Mapper<User, Long> {

}

這個(gè)接口只要被 MyBatis 掃描到即可直接使用。

下面是幾種常見的掃描配置：

1、MyBatis 自帶的配置文件方式 mybatis-config.xml：

<mappers>
<!-- 掃描指定的包 -->
<package name="com.example.mapper"/>
</mappers>

2、Spring 中的 spring.xml 配置：

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.example.mapper"/>
<property name="markerInterface" value="io.mybatis.service.mapper.RoleMarker"/>
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactoryRole"/>
</bean>

3、Spring Boot 配置，啟動(dòng)類注解方式：

@MapperScan(basePackages = "com.example.mapper")
@SpringBootApplication
public class SpringBootDemoApplication {

public static void main(String[] args) {
SpringApplication.run(SpringBootDemoApplication.class, args);
}

}

Spring Boot 中，還可以直接給接口添加 @org.apache.ibatis.annotations.Mapper 注解，增加注解后可以省略 @MapperScan 配置。

三、使用

定義好接口后，就可以獲取 UserMapper 使用，下面是簡(jiǎn)單示例：

User user=new User();
user.setUserName("測(cè)試");
userMapper.insert(user);
//保存后自增id回寫，不為空
Assert.assertNotNull(user.getId());
//根據(jù)id查詢
user=userMapper.selectByPrimaryKey(user.getId());
//刪除
Assert.assertEquals(1,userMapper.deleteByPrimaryKey(user.getId()));

看到這里，可以發(fā)現(xiàn)除了 MyBatis 自身的配置外，MyBatis Mapper 只需要配置實(shí)體類注解， 創(chuàng)建對(duì)應(yīng)的 Mapper 接口就可以直接使用，沒有任何繁瑣的配置。

上面的示例只是簡(jiǎn)單的使用了 MyBatis Mapper，還有很多開箱即用的功能沒有涉及， 建議在上述示例運(yùn)行成功后，繼續(xù)查看本項(xiàng)目其他模塊的詳細(xì)文檔，熟悉各部分文檔后， 在使用 MyBatis Mapper 時(shí)會(huì)更得心應(yīng)手，隨心所欲。

四、wrapper 用法

在 1.2.0 版本之后，針對(duì) Example 封裝了一個(gè) ExampleWrapper，可以通過鏈?zhǔn)秸{(diào)用方便的使用 Example 方法。

mapper.wrapper()
.eq(User::getSex,"女")
.or(c->c.gt(User::getId,40),c->c.lt(User::getId,10))
.or()
.startsWith(User::getUserName,"張").list();

對(duì)應(yīng)的 SQL 如下：

SELECT id, name AS userName, sex
FROM user
WHERE (sex = ? AND ((id > ?) OR (id < ?)))
OR (name LIKE ?)