Java如何獲取方法參數(shù)具體名稱？這是個(gè)好問(wèn)題！

原創(chuàng)：小姐姐味道（微信公眾號(hào)ID：xjjdog），歡迎分享，轉(zhuǎn)載請(qǐng)保留出處。

默認(rèn)情況下，我們是無(wú)法獲取方法中參數(shù)名稱的。通過(guò)反射機(jī)制，也只能得到參數(shù)的順序以及一些沒(méi)有意義的變量：arg0、arg1等等。

但我們又確實(shí)需要這部分信息。比如IDE的自動(dòng)提示，文檔化服務(wù)接口的詳細(xì)信息等。

這是因?yàn)椋@些變量的名字，根本就沒(méi)有編譯進(jìn)class文件中，它不可能憑空產(chǎn)生。

在JDK 8之后，可以通過(guò)在編譯時(shí)指定-parameters選項(xiàng)，將方法的參數(shù)名記入class文件，并在運(yùn)行時(shí)通過(guò)反射機(jī)制獲取相關(guān)信息。

如果你的項(xiàng)目是實(shí)用maven構(gòu)建，那么就可以加入幾行配置，追加參數(shù)。

<plugin>  
    <artifactId>maven-compiler-pluginartifactId>  
    <version>3.8.0version>  
    <configuration>  
        <source>1.8source>  
        <target>1.8target>  
        <encoding>utf8encoding>  
        <compilerArgs>  
            <arg>-parametersarg>  
        compilerArgs>  
    configuration>  
plugin>  

如果是用的IDEA等編輯器，也可以通過(guò)設(shè)置界面進(jìn)行配置。不過(guò)不推薦這樣，因?yàn)槟愕倪@些配置不好進(jìn)行共享。

在普通Java項(xiàng)目里，就可以通過(guò)下面的方式來(lái)獲取反射數(shù)據(jù)。Method.getParameters這個(gè)方法是新加的。

public class Test {
  
    public static void main(String[] args) throws Exception{
        Class clazz = Class.forName("com.test.MethodParameterTest");
        Method[] methods = clazz.getMethods();
        Constructor[] constructors = clazz.getConstructors();
        for (Constructor constructor : constructors) {
            System.out.println("+++" + constructor.getName());
            Parameter[] parameters = constructor.getParameters();
            for (Parameter parameter : parameters) {
                printParameter(parameter);
            }
        }
  
        System.out.println("------------------");
        for (Method method : methods) {
            System.out.println(method.getName());
            Parameter[] parameters = method.getParameters();
            for (Parameter parameter : parameters) {
                printParameter(parameter);
            }
        }
    }
  
    private static void printParameter(Parameter parameter) {
        //參數(shù)名
        System.out.println("\t\t" + parameter.getName());
        //是否在源碼中隱式聲明的參數(shù)名
        System.out.println("\t\t\t implicit:" + parameter.isImplicit());
        //類文件中，是否存在參數(shù)名
        System.out.println("\t\t\t namePresent:" + parameter.isNamePresent());
        //是否為虛構(gòu)參數(shù)
        System.out.println("\t\t\t synthetic:" + parameter.isSynthetic());
        System.out.println("\t\t\t VarArgs:" + parameter.isVarArgs());
    }
}

下面介紹幾個(gè)方法的意義：

isImplicit()

參數(shù)是否為隱式聲明在源文件中，比如內(nèi)部類，默認(rèn)構(gòu)造函數(shù)（無(wú)參）其實(shí)在編譯成class時(shí)將會(huì)把包含它的主類引用作為首個(gè)參數(shù)，此參數(shù)即為隱式聲明。

如果為true，即表示有JDK編譯器隱式生成在class文件中的方法參數(shù)，而source文件中并不可見(jiàn)。常規(guī)的普通方法，此值為false。

isNamePresent()

此參數(shù)在class文件中是否有此參數(shù)名；受制于在編譯時(shí)是否指定了“-parameter”，對(duì)于指定此參數(shù)的編譯文件，通常為true；對(duì)于JDK 內(nèi)部類、默認(rèn)編譯的類，通常為false；此時(shí)你會(huì)發(fā)現(xiàn)，它們的參數(shù)名通常為表意名稱：arg0、arg1等等，此時(shí)為false。

isSynthetic()

是否為“虛構(gòu)”參數(shù)，如果為true，表示既不是“顯式”聲明、也不是隱式聲明在源文件中的參數(shù)，比如enum類的“values()”、“valueOf(String)”這是編譯器“虛構(gòu)”的系統(tǒng)方法。

在Spring環(huán)境中，由于有工具類的支持，會(huì)更加方便一些。

public class SpringTest {
  
    private static final ParameterNameDiscoverer parameterNameDiscoverer = new DefaultParameterNameDiscoverer();
  
  
    public static void main(String[] args) throws Exception{
        Class clazz = Class.forName("com.test.MethodParameterTest");
        Method[] methods = clazz.getMethods();
        for (Method method : methods) {
            System.out.println(method.getName());
            //JDK 1.8 + is better.
            String[] parameterNames = parameterNameDiscoverer.getParameterNames(method);
            if (parameterNames == null) {
                continue;
            }
            for (String pn : parameterNames) {
                System.out.println("\t\t" + pn);
            }
        }
    }
}

那Java版本低于1.8的時(shí)候，又是怎么獲取的呢？我們可以參考Spring的LocalVariableTableParameterNameDiscoverer類。

public String[] getParameterNames(Method method) {
		Method originalMethod = BridgeMethodResolver.findBridgedMethod(method);
		return doGetParameterNames(originalMethod);
}
@Nullable
private String[] doGetParameterNames(Executable executable) {
		Class declaringClass = executable.getDeclaringClass();
		Map map = this.parameterNamesCache.computeIfAbsent(declaringClass, this::inspectClass);
		return (map != NO_DEBUG_INFO_MAP ? map.get(executable) : null);
}

最后就走到了inspectClass方法中。

private Map inspectClass(Class clazz) {
		InputStream is = clazz.getResourceAsStream(ClassUtils.getClassFileName(clazz));
		if (is == null) {
			// We couldn't load the class file, which is not fatal as it
			// simply means this method of discovering parameter names won't work.
			if (logger.isDebugEnabled()) {
				logger.debug("Cannot find '.class' file for class [" + clazz +
						"] - unable to determine constructor/method parameter names");
			}
			return NO_DEBUG_INFO_MAP;
		}
		try {
			ClassReader classReader = new ClassReader(is);
			Map map = new ConcurrentHashMap<>(32);
			classReader.accept(new ParameterNameDiscoveringVisitor(clazz, map), 0);
			return map;
		}
		...

可以看到，這種情況下，Spring是通過(guò)直接讀取class文件進(jìn)行解析的。實(shí)際上是通過(guò)讀取LocalVariableTable中的數(shù)據(jù)進(jìn)行獲取的。如果你編譯的時(shí)候沒(méi)有加入這些debug選項(xiàng)，同樣也拿不到方法參數(shù)的具體名稱。

總結(jié)一下。Java8以前，讀取Class中的LocalVariableTable屬性表，需要編譯時(shí)加入?yún)?shù)-g或者-g:vars 獲取方法局部變量調(diào)試信息；Java8及其以后，通過(guò)java.lang.reflect.Parameter#getName即可獲取，但需要編譯時(shí)加入?yún)?shù)-parameters參數(shù)。

作者簡(jiǎn)介：小姐姐味道 ?(xjjdog)，一個(gè)不允許程序員走彎路的公眾號(hào)。聚焦基礎(chǔ)架構(gòu)和Linux。十年架構(gòu)，日百億流量，與你探討高并發(fā)世界，給你不一樣的味道。我的個(gè)人微信xjjdog0，歡迎添加好友，進(jìn)一步交流。