文章目录
1.注解概述
1)注解,或者叫做注释类型,英文单词是:Annotation
2)注解Annotation是一种引用数据类型。编译之后也是生成xxx.class文件。
3)怎么自定义注解呢?语法格式?
[修饰符列表] @interface 注解类型名{
}
4)注解怎么使用,用在什么地方?
第一: 注解使用时的语法格式是:
@注解类型名
第二: 注解可以出现在类上、属性上、方法上、变量上…
注解还可以出现在注解类型上。
5)JDK内置了那些注解呢?
java.lang包下的注释类型:
掌握:
Deprecated用@Deprecated注释的程序元素,
不鼓励程序员使用这样的元素,通常是因为他很危险或存在更好的选择。
掌握:
Override表示一个方法声明打算重写超类中的另一个方法声明。
不用掌握:
SuppressWarnings指示应该在注释元素(以及包含在该注释元素中的所有程序元素)中取消显示指定的编译器警告。
2.元注解
1)什么是元注解?
用来标注"注解类型"的"注解",称为元注解。
2)常见的元注解有哪些?
Target(掌握)
Retention(掌握)
3)关于Target注解:
这是一个元注解,用来标注"注解类型"的"注解"
这个Target注解用来标注"被标注的注解"可以出现在哪些位置上。
@Target(ElementType.Method):表示"被标注的注解"只能出现在方法上。
4)关于Retention注解:
这是一个元注解,用来标注"注解类型"的注解。
这个Retention注解用来标注"被标注的注解"最终保存在哪里。
@Retention(RetentionPolicy.SOURCE):表示该注解只能被保留在java源文件中。
@Retention(RetentionPolicy.CLASS):表示该注解被保存在class文件中。
@Retention(RetentionPolicy.RUNTIME):表示该注解被保存在class文件中,并且可以被反射机制所读取。
3.注解的定义及用法
package com.jmpower.javase.annotation;
public class MyAnnotationTest {
//报错的原因: 如果一个注解当中有属性,那么必须给属性赋值。
/*@MyAnnotation()
public void doSome(){
}*/
//@MyAnnotation(属性名=属性值)
//指定name属性的值就好了
@MyAnnotation(name="zhangsan",color="红色"/*,age=25*/)//有默认值了,这里可以更改
public void doSome(){
}
}
@interface MyAnnotation {
/*
我们通常在注解当中定义属性,以下这个是MyAnnotation的name属性。
看着像1个方法,但实际上我们称之为属性name。
*/
String name();
/*
颜色属性
*/
String color();
/*
年龄属性,default赋默认值
*/
int age() default 25;
}
4.Override注解
package com.jmpower.javase.annotation;
/*
关于JDK lang包下的Override注解
源代码:
public @interface Override{
}
标识性注解,给编译器做参考的。
编译器看到方法上有这个注解的时候,编译器会自动检查该方法是否重写了父类的方法。
如果没有,报错。
这个注解只是在编译阶段起作用,和运行期无关!
*/
//@Override这个注解只能注解方法
//@Override这个注解是给编译器参考的,和运行阶段没有关系
//凡是java中的方法带有这个注解的,编译器都会进行编译检查,如果这个方法不是重写父类的方法,编译器报错。
public class AnnotationTest01 {
@Override
public String toString() {
return "toString";
}
}
5.属性是value时可以省略
package com.jmpower.javase.annotation2;
/*
如果一个注解的属性的名字是value的话,在使用的时候可以省略。
*/
public class MyAnnotationTest {
//报错原因: 没有指定属性的值
/*@MyAnnotation()
public void doSome(){
}*/
@MyAnnotation(value="hehe")
public void doSome(){
}
@MyAnnotation("hehe")
public void doOther(){
}
}
@interface MyAnnotation {
/*
指定一个value属性
*/
String value();
}
6.Target和Retention注解
package com.jmpower.javase.annotation3;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@MyAnnotation("山东济南")
public class MyAnnotationTest {
//@MyAnnotation
int i;
//@MyAnnotation
public MyAnnotationTest(){
}
@MyAnnotation
public void doSome(){
//@MyAnnotation
int i;
}
}
//只允许该注解标注类、方法
@Target({ElementType.TYPE,ElementType.METHOD})
//希望这个注解可以被反射
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation{
/*
value属性
*/
String value() default "山东烟台";
}
7.反射注解
package com.jmpower.javase.annotation3;
/*
判断一个类上是否存在某个注解,用c.isAnnotationPresent(某个注解名.class);
*/
public class Test {
public static void main(String[] args) throws Exception{
//获取这个类
Class c=Class.forName("com.jmpower.javase.annotation3.MyAnnotationTest");
//判断类上面是否有@MyAnnotation
//System.out.println(c.isAnnotationPresent(MyAnnotation.class));// true
if(c.isAnnotationPresent(MyAnnotation.class)){
MyAnnotation myAnnotation=(MyAnnotation)c.getAnnotation(MyAnnotation.class);
String value= myAnnotation.value();
System.out.println(value);
}
//判断String类上面是否存在这个注解
Class stringClass=Class.forName("java.lang.String");
System.out.println(stringClass.isAnnotationPresent(MyAnnotation.class));// false
}
}
8.通过反射获取注解对象的属性值
package com.jmpower.javase.annotation4;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Method;
public class MyAnnotationTest {
@Annotation(name="admin",password="121")
public void doSome(){
}
public static void main(String[] args) throws Exception{
//获取MyAnnotation的doSome()方法上面的注释信息。
Class c=Class.forName("com.jmpower.javase.annotation4.MyAnnotationTest");
//获取doSome方法。
Method doSomeMethod=c.getDeclaredMethod("doSome");
//判断该方法上是否存在Annotation注解
if(doSomeMethod.isAnnotationPresent(Annotation.class)){
Annotation annotation=doSomeMethod.getAnnotation(Annotation.class);
System.out.println(annotation.name());
System.out.println(annotation.password());
}
}
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@interface Annotation{
//属性
String name();
String password();
}
9.注解在开发中有什么作用?
需求:
假设有这样一个注解,叫做: @ID
这个注解只能出现在类上面,当这个类上有这个注解的时候,要求这个类中必须有一个int类型的id属性。如果没有这个属性,就报异常。如果有这个属性则正常执行!
ID注解
package com.jmpower.javase.annotation5;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ID {
}
//这个注解@ID用来标注类,被标注的类中必须有一个int类型的id属性,没有就报异常
自定义异常类
package com.jmpower.javase.annotation5;
/*
自定义异常
*/
public class HasNotIdException extends Exception{
public HasNotIdException(){
}
public HasNotIdException(String s){
super(s);
}
}
User类
package com.jmpower.javase.annotation5;
@ID
public class User {
int id;
String name;
}
测试类
package com.jmpower.javase.annotation5;
import java.lang.reflect.Field;
public class Test {
public static void main(String[] args) throws Exception{
//获取类
Class userClass=Class.forName("com.jmpower.javase.annotation5.User");
//判断类上是否有ID注解
if(userClass.isAnnotationPresent(ID.class)){
//当一个类上有@ID注解的时候,要求类中必须存在int类型的id属性
//如果没有int类型的id属性则报异常
//获取类的属性
Field[] fields=userClass.getDeclaredFields();
boolean isOK=false;//给一个默认的标记
for(Field field:fields){
if("id".equals(field.getName())&&"int".equals(field.getType().getSimpleName())){
//表示这个类是合法的类。有@ID注解,则这个类中必须有int类型的id
isOK=true;// 表示合法
break;
}
}
//判断是否合法
if(!isOK){
throw new HasNotIdException("被@ID注解标注的类中必须要有一个int类型的id属性!");
}
}
}
}