Puis-je obtenir le nom du paramètre de la méthode en utilisant la réflexion Java ?

Question

Si j'ai un cours comme ça :

public class Whatever
{
  public void aMethod(int aParam);
}

Y a-t-il un moyen de savoir que aMethod utilise un paramètre nommé aParam qui est de type int ?

Answer 1

En Java 8, vous pouvez faire ce qui suit :

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.ArrayList;
import java.util.List;

public final class Methods {

    public static List<String> getParameterNames(Method method) {
        Parameter[] parameters = method.getParameters();
        List<String> parameterNames = new ArrayList<>();

        for (Parameter parameter : parameters) {
            if(!parameter.isNamePresent()) {
                throw new IllegalArgumentException("Parameter names are not present!");
            }

            String parameterName = parameter.getName();
            parameterNames.add(parameterName);
        }

        return parameterNames;
    }

    private Methods(){}
}

Donc pour votre classe Whatever nous pouvons faire un test manuel :

import java.lang.reflect.Method;

public class ManualTest {
    public static void main(String[] args) {
        Method[] declaredMethods = Whatever.class.getDeclaredMethods();

        for (Method declaredMethod : declaredMethods) {
            if (declaredMethod.getName().equals("aMethod")) {
                System.out.println(Methods.getParameterNames(declaredMethod));
                break;
            }
        }
    }
}

qui devrait imprimer [aParam] si vous avez passé -parameters à votre compilateur Java 8.

Pour les utilisateurs de Maven :

<properties>
    <!-- PLUGIN VERSIONS -->
    <maven-compiler-plugin.version>3.1</maven-compiler-plugin.version>

    <!-- OTHER PROPERTIES -->
    <java.version>1.8</java.version>
</properties>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>${maven-compiler-plugin.version}</version>
            <configuration>
                <!-- Original answer -->
                <compilerArgument>-parameters</compilerArgument>
                <!-- Or, if you use the plugin version >= 3.6.2 -->
                <parameters>true</parameters>
                <testCompilerArgument>-parameters</testCompilerArgument>
                <source>${java.version}</source>
                <target>${java.version}</target>
            </configuration>
        </plugin>
    </plugins>
</build>

Pour plus d'informations, voir les liens suivants :

1. Tutoriel officiel de Java : Obtenir le nom des paramètres d'une méthode
2. JEP 118 : Accès aux noms de paramètres à l'exécution
3. Javadoc pour la classe Parameter

Answer 2

Pour résumer :

• obtenir les noms des paramètres est possible si les informations de débogage sont incluses lors de la compilation. Voir cette réponse pour plus de détails
• sinon, obtenir les noms des paramètres est pas possible
• obtenir le type de paramètre est possible, en utilisant method.getParameterTypes()

Pour écrire une fonctionnalité de complétion automatique pour un éditeur (comme vous l'avez indiqué dans l'un des commentaires), il existe quelques options :

• utiliser arg0 , arg1 , arg2 etc.
• utiliser intParam , stringParam , objectTypeParam etc.
• utiliser une combinaison des éléments ci-dessus - le premier pour les types non primitifs, et le second pour les types primitifs.
• ne montrent pas du tout les noms des arguments - seulement les types.

Answer 3

La bibliothèque Paranamer a été créée pour résoudre ce même problème.

Il tente de déterminer les noms des méthodes de plusieurs manières différentes. Si la classe a été compilée avec débogage, il peut extraire les informations en lisant le bytecode de la classe.

Une autre méthode consiste à injecter un membre statique privé dans le bytecode de la classe après sa compilation, mais avant qu'elle ne soit placée dans un jar. Il utilise ensuite la réflexion pour extraire cette information de la classe au moment de l'exécution.

https://github.com/paul-hammant/paranamer

J'ai eu des difficultés à utiliser cette bibliothèque, mais j'ai fini par la faire fonctionner. J'espère pouvoir signaler les problèmes au mainteneur.

Answer 4

Vous pouvez récupérer la méthode avec la réflexion et détecter ses types d'arguments. Vérifiez [getParameterTypes()](https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/reflect/Method.html#getParameterTypes()) .

Cependant, vous ne pouvez pas connaître le nom de l'argument utilisé.

Answer 5

C'est possible et Spring MVC 3 le fait, mais je n'ai pas pris le temps de voir exactement comment.

La correspondance des noms de paramètres de méthode aux noms de variables URI Template ne peut seulement si votre code est compilé avec le débogage activé. Si vous n'avez pas activé le débogage, vous devez spécifier le nom du modèle URI dans l'annotation @PathVariable afin de lier la valeur valeur résolue du nom de la variable à un paramètre de méthode. Par exemple :

Tiré du documentation sur le printemps