web-dev-qa-db-fra.com

Comment obtenir des annotations d'une variable membre?

Je souhaite connaître les annotations d'une variable de membre d'une classe, j'utilise BeanInfo beanInfo = Introspector.getBeanInfo(User.class) pour faire l'introspection d'une classe, et BeanInfo.getPropertyDescriptors() pour rechercher une propriété spécifique, et la classe type = propertyDescriptor.getPropertyType() pour obtenir la classe de la propriété.

Mais je ne sais pas comment ajouter les annotations à la variable membre?

J'ai essayé type.getAnnotations() et type.getDeclaredAnnotations(), mais les deux renvoient les annotations de la classe, pas ce que je veux. Par exemple :

class User 
{
  @Id
  private Long id;

  @Column(name="ADDRESS_ID")
  private Address address;

  // getters , setters
}

@Entity
@Table(name = "Address")
@Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
class Address 
{
  ...
}

Je souhaite obtenir l'annotation de l'adresse: @Column, et non les annotations de la classe Address (@Entity, @Table, @Cache). Comment y arriver? Merci.

javareflectionannotationsbeaninfo
52
smallufo
for(Field field : cls.getDeclaredFields()){
  Class type = field.getType();
  String name = field.getName();
  Annotation[] annotations = field.getDeclaredAnnotations();
}

Voir aussi: http://docs.Oracle.com/javase/tutorial/reflect/class/classMembers.html

67
Laurence Gonsalves

Tout le monde décrit le problème d'obtention d'annotations, mais le problème réside dans la définition de votre annotation. Vous devriez ajouter à votre définition d'annotation une @Retention(RetentionPolicy.RUNTIME):

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface MyAnnotation{
    int id();
}
75
Saturnim

Si vous avez besoin de savoir si une annotation spécifique est présente. Vous pouvez le faire

    Field[] fieldList = obj.getClass().getDeclaredFields();

        boolean isAnnotationNotNull, isAnnotationSize, isAnnotationNotEmpty;

        for (Field field : fieldList) {

            //Return the boolean value
            isAnnotationNotNull = field.isAnnotationPresent(NotNull.class);
            isAnnotationSize = field.isAnnotationPresent(Size.class);
            isAnnotationNotEmpty = field.isAnnotationPresent(NotEmpty.class);

        }

Et ainsi de suite pour les autres annotations ...

J'espère aider quelqu'un.

12
Marcelo Rebouças

Vous devez utiliser la réflexion pour obtenir tous les champs membres de la classe User, parcourez-les et recherchez leurs annotations.

quelque chose comme ça:

public void getAnnotations(Class clazz){
    for(Field field : clazz.getDeclaredFields()){
        Class type = field.getType();
        String name = field.getName();
        field.getDeclaredAnnotations(); //do something to these
    }
}
8
mkoryak

Vous pouvez obtenir des annotations sur la méthode getter:

propertyDescriptor.getReadMethod().getDeclaredAnnotations();

Obtenir les annotations d'un champ privé semble être une mauvaise idée ... que se passe-t-il si la propriété n'est même pas adossée à un champ ou si elle est adossée à un champ d'un nom différent? Même en ignorant ces cas, vous brisez l'abstraction en regardant des choses privées.

5
Laurence Gonsalves
package be.fery.annotation;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.PrePersist;

@Entity
public class User {
    @Id
    private Long id;

    @Column(name = "ADDRESS_ID")
    private Address address;

    @PrePersist
    public void doStuff(){

    }
}

Et un cours de test:

    package be.fery.annotation;

import Java.lang.annotation.Annotation;
import Java.lang.reflect.Field;
import Java.lang.reflect.Method;

public class AnnotationIntrospector {

    public AnnotationIntrospector() {
        super();
    }

    public Annotation[] findClassAnnotation(Class<?> clazz) {
        return clazz.getAnnotations();
    }

    public Annotation[] findMethodAnnotation(Class<?> clazz, String methodName) {

        Annotation[] annotations = null;
        try {
            Class<?>[] params = null;
            Method method = clazz.getDeclaredMethod(methodName, params);
            if (method != null) {
                annotations = method.getAnnotations();
            }
        } catch (SecurityException e) {
            e.printStackTrace();
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }
        return annotations;
    }

    public Annotation[] findFieldAnnotation(Class<?> clazz, String fieldName) {
        Annotation[] annotations = null;
        try {
            Field field = clazz.getDeclaredField(fieldName);
            if (field != null) {
                annotations = field.getAnnotations();
            }
        } catch (SecurityException e) {
            e.printStackTrace();
        } catch (NoSuchFieldException e) {
            e.printStackTrace();
        }
        return annotations;
    }

    /**
     * @param args
     */
    public static void main(String[] args) {
        AnnotationIntrospector ai = new AnnotationIntrospector();
        Annotation[] annotations;
        Class<User> userClass = User.class;
        String methodDoStuff = "doStuff";
        String fieldId = "id";
        String fieldAddress = "address";

        // Find class annotations
        annotations = ai.findClassAnnotation(be.fery.annotation.User.class);
        System.out.println("Annotation on class '" + userClass.getName()
                + "' are:");
        showAnnotations(annotations);

        // Find method annotations
        annotations = ai.findMethodAnnotation(User.class, methodDoStuff);
        System.out.println("Annotation on method '" + methodDoStuff + "' are:");
        showAnnotations(annotations);

        // Find field annotations
        annotations = ai.findFieldAnnotation(User.class, fieldId);
        System.out.println("Annotation on field '" + fieldId + "' are:");
        showAnnotations(annotations);

        annotations = ai.findFieldAnnotation(User.class, fieldAddress);
        System.out.println("Annotation on field '" + fieldAddress + "' are:");
        showAnnotations(annotations);

    }

    public static void showAnnotations(Annotation[] ann) {
        if (ann == null)
            return;
        for (Annotation a : ann) {
            System.out.println(a.toString());
        }
    }

}

J'espère que ça aide...

;-)

3
Philippe Fery

Ma façon

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import Java.beans.BeanInfo;
import Java.beans.Introspector;
import Java.beans.PropertyDescriptor;

public class ReadAnnotation {
    private static final Logger LOGGER = LoggerFactory.getLogger(ReadAnnotation.class);

    public static boolean hasIgnoreAnnotation(String fieldName, Class entity) throws NoSuchFieldException {
        return entity.getDeclaredField(fieldName).isAnnotationPresent(IgnoreAnnotation.class);
    }

    public static boolean isSkip(PropertyDescriptor propertyDescriptor, Class entity) {
        boolean isIgnoreField;
        try {
            isIgnoreField = hasIgnoreAnnotation(propertyDescriptor.getName(), entity);
        } catch (NoSuchFieldException e) {
            LOGGER.error("Can not check IgnoreAnnotation", e);
            isIgnoreField = true;
        }
        return isIgnoreField;
    }

    public void testIsSkip() throws Exception {
        Class<TestClass> entity = TestClass.class;
        BeanInfo beanInfo = Introspector.getBeanInfo(entity);

        for (PropertyDescriptor propertyDescriptor : beanInfo.getPropertyDescriptors()) {
            System.out.printf("Field %s, has annotation %b", propertyDescriptor.getName(),  isSkip(propertyDescriptor, entity));
        }
    }

}
0
Gleb Belyaev