java獲取方法引數名的若干實踐
文章首發於我的個人部落格網站梧桐和風的部落格,歡迎關注。
前言
我們知道java可以通過反射得到方法名、引數型別等資訊。但我們似乎不能直接得到方法的引數名。而在一些場景中，比如構建自己的MVC框架時，我們也想像Spring MVC一樣，根據引數名獲取使用者傳來的資料。下面就來總結一下，都有哪些方法可以獲得方法的引數名。
1. 使用java8
自java8開始，可以直接通過反射得到方法的引數名。取代了之前如arg0、arg1 等無含義的引數名稱。不過這樣有個條件：你必須手動在編譯時開啟-parameters 引數，否則還是獲取不到。
以IDEA為例，你需要在Preferences->Build,Execution,Deployment->Compiler->java Compiler
下面就是程式碼了
public class TestMethodArg {
public void method1(String name,String email){
System.out.println(name+":"+email);
}
@Test
public void test(){
Class<TestMethodArg> clazz = TestMethodArg.class;
try {
//得到方法實體
Method method = clazz.getMethod("method1" 輸出結果：
name : class java.lang.String
email : class java.lang.String可見該方法很簡單，重點在於Parameter 這個類，其儲存了所代表的這個引數資訊，包括這個引數型別、名稱、註解等。可惜這個類是java8新加的，只能在jdk8及以後版本使用。
可以試試去掉-parameters引數，結果會看到引數名又變成arg0、arg1等名稱了。
2. 使用javassist獲取引數名
使用java8方法有侷限性，沒辦法，既然原生的只能幫我們到這，那我們就嘗試使用第三方類庫了。比較有名的java位元組碼操作類庫如javassist、asm、cglib 都可以辦到。據說cglib 底層使用asm 實現。我們重點研究前兩個。
先看看javassist。javassist 是一個處理java位元組碼的類庫。現已加入JBoss 應用伺服器專案。JBoss 就是使用它作為實現AOP 的框架。
可以看看這篇文章Javassist 使用指南（一) 來了解。簡單來說，CtClass表示類物件；CtMethod 表示方法；ClassPool 表示CtClass物件的容器，可從這裡獲取CtClass。其他的我們通過程式碼來實踐。
@Test
public void test3() {
try {
//獲取要操作的類物件
ClassPool pool = ClassPool.getDefault();
CtClass ctClass = pool.get("com.wthfeng.learn.classtest.Sample");
//獲取要操作的方法引數型別陣列，為獲取該方法代表的CtMethod做準備
Method method = Sample.class.getMethod("start", String.class);
int count = method.getParameterCount();
Class<?>[] paramTypes = method.getParameterTypes();
CtClass[] ctParams = new CtClass[count];
for (int i = 0; i < count; i++) {
ctParams[i] = pool.getCtClass(paramTypes[i].getName());
}
CtMethod ctMethod = ctClass.getDeclaredMethod("start", ctParams);
//得到該方法資訊類
MethodInfo methodInfo = ctMethod.getMethodInfo();
//獲取屬性變數相關
CodeAttribute codeAttribute = methodInfo.getCodeAttribute();
//獲取方法本地變數資訊，包括方法宣告和方法體內的變數
//需注意，若方法為非靜態方法，則第一個變數名為this
LocalVariableAttribute attr = (LocalVariableAttribute) codeAttribute.getAttribute(LocalVariableAttribute.tag);
int pos = Modifier.isStatic(method.getModifiers()) ? 0 : 1;
for (int i = 0; i < count; i++) {
System.out.println(attr.variableName(i + pos));
}
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (NotFoundException e) {
e.printStackTrace();
}
}Sample是一個簡單的測試類
class Sample {
private String name;
public void start(String tag) {
int i = 0;
String abc = "abc";
System.out.println(i);
System.out.println(tag);
System.out.println(abc);
}
}結果輸出tag。
控制迴圈的大小，還可以輸出i 、abc等方法體內的變數，這裡就不演示了。
3. 使用ASM獲取方法引數名
ASM也是一個java位元組碼操作類庫，不同的是它採用事件驅動模型。java class被描述為一棵樹，使用visitor 模式遍歷類結構，並在需要時進行修改。
其中主要的類有ClassReader，它可以通過位元組陣列或class檔案獲取位元組碼資料用於後面對位元組碼的操作。可以認為是位元組碼的生產者。其主要方法是accept，接受以ClassVisitor、ClassAdapter所代表的消費者對位元組碼的操作。操作均以遍歷的形式進行。下面我們來看看
@Test
public void test() {
try {
// 讀取HelloTest的位元組碼資訊到ClassReader中
ClassReader reader = new ClassReader(HelloTest.class.getName());
ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS);
//accept接收了一個ClassAdapter的子類，想要操作什麼，就在子類實現什麼
reader.accept(new ClassAdapter(cw) {
/**
* 會遍歷該類的所有方法，你可以對不需要操作的方法直接返回
*/
@Override
public MethodVisitor visitMethod(final int access, final String name, final String desc,
final String signature, final String[] exceptions) {
//不需要操作的方法，直接返回，注意不要返回null,會把該方法刪掉
if (!name.equals("test1")) {
return super.visitMethod(access, name, desc, signature, exceptions);
}
MethodVisitor v = super.visitMethod(access, name, desc,
signature, exceptions);
/**
* 遍歷該方法資訊，比如引數、註解等，這裡我們要操作引數，所以實現了引數方法
*/
return new MethodAdapter(v) {
public void visitLocalVariable(String name, String desc, String signature, Label start, Label end, int index) {
//如果是靜態方法，第一個引數就是方法引數，非靜態方法，則第一個引數是 this ,然後才是方法的引數
System.out.println(name + "," + index);
super.visitLocalVariable(name, desc, signature, start, end, index);
}
};
}
}, 0);
} catch (IOException e) {
e.printStackTrace();
}
}HelloTest是測試類，程式碼如下：
class HelloTest {
public void test1(String userName) {
System.out.println(userName);
}
public void test2(String email) {
System.out.println(email);
}
}我們這裡獲取的是test1 這個方法的引數名，輸出如下：
this,0
userName,1可見如願獲得了引數名，如果你不想獲取this，可參考javassist的例子。
4. Spring MVC是怎樣獲取的
一開始我們就提過，spring mvc 框架本身支援這個功能，那何不看看它是怎麼實現的？
Spring MVC的DefaultParameterNameDiscoverer 負責實現這個功能。大體思路是：
- 判斷是否是java8（通過
Executable這個java8引入的類判斷，Parameter許多方法使用了該類），若是，嘗試使用java8的方法獲取。 - 使用經spring封裝的ASM獲取，本質還是使用ASM。
public class DefaultParameterNameDiscoverer extends PrioritizedParameterNameDiscoverer {
private static final boolean standardReflectionAvailable = ClassUtils.isPresent(
"java.lang.reflect.Executable", DefaultParameterNameDiscoverer.class.getClassLoader());
public DefaultParameterNameDiscoverer() {
//java8的方式
if (standardReflectionAvailable) {
addDiscoverer(new StandardReflectionParameterNameDiscoverer());
}
//ASM的方式
addDiscoverer(new LocalVariableTableParameterNameDiscoverer());
}
}具體實現程式碼就不貼了。
———-全文完————