來源：www.jianshu.com/p/828d2bd12b2f

序言：使用MyBatis3提供的註解可以逐步取代XML，例如使用@Select註解直接編寫SQL完成資料查詢，使用@SelectProvider高階註解還可以編寫動態SQL，以應對複雜的業務需求。

一. 基礎註解

MyBatis 主要提供了以下CRUD註解：

• @Select

• @Insert

• @Update

• @Delete

增刪改查佔據了絕大部分的業務操作，掌握這些基礎註解的使用還是很有必要的，例如下面這段程式碼無需XML即可完成資料查詢：

@Mapper
public interface UserMapper {
    @Select("select * from t_user")
    List<User> list();
}

使用過Hibernate的同學可能會好奇，這裡為什麼沒有配置對映關係也能完成屬性注入？在傳統專案中使用過Mybatis的童鞋可能很快就反應過來，是因為在配置檔案中開啟了全域性駝峰對映，SpringBoot中同樣能夠做到，並且更為簡單快捷。

雖然開啟了全域性駝峰對映，但你可能還會質疑，如果不符合下劃線轉駝峰規則的欄位，拿查詢回來的實體物件屬性將獲取為null，比如上述User物件屬性mobileNum和對應的資料庫欄位phoneNum，則查詢結果為：

[
  {
    "userId": "1",
    "username": "admin",
    "password": "admin",
    "mobileNum": null
  },
  {
    "userId": "2",
    "username": "roots",
    "password": "roots",
    "mobileNum": null
  }
]

為了解決物件屬性和欄位駝峰不一致的問題，我們可以使用對映註解@Results來指定對映關係。

二.  對映註解

Mybatis主要提供這些對映註解：

• @Results  用於填寫結果集的多個欄位的對映關係.

• @Result  用於填寫結果集的單個欄位的對映關係.

• @ResultMap 根據ID關聯XML裡面<resultMap>.

例如上面的list方法，我們可以在查詢SQL的基礎上，指定返回的結果集的對映關係，其中property表示實體物件的屬性名，column表示對應的資料庫欄位名。

@Results({
            @Result(property = "userId", column = "USER_ID"),
            @Result(property = "username", column = "USERNAME"),
            @Result(property = "password", column = "PASSWORD"),
            @Result(property = "mobileNum", column = "PHONE_NUM")
    })
    @Select("select * from t_user")
    List<User> list();

查詢結果如下，：

[
  {
    "userId": "1",
    "username": "admin",
    "password": "admin",
    "mobileNum": "15011791234"
  },
  {
    "userId": "2",
    "username": "roots",
    "password": "roots",
    "mobileNum": "18812342017"
  }
]

為了解決物件屬性和欄位駝峰不一致的問題，我們可以使用對映註解@Results來指定對映關係。

為了方便演示和免除手工編寫對映關係的煩惱，這裡提供了一個快速生成對映結果集的方法，具體內容如下：

/**
     * 1.用於獲取結果集的對映關係
     */
    public static String getResultsStr(Class origin) {
        StringBuilder stringBuilder = new StringBuilder();
        stringBuilder.append("@Results({\n");
        for (Field field : origin.getDeclaredFields()) {
            String property = field.getName();
            //對映關係：物件屬性(駝峰)->資料庫欄位(下劃線)
            String column = new PropertyNamingStrategy.SnakeCaseStrategy().translate(field.getName()).toUpperCase();
            stringBuilder.append(String.format("@Result(property = \"%s\", column = \"%s\"),\n", property, column));
        }
        stringBuilder.append("})");
        return stringBuilder.toString();
    }

在當前Main方法執行效果如下：然後我們將控制檯這段列印資訊複製到介面方法上即可。

三. 高階註解

MyBatis-3 主要提供了以下CRUD的高階註解：

• @SelectProvider

• @InsertProvider

• @UpdateProvider

• @DeleteProvider

見名知意，這些高階註解主要用於動態SQL，這裡以@SelectProvider 為例，主要包含兩個註解屬性，其中type表示工具類，method 表示工具類的某個方法，用於返回具體的SQL。

@Mapper
public interface UserMapper {
    @SelectProvider(type = UserSqlProvider.class, method = "list222")
    List<User> list2();
}

工具類程式碼如下：

public class UserSqlProvider {
    public String list222() {
        return "select * from t_user ;
    }

四. 詳細教程

對上述註解有所瞭解之後，我們以具體專案案例來進一步鞏固這些註解的實際使用。

1. 引入依賴

為了方便演示，首選搭建Web環境，另外資料庫選擇Mysql 5.5+。

<dependencies>
        <dependency> <!--新增Web依賴 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency> <!--新增Mybatis依賴 -->
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.1</version>
        </dependency>
        <dependency><!--新增MySQL驅動依賴 -->
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency><!--新增Test依賴 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

2. 新增配置

這裡主要是新增資料來源，配置駝峰對映和開啟SQL日誌的控制檯列印。在專案的資源目錄中，新增 application.yml 配置如下：

spring:
  datasource:
    #連線MySQL
    url: jdbc:mysql://localhost:3306/socks?useSSL=false
    username: root
    password: root
    driver-class-name: com.mysql.jdbc.Driver

mybatis:
  configuration:
   #配置項：開啟下劃線到駝峰的自動轉換. 作用：將資料庫欄位根據駝峰規則自動注入到物件屬性。
   map-underscore-to-camel-case: true

logging:
  level:
   #列印SQL資訊
   com.hehe.mapper: debug

3. 編寫資料層程式碼

這裡以我們熟悉的使用者資訊為例，編寫UserMapper介面和本案例使用的UserSqlProvider。

3.1 UserMapper

新增UserMapper介面用於資料查詢：

package com.hehe.mapper;
@Mapper
public interface UserMapper {
    /**
     * 方式1：使用註解編寫SQL。
     */
    @Select("select * from t_user")
    List<User> list();

    /**
     * 方式2：使用註解指定某個工具類的方法來動態編寫SQL.
     */
    @SelectProvider(type = UserSqlProvider.class, method = "listByUsername")
    List<User> listByUsername(String username);

    /**
     * 延伸：上述兩種方式都可以附加@Results註解來指定結果集的對映關係.
     *
     * PS：如果符合下劃線轉駝峰的匹配項可以直接省略不寫。
     */
    @Results({
            @Result(property = "userId", column = "USER_ID"),
            @Result(property = "username", column = "USERNAME"),
            @Result(property = "password", column = "PASSWORD"),
            @Result(property = "mobileNum", column = "PHONE_NUM")
    })
    @Select("select * from t_user")
    List<User> listSample();

    /**
     * 延伸：無論什麼方式,如果涉及多個引數,則必須加上@Param註解,否則無法使用EL表示式獲取引數。
     */
    @Select("select * from t_user where username like #{username} and password like #{password}")
    User get(@Param("username") String username, @Param("password") String password);

    @SelectProvider(type = UserSqlProvider.class, method = "getBadUser")
    User getBadUser(@Param("username") String username, @Param("password") String password);

}

3.2 UserSqlProvider

新增UserSqlProvider，用於生成SQL的工具類 。

/**
 * 主要用途：根據複雜的業務需求來動態生成SQL.
 * <p>
 * 目標：使用Java工具類來替代傳統的XML檔案.(例如：UserSqlProvider.java <-- UserMapper.xml)
 */
public class UserSqlProvider {
    /**
     * 方式1：在工具類的方法裡,可以自己手工編寫SQL。
     */
    public String listByUsername(String username) {
        return "select * from t_user where username =#{username}";
    }

    /**
     * 方式2：也可以根據官方提供的API來編寫動態SQL。
     */
    public String getBadUser(@Param("username") String username, @Param("password") String password) {
        return new SQL() {{
            SELECT("*");
            FROM("t_user");
            if (username != null && password != null) {
                WHERE("username like #{username} and password like #{password}");
            } else {
                WHERE("1=2");
            }
        }}.toString();
    }
}

3.3 實體類User

新增實體類User

public class User {
    private String userId;
    private String username;
    private String password;
    private String mobileNum;
    //Getters & Setters
}

3.4 新增資料庫記錄

開啟Navicat 查詢視窗，然後只需下面這段指令碼。

USE `SOCKS`;
DROP TABLE IF EXISTS `t_user`;
CREATE TABLE `t_user` (
  `USER_ID` varchar(50) ,
  `USERNAME` varchar(50) ,
  `PASSWORD` varchar(50) ,
    `PHONE_NUM` varchar(15) 
) ;

INSERT INTO `t_user` VALUES ('1', 'admin', 'admin','15011791234');
INSERT INTO `t_user` VALUES ('2', 'roots', 'roots','18812342017');

4. 編寫控制層程式碼

package com.hehe.controller;

@RestController
@RequestMapping("/user/*")
public class UserController {

    @SuppressWarnings("all")
    @Autowired
    UserMapper userMapper;

    @GetMapping("list")
    public List<User> list() {
        return userMapper.list();
    }

    @GetMapping("list/{username}")
    public List<User> listByUsername(@PathVariable("username") String username) {
        return userMapper.listByUsername(username);
    }

    @GetMapping("get/{username}/{password}")
    public User get(@PathVariable("username") String username, @PathVariable("password") String password) {
        return userMapper.get(username, password);
    }

    @GetMapping("get/bad/{username}/{password}")
    public User getBadUser(@PathVariable("username") String username, @PathVariable("password") String password) {
        return userMapper.getBadUser(username, password);
    }

}

5. 啟動和測試

啟動工程後，訪問 http://localhost:8080/user/list 可以檢視使用者列表如下：

訪問 http://localhost:8080/user/list/admin 可以查詢使用者名稱為admin的資訊：

五. 原始碼和文件

原始碼地址：

https://github.com/yizhiwazi/springboot-socks

官方文件：

http://www.mybatis.org/mybatis-3/zh/java-api.html

（完）

Java團長

專注於Java乾貨分享

掃描上方二維碼獲取更多Java乾貨