Можно ли прочитать значение аннотации в java?

100

это мой код:

@Column(columnName="firstname")


private String firstName;

 @Column(columnName="lastname")
 private String lastName;

 public String getFirstName() {
  return firstName;
 }

 public void setFirstName(String firstName) {
  this.firstName = firstName;
 }

 public String getLastName() {
  return lastName;
 }

 public void setLastName(String lastName) {
  this.lastName = lastName;
 }

можно ли прочитать значение моей аннотации @Column ( columnName = "xyz123") в другом классе?

Пчелы
источник

Ответы:

122

Да, если ваша аннотация столбца имеет сохранение во время выполнения

@Retention(RetentionPolicy.RUNTIME)
@interface Column {
    ....
}

ты можешь сделать что-то вроде этого

for (Field f: MyClass.class.getFields()) {
   Column column = f.getAnnotation(Column.class);
   if (column != null)
       System.out.println(column.columnName());
}

ОБНОВЛЕНИЕ: чтобы получить частные поля, используйте

Myclass.class.getDeclaredFields()
Головоногие моллюски
источник
1
мне нравится ваше решение. Как мы можем сделать его более общим, например, вместо MyClass, я хочу использовать T как для (Поле f: T.class.getFields ()) {Column column = f.getAnnotation (Column.class); если (столбец! = ноль) System.out.println (column.columnName ()); }
ATHER
1
Именно! Я тоже пытался понять это. Что, если я хочу иметь обработчик аннотаций, которому не нужно явно указывать имя класса? Можно ли подобрать это из контекста; 'этот'??
5122014009
Я не уверен, что понимаю, что вам двоим нужно. Задайте это как новый вопрос с полным примером. Вы можете связать это здесь, если хотите.
Cephalopod
3
Используйте Myclass.class.getDeclaredFields()для получения приватных полей
q0re 08
У меня это сработало. Спасибо. Я искал частные поля суперкласса, поэтому я использовал clsName.getSuperclass (). GetDeclaredFields ()
Shashank
88

Конечно, это является. Вот пример аннотации:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {

    String testText();
}

И пример аннотированного метода:

class TestClass {

    @TestAnnotation(testText="zyx")
    public void doSomething() {}
}

И пример метода в другом классе, который печатает значение testText:

Method[] methods = TestClass.class.getMethods();
for (Method m : methods) {
    if (m.isAnnotationPresent(TestAnnotation.class)) {
        TestAnnotation ta = m.getAnnotation(TestAnnotation.class);
        System.out.println(ta.testText());
    }
}

Не сильно отличается для аннотаций полей, подобных вашему.

Cheerz!

Лачезар Балев
источник
22

Я никогда этого не делал, но похоже, что Reflection обеспечивает это. Fieldесть AnnotatedElementи так оно и есть getAnnotation. На этой странице есть пример (скопирован ниже); довольно просто, если вы знаете класс аннотации и если политика аннотации сохраняет аннотацию во время выполнения. Естественно, если политика хранения не сохраняет аннотацию во время выполнения, вы не сможете запросить ее во время выполнения.

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

Пример с этой страницы :

import java.lang.annotation.Retention; 
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Method;

@Retention(RetentionPolicy.RUNTIME)
@interface MyAnno {
  String str();

  int val();
}

class Meta {
  @MyAnno(str = "Two Parameters", val = 19)
  public static void myMeth(String str, int i) {
    Meta ob = new Meta();

    try {
      Class c = ob.getClass();

      Method m = c.getMethod("myMeth", String.class, int.class);

      MyAnno anno = m.getAnnotation(MyAnno.class);

      System.out.println(anno.str() + " " + anno.val());
    } catch (NoSuchMethodException exc) {
      System.out.println("Method Not Found.");
    }
  }

  public static void main(String args[]) {
    myMeth("test", 10);
  }
}
TJ Crowder
источник
6

Разрабатывая ответ @Cephalopod, если вам нужны все имена столбцов в списке, вы можете использовать этот oneliner:

List<String> columns = 
        Arrays.asList(MyClass.class.getFields())
              .stream()
              .filter(f -> f.getAnnotation(Column.class)!=null)
              .map(f -> f.getAnnotation(Column.class).columnName())
              .collect(Collectors.toList());
Саймон Баарс
источник
Objects.nonNull полностью принять Java 8 :) .filter (п -> ненулевым (f.getAnnotation (Column.class)))
Dehumanizer
4

Хотя все ответы, приведенные до сих пор, совершенно верны, следует также иметь в виду библиотеку отражений Google для более общего и простого подхода к сканированию аннотаций, например

 Reflections reflections = new Reflections("my.project.prefix");

 Set<Field> ids = reflections.getFieldsAnnotatedWith(javax.persistence.Id.class);
Фриц Дюшардт
источник
3

В моем случае вы также можете использовать общие типы, принимая во внимание все сказанное, прежде чем вы сможете сделать что-то вроде:

public class SomeTypeManager<T> {

    public SomeTypeManager(T someGeneric) {

        //That's how you can achieve all previously said, with generic types.
        Annotation[] an = someGeneric.getClass().getAnnotations();

    }

}

Помните, что это не будет на 100% равным SomeClass.class.get (...) ();

Но все может получиться ...

СигмаСолдат
источник
3

В общем случае у вас есть частный доступ к полям, поэтому вы НЕ МОЖЕТЕ использовать getFields в отражении. Вместо этого вы должны использовать getDeclaredFields

Итак, во-первых, вы должны знать, имеет ли ваша аннотация Column сохранение времени выполнения:

@Retention(RetentionPolicy.RUNTIME)
@interface Column {
}

После этого вы можете сделать что-то вроде этого:

for (Field f: MyClass.class.getDeclaredFields()) {
   Column column = f.getAnnotation(Column.class);
       // ...
}

Очевидно, вы хотели бы что-то сделать с полем - установить новое значение, используя значение аннотации:

Column annotation = f.getAnnotation(Column.class);
if (annotation != null) {
    new PropertyDescriptor(f.getName(), Column.class).getWriteMethod().invoke(
        object,
        myCoolProcessing(
            annotation.value()
        )
    );
}

Итак, полный код может выглядеть так:

for (Field f : MyClass.class.getDeclaredFields()) {
    Column annotation = f.getAnnotation(Column.class);
    if (annotation != null)
        new PropertyDescriptor(f.getName(), Column.class).getWriteMethod().invoke(
                object,
                myCoolProcessing(
                        annotation.value()
                )
        );
}
Олег Полторацкий
источник
2

Это должно помочь тем немногим, кто просит универсальный метод (5 лет спустя: p).

В моем примере ниже я извлекаю значение URL-адреса RequestMapping из методов, которые имеют аннотацию RequestMapping. Чтобы адаптировать это для полей, просто измените

for (Method method: clazz.getMethods())

к

for (Field field: clazz.getFields())

И замените использование RequestMapping на любую аннотацию, которую вы хотите прочитать. Но убедитесь, что в аннотации есть @Retention (RetentionPolicy.RUNTIME) .

public static String getRequestMappingUrl(final Class<?> clazz, final String methodName)
{
    // Only continue if the method name is not empty.
    if ((methodName != null) && (methodName.trim().length() > 0))
    {
        RequestMapping tmpRequestMapping;
        String[] tmpValues;

        // Loop over all methods in the class.
        for (Method method: clazz.getMethods())
        {
            // If the current method name matches the expected method name, then keep going.
            if (methodName.equalsIgnoreCase(method.getName()))
            {
                // Try to extract the RequestMapping annotation from the current method.
                tmpRequestMapping = method.getAnnotation(RequestMapping.class);

                // Only continue if the current method has the RequestMapping annotation.
                if (tmpRequestMapping != null)
                {
                    // Extract the values from the RequestMapping annotation.
                    tmpValues = tmpRequestMapping.value();

                    // Only continue if there are values.
                    if ((tmpValues != null) && (tmpValues.length > 0))
                    {
                        // Return the 1st value.
                        return tmpValues[0];
                    }
                }
            }
        }
    }

    // Since no value was returned, log it and return an empty string.
    logger.error("Failed to find RequestMapping annotation value for method: " + methodName);

    return "";
}
Мэтт Вейлер
источник
0

один из способов, которыми я его использовал:

protected List<Field> getFieldsWithJsonView(Class sourceClass, Class jsonViewName){
    List<Field> fields = new ArrayList<>();
    for (Field field : sourceClass.getDeclaredFields()) {
        JsonView jsonViewAnnotation = field.getDeclaredAnnotation(JsonView.class);
        if(jsonViewAnnotation!=null){
            boolean jsonViewPresent = false;
            Class[] viewNames = jsonViewAnnotation.value();
            if(jsonViewName!=null && Arrays.asList(viewNames).contains(jsonViewName) ){
                fields.add(field);
            }
        }
    }
    return fields;
}    
РК Пунджал
источник