序言：使用MyBatis3提供的注解可以逐步取代XML，例如使用@Select注解直接編寫SQL完成數據查詢，使用@SelectProvider高級注解還可以編寫動態SQL，以應對復雜的業務需求。
一. 基礎注解
MyBatis 主要提供了以下CRUD注解：
增刪改查占據了絕大部分的業務操作，掌握這些基礎注解的使用是很必要的。例如下面這段代碼無需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主要提供這些映射注解：
例如上面的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"
}
]
為了方便演示和免除手工編寫映射關系的煩惱，這里提供了一個快速生成映射結果集的方法，具體內容如下：
/**
* 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的高級注解：
見名知意，這些高級注解主要用于動態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的工具類 。
package com.hehe.mapper;
/**
* 主要用途：根據復雜的業務需求來動態生成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的信息：
五. 文檔
官方文檔：Mybatis3-中文手冊
關于MyBatis注解的使用：
優點：無需XML，使用輕量級注解就可以編寫SQL并返回查詢結果，功能強大且方便。
缺點：MyBatis使用注解最大的缺點是無法實現實體屬性和數據庫字段的映射關系，如果不滿足駝峰的話，每個查詢都要使用@Results，會造成一定代碼冗余，官方承認把這個重大缺陷甩給了Java注解的限制，為了解決這個問題，接下來我們學習如何在項目中快速引入通用Mapper，讓Mapper接口通過泛型繼承就能獲取基于單個對象的增刪改查??！
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
