枚举和注解知识概括

GeorgeLin
98 阅读12分钟

@TOC

枚举类的使用

什么时候使用枚举类呢？

  • 当创建的类需要使用的对象是有限个时，数目是确定时。
  • 当需要使用一组常量时。

枚举类的要求：

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

因此自定义枚举类时：

  • 私有化类的构造器，保证不能在类的外部创建其对象。
  • 在类的内部创建枚举类的实例。声明为：public static final
  • 对象如果有实例变量，应该声明为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类：

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

//省略了public static final Season以及new Season 这两个一样的部分。
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; 
	}

Enum类的主要方法：

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

注意：

  • 此外由于Enum继承了Enum类，因此不可再继承其他类，但可以实现接口。
  • 若每个枚举值在调用实现的接口方法呈现相同的行为方式，则只要统一实现该方法即可。
  • 若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式, 则可以让每个枚举值分别来实现该方法。

注解类的使用

元数据介绍：

  • 元数据（Metadata），又称中介数据、中继数据，为描述数据的数据（data about data），主要是描述数据属性（property）的信息，用来支持如指示存储位置、历史数据、资源查找、文件记录等功能。
  • 元数据是关于数据的组织、数据域及其关系的信息，简言之，元数据就是关于数据的数据。

注解简介：

  • 从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是 Annotation(注解)
  • Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加 载, 运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员 可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证 或者进行部署。
  • Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方 法, 成员变量, 参数, 局部变量的声明,这些信息被保存在 Annotation 的 “name=value” 对中。
  • 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
  • 未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。
  • 链接：Java注解详解

注解的使用：

  • 使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成 一个修饰符使用。用于修饰它支持的程序元素
  • 示例一：生成文档相关的注解 ①@author 标明开发该类模块的作者，多个作者之间使用,分割 ②@version 标明该类模块的版本 ③@see 参考转向，也就是相关主题 ④@since 从哪个版本开始增加的 ⑤@param 对方法中某参数的说明，如果没有参数就不能写 ⑥@return 对方法返回值的说明，如果方法的返回值类型是void就不能写 ⑦@exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写其中 <1>@param @return 和 @exception 这三个标记都是只用于方法的。 <2>@param的格式要求：@param 形参名 形参类型 形参说明 <3>@return 的格式要求：@return 返回值类型 返回值说明 <4>@exception的格式要求：@exception 异常类型 异常说明 <5>@param和@exception可以并列多个
  • 示例二：在编译时进行格式检查(JDK内置的三个基本注解) ①@Override: 限定重写父类方法, 该注解只能用于方法 ②@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择 ③@SuppressWarnings: 抑制编译器警告
  • 示例三：跟踪代码依赖性，实现替代配置文件功能 ①Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。

自定义Annotation：

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

元注解：

  • 元注解就是描述注解的注解 （即描述数据的数据的数据）
  • JDK 的元 Annotation 用于修饰其他 Annotation 定义
  • JDK5.0提供了4个标准的meta-annotation类型，分别是： ①Retention：指定生命周期 ②Target：指定目标 ③Documented：提取成文档 ④Inherited：有继承性
  • 元数据的理解：String name = “atguigu”;

元注解详解：

  • @Retention只能用于修饰一个 Annotation 定义，用于指定该 Annotation的生命周期，@Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value成员变量指定值： ①RetentionPolicy.SOURCE：在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释 ②RetentionPolicy.CLASS：在class文件中有效（即class保留） ， 当运行 Java 程序时, JVM 不会保留注解。 这是默认值。 ③RetentionPolicy.RUNTIME：在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。 在这里插入图片描述

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

取值(ElementType)作用
CONSTRUCTOR用于描述构造器
FIELD用于描述域
LOCAL_VARIABLE用于描述局部变量
METHOD用于描述方法
PACKAGE用于描述包
PARAMETER用于描述参数
TYPE用于描述类、接口(包括注解类型)或enum声明
  • @Documented用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc工具提取成文档。默认情况下，javadoc是不包括注解的。 ①定义为Documented的注解必须设置Retention值为RUNTIME。
  • @Inherited被它修饰的 Annotation 将具有继承性。如果某个类使用了被 @Inherited 修饰的Annotation, 则其子类将自动具有该注解。 ①比如如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解 ②实际应用中，使用较少

利用反射获取注解信息：

  • JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素
  • 当一个 Annotation 类型被定义为运行时 Annotation 后, 该注解才是运行时可见, 当 class 文件被载入时保存在class 文件中的 Annotation 才会被虚拟机读取
  • 程序可以调用 AnnotatedElement对象的如下方法来访问 Annotation 信息
//如果存在这样的注释，则java.lang.reflect.Field.getAnnotation(Class《T》 annotationClass)方法
//返回指定类型的此元素的注释，否则为null。
<T extends Annotation> getAnnotation(Class<T> annotationClass);

//java.lang.Class.getAnnotations()方法返回此元素上存在的所有注释。 如果此元素没有注释，则返回长度
//为零的数组。 此方法的调用者可以自由修改返回的数组; 它对返回给其他调用者的数组没有影响。
Annotation[] getAnnotations();

//java.lang.reflect.Method.getDeclaredAnnotations()方法返回直接出现在此元素上的所有注释。 与此
//接口中的其他方法不同，此方法忽略继承的注释。 （如果此元素上没有直接出现注释，则返回长度为零的数组。）
//此方法的调用者可以自由修改返回的数组; 它对返回给其他调用者的数组没有影响。
Annotation[] getDeclaredAnnotations();

//如果此元素上存在指定类型的注释，则java.lang.Package.isAnnotationPresent(Class《? extends 
//Annotation》 annotationClass)方法返回true，否则返回false。 此方法主要用于方便地访问标记注释。
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

JDK8中注解的新特性：

  • Java 8对注解处理提供了两点改进：可重复的注解及可用于类型的注解。此外反射也得到了加强，在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。
  • 可重复注解示例：
Target({TYPE，FTELD，METHOD，PARAMETER,CONSTRUCTOR，LOCAL_VARITABLE})
@Retention(RetentionPolicy.RUNTIME)
public interface MyAnnotations {
	MyAnnotation[ ] value();
}

@Repeatable(MyAnnotations.c1ass)//可重复注解
@Target({TVPE，FTELD，METHOD，PARANETER，CONSTRUCTOR，LOCAl_VARTABLE，E1ementType.TYPE_PARANETER})
@Retention(RetentionPolicy.RUNTIME)
public interface MyAnnotation {
	String va1ue();
}
//可重复注解示例：
@MyAnnotation( "He11o")
@MyAnnotation( "wor1d")
public void show(@MyAnnotation( "abc") String str){

}
  • 类型注解： ①JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER，TYPE_USE。 ②在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。 <1>ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）。 <2>ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。
public class TestTypeDefine<@TypeDefine() U> {
	private U u;
	public <@TypeDefine() T> void test(T t){
	} 
}
@Target({ElementType.TYPE_PARAMETER})
@interface TypeDefine{ 
}

@MyAnnotation
public class AnnotationTest<U> {
	@MyAnnotation
	private String name;
	public static void main(String[] args) {
		AnnotationTest<@MyAnnotation String> t = null;
		int a = (@MyAnnotation int) 2L;
		@MyAnnotation
		int b = 10;
	}
	public static <@MyAnnotation T> void method(T t) { 
	}
	public static void test(@MyAnnotation String arg) throws @MyAnnotation Exception { 
	} 
}
@Target(ElementType.TYPE_USE)
@interface MyAnnotation { 
}

自定义注解示例

FruitName.java：

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 水果名称注解
 */
@Target(FIELD)
@Retention(RUNTIME)
@Documented
public @interface FruitName {
    String value() default "";
}

FruitColor.java：

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 水果颜色注解
 */
@Target(FIELD)
@Retention(RUNTIME)
@Documented
public @interface FruitColor {
    /**
     * 颜色枚举
     */
    public enum Color{ BLUE,RED,GREEN};
    
    /**
     * 颜色属性
     */
    Color fruitColor() default Color.GREEN;

}

FruitProvider.java：

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;


/**
 * 水果供应者注解
 */
@Target(FIELD)
@Retention(RUNTIME)
@Documented
public @interface FruitProvider {
    /**
     * 供应商编号
     */
    public int id() default -1;
    
    /**
     * 供应商名称
     */
    public String name() default "";
    
    /**
     * 供应商地址
     */
    public String address() default "";
}

FruitInfoUtil.java：

  • 重点关注：反射过程
import java.lang.reflect.Field;

/**
 * 注解处理器
 */
public class FruitInfoUtil {
    public static void getFruitInfo(Class<?> clazz){
        
        String strFruitName=" 水果名称：";
        String strFruitColor=" 水果颜色：";
        String strFruitProvicer="供应商信息：";
        
        Field[] fields = clazz.getDeclaredFields();
        
        for(Field field :fields){
            if(field.isAnnotationPresent(FruitName.class)){
                FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);
                strFruitName=strFruitName+fruitName.value();
                System.out.println(strFruitName);
            }
            else if(field.isAnnotationPresent(FruitColor.class)){
                FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);
                strFruitColor=strFruitColor+fruitColor.fruitColor().toString();
                System.out.println(strFruitColor);
            }
            else if(field.isAnnotationPresent(FruitProvider.class)){
                FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);
                strFruitProvicer=" 供应商编号："+fruitProvider.id()+" 供应商名称："+fruitProvider.name()+" 供应商地址："+fruitProvider.address();
                System.out.println(strFruitProvicer);
            }
        }
    }
}

Apple.java：

import test.FruitColor.Color;

/**
 * 注解使用
 */
public class Apple {
    
    @FruitName("Apple")
    private String appleName;
    
    @FruitColor(fruitColor=Color.RED)
    private String appleColor;
    
    @FruitProvider(id=1,name="陕西红富士集团",address="陕西省西安市延安路89号红富士大厦")
    private String appleProvider;
    
    public void setAppleColor(String appleColor) {
        this.appleColor = appleColor;
    }
    public String getAppleColor() {
        return appleColor;
    }
    
    public void setAppleName(String appleName) {
        this.appleName = appleName;
    }
    public String getAppleName() {
        return appleName;
    }
    
    public void setAppleProvider(String appleProvider) {
        this.appleProvider = appleProvider;
    }
    public String getAppleProvider() {
        return appleProvider;
    }
    
    public void displayName(){
        System.out.println("水果的名字是：苹果");
    }
}

FruitRun.java：

/**
 * 输出结果
 */
public class FruitRun {
    public static void main(String[] args) {
        FruitInfoUtil.getFruitInfo(Apple.class);
    }
}

运行结果是：

水果名称：Apple
水果颜色：RED
供应商编号：1 供应商名称：陕西红富士集团 供应商地址：陕西省西安市延安路89号红富士大厦
avatar
文章
阅读
粉丝