Могу ли я получить имя параметра метода с помощью отражения Java?


124

Если у меня есть такой класс:

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

есть ли способ узнать, что aMethodиспользует параметр с именем aParamтипа int?


10
7 ответов, и никто не упомянул термин «подпись метода». Это в основном то, что вы можете исследовать с помощью отражения, что означает отсутствие имен параметров.
ewernli

3
это это возможно, увидеть мой ответ ниже
ЭЛЕКТРОДИСТАНЦИОННАЯ СИСТЕМЫ УПРАВЛЕНИЯ

4
6 лет спустя это стало возможным благодаря отражению в Java 8 , см. Этот SO-ответ
Earcam

Ответы:


90

Подвести итоги:

  • получение имен параметров является возможным , если отладочная информация включается во время компиляции. См. Этот ответ для получения более подробной информации.
  • в противном случае получение имен параметров является не возможно
  • получение типа параметра возможно, используя method.getParameterTypes()

Для написания функции автозаполнения для редактора (как вы сказали в одном из комментариев) есть несколько вариантов:

  • использование arg0, arg1, и arg2т.д.
  • использование intParam, stringParam, objectTypeParamи т.д.
  • используйте комбинацию вышеперечисленного - первые для непримитивных типов, а вторые для примитивных типов.
  • не отображать имена аргументов - только типы.

4
Возможно ли это с интерфейсами? Я все еще не мог найти способ получить имена параметров интерфейса.
Cemo

@Cemo: удалось ли вам найти способ получить имена параметров интерфейса?
Вайбхав Гупта

Чтобы добавить, именно поэтому Spring нужна аннотация @ConstructorProperties для однозначного создания объекта из примитивных типов.
Bharat

102

В Java 8 вы можете делать следующее:

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(){}
}

Итак, для вашего класса Whateverмы можем провести ручной тест:

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;
            }
        }
    }
}

который должен печататься, [aParam]если вы передали -parametersаргумент компилятору Java 8.

Для пользователей 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>

Для получения дополнительной информации см. Следующие ссылки:

  1. Официальное руководство по Java: получение имен параметров метода
  2. JEP 118: Доступ к именам параметров во время выполнения
  3. Документация Javadoc для класса Parameter

2
Я не знаю, изменили ли они аргументы для плагина компилятора, но с последней версией (3.5.1 на данный момент) мне пришлось использовать аргументы компилятора в разделе конфигурации: <configuration> <compilerArgs> <arg> - параметры </arg> </compilerArgs> </configuration>
максимум

15

Библиотека Paranamer была создана для решения этой же проблемы.

Он пытается определить имена методов несколькими способами. Если класс был скомпилирован с отладкой, он может извлечь информацию, прочитав байт-код класса.

Другой способ - ввести частный статический член в байт-код класса после его компиляции, но до того, как он будет помещен в jar. Затем он использует отражение для извлечения этой информации из класса во время выполнения.

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

У меня были проблемы с использованием этой библиотеки, но в конце концов она заработала. Я надеюсь сообщить о проблемах сопровождающему.


Я пытаюсь использовать paranamer внутри apk для Android. Но я получаюParameterNAmesNotFoundException
Рилван

10

см. класс org.springframework.core.DefaultParameterNameDiscoverer

DefaultParameterNameDiscoverer discoverer = new DefaultParameterNameDiscoverer();
String[] params = discoverer.getParameterNames(MathUtils.class.getMethod("isPrime", Integer.class));

10

Да.
Код должен быть скомпилирован с помощью компилятора, совместимого с Java 8, с включенной опцией хранения формальных имен параметров ( опция -parameters ).
Тогда этот фрагмент кода должен работать:

Class<String> clz = String.class;
for (Method m : clz.getDeclaredMethods()) {
   System.err.println(m.getName());
   for (Parameter p : m.getParameters()) {
    System.err.println("  " + p.getName());
   }
}

Пробовал, и это сработало! Однако один совет: мне пришлось пересобрать ваш проект, чтобы эти конфигурации компилятора вступили в силу.
ishmaelMakitla

5

Вы можете получить метод с отражением и определить его типы аргументов. Проверьте http://java.sun.com/j2se/1.4.2/docs/api/java/lang/reflect/Method.html#getParameterTypes%28%29

Однако вы не можете сказать название используемого аргумента.


17
Воистину это все возможно. Однако его вопрос явно касался имени параметра . Проверьте заголовок.
BalusC

1
И цитирую: «Однако вы не можете сказать название используемого аргумента». просто прочтите мой ответ -_-
Johnco

3
Вопрос был сформулирован не так, как он не знал о получении шрифта.
BalusC

3

Это возможно, и Spring MVC 3 это делает, но я не нашел времени, чтобы понять, как именно.

Сопоставление имен параметров метода с именами переменных шаблона URI может быть выполнено только в том случае, если ваш код скомпилирован с включенной отладкой. Если у вас не включена отладка, вы должны указать имя имени переменной шаблона URI в аннотации @PathVariable, чтобы привязать разрешенное значение имени переменной к параметру метода. Например:

Взято из весенней документации


org.springframework.core.Conventions.getVariableName (), но я полагаю, что у вас должен быть cglib в качестве зависимости
Раду Тоадер

3

Хотя это невозможно (как показали другие), вы можете использовать аннотацию, чтобы перенести имя параметра и получить его через отражение.

Не самое чистое решение, но оно выполняет свою работу. Некоторые веб-службы фактически делают это для сохранения имен параметров (например, развертывание WS с помощью Glassfish).



3

Итак, вы должны уметь:

Whatever.declaredMethods
        .find { it.name == 'aMethod' }
        .parameters
        .collect { "$it.type : $it.name" }

Но вы, вероятно, получите такой список:

["int : arg0"]

Я считаю, что это будет исправлено в Groovy 2.5+.

Итак, в настоящее время ответ таков:

  • Если это класс Groovy, то нет, вы не можете получить имя, но в будущем сможете.
  • Если это класс Java, скомпилированный под Java 8, вы сможете это сделать.

Смотрите также:


Для каждого метода нужно что-то вроде:

Whatever.declaredMethods
        .findAll { !it.synthetic }
        .collect { method -> 
            println method
            method.name + " -> " + method.parameters.collect { "[$it.type : $it.name]" }.join(';')
        }
        .each {
            println it
        }

Я также не хочу указывать имя метода aMethod. Я хочу получить его для всех методов в классе.
Snoop

@snoop добавил пример получения каждого несинтетического метода
tim_yates

Не можем мы использовать antlrдля этого имена параметров?
Snoop

2

если вы используете eclipse, см. изображение ниже, чтобы компилятор мог хранить информацию о параметрах метода.

введите описание изображения здесь


2

Как заявил @Bozho, это можно сделать, если во время компиляции включена отладочная информация. Здесь есть хороший ответ ...

Как получить имена параметров конструкторов объекта (отражение)? автор: @AdamPaynter

... используя библиотеку ASM. Я собрал пример, показывающий, как можно достичь своей цели.

Прежде всего, начните с pom.xml с этими зависимостями.

<dependency>
    <groupId>org.ow2.asm</groupId>
    <artifactId>asm-all</artifactId>
    <version>5.2</version>
</dependency>
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
</dependency>

Затем этот класс должен делать то, что вы хотите. Просто вызовите статический метод getParameterNames().

import org.objectweb.asm.ClassReader;
import org.objectweb.asm.Type;
import org.objectweb.asm.tree.ClassNode;
import org.objectweb.asm.tree.LocalVariableNode;
import org.objectweb.asm.tree.MethodNode;

public class ArgumentReflection {
    /**
     * Returns a list containing one parameter name for each argument accepted
     * by the given constructor. If the class was compiled with debugging
     * symbols, the parameter names will match those provided in the Java source
     * code. Otherwise, a generic "arg" parameter name is generated ("arg0" for
     * the first argument, "arg1" for the second...).
     * 
     * This method relies on the constructor's class loader to locate the
     * bytecode resource that defined its class.
     * 
     * @param theMethod
     * @return
     * @throws IOException
     */
    public static List<String> getParameterNames(Method theMethod) throws IOException {
        Class<?> declaringClass = theMethod.getDeclaringClass();
        ClassLoader declaringClassLoader = declaringClass.getClassLoader();

        Type declaringType = Type.getType(declaringClass);
        String constructorDescriptor = Type.getMethodDescriptor(theMethod);
        String url = declaringType.getInternalName() + ".class";

        InputStream classFileInputStream = declaringClassLoader.getResourceAsStream(url);
        if (classFileInputStream == null) {
            throw new IllegalArgumentException(
                    "The constructor's class loader cannot find the bytecode that defined the constructor's class (URL: "
                            + url + ")");
        }

        ClassNode classNode;
        try {
            classNode = new ClassNode();
            ClassReader classReader = new ClassReader(classFileInputStream);
            classReader.accept(classNode, 0);
        } finally {
            classFileInputStream.close();
        }

        @SuppressWarnings("unchecked")
        List<MethodNode> methods = classNode.methods;
        for (MethodNode method : methods) {
            if (method.name.equals(theMethod.getName()) && method.desc.equals(constructorDescriptor)) {
                Type[] argumentTypes = Type.getArgumentTypes(method.desc);
                List<String> parameterNames = new ArrayList<String>(argumentTypes.length);

                @SuppressWarnings("unchecked")
                List<LocalVariableNode> localVariables = method.localVariables;
                for (int i = 1; i <= argumentTypes.length; i++) {
                    // The first local variable actually represents the "this"
                    // object if the method is not static!
                    parameterNames.add(localVariables.get(i).name);
                }

                return parameterNames;
            }
        }

        return null;
    }
}

Вот пример с модульным тестом.

public class ArgumentReflectionTest {

    @Test
    public void shouldExtractTheNamesOfTheParameters3() throws NoSuchMethodException, SecurityException, IOException {

        List<String> parameterNames = ArgumentReflection
                .getParameterNames(Clazz.class.getMethod("callMe", String.class, String.class));
        assertEquals("firstName", parameterNames.get(0));
        assertEquals("lastName", parameterNames.get(1));
        assertEquals(2, parameterNames.size());

    }

    public static final class Clazz {

        public void callMe(String firstName, String lastName) {
        }

    }
}

Вы можете найти полный пример на GitHub

Предостережения

  • Я немного изменил исходное решение от @AdamPaynter, чтобы оно работало для методов. Если я правильно понял, его решение работает только с конструкторами.
  • Это решение не работает с staticметодами. Это связано с тем, что в данном случае количество аргументов, возвращаемых ASM, отличается, но это легко исправить.

0

Имена параметров полезны только компилятору. Когда компилятор создает файл класса, имена параметров не включаются - список аргументов метода состоит только из количества и типов его аргументов. Таким образом, было бы невозможно получить имя параметра с помощью отражения (как указано в вашем вопросе) - его нигде нет.

Однако, если использование отражения не является жестким требованием, вы можете получить эту информацию непосредственно из исходного кода (при условии, что она у вас есть).


2
Имя параметра не только полезно для компилятора, оно также передает информацию потребителю библиотеки, предположим, что я написал класс StrangeDate, у которого был метод add (int day, int hour, int minute), если вы пошли использовать это и нашли метод add (int arg0, int arg1, int arg2) насколько это было бы полезно?
Дэвид Уотерс,

Извините - вы совершенно неправильно поняли мой ответ. Пожалуйста, перечитайте это в контексте вопроса.
danben

2
Получение имен параметров является большим преимуществом для рефлексивного вызова этого метода. Это полезно не только для компилятора, даже в контексте вопроса.
corsiKa

Parameter names are only useful to the compiler.Неправильно. Посмотрите библиотеку модернизации. Он использует динамические интерфейсы для создания запросов REST API. Одна из его функций - возможность определять имена заполнителей в путях URL и заменять эти заполнители соответствующими именами параметров.
TheRealChx101 05

0

Чтобы добавить мои 2 цента; информация о параметрах доступна в файле класса «для отладки», когда вы используете javac -g для компиляции источника. И он доступен для APT, но вам понадобится аннотация, поэтому от вас нет никакой пользы. (Кто-то обсуждал нечто подобное 4-5 лет назад здесь: http://forums.java.net/jive/thread.jspa?messageID=13467&tstart=0 )

Короче говоря, вы не можете получить его, если не работаете с исходными файлами напрямую (аналогично тому, что APT делает во время компиляции).

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.