この記事では Java アノテーションの定義と使用法 (コード例) を紹介します。必要な方は参考にしていただければ幸いです。
Java アノテーションは、特に Spring を使用した後、実際のプロジェクトでよく使用されます。
この記事では、Java アノテーションの構文と Spring でのアノテーションの使用例を紹介します。アノテーションの構文
アノテーションの例
例として Junit の @Test アノテーションを取り上げます
@Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface Test { long timeout() default 0L; }
@Test
を確認できます。アノテーション @Target()
と @Retention()
の 2 つのアノテーションがあります。
このようにアノテーションを付けるアノテーションを meta-annotation と呼びます。
メタデータと呼ばれるデータを宣言するデータと同じ意味です。
の後のアノテーションの形式は
修饰符 @interface 注解名 { 注解元素的声明1 注解元素的声明2 }
アノテーション の要素は 2 つの形式で宣言されます
type elementName(); type elementName() default value; // 带默认值
@Target
Annotation @Target
注釈は、@Target
のない注釈を適用できる項目を制限するために使用されます。どのアイテムにも適用できます。
java.lang.annotation.ElementType
クラスの @Target
# によって受け入れられるすべての項目を確認できます。 ##TYPE [クラス、インターフェイス、アノテーション] で
を使用 [フィールド、列挙定数] で ## を使用
#CONSTRUCTOR
[コンストラクター] で使用します
##LOCAL_VARIABLE [ローカル変数] で使用します
ANNOTATION_TYPE [アノテーション] で
を使用 [パッケージ] で を使用
Java で導入[型パラメータ] の 1.8
@Target(ElementType.METHOD) public @interface Test { ... }
複数の項目をサポートする場合は、複数の値を渡します。
@Target({ElementType.TYPE, ElementType.METHOD}) public @interface MyAnnotation { ... }さらに、メタアノテーションもアノテーションであり、
@Target(ElementType.ANNOTATION_TYPE)
注釈が注釈でのみ使用できることを示します。
@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Target { ElementType[] value(); }
@Retention
Annotation@Retention
注釈を保持する期間を指定します。デフォルトは
RetentionPolicy.CLASS## です。 #。
SOURCE
はクラス ファイルに含まれていません
@Retention(RetentionPolicy.RUNTIME) public @interface Test { ... }
@Documented
Annotation
または同様のツールを使用して文書化できます。
アノテーションのアノテーションを追加しました。アノテーションが付けられたクラスのサブクラスにもこのアノテーションが付けられます
Annotation
@Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Inherited public @interface MyAnnotation { ... }
<pre class="brush:php;toolbar:false">@MyAnnotation
class Parent { ... }</pre>
サブクラスは、@MyAnnotation
を
Inherited
に追加します。class Child extends Parent { ... }@Repeatable
AnnotationsJava 1.8 で導入されたアノテーションは、アノテーションを再利用可能としてマークします。
注 1
<pre class="brush:php;toolbar:false">public @interface MyAnnotations {
MyAnnotation[] value();
}</pre>
注 2
@Repeatable(MyAnnotations.class) public @interface MyAnnotation { int value(); }
@Repeatable() を使用する場合に使用されます
@MyAnnotation(1) @MyAnnotation(2) @MyAnnotation(3) public class MyTest { ... }
使用されません## を使用する場合#@Repeatable()
,@MyAnnotation
remove@Repeatable
meta-annotation@MyAnnotations({ @MyAnnotation(1), @MyAnnotation(2), @MyAnnotation(3)}) public class MyTest { ... }
このアノテーションは依然として非常に有用であり、コードを変更する必要があります。
Spring の @ComponentScan
アノテーションもこのメタ アノテーションを使用します。 要素の種類
サポートされる要素の種類
8 つの基本データ型 (
byte、
short
float、
double、
boolean )
文字列
##クラス
enum
アノテーション タイプ
#Example
public enum Status { GOOD, BAD }
@Target(ElementType.ANNOTATION_TYPE) public @interface MyAnnotation1 { int val(); }注2
@Target(ElementType.TYPE) public @interface MyAnnotation2 { boolean boo() default false; Class<?> cla() default Void.class; Status enu() default Status.GOOD; MyAnnotation1 anno() default @MyAnnotation1(val = 1); String[] arr(); }
@MyAnnotation2( cla = String.class, enu = Status.BAD, anno = @MyAnnotation1(val = 2), arr = {"a", "b"}) public class MyTest { ... }
@Override
Annotations は、これが親クラスをオーバーライドするメソッドであることをコンパイラーに伝えます。 。親クラスがこのメソッドを削除すると、サブクラスはエラーを報告します。@Deprecated
Annotation は、注釈が付けられた要素が非推奨になったことを示します。
注釈
アノテーション
javac
は、インターフェイスが関数型インターフェイス標準に準拠しているかどうかを確認するようになります。有两种比较特别的注解
标记注解 : 注解中没有任何元素,使用时直接是 @XxxAnnotation
, 不需要加括号
单值注解 : 注解只有一个元素,且名字为value
,使用时直接传值,不需要指定元素名@XxxAnnotation(100)
Java
的AnnotatedElement
接口中有getAnnotation()
等获取注解的方法。
而Method
,Field
,Class
,Package
等类均实现了这个接口,因此均有获取注解的能力。
@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD}) public @interface MyAnno { String value(); }
@MyAnno("class") public class MyClass { @MyAnno("feild") private String str; @MyAnno("method") public void method() { } }
public class Test { public static void main(String[] args) throws Exception { MyClass obj = new MyClass(); Class<?> clazz = obj.getClass(); // 获取对象上的注解 MyAnno anno = clazz.getAnnotation(MyAnno.class); System.out.println(anno.value()); // 获取属性上的注解 Field field = clazz.getDeclaredField("str"); anno = field.getAnnotation(MyAnno.class); System.out.println(anno.value()); // 获取方法上的注解 Method method = clazz.getMethod("method"); anno = method.getAnnotation(MyAnno.class); System.out.println(anno.value()); } }
Spring
中使用自定义注解注解本身不会有任何的作用,需要有其他代码或工具的支持才有用。
设想现有这样的需求,程序需要接收不同的命令CMD
,
然后根据命令调用不同的处理类Handler
。
很容易就会想到用Map
来存储命令和处理类的映射关系。
由于项目可能是多个成员共同开发,不同成员实现各自负责的命令的处理逻辑。
因此希望开发成员只关注Handler
的实现,不需要主动去Map
中注册CMD
和Handler
的映射。
最终希望看到效果是这样的
@CmdMapping(Cmd.LOGIN) public class LoginHandler implements ICmdHandler { @Override public void handle() { System.out.println("handle login request"); } } @CmdMapping(Cmd.LOGOUT) public class LogoutHandler implements ICmdHandler { @Override public void handle() { System.out.println("handle logout request"); } }
开发人员增加自己的Handler
,只需要创建新的类并注上@CmdMapping(Cmd.Xxx)
即可。
具体的实现是使用Spring
和一个自定义的注解
定义@CmdMapping
注解
@Documented @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Component public @interface CmdMapping { int value(); }
@CmdMapping
中有一个int
类型的元素value
,用于指定CMD
。这里做成一个单值注解。
这里还加了Spring
的@Component
注解,因此注解了@CmdMapping
的类也会被Spring创建实例。
然后是CMD
接口,存储命令。
public interface Cmd { int REGISTER = 1; int LOGIN = 2; int LOGOUT = 3; }
之后是处理类接口,现实情况接口会复杂得多,这里简化了。
public interface ICmdHandler { void handle(); }
上边说过,注解本身是不起作用的,需要其他的支持。下边就是让注解生效的部分了。
使用时调用handle()
方法即可。
@Component public class HandlerDispatcherServlet implements InitializingBean, ApplicationContextAware { private ApplicationContext context; private Map<Integer, ICmdHandler> handlers = new HashMap<>(); public void handle(int cmd) { handlers.get(cmd).handle(); } public void afterPropertiesSet() { String[] beanNames = this.context.getBeanNamesForType(Object.class); for (String beanName : beanNames) { if (ScopedProxyUtils.isScopedTarget(beanName)) { continue; } Class<?> beanType = this.context.getType(beanName); if (beanType != null) { CmdMapping annotation = AnnotatedElementUtils.findMergedAnnotation( beanType, CmdMapping.class); if(annotation != null) { handlers.put(annotation.value(), (ICmdHandler) context.getBean(beanType)); } } } } public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.context = applicationContext; } }
主要工作都是Spring
做,这里只是将实例化后的对象put
到Map
中。
测试代码
@ComponentScan("pers.custom.annotation") public class Main { public static void main(String[] args) { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(Main.class); HandlerDispatcherServlet servlet = context.getBean(HandlerDispatcherServlet.class); servlet.handle(Cmd.REGISTER); servlet.handle(Cmd.LOGIN); servlet.handle(Cmd.LOGOUT); context.close(); } }
> 完整项目
可以看到使用注解能够写出很灵活的代码,注解也特别适合做为使用框架的一种方式。
所以学会使用注解还是很有用的,毕竟这对于上手框架或实现自己的框架都是非常重要的知识。
以上がJava アノテーションの定義と使用の概要 (コード例)の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。