通過方法引用獲取屬性名的底層邏輯是什么?
很多小伙伴可能都用過 MyBatis-Plus,這里邊我們構(gòu)造 where 條件的時(shí)候,可以直接通過方法引用的方式去指定屬性名:
LambdaQueryWrapper<Book> qw = new LambdaQueryWrapper<>();
qw.eq(Book::getId, 2);
List<Book> list = bookMapper.selectList(qw);
System.out.println("list = " + list);
Book::getId 這就是方法引用,松哥之前也專門寫過文章介紹相關(guān)內(nèi)容,這里就不再多說。這里我們就單純來說說為什么 MP 通過 Book::getId 就可以識別出來這里的屬性名。
1. 源碼分析
這個(gè)問題其實(shí)好解決,我們順著 qw.eq 這個(gè)方法往下看就可以了,這個(gè)方法在執(zhí)行的過程中幾經(jīng)輾轉(zhuǎn)會來到 getColumnCache 方法中,這個(gè)方法就是解析出來屬性值的地方。
protected ColumnCache getColumnCache(SFunction<T, ?> column) {
LambdaMeta meta = LambdaUtils.extract(column);
String fieldName = PropertyNamer.methodToProperty(meta.getImplMethodName());
Class<?> instantiatedClass = meta.getInstantiatedClass();
tryInitCache(instantiatedClass);
return getColumnCache(fieldName, instantiatedClass);
}
首先這里先將我們傳入的 Lambda 表達(dá)式通過 LambdaUtils.extract 方法解析出來一個(gè) LambdaMeta 對象。
public static <T> LambdaMeta extract(SFunction<T, ?> func) {
// 1. IDEA 調(diào)試模式下 lambda 表達(dá)式是一個(gè)代理
if (func instanceof Proxy) {
return new IdeaProxyLambdaMeta((Proxy) func);
}
// 2. 反射讀取
try {
Method method = func.getClass().getDeclaredMethod("writeReplace");
method.setAccessible(true);
return new ReflectLambdaMeta((SerializedLambda) method.invoke(func), func.getClass().getClassLoader());
} catch (Throwable e) {
// 3. 反射失敗使用序列化的方式讀取
return new ShadowLambdaMeta(com.baomidou.mybatisplus.core.toolkit.support.SerializedLambda.extract(func));
}
}
這塊的重點(diǎn)其實(shí)就在反射讀取這塊,這是從我們傳入的 Lambda 中找到了一個(gè)名為 writeReplace 的方法,并且通過反射執(zhí)行了這個(gè)方法,然后將執(zhí)行結(jié)果封裝為一個(gè) ReflectLambdaMeta 對象返回。
接下來回到 getColumnCache 方法中,繼續(xù)通過 String fieldName = PropertyNamer.methodToProperty(meta.getImplMethodName()); 獲取到屬性名稱。
這里有一個(gè) meta.getImplMethodName() 方法,這個(gè)方法的拿到的其實(shí)就是我們 Lambda 表達(dá)式中的方法名,也就是 getId,然后再通過 PropertyNamer.methodToProperty 對這個(gè)方法名進(jìn)行處理,最終拿到屬性名:
public static String methodToProperty(String name) {
if (name.startsWith("is")) {
name = name.substring(2);
} else if (name.startsWith("get") || name.startsWith("set")) {
name = name.substring(3);
} else {
throw new ReflectionException(
"Error parsing property name '" + name + "'. Didn't start with 'is', 'get' or 'set'.");
}
if (name.length() == 1 || name.length() > 1 && !Character.isUpperCase(name.charAt(1))) {
name = name.substring(0, 1).toLowerCase(Locale.ENGLISH) + name.substring(1);
}
return name;
}
大家看到,這個(gè)解析的過程其實(shí)就是把方法名的前綴 get/set/is 這些去掉,然后剩余的字符串首字母小寫之后返回。
這就是我們傳入 Book::getId,最終能夠拿到 id 這個(gè)名稱的原因。
現(xiàn)在的問題變成了 writeReplace 方法究竟是個(gè)什么方法?
2. writeReplace
這個(gè)方法其實(shí)是系統(tǒng)底層自動生成的。我們可以將 Lambda 表達(dá)式在運(yùn)行時(shí)生成的字節(jié)碼保存下來,然后進(jìn)行反編譯,這樣就能夠看到 writeReplace 方法了。
如果需要將 Lambda 運(yùn)行時(shí)生成的字節(jié)碼保存,需要在啟動參數(shù)中添加如下內(nèi)容:
-Djdk.internal.lambda.dumpProxyClasses=/Users/sang/workspace/code/mp_demo/lambda/
等于號后面的部分是指定生成的字節(jié)碼的保存位置,大家可以根據(jù)自己的實(shí)際情況去配置。
以本文一開頭的 Lambda 表達(dá)式為例,最終生成的字節(jié)碼反編譯之后,內(nèi)容如下:
final class MpDemo02ApplicationTests$$Lambda$1164 implements SFunction {
private MpDemo02ApplicationTests$$Lambda$1164() {
}
public Object apply(Object var1) {
return ((Book)var1).getId();
}
private final Object writeReplace() {
return new SerializedLambda(MpDemo02ApplicationTests.class, "com/baomidou/mybatisplus/core/toolkit/support/SFunction", "apply", "(Ljava/lang/Object;)Ljava/lang/Object;", 5, "org/javaboy/mp_demo02/model/Book", "getId", "()Ljava/lang/Integer;", "(Lorg/javaboy/mp_demo02/model/Book;)Ljava/lang/Object;", new Object[0]);
}
}
大家可以看到,apply 方法實(shí)際上是重寫的接口的方法,在這個(gè)方法中將傳入的對象強(qiáng)轉(zhuǎn)為 Book 類型,然后調(diào)用其 getId 方法。
然后大家看到,反編譯之后多了一個(gè) writeReplace 方法,這個(gè)方法的返回值是一個(gè) SerializedLambda,這個(gè) SerializedLambda 對象其實(shí)就是對 Lambda 表達(dá)式的描述?;旧厦總€(gè)參數(shù)都能做到見名知意,我這里說一下第七個(gè)參數(shù),值是 getId,這個(gè)參數(shù)的變量名是 implMethodName,這就是我們 Lambda 表達(dá)式中給出來的變量名。這也是第一小節(jié)中,meta.getImplMethodName() 所獲取到的值。
這下就清楚了,為什么寫了 Book::getId 就能拿到屬性名了。
3. 擴(kuò)展知識
有的小伙伴注意到,在 qw.eq(Book::getId, 2); 方法中,第一個(gè)參數(shù)是一個(gè) SFunction 的實(shí)例,那就說我直接給一個(gè) SFunction 的實(shí)例,不用 Lambda。大家注意,這種寫法不對!
原因在于經(jīng)過前面的源碼分析之后,我們發(fā)現(xiàn),MP 中根據(jù) Book::getId 去獲取屬性名稱,一個(gè)關(guān)鍵點(diǎn)是利用 Lambda 在執(zhí)行的時(shí)候生成的字節(jié)碼去獲取,如果你都沒有用 Lambda,那也就不會生成所謂的 Lambda 字節(jié)碼,也就不存在 writeReplace 方法,按照前文所分析的源碼,就無法獲取到屬性名稱。
還有小伙伴說,既然是 Lambda,那么我不用方法引用行不行?我像下面這樣寫行不行?
LambdaQueryWrapper<Book> qw = new LambdaQueryWrapper<>();
qw.eq(b -> b.getId(), 2);
List<Book> list = bookMapper.selectList(qw);
System.out.println("list = " + list);
這也是一個(gè) Lambda,但是如果你這樣寫了,運(yùn)行之后就會報(bào)錯(cuò)。為什么呢?我們來看下這個(gè) Lambda 生成的字節(jié)碼反編譯之后是什么樣的:
final class MpDemo02ApplicationTests$$Lambda$1164 implements SFunction {
private MpDemo02ApplicationTests$$Lambda$1164() {
}
public Object apply(Object var1) {
return MpDemo02ApplicationTests.lambda$test18$3fed5817$1((Book)var1);
}
private final Object writeReplace() {
return new SerializedLambda(MpDemo02ApplicationTests.class, "com/baomidou/mybatisplus/core/toolkit/support/SFunction", "apply", "(Ljava/lang/Object;)Ljava/lang/Object;", 6, "org/javaboy/mp_demo02/MpDemo02ApplicationTests", "lambda$test18$3fed5817$1", "(Lorg/javaboy/mp_demo02/model/Book;)Ljava/lang/Object;", "(Lorg/javaboy/mp_demo02/model/Book;)Ljava/lang/Object;", new Object[0]);
}
}
首先大家注意到 apply 方法生成的就不一樣,apply 里邊調(diào)用了 MpDemo02ApplicationTests.lambda$test18$3fed5817$1 方法,傳入了 Book 對象作為參數(shù)。這個(gè)方法內(nèi)容相當(dāng)于就是 return book.getId();。然后在 writeReplace 方法中,返回 SerializedLambda 對象的時(shí)候,implMethodName 的值就是 lambda$test18$3fed5817$1 了。回到本文一開始的源碼分析中,你會發(fā)現(xiàn)這樣的方法名就無法提取出來我們想要的屬性名。所以這種寫法也不對。
從這里大家也可以看到,類似于 b -> b.getId() 這樣的 Lambda,和方法引用 Book::getId 在底層是不同的。
再給小伙伴們舉個(gè)例子,比如下面一段代碼:
public class Demo01 {
public static void main(String[] args) {
Consumer<String> out1 = System.out::println;
out1.accept("javaboy");
Consumer<String> out2 = s -> System.out.println(s);
out2.accept("江南一點(diǎn)雨");
}
}
這里有兩個(gè)輸出,第一個(gè)是一個(gè)方法引用,第二個(gè)則是一個(gè)常規(guī)的 Lambda 表達(dá)式。這兩個(gè)執(zhí)行起來效果是一致的,但是底層原理不同。
先來看第一個(gè)底層生成的 Lambda 字節(jié)碼:
final class Demo01$$Lambda$14 implements Consumer {
private final PrintStream arg$1;
private Demo01$$Lambda$14(PrintStream var1) {
this.arg$1 = var1;
}
public void accept(Object var1) {
this.arg$1.println((String)var1);
}
}
可以看到,這里把 System.out 的值 PrintStream 作為構(gòu)造函數(shù)的參數(shù)傳進(jìn)來賦值給 arg變量,當(dāng)調(diào)用方法的時(shí)候,再調(diào)用1.println 方法將字符串輸出。
對于第二個(gè)底層生成的 Lambda 字節(jié)碼如下:
final class Demo01$$Lambda$16 implements Consumer {
private Demo01$$Lambda$16() {
}
public void accept(Object var1) {
Demo01.lambda$main$0((String)var1);
}
}
可以看到,這里有一個(gè)新的 lambda$main$0 方法,這個(gè)方法的底層邏輯其實(shí)就是我們自定義 Lambda 的時(shí)候?qū)懙?nbsp;System.out.println(s)。
3. 小結(jié)
好啦,一篇小文,和小伙伴們探討下 MP 中 qw.eq(Book::getId, 2); 方法的底層邏輯。