web-dev-qa-db-ja.com

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

これは私のコードです：

@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"）の値を読み取ることはできますか？

javaannotationsgetter-setterjava-6
90
BeeS

はい、列注釈にランタイム保持がある場合

@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()
109
Cephalopod

もちろん。サンプルアノテーションは次のとおりです。

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

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

チアーズ！

80
Lachezar Balev

私は一度もやったことがありませんが、 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);
  }
}
19
T.J. Crowder

@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());
4
Simon Baars

これまでに与えられたすべての回答は完全に有効ですが、注釈スキャンに対するより一般的で簡単なアプローチのために google reflections library を念頭に置く必要があります。

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

 Set<Field> ids = reflections.getFieldsAnnotatedWith(javax.persistence.Id.class);
4
Fritz Duchardt

私の場合、次のようなことをする前に言ったことをすべて考慮して、ジェネリック型を使用することもできます：

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
SigmaSoldier

一般的な場合、フィールドにはprivateのアクセス権があるため、リフレクションではgetFieldsを使用できません。これの代わりにgetDeclaredFieldsを使用する必要があります

そのため、まず、列注釈にランタイム保持があるかどうかに注意する必要があります。

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

一般的な方法を求めている少数の人々にとって、これはあなたを助けるはずです（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 "";
}
1
MattWeiler