序言：使用mybatis3提供的注解可以逐步取代xml，例如使用@select注解直接編寫sql完成數(shù)據(jù)查詢，使用@selectprovider高級(jí)注解還可以編寫動(dòng)態(tài)sql，以應(yīng)對(duì)復(fù)雜的業(yè)務(wù)需求。
一. 基礎(chǔ)注解
mybatis 主要提供了以下crud注解：
- @select
- @insert
- @update
- @delete
增刪改查占據(jù)了絕大部分的業(yè)務(wù)操作，掌握這些基礎(chǔ)注解的使用是很必要的。例如下面這段代碼無(wú)需xml即可完成數(shù)據(jù)查詢：
|
1
2
3
4
5
|
@mapperpublic interface usermapper { @select("select * from t_user") list<user> list();} |
使用過(guò)hibernate的同學(xué)可能會(huì)好奇，這里為什么沒(méi)有配置映射關(guān)系也能完成屬性注入？在傳統(tǒng)項(xiàng)目使用過(guò)mybatis的童鞋可能很會(huì)就能反應(yīng)過(guò)來(lái)，是因?yàn)樵谂渲梦募虚_(kāi)啟了全局駝峰映射，springboot中同樣能夠做到，并且更為簡(jiǎn)單快捷。
雖然開(kāi)啟了全局駝峰映射，但你可能還會(huì)質(zhì)疑，如果不符合下劃線轉(zhuǎn)駝峰規(guī)則的字段，拿查詢回來(lái)的實(shí)體對(duì)象屬性將獲取為null，比如上述user對(duì)象屬性mobilenum和對(duì)應(yīng)的數(shù)據(jù)庫(kù)字段phonenum，則查詢結(jié)果為：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
[ { "userid": "1", "username": "admin", "password": "admin", "mobilenum": null }, { "userid": "2", "username": "roots", "password": "roots", "mobilenum": null }] |
為了解決對(duì)象屬性和字段駝峰不一致的問(wèn)題，我們可以使用映射注解@results來(lái)指定映射關(guān)系。
二. 映射注解
mybatis主要提供這些映射注解：
- @results 用于填寫結(jié)果集的多個(gè)字段的映射關(guān)系.
- @result 用于填寫結(jié)果集的單個(gè)字段的映射關(guān)系.
- @resultmap 根據(jù)id關(guān)聯(lián)xml里面<resultmap>.
例如上面的list方法，我們可以在查詢sql的基礎(chǔ)上，指定返回的結(jié)果集的映射關(guān)系，其中property表示實(shí)體對(duì)象的屬性名，column表示對(duì)應(yīng)的數(shù)據(jù)庫(kù)字段名。
|
1
2
3
4
5
6
7
8
|
@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(); |
查詢結(jié)果如下，：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
[ { "userid": "1", "username": "admin", "password": "admin", "mobilenum": "15011791234" }, { "userid": "2", "username": "roots", "password": "roots", "mobilenum": "18812342017" }] |
為了方便演示和免除手工編寫映射關(guān)系的煩惱，這里提供了一個(gè)快速生成映射結(jié)果集的方法，具體內(nèi)容如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
/** * 1.用于獲取結(jié)果集的映射關(guān)系 */public static string getresultsstr(class origin) { stringbuilder stringbuilder = new stringbuilder(); stringbuilder.append("@results({\n"); for (field field : origin.getdeclaredfields()) { string property = field.getname(); //映射關(guān)系：對(duì)象屬性(駝峰)->數(shù)據(jù)庫(kù)字段(下劃線) 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();} |
在當(dāng)前main方法執(zhí)行效果如下：然后我們將控制臺(tái)這段打印信息復(fù)制到接口方法上即可。
三. 高級(jí)注解
mybatis-3 主要提供了以下crud的高級(jí)注解：
- @selectprovider
- @insertprovider
- @updateprovider
- @deleteprovider
見(jiàn)名知意，這些高級(jí)注解主要用于動(dòng)態(tài)sql，這里以@selectprovider 為例，主要包含兩個(gè)注解屬性，其中type表示工具類，method 表示工具類的某個(gè)方法，用于返回具體的sql。
|
1
2
3
4
5
6
7
8
9
10
11
|
@mapperpublic interface usermapper { @selectprovider(type = usersqlprovider.class, method = "list222") list<user> list2();}工具類代碼如下：public class usersqlprovider { public string list222() { return "select * from t_user ; } |
四. 詳細(xì)教程
對(duì)上述注解有所了解之后，我們以具體項(xiàng)目案例來(lái)進(jìn)一步鞏固這些注解的實(shí)際使用。
具體步驟
1. 引入依賴
為了方便演示，首選搭建web環(huán)境，另外數(shù)據(jù)庫(kù)選擇mysql 5.5+。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
<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驅(qū)動(dòng)依賴 --> <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. 添加配置
這里主要是添加數(shù)據(jù)源，配置駝峰映射和開(kāi)啟sql日志的控制臺(tái)打印。在項(xiàng)目的資源目錄中，添加 application.yml 配置如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
spring: datasource: #連接mysql url: jdbc:mysql://localhost:3306/socks?usessl=false username: root password: root driver-class-name: com.mysql.jdbc.drivermybatis: configuration: #配置項(xiàng)：開(kāi)啟下劃線到駝峰的自動(dòng)轉(zhuǎn)換. 作用：將數(shù)據(jù)庫(kù)字段根據(jù)駝峰規(guī)則自動(dòng)注入到對(duì)象屬性。 map-underscore-to-camel-case: truelogging: level: #打印sql信息 com.hehe.mapper: debug |
3. 編寫數(shù)據(jù)層代碼
這里以我們熟悉的用戶信息為例，編寫usermapper接口和本案例使用的usersqlprovider。
3.1 usermapper
添加usermapper接口用于數(shù)據(jù)查詢：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
package com.hehe.mapper;@mapperpublic interface usermapper { /** * 方式1：使用注解編寫sql。 */ @select("select * from t_user") list<user> list(); /** * 方式2：使用注解指定某個(gè)工具類的方法來(lái)動(dòng)態(tài)編寫sql. */ @selectprovider(type = usersqlprovider.class, method = "listbyusername") list<user> listbyusername(string username); /** * 延伸：上述兩種方式都可以附加@results注解來(lái)指定結(jié)果集的映射關(guān)系. * * ps：如果符合下劃線轉(zhuǎn)駝峰的匹配項(xiàng)可以直接省略不寫。 */ @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(); /** * 延伸：無(wú)論什么方式,如果涉及多個(gè)參數(shù),則必須加上@param注解,否則無(wú)法使用el表達(dá)式獲取參數(shù)。 */ @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的工具類 。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
package com.hehe.mapper;/** * 主要用途：根據(jù)復(fù)雜的業(yè)務(wù)需求來(lái)動(dòng)態(tài)生成sql. * <p> * 目標(biāo)：使用java工具類來(lái)替代傳統(tǒng)的xml文件.(例如：usersqlprovider.java <-- usermapper.xml) */public class usersqlprovider { /** * 方式1：在工具類的方法里,可以自己手工編寫sql。 */ public string listbyusername(string username) { return "select * from t_user where username =#{username}"; } /** * 方式2：也可以根據(jù)官方提供的api來(lái)編寫動(dòng)態(tài)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 實(shí)體類user
添加實(shí)體類user
|
1
2
3
4
5
6
7
|
public class user { private string userid; private string username; private string password; private string mobilenum; //getters & setters} |
3.4 添加數(shù)據(jù)庫(kù)記錄
打開(kāi)navicat 查詢窗口，然后只需下面這段腳本。
|
1
2
3
4
5
6
7
8
9
10
11
|
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. 編寫控制層代碼
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
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. 啟動(dòng)和測(cè)試
啟動(dòng)工程后，訪問(wèn) http://localhost:8080/user/list 可以查看用戶列表如下：
訪問(wèn) http://localhost:8080/user/list/admin 可以查詢用戶名為admin的信息：
五. 文檔
官方文檔：mybatis3-中文手冊(cè)
關(guān)于mybatis注解的使用：
優(yōu)點(diǎn)：無(wú)需xml，使用輕量級(jí)注解就可以編寫sql并返回查詢結(jié)果，功能強(qiáng)大且方便。
缺點(diǎn)：mybatis使用注解最大的缺點(diǎn)是無(wú)法實(shí)現(xiàn)實(shí)體屬性和數(shù)據(jù)庫(kù)字段的映射關(guān)系，如果不滿足駝峰的話，每個(gè)查詢都要使用@results，會(huì)造成一定代碼冗余，官方承認(rèn)把這個(gè)重大缺陷甩給了java注解的限制，為了解決這個(gè)問(wèn)題，接下來(lái)我們學(xué)習(xí)如何在項(xiàng)目中快速引入通用mapper，讓mapper接口通過(guò)泛型繼承就能獲取基于單個(gè)對(duì)象的增刪改查！！
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持服務(wù)器之家。
原文鏈接：http://www.jianshu.com/p/828d2bd12b2f
