Java_枚举类和注解

Posted 2021-09-07 小企鹅推雪球!

文章目录

• Java_枚举类
• • Java_自定义枚举类
  • Java_使用enum定义枚举类
  • Java_Enum类的主要方法
  • Java_实现接口的枚举类
• Java_注解(Annotation)
• • Java_常见的Annotation示例
  • Java_JDK内置的三个基本注解
  • Java_自定义注解 Annotation
• Java_JDK中的元注解
• • Java_JDK中的元数据注解Retention类型
  • Java_JDK中的元数据注解Target类型
  • Java_JDK中的元数据注解@Documented和@Inherited
  • Java_可重复的注解及可用于类型的注解

Java_枚举类

1. 枚举类就是对象只有有限的,确定的类,例如:星期,性别,季节等
2. 当需要定义一组常量时，经常使用枚举类

枚举类的实现

1. 使用的 enum关键字用于定义枚举类
2. 若枚举只有一个对象, 则可以作为一种单例模式的实现方式。

枚举类的属性

1. 枚举类对象的属性不应允许被改动, 所以应该使用private final修饰
2. 枚举类的使用private final修饰的属性应该在构造器中为其赋值
3. 若枚举类显式的定义了带参数的构造器, 则在列出枚举值时也必须对应的传入参数

Java_自定义枚举类

1. 私有化类的构造器，保证不能在类的外部创建其对象
2. 在类的内部创建枚举类的实例。声明为：public static final
3. 对象如果有实例变量，应该声明为private final，并在构造器中初始化

class Season{
private final String SEASONNAME;//季节的名称
private final String SEASONDESC;//季节的描述
private Season(String seasonName,String seasonDesc){
	this.SEASONNAME = seasonName;
	this.SEASONDESC = seasonDesc;
}
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("冬天", "白雪皑皑");
}

Java_使用enum定义枚举类

1. 使用 enum 定义的枚举类默认继承了java.lang.Enum类，因此不能再继承其他类
2. 枚举类的构造器只能使用 private权限修饰符
3. 枚举类的所有实例必须在枚举类中显式列出(, 分隔 ; 结尾)。列出的实例,系统会自动添加 public static final 修饰
4. 必须在枚举类的第一行声明枚举类对象

注意:可以在 switch 表达式中使用Enum定义的枚举类的对象作为表达式, case 子句可以直接使用枚举值的名字, 无需添加枚举类作为限定。

public enum SeasonEnum {
	SPRING("春天","春风又绿江南岸"),
	SUMMER("夏天","映日荷花别样红"),
	AUTUMN("秋天","秋水共长天一色"),
	WINTER("冬天","窗含西岭千秋雪");
	
	private final String seasonName;
	private final String seasonDesc;
	private SeasonEnum(String seasonName, String seasonDesc) {
		this.seasonName = seasonName;
		this.seasonDesc = seasonDesc;
	}
	public String getSeasonName() {
		return seasonName;
	}
	public String getSeasonDesc() {
		return seasonDesc;
	}
}

Java_Enum类的主要方法

1. valueOf:传递枚举类型的Class对象和枚举常量给静态方法valueOf,会得到与参数匹配的枚举常量,
2. toString:得到当前枚举常量的名称,
3. equals:在枚举类型中,可以直接使用== 来比较两个枚举常量是否相等,Enum提供的equals()方法也是直接使用==实现的,是为了在Set,List和Map中使用,
4. getDeclaringClass:得到的枚举常量所属枚举类型的Class对象,可以用它来判断两个枚举常量是否属于同一个枚举类型
5. ordinal得到当前枚举常量的次序
6. compareTo:枚举类型实现了Comparable接口,用来比较两个枚举常量的大小(按照声明的顺序排列)
7. clone:枚举类型不能配Clone,为了防止子类实现克隆方法,Enum实现了一个仅抛出CloneNotSupportedException异常的不变Clone()

三个特别重要的方法

1. values()方法：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
2. valueOf(String str)：可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的“名字”。如不是，会有运行时异常：IllegalArgumentException。
3. toString()：返回当前枚举类对象常量的名程

Java_实现接口的枚举类

1. 枚举类和普通 Java 类一样，枚举类可以实现一个或多个接口
2. 若每个枚举值在调用实现的接口方法呈现相同的行为方式，则只要统一实现该方法即可。
3. 若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式, 则可以让每个枚举值分别来实现该方法

Java_注解(Annotation)

1. Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)
2. Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。
3. 通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
4. Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation 的“name=value” 对中

Java_常见的Annotation示例

1. 使用 Annotation 时要在其前面增加 @符号, 并把该Annotation当成一个修饰符使用。用于修饰它支持的程序元素

生成文档相关的注解:

1. @author 标明开发该类模块的作者，多个作者之间使用,分割
2. @version 标明该类模块的版本
3. @see 参考转向，也就是相关主题
4. @since 从哪个版本开始增加的
5. @param 对方法中某参数的说明，如果没有参数就不能写
6. @return 对方法返回值的说明，如果方法的返回值类型是void就不能写
7. @exception 对方法可能抛出的异常进行说明 ,如果方法没有用throws显式抛出的异常就不能写

注意:

1. @param @return 和 @exception 这三个标记都是只用于方法的。
2. @param的格式要求：@param 形参名 形参类型 形参说明
3. @return 的格式要求：@return 返回值类型 返回值说明
4. @exception的格式要求：@exception 异常类型 异常说明
5. @param和@exception可以并列多个

package com.commany;
/**
* @author ryx
* @version 1.0
* @see Math.java
*/
public class JavadocTest {
	/**
	* 程序的主方法，程序的入口
	* @param args String[] 命令行参数
	*/
	public static void main(String[] args) {
	}
	/**
	* 求圆面积的方法
	* @param radius double 半径值
	* @return double 圆的面积
	*/
	public static double getArea(double radius){
	return Math.PI * radius * radius;
	}
}

Java_JDK内置的三个基本注解

1. @Override: 限定重写父类方法, 该注解只能用于方法
2. @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
3. @SuppressWarnings: 抑制编译器警告

package com.commany;
public class AnnotationTest{
	public static void main(String[] args) {
		@SuppressWarnings("unused")
		int a = 10;
	}
	@Deprecated
	public void print(){
		System.out.println("过时的方法");
	}
	@Override
	public String toString() {
		return "重写的toString方法()";
	}
}

Java_自定义注解 Annotation

1. 定义新的Annotation 类型使用 @interface关键字
2. 自定义注解自动继承了java.lang.annotation.Annotation接口
3. Annotation 的成员变量在 Annotation定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
4. 可以在定义Annotation的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default关键字
5. 如果只有一个参数成员，建议使用参数名为value
6. 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value，可以省略“value=”
7. 没有成员定义的 Annotation称为标记; 包含成员变量的 Annotation 称为元数据 Annotation
   注意：自定义注解必须配上注解的信息处理流程才有意义

@MyAnnotation(value="安岩师范")
public class MyAnnotationTest {
	public static void main(String[] args) {
	Class clazz = MyAnnotationTest.class;
	Annotation a = clazz.getAnnotation(MyAnnotation.class);
	MyAnnotation m = (MyAnnotation) a;
	String info = m.value();
	System.out.println(info);
	}
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface MyAnnotation{
	String value() default "anyangshifan";
}

Java_JDK中的元注解

1. JDK 的元 Annotation 用于修饰其他 Annotation 定义
2. JDK5.0提供了4个标准的meta-annotation类型，分别是：Retention,Target,Documented,Inherited
3. 包含成员变量的 Annotation 称为元数据 Annotation
4. 元数据的理解：String name = "安阳师范"

Java_JDK中的元数据注解Retention类型

1. @Retention: 只能用于修饰一个Annotation定义, 用于指定该 Annotation的生命周期, @Rentention包含一个RetentionPolicy 类型的成员变量, 使用@Rentention时必须为该 value成员变量指定值:
2. RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
3. RetentionPolicy.CLASS:在class文件中有效（即class保留） ，当运行 Java 程序时, JVM 不会保留注解。 这是默认值
4. RetentionPolicy.CLASS:在class文件中有效（即class保留） ， 当运行 Java 程序时,JVM 不会保留注解。 这是默认值

public enum RetentionPolicy{
	SOURCE,
	CLASS,
	RUNTIME
}
@Retention(RetentionPolicy.SOURCE)
@interface MyAnnotation1{ }
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{ }

Java_JDK中的元数据注解Target类型

1. @Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。
2. @Target 也包含一个名为 value 的成员变量。

Java_JDK中的元数据注解@Documented和@Inherited

1. @Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。
2. 定义为Documented的注解必须设置Retention值为RUNTIME。
3. @Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被
4. @Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
5. 比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解,实际应用中，使用较少

Java_可重复的注解及可用于类型的注解

类型注解:

1. 关于元注解@Target的参数类型ElementType枚举值多了两个:TYPE_PARAMETER,TYPE_USE。
2. 在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。
3. ElementType.TYPE_PARAMETER表示该注解能写在类型变量的声明语句中（如：泛型声明）。
4. ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。

public class TestTypeDefine<@TypeDefine() U> {
	private U u;
	public <@TypeDefine() T> void test(T t){
	}
}
@Target({ElementType.TYPE_PARAMETER})
@interface TypeDefine{
}