SpringBoot 快速整合Mybatis（去XML化+註解進階）

一. 基礎註解

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

@Select
@Insert
@Update
@Delete

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

@Mapperpublic 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裏面.

例如上面的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。

@Mapperpublic 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://link.jianshu.com/?t=https://github.com/yizhiwazi/springboot-socks

SpringBoot 快速整合Mybatis（去XML化+註解進階）

一. 基礎註解

二. 映射註解

三. 高級註解

四. 詳細教程

1. 引入依賴

2. 添加配置

3. 編寫數據層代碼

3.1 UserMapper

3.2 UserSqlProvider

3.3 實體類User

3.4 添加數據庫記錄

4. 編寫控制層代碼

5. 啓動和測試

五. 源碼和文檔

Spring Boot 最流行的 16 條實踐解讀！

騰訊這套SpringMvc面試題你瞭解多少？（面試必備）

Tomcat相關面試題，看這篇就夠了！保證能讓面試官顫抖！

MySQL主從複製雖好，能完美解決數據庫單點問題嗎？

詳解設計模式在Spring中的應用

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結