Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Java

Reflexão em Java: nomes de tipos, membros declarados e construtores

Consulta o nome de um tipo, procura campos e métodos declarados diretamente nele e cria um objeto com o construtor escolhido, distinguindo a pesquisa da permissão de acesso.

Versão: Java SE 21

Sintaxe

String Class.getName()
String Class.getSimpleName()
Field[] Class.getDeclaredFields()
Field Class.getDeclaredField(String name) throws NoSuchFieldException
Method[] Class.getDeclaredMethods()
Method Class.getDeclaredMethod(String name, Class<?>... parameterTypes) throws NoSuchMethodException
Constructor<T> Class<T>.getDeclaredConstructor(Class<?>... parameterTypes) throws NoSuchMethodException
T Constructor<T>.newInstance(Object... initargs) throws InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException

Em Java SE 21, Class.getName() devolve o nome binário de uma classe ou interface não oculta, como demo.Main$Item. Um tipo oculto tem um nome especial com um sufixo após /; um array usa uma codificação como [I; os tipos primitivos e void usam a respetiva palavra-chave. Class.getSimpleName() devolve o nome simples no código-fonte, como Item, uma cadeia vazia para uma classe anónima e, para um array, o nome simples do componente seguido de [].

getDeclaredFields() e getDeclaredMethods() devolvem Field[] e Method[], respetivamente. Incluem os membros declarados diretamente no tipo com qualquer visibilidade, mesmo private, mas excluem os herdados. getFields() e getMethods() devolvem apenas membros públicos e podem incluir os herdados. A ordem não é garantida; a lista de métodos pode incluir métodos-ponte ou outros métodos sintéticos.

getDeclaredField(name) procura um campo pelo nome e lança NoSuchFieldException se não o encontrar. getDeclaredMethod(name, parameterTypes...) exige o nome e os tipos exatos dos parâmetros formais pela ordem de declaração. getDeclaredConstructor(parameterTypes...) compara os parâmetros da mesma forma e devolve um Constructor<T>, mesmo para um construtor não público. Se não houver método ou construtor correspondente, é lançada NoSuchMethodException. A pesquisa não aplica boxing nem aceita correspondências por subtipo: int.class e Integer.class são distintos. Para String..., indica String[].class; para uma assinatura sem parâmetros, não indiques tipos. O tipo de retorno não é um argumento da pesquisa: se corresponderem vários métodos, é escolhido o que tem um tipo de retorno mais específico do que todos os outros, se existir; caso contrário, a escolha é arbitrária.

Encontrar um membro não dá autorização para o usar. Para suprimir as verificações de acesso a um membro privado de outro módulo, o pacote tem de estar aberto ao módulo que faz a chamada. Se as restrições impedirem a supressão, trySetAccessible() devolve false, enquanto setAccessible(true) lança InaccessibleObjectException. Em Java SE 21, ambos os métodos podem lançar SecurityException se um gestor de segurança instalado negar a permissão ReflectPermission("suppressAccessChecks").

Na pesquisa de um construtor, os objetos Class indicam os tipos dos parâmetros. Para invocar o construtor escolhido, Constructor.newInstance recebe os valores efetivos dos argumentos, incluindo um objeto Class se este for compatível com o tipo do parâmetro correspondente. Admite conversões como unboxing e os alargamentos permitidos. Para uma classe membro não estática, passa primeiro o tipo da classe envolvente na pesquisa e a sua instância na invocação. Se as verificações passarem, a classe é inicializada, se necessário, antes da criação do objeto. O acesso negado causa IllegalAccessException; uma quantidade incorreta de argumentos, tipos incompatíveis ou um construtor de enum causam IllegalArgumentException; uma classe abstrata causa InstantiationException. Uma exceção do construtor fica encapsulada em InvocationTargetException; consulta getCause(). A inicialização da classe pode falhar separadamente com ExceptionInInitializerError. Não confundas esta API com Class.newInstance(), que só chama um construtor sem argumentos e está obsoleto desde Java 9.

Exemplos

package demo;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.util.Arrays;

public class Main {
    static class Base {
        public int inherited;
        public void reset() {}
    }

    static final class Item extends Base {
        private final int count;

        private Item(int count) {
            this.count = count;
        }

        private String label(int offset) { return "count=" + (count + offset); }
        public String label(String prefix) { return prefix + count; }
    }

    public static void main(String[] args) throws ReflectiveOperationException {
        Class<Item> type = Item.class;
        System.out.println(type.getName());
        System.out.println(type.getSimpleName());
        System.out.println(Arrays.stream(type.getDeclaredFields())
                .map(Field::getName).sorted().toList());
        System.out.println(Arrays.stream(type.getDeclaredMethods())
                .map(m -> m.getName() + "(" + m.getParameterTypes()[0].getSimpleName() + ")")
                .sorted().toList());
        System.out.println(type.getDeclaredField("count").getType().getName());
        var method = type.getDeclaredMethod("label", int.class);
        Constructor<Item> constructor = type.getDeclaredConstructor(int.class);
        Item item = constructor.newInstance(7);
        System.out.println(method.invoke(item, 0));
    }
}

Resultado

demo.Main$Item
Item
[count]
[label(String), label(int)]
int
count=7

As listas são ordenadas antes de serem apresentadas. `inherited` e `reset` vêm de `Base`, pelo que não aparecem nas listas de `Item`. `int.class` seleciona `label(int)` e `7` é passado ao construtor. `Main` e `Item` pertencem ao mesmo ninho de classes, pelo que não é preciso suprimir as verificações de acesso ao construtor e ao método privados.

Lições relacionadas

  • Java · Lição 54 · Avançado · Versão: 2

Fontes