java注解教程 pdf_Java注解教程和示例
Java注解教程和示例
塔尼亚·辛格
Java注解使我们可以将元数据信息添加到源代码中,尽管它们不是程序本身的一部分。注解是从JDK 5添加到Java的。注解对其注解的代码的操作没有直接影响(即,它不影响程序的执行)。
在本教程中,我们将涵盖以下主题:注解的用法,如何应用注解,Java中可用的预定义注解类型以及如何创建自定义注解。
注解的用途是什么?
1)编译器指令:Java(@Deprecated,@Override&@SuppressWarnings)提供了三个内置注解,可用于向编译器提供某些指令。例如,@override批注用于指示编译器已批注的方法将覆盖该方法。本文的下一部分将讨论更多有关这些内置注解的示例。
2)编译时指令:注解可以向编译器提供编译时指令,软件构建工具可以将其进一步用于生成代码,XML文件等。
3)运行时指令:我们可以定义在运行时可用的批注,我们可以使用java反射对其进行访问,并且可以在运行时向程序提供指令。在同一篇文章的后面,我们将借助示例进行讨论。
注解基础
注解始终以符号开头,@后跟注解名称。@符号向编译器指示这是一个注解。
例如,@Override
在这里@符号表示这是一个注解,而Override是此注解的名称。
在哪里可以使用注解?
注解可以应用于类,接口,方法和字段。例如,以下注解将应用于该方法。
@Override void myMethod (){ //做某事}
下一节将说明此注解的确切功能,但要简要说明一下,它是指示编译器myMethod()重写了超类的方法。
Java内置注解
Java具有三个内置注解:
@Override
@Deprecated
@SuppressWarnings
1)@Override:
在子类中重写方法时,我们应使用此批注标记该方法。这使代码易于阅读并避免了维护问题,例如:在更改父类的方法签名时,必须在子类(使用此注解的地方)中更改签名,否则编译器会抛出编译错误。当您未使用此注解时,很难跟踪。
例:
public class MyParentClass {
public void justaMethod() {
System.out.println("Parent class method");
}
}
public class MyChildClass extends MyParentClass {
@Override
public void justaMethod() {
System.out.println("Child class method");
}
}
我相信这个例子是不言自明的。要阅读有关此注解的更多信息,请参阅本文:@Override 内置注解。
2)@Deprecated
@Deprecated 注解指示已弃用已标记的元素(类,方法或字段),并且不应再使用。每当程序使用已被 @Deprecated 注解标记的方法,类或字段时,编译器都会生成警告。不推荐使用元素时,还应使用Javadoc @deprecated 标记对其进行记录,如以下示例所示。使用 @Deprecated 和 @deprecated, 注意大小写差异。@deprecated用于文档目的。
例:
/**
* @deprecated
* reason for why it was deprecated
*/
@Deprecated
public void anyMethodHere(){
// Do something
}
现在,只要任何程序使用此方法,编译器都会生成警告。要阅读有关此注解的更多信息,请参阅本文:Java – @Deprecated注解。
3)@SuppressWarnings
该注解指示编译器忽略特定的警告。例如,在下面的代码中,我正在调用不赞成使用的方法(假设方法deprecatedMethod()已用 @Deprecated 注解标记),因此编译器应生成警告,但是我使用的是 @SuppressWarnings 批注,它将禁止该弃用警告。
@SuppressWarnings("deprecation")
void myMethod() {
myObject.deprecatedMethod();
}
创建自定义注解
注解是通过使用 @interface 创建的,后跟注解名称,如以下示例所示。
注解也可以具有属性。它们看起来像方法。例如,在下面的代码中,我们有四个属性。我们需要为这些属性提供相应的getter,setter 方法。
所有注解都扩展了java.lang.annotation.Annotation接口。注解不能包含任何extends子句, 不像类可以继承。
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Documented
@Target(ElementType.METHOD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyCustomAnnotation{
int studentAge() default 18;
String studentName();
String stuAddress();
String stuStream() default "CSE";
}
注意:使用注解时,可以跳过创建注解时设置了默认值的所有元素。例如,如果我将上述注解应用于一个类,则可以这样进行:
@MyCustomAnnotation(
studentName="Chaitanya",
stuAddress="Agra, India"
)
public class MyClass {
...
}
如您所见,我们没有给 studentAge 和 stuStream 元素赋予任何值,因为设置这些元素的值是可选的(注解值定义中已经设置了默认值,但是如果您想在使用注解时分配新值,则只需就像我们对其他属性所做的一样)。但是,在使用注解时,我们必须提供其他属性的值(未设置默认值的属性)。
注意:我们也可以在注解中包含数组属性。这是我们如何使用它们:
注解定义:
@interface MyCustomAnnotation {
int count();
String[] books();
}
用法:
@MyCustomAnnotation(
count=3,
books={"C++", "Java"}
)
public class MyClass {
}
让我们回到正题再次:在自定义注解例子中我们使用这四个注解:@Documented,@Target,@Inherited和 @Retention。Java 8以后又引入了 @Repeatable注解, 有些人把他们称作元注解,即用于注解的注解,他们共同特点是都被@Target(ElementType.ANNOTATION_TYPE)所标记,包括@Target自己。
让我们详细讨论它们。
@Documented
@Documented 注解指示使用此注解的元素应由 JavaDoc 记录。例如:
java.lang.annotation.Documented
@Documented
public @interface MyCustomAnnotation {
//Annotation body
}
@MyCustomAnnotation
public class MyClass {
//Class body
}
在为class生成 javadoc 时 MyClass,@MyCustomAnnotation 将包括注解。
@Target
它指定了我们可以在哪里使用注解。例如:在下面的代码中,我们将目标类型定义为 METHOD,这意味着下面的注解只能在方法上使用。
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Target({ElementType.METHOD})
public @interface MyCustomAnnotation {
}
public class MyClass {
@MyCustomAnnotation
public void myMethod()
{
//Doing something
}
}
注意:1)如果未定义任何目标类型,则意味着可以将注解应用于任何元素。
2)除了ElementType.METHOD,注解可以具有以下可能的Target值。
ElementType.METHOD
ElementType.PACKAGE
ElementType.PARAMETER
ElementType.TYPE
ElementType.ANNOTATION_TYPE
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.FIELD
以上这些放置位置并不是完全的互斥关系,比如 TYPE 实际上可以放在类、接口、注解类型和枚举类形前(即包括 ANNOTATION_TYPE 因为他们都是广义的类)。
@Inherited 继承
@Inherited 注解表示一个类中使用的自定义注解应由其所有子类继承。例如:
java.lang.annotation.Inherited
@Inherited
public @interface MyCustomAnnotation {
}
@MyCustomAnnotation
public class MyParentClass {
...
}
public class MyChildClass extends MyParentClass {
...
}
在这里,该类 MyParentClass 使用的 @MyCustomAnnotation 是带有 @Inherited 注解的注解。这意味着子类MyChildClass 继承了@MyCustomAnnotation。
@Retention 保留
它指示带有注解类型的注解将保留多长时间。
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
@interface MyCustomAnnotation {
}
在这里,我们使用了 RetentionPolicy.RUNTIME。也有两个其他选择。让我们看看它们的含义:
RetentionPolicy.RUNTIME 注解应该在运行时可用,以便通过Java反射进行检查。
RetentionPolicy.CLASS:注解将位于.class文件中,但在运行时将不可用。
RetentionPolicy.SOURCE 注解将在程序的源代码中提供,而不是在.class文件中,也不在运行时可用。
java注解教程 pdf_Java注解教程和示例相关推荐
- java注解教程 pdf_Java注解教程和自定义注解
Java注解提供关于代码的信息,并且对它们注解的代码没有直接的影响.在这篇教程中,我们将学习Java注解,如何自定义注解,注解用法和如何使用反射解析注解. Java注解在Java1.5被引用并且在一些 ...
- java注解教程 pdf_Java注解详解
在使用SpringBoot作为Web敏捷开发的框架之后,SpringBoot除了自动装配配置的便捷之外,在很多时候需要基于注解来开发.注解不仅增加了代码的可读性,还增加了开发的速度.这篇文章主要讲述J ...
- Java基础教程:注解
Java基础教程:注解 本篇文章参考的相关资料链接: 维基百科:https://zh.wikipedia.org/wiki/Java%E6%B3%A8%E8%A7%A3 注解基础与高级应用:http: ...
- java 自定义注解 教程_Java注解教程及自定义注解
Java注解提供了关于代码的一些信息,但并不直接作用于它所注解的代码内容.在这个教程当中,我们将学习Java的注解,如何定制注解,注解的使用以及如何通过反射解析注解. Java1.5引入了注解,当前许 ...
- 【廖雪峰官方网站/Java教程】注解
本节我们将介绍Java程序的一种特殊"注释"--注解(Annotation). 1.使用注解 1.1.注解入门示例 什么是注解(Annotation)?注解是放在Java源码的类. ...
- java抽取注释_JAVA 注解教程(五)注解的提取
注解与反射 注解通过反射获取.首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解 public boolean isAnnotationPres ...
- Java中使用ArrayList的10个示例–教程
Java中的ArrayList是HashMap之后最常用的集合类. Java ArrayList表示一个可自动调整大小的数组,并用于代替数组. 由于创建数组后我们无法修改数组的大小,因此我们更喜欢在J ...
- @value注解取不到值_教学笔记:Java注解及自定义注解示例
现代的Java编程过程中,会经常需要使用到注解,各种流行框架,比如在使用spring进行应用构建的过程中会使用到非常多的spring注解. 本文简要谈一谈Java注解以及如何去定义自己的注解在程序中进 ...
- java编程入门pdf_Java 8编程入门官方教程(第6版) [(美)Schildt H.] 中文完整pdf扫描版[233MB]...
Java8编程入门官方教程(第6版)针对新版JavaSE8对内容进行了全面更新.在畅销书作者Herbert Schildt(施密特)的帮助下,可以即刻开始学习Java程序设计的基础知识.<Jav ...
最新文章
- 什么是大数据口子_大数据分析师年薪几十万,学什么专业才能从事大数据?
- B站收藏6.1w+!这门课拯救你薄弱的计算机基础
- mysql保存中文乱码的原因和解决办法
- SQL -- 是否或推断线相交以在其内部的平面
- Toad for Oracle工具的使用(二)
- css expressionr,CSS Expression讲解
- ASP.NET MVC 4 (一)路径映射
- System Information for Windows
- Defend Your Country
- 线程间的通信 设置线程等待与线程唤醒
- 记一次参加 CrossOver Meetup 的经历
- 云计算实战系列四(Linux文件权限I)
- biztalk中架构验证、实例生成和验证
- 给Chrome和Firefox添加js脚本作为插件的方法
- python123月份名称缩写_月份及其缩写
- springboot基于微信小程序的运动软件前端的设计与实现毕业设计源码100932
- Linux学习总结(60)——Linux系统常用命令速查手册
- 无监督降维 效果评价 trustworthiness measure
- httpd配置三种虚拟主机带访问控制
- 数据库的三级模式结构和两级映像