第十章:枚举类与注解
2021年3月1日
16:13
一、枚举类的使用
1.枚举类的理解:类的对象只有有限个,确定的。我们称此类为枚举类
2.当需要定义一组常量时,强烈建议使用枚举类
3.如果枚举类中只有一个对象,则可以作为单例模式的实现方式。
二、如何定义枚举类
* 方式一:jdk5.0之前,自定义枚举类
* 方式二:jdk5.0,可以使用enum关键字定义枚举类
l使用说明
Ø使用 enum 定义的枚举类默认继承了 java.lang.Enum类,因此不能再继承其他类
Ø枚举类的构造器只能使用 private 权限修饰符
Ø枚举类的所有实例必须在枚举类中显式列出(, 分隔; 结尾)。列出的实例系统会自动添加 public static final 修饰
Ø必须在枚举类的第一行声明枚举类对象
lJDK 1.5 中可以在 switch 表达式中使用Enum定义的枚举类的对象作为表达式, case 子句可以直接使用枚举值的名字, 无需添加枚举类作为限定。
//自定义枚举类
class Season{ //1.声明Season对象的属性:private final修饰 private final String seasonName; private final String seasonDesc;
//2.私有化类的构造器,并给对象属性赋值 private Season(String seasonName,String seasonDesc){ this.seasonName = seasonName; this.seasonDesc = seasonDesc; }
//3.提供当前枚举类的多个对象:public static final的 public static final Season SPRING = new Season("春天","春暖花开"); public static final Season SUMMER = new Season("夏天","烈日炎炎"); public static final Season AUTUMN = new Season("秋天","秋高气爽"); public static final Season WINTER = new Season("冬天","银装素裹");
//4.其他诉求1:获取枚举类对象的属性 public String getSeasonName() { return seasonName; } public String getSeasonDesc() { return seasonDesc; }
//4.其他诉求2:提供toString() @Override public String toString() { return "Season{" + "seasonName='" + seasonName + '\'' + ", seasonDesc='" + seasonDesc + '\'' + '}'; } } |
使用enum关键字定义枚举类
enum Sex{ //1.提供当前枚举类的对象,多个对象之间用","隔开,末尾对象";"结束 MAN("男人","男人帅"), WOMAN("女人","女人漂亮"); //2.声明Season对象的属性:private final修饰 private final String name; private final String desc; //3.私有化类的构造器,并给对象属性赋值 private Sex(String name,String desc){ this.name = name; this.desc = desc; } //4.其他诉求1:获取枚举类对象的属性 //4.其他诉求2:提供toString() enum有默认的toString()方法,继承于Enum类,返回枚举类对象的名称 } |
//System.out.println(Sex.class.getSuperclass());//java.lang.Enum
类.class.getSuperclass() 获取类的父类
三、Enum类中的常用方法:
* values()方法:返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
* valueOf(String str):可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的“名字”。如不是,会有运行时异常:IllegalArgumentException。
* toString():返回当前枚举类对象常量的名称
//values():返回所有的枚举类对象构成的数组 Season1[] values = Season1.values(); Thread.State[] values1 = Thread.State.values(); //valueOf(String objName):返回枚举类中对象名是objName的对象。 Season1 winter = Season1.valueOf("WINTER"); //如果没有objName的枚举类对象,则抛异常:IllegalArgumentException // Season1 winter1 = Season1.valueOf("WINTER1"); |
四、使用enum关键字定义的枚举类实现接口的情况
* 情况一:实现接口,在enum类中实现抽象方法
* 情况二:让枚举类的对象分别实现接口中的抽象方法
一、直接implements enum Season1 implements Info{} 二、提供当前枚举类的对象时,可以提供单独的重写的方法(也可以不提供,使用类中提供的) 提供了单独的重写的方法后,其实这个枚举类的对象已经成了枚举类的匿名子类 //class com.atguigu.java.Season1$1 SPRING("春天","春暖花开"){ @Override public void show() { System.out.println("春天在哪里"); } }, SUMMER("夏天","烈日炎炎"); |
注解 (Annotation)
l从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)
lAnnotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
lAnnotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方
法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation
的 “name=value” 对中。
l一定程度上可以说:框架 = 注解 + 反射 + 设计模式。
注解的使用
*
* 1. 理解Annotation:
* ① jdk 5.0 新增的功能
*
* ② Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation,程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。
*
* ③在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE/Android中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
*
* 2. Annocation的使用示例
* 示例一:生成文档相关的注解
@author 标明开发该类模块的作者,多个作者之间使用,分割 @version 标明该类模块的版本 @see 参考转向,也就是相关主题 @since 从哪个版本开始增加的 @param 对方法中某参数的说明,如果没有参数就不能写 @return 对方法返回值的说明,如果方法的返回值类型是void就不能写 @exception 对方法可能抛出的异常进行说明 ,如果方法没有用throws显式抛出的异常就不能写 其中 @param @return 和 @exception 这三个标记都是只用于方法的。 @param的格式要求:@param 形参名 形参类型 形参说明 @return 的格式要求:@return 返回值类型 返回值说明 @exception的格式要求:@exception 异常类型 异常说明 @param和@exception可以并列多个 |
* 示例二:在编译时进行格式检查(JDK内置的三个基本注解)
@Override: 限定重写父类方法, 该注解只能用于方法 (如果写了@Override,但是实际上方法没有构成重写,会报错。格式检查的作用)
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择(子类重写了父类的方法,那么只有在父类写上@Deprecated才可以,在子类写没有效果)
@SuppressWarnings: 抑制编译器警告(必须有参数)
@SuppressWarnings("unused") Date date = new Date(2020,11,12); @SuppressWarnings({"unused","rawtypes"}) ArrayList list = new ArrayList(); |
* 示例三:跟踪代码依赖性,实现替代配置文件功能
3. 如何自定义注解:参照@SuppressWarnings定义
l 定义新的 Annotation 类型使用 @interface 关键字
l 自定义注解自动继承了java.lang.annotation.Annotation接口
l Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其
方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能
是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、
以上所有类型的数组。
l 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始
值可使用 default 关键字
l 如果只有一个参数成员,建议使用参数名为value
l 如果定义的注解含有配置参数,那么使用时必须指定参数值,除非它有默认
值(有默认值可以不指定,并且可以不写括号)。格式是“参数名 = 参数值”,如果只有一个参数成员,且名称为value,可以省略“value=”(参数名不是value的话,不可以省略"value=")
l 没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数
据 Annotation
注意:自定义注解必须配上注解的信息处理流程才有意义
public @interface MyAnnotation { String vs() default "hello"; } 使用: @MyAnnotation(vs = "hi") @MyAnnotation |
4.JDK 中的元注解
JDK 的元 Annotation 用于修饰其他 Annotation 定义
JDK5.0提供了4个标准的meta-annotation类型,分别是:
ØRetention
@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命 周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值: ØRetentionPolicy.SOURCE:在源文件中有效(即源文件保留),编译器直接丢弃这种策略的 注释 ØRetentionPolicy.CLASS:在class文件中有效(即class保留) , 当运行 Java 程序时, JVM 不会保留注解。 这是默认值 ØRetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当运行 Java 程序时, JVM 会 保留注释。程序可以通过反射获取该注释。 eg: @Retention(RetentionPolicy.RUNTIME) |
只有声明为RUNTIME生命周期的注解,才能通过反射获取。
ØTarget
@Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。 不写@Target就是没有限制,都可以用! eg: @Target({TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE}) |
下面两个不常用:
ØDocumented
@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下,javadoc是不包括注解的。 Ø定义为Documented的注解必须设置Retention值为RUNTIME。 eg:@Deprecated就设置为@Documented |
ØInherited
@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。 Ø比如:如果把标有@Inherited注解的自定义的注解标注在类级别上,子类则可以继承父类级别的注解 |
自定义注解通过都会指明两个元注解:Retention、Target
6. jdk 8 中注解的新特性:可重复注解、类型注解
//jdk 8之前的写法 @MyAnnotations({@MyAnnotation(vs = "thank"),@MyAnnotation(vs = "hi")}) 把两个相同的注解当做另一个注解属性(数组)的元素。注意两个注解的@符号要写上 |
jdk 8可重复注解:
① 在MyAnnotation上声明@Repeatable,成员值为MyAnnotations.class
② MyAnnotation的Target和Retention等元注解与MyAnnotations相同。
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) @Retention(RetentionPolicy.RUNTIME) public @interface MyAnnotations { MyAnnotation[] value(); } ******************************************************************* @Repeatable(MyAnnotations.class) //注意这里 @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) //要一致 @Retention(RetentionPolicy.RUNTIME) //要一致 public @interface MyAnnotation { String vs() default "hello"; } ********************************************************************************************** @MyAnnotation(vs = "thank") //这样就可以直接写两个了 @MyAnnotation(vs = "hi") class Person{} |
类型注解:
l JDK1.8之后,关于元注解@Target的参数类型ElementType枚举值多了两个:
TYPE_PARAMETER,TYPE_USE。
l 在Java 8之前,注解只能是在声明的地方所使用,Java8开始,注解可以应用
在任何地方。
Ø ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)。
Ø ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。
@Target({******,TYPE_PARAMETER,TYPE_USE})
class Generic<@MyAnnotation @MyAnnotation T>{ public void show() throws @MyAnnotation RuntimeException{ ArrayList<@MyAnnotation String> list = new ArrayList<>(); int num = (@MyAnnotation int) 10L; } } |
存在可重复注解的情况下 ,数组注解的@Target可以没有TYPE_PARAMETER,TYPE_USE。
没有的情况下可以正常用单个注解,但是不可以用重复注解。想要在任意位置用重复注解的话,需要在数组注解的@Target也加上TYPE_PARAMETER,TYPE_USE
2021年3月1日22:53:32 删除了结尾前的空行
结尾
使用 Microsoft OneNote 2016 创建。 版权所有:古木苏