Javaで注釈の値を読み取ることは可能ですか?


98

これは私のコードです:

@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

はい、Columnアノテーションにランタイム保持がある場合

@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());
}

UPDATE:プライベートフィールドを取得するには、

Myclass.class.getDeclaredFields()

1
私はあなたの解決策が好きです。MyClassの代わりに、より一般的なようにするにはどうすればよいですか(Field f:T.class.getFields()){Column column = f.getAnnotation(Column.class); if(column!= null)System.out.println(column.columnName()); }
ATHER

1
丁度!私もそれを理解するのに苦労しています。クラス名を明示的に提供する必要がない注釈プロセッサが必要な場合はどうなりますか?文脈からそれを拾うようにすることはできますか?'この'??
5122014009 2014

二人が何を必要としているのかよくわかりません。完全な例を使って、新しい質問としてそれを聞いてください。必要に応じて、ここにリンクできます。
頭足類2014

3
Myclass.class.getDeclaredFields()プライベートフィールドの取得に使用
q0re

それは私のために働いた。ありがとう。。私は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());
    }
}

あなたのようなフィールド注釈の場合はそれほど違いはありません。

チアーズ!


21

私はそれをやったことはありませんが、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);
  }
}

6

@Cephalopodの答えを詳しく説明すると、リスト内のすべての列名が必要な場合は、次のワンライナーを使用できます。

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は- >非NULL(f.getAnnotation(Column.class)))
ディヒューマナイザー

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();

    }

}

これは、SomeClass.class.get(...)();と100%等しくないことに注意してください。

しかし、トリックを行うことができます...


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)。

以下の例では、RequestMappingアノテーションを持つメソッドからRequestMapping URL値をプルしています。これをフィールドに適合させるには、

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

私がそれを使用した方法の1つ:

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;
}    
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.