Java学习-第一部分-第二阶段-第二节：枚举和注释

枚举和注解

笔记目录：(https://www.cnblogs.com/wenjie2000/p/16378441.html)

自定义类实现枚举

先看一个需求

要求创建季节(Season)对象，请设计并完成。

创建Season对象有如下特点

1.季节的值是有限的几个值(spring, summer, autumn, winter)

2.只读，不需要修改。

public class Test {
    public static void main(String[] args) {
        //使用
        Season spring = new Season("春天", "温暖");
        Season winter = new Season("冬天","寒冷");
        Season summer = new Season("夏天","炎热");
        Season autumn = new Season("秋天","凉爽");
        //autumn.setName("XXX");
        //autumn.setDesc("非常的热..");
        //因为对于季节而已，他的对象(具体值)，是固定的四个，不会有更多
        //按照这个设计类的思路，不能体现季节是固定的四个对象
        //因此，这样的设计不好===>枚举类[枚:一个一个举:例举，即把具体的对象一个一个例举出来的类
        //就称为枚举类]
        Season other = new Season("红天","~~" );
    }
}
class Season {
    private String name;
    private String desc;//描述
    public Season(String name, String desc) {this.name = name;this.desc = desc;}
    public String getName() {return name;}
    public void setName(String name) {this.name = name;}
    public String getDesc() { return desc;}
    public void setDesc(String desc) {this.desc = desc;}
}

解决方案-枚举

1. 枚举对应英文(enumeration,简写enum)
2. 枚举是一组常量的集合。
3. 可以这里理解:枚举属于一种特殊的类,里面只包含一组有限的特定的对象。

枚举的二种实现方式

1. 自定义类实现枚举
2. 使用enum关键字实现枚举

package enum_;

public class Test {
    public static void main(String[] args) {
        System.out.println(Season.AUTUMN);
        System.out.println(Season.SPRING);
    }
}

//演示定义枚举实现
class Season {
    private String name;
    private String desc;//描述

    //定义了四个对象，固定.
    public static final Season SPRING = new Season("春天","温暖");
    public static final Season WINTER = new Season("冬天","寒冷");
    public static final Season AUTUMN = new Season("秋天","凉爽");
    public static final Season SUIMMER = new Season("夏天","炎热");

    //1．将构造器私有化,目的防止直接new
    //2．去掉setXxx方法，防止属性被修改
    //3．在Season内部，直接创建固定的对象
    //4.优化,可以加入final修饰符
    private Season(String name, String desc) {
        this.name = name;
        this.desc = desc;
    }

    public String getName() {
        return name;
    }

    public String getDesc() {
        return desc;
    }

    @Override
    public String toString() {
        return "Season{" +
                "name='" + name + '\'' +
                ", desc='" + desc + '\'' +
                '}';
    }
}

小结:进行自定义类实现枚举,有如下特点;

1. 构造器私有化

2. 本类内部创建一组对象

3. 对外暴露对象(通过为对象添加public final static修饰符)

4. 可以提供get方法,但是不要提供set

enum关键字实现枚举

使用enum来实现前面的枚举案例，看演示，主要体会和自定义类实现枚举不同的地方。

public class Test {
    public static void main(String[] args) {
        System.out.println(Season.SPRING);
    }
}

//演示定义枚举实现
enum Season {
    //定义了四个对象，固定.
//    public static final Season SPRING = new Season("春天","温暖");
//    public static final Season WINTER = new Season("冬天","寒冷");
//    public static final Season AUTUMN = new Season("秋天","凉爽");
//    public static final Season SUIMMER = new Season("夏天","炎热");

    //如果使用了enum来实现枚举类//1。使用关键字 enum替代 class
    //2. public static final Season SPRING = new Season("春天"，"温暖")直接使用//SPRING("春天"，"温暖")）解读常量名(实参列表I
    //3．如果有多个常量(对象)，使用，号间隔即可
    //4．如果使用enum 来实现枚举，要求将定义常量对象，写在前面
    SPRING("春天", "温暖"), WINTER("冬天", "寒冷");;

    private String name;
    private String desc;//描述

    //1．将构造器私有化,目的防止直接new
    //2．去掉setXxx方法，防止属性被修改
    //3．在Season内部，直接创建固定的对象
    //4.优化,可以加入final修饰符
    private Season(String name, String desc) {
        this.name = name;
        this.desc = desc;
    }
    public String getName() {
        return name;
    }
    public String getDesc() {
        return desc;
    }
    @Override
    public String toString() {
        return "Season{" +
                "name='" + name + '\'' +
                ", desc='" + desc + '\'' +
                '}';
    }
}

enum关键字实现枚举注意事项

1. 当我们使用enum 关键字开发一个枚举类时，默认会继承Enum类[如何证明:用javap指令反编译能看见继承自Enum]

   

2. 传统的public static final Season2 SPRING = new Season2("春天""温暖");简化成SPRING(“春天","温暖")，这里必须知道，它调用的是哪个构造器.

3. 如果使用无参构造器创建枚举对象，则实参列表和小括号都可以省略

   enum Season {
       SPRING("春天", "温暖"),AUTUMN;;
       private Season() {
       }
       //......
   }
   

4. 当有多个枚举对象时，使用,间隔，最后有一个分号结尾

5. 枚举对象必须放在枚举类的行首.

举例说明enum常用的方法的使用

1. toString:Enum类已经重写过了,返回的是当前对象名,子类可以重写该方法,用于返回对象的属性信息

2. name:返回当前对象名(常量名）,子类中不能重写

3. ordinal:返回当前对象的位置号，默认从0开始

4. values:返回当前枚举类中所有的常量（此处常量即枚举对象）（value方法被隐藏了，源码中找不到）

5. valueOf:将字符串转换成枚举对象,要求字符串必须为已有的常量名，否则报异常!

6. compareTo: 比较两个枚举常量，比较的就是编号!

public class Test {
    public static void main(String[] args) {
        //使用Season2枚举类,来演示各种方法
        Season2 autumn = Season2.AUTUMN;
        //输出枚举对象的名字
        System.out.println(autumn.name());
        //ordinal()输出的是该枚举对象的次序/编号，从0开始编号
        // AUTUMN枚举对象是第三个，因此输出2
        System.out.println(autumn.ordinal());
        //从反编译可以看出values方法,返回Season2[]
        //含有定义的所有枚举对象
        Season2[] values = Season2.values();
        System.out.println("===遍历取出枚举对象(增强for)====");
        for (Season2 season : values) {//增强for循环
            System.out.println(season);
        }
        //valueOf:将字符串转换成枚举对象，要求字符串必须VT为已有的常量名，否则报异常
        // 执行流程
        // 1.根坍你输入的“AUTUMN ”到Season2的枚举对象去查找
        // 2.如果找到了，就返回，.如果没有找到，就报错
        Season2 autumn1 = Season2.valueOf("AUTUMN");
        System.out.println("autumn1=" + autumn1);
        System.out.println(autumn == autumn1);
        //compareTo:比较两个枚举常量，比较的就是编号
        //2．看看结果
        /*
        public final int compareTo(E o) {
            return self.ordinal - other.ordinal;
        }
        Season2.AUTUMN的编号[3] - Season2.SUMMER的编号[1]
        */
        System.out.println(Season2.AUTUMN.compareTo(Season2.SUMMER));//3-1
    }
}
//演示定义枚举实现
enum Season2 {
    //定义了四个对象，固定.
    //    public static final Season SPRING = new Season("春天","温暖");
    //    public static final Season WINTER = new Season("冬天","寒冷");
    //    public static final Season AUTUMN = new Season("秋天","凉爽");
    //    public static final Season SUMMER = new Season("夏天","炎热");
    //如果使用了enum来实现枚举类//1。使用关键字 enum替代 class
    //2. public static final Season SPRING = new Season("春天"，"温暖")直接使用//SPRING("春天"，"温暖")）解读常量名(实参列表I
    //3．如果有多个常量(对象)，使用，号间隔即可
    //4．如果使用enum 来实现枚举，要求将定义常量对象，写在前面
    SPRING("春天", "温暖"),
    SUMMER("夏天", "炎热"),
    WINTER("冬天", "寒冷"),
    AUTUMN;
    Season2() {
    }
    private String name;
    private String desc;//描述
    //1．将构造器私有化,目的防止直接new
    //2．去掉setXxx方法，防止属性被修改
    //3．在Season内部，直接创建固定的对象
    //4.优化,可以加入final修饰符
    private Season2(String name, String desc) {
        this.name = name;
        this.desc = desc;
    }
    public String getName() {return name;}
    public String getDesc() { return desc;}
}

注意

1. 使用enum关键字后，就不能再继承其它类了，因为enum会隐式继承Enum,而Java是单继承机制。

2. 枚举类和普通类一样，可以实现接口，如下形式。

   enum 类名 implements 接口1，接口2{}

JDK内置的基本注解类型(了解就行)

注解的理解

1. 注解(Annotation)也被称为元数据(Metadata)，用于修饰解释包、类、方法、属性、构造器、局部变量等数据信息。
2. 和注释一样，注解不影响程序逻辑，但注解可以被编译或运行，相当于嵌入在代码中的补充信息。
3. 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替java EE旧版中所遗留的繁冗代码和XML配置等。

基本的Annotation介绍

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

三个基本的Annotation:

1. @Override:限定某个方法,是重写父类方法,该注解只能用于方法
2. @Deprecated:用于表示某个程序元素(类,方法等)已过时
3. @SuppressWarnings:抑制编译器警告

@Override

Override:限定某个方法，是重写父类方法,该注解只能用于方法

class Father{
    public void fly(){
        System.out.println("Father fly.….");
    }
}
class Son extends Father {
    //解读
    //1.@Override 注解放在fly方法上，表示子类的fly方法时重写了父类的fly
    //2.这里如果没有写@0verride还是重写了父类fly
    //3．如果你写了@Override注解，编译器就会去检查该方法是否真的重写了父类的
    // 方法，如果的确重写了，则编译通过，如果没有构成重写，则编译错误
    /*
        @Target(ElementType.HETHOD)
        @Retention(RetentionPolicy.SOURCE)
        public @interface Override {
        }
    */
    @Override  //说明
    public void fly() {
        System.out.println("Son fly...");
    }
}

> 补充说明:@interface的说明

@interface不是interface，是注解类，是jdk5.0之后加入的

>Override使用说明

1. @Override表示指定重写父类的方法（从编译层面验证)，如果父类没有fly方法，则会报错
2. 如果不写@Override注解,而父类仍有public void fly00，仍然构成重写
3. @Override只能修饰方法，不能修饰其它类，包，属性等等
4. 查看@Override注解源码为@Target(ElementType.METHOD),说明只能修饰方法
5. @Target是修饰注解的注解，称为元注解

@Deprecated

@Deprecated的说明

1. 用于表示某个程序元素(类,方法等)已过时

2. 可以修饰方法，类,字段,包,参数等等

3. @Target(value={CONSTRUCTOR,FIELD, LOCAL_VARIABLE,METHOD,PACKAGE,PARAMETER, TYPE})

4. @Deprecated的作用可以做到新旧版本的兼容和过渡

@Deprecated
class A{

}

@suppresswarnings

@SuppressWarnings:抑制编译器警告

//关于SuppressWarnings作用范围是和你放置的位置相关
//看看@SuppressWarnings 源码
/*
    @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
    @Retention(RetentionPolicy.SOURCE)
    public @interface SuppressWarnings {
        String[] value();
    }
*/
@SuppressWarnings({"unused","unchecked"})
public class Test {
    public static void main(String[] args) {
        int i;//没有 @SuppressWarnings({"unused"})会出现黄色警告:i没有被使用
    }
}

>说明各种值

1. all是忽略所有警告
2. unchecked是忽略没有检查的警告
3. rawtypes是忽略没有指定泛型的警告(传参时没有指定泛型的警告错误)
4. unused是忽略没有使用某个变量的警告错误
5. 其他关键字使用相对较少，需要可自行百度
6. @SuppressWarnings可以修饰的程序元素为,查看@Target
7. 生成@SupperssWarnings时，不用背，直接点击左侧的黄色提示，就可以选择(注意可以指定生成的位置)

元注解:对注解进行注解(不重要，仅需了解)

元注解的基本介绍

JDK的元 Annotation用于修饰其他Annotation

元注解:本身作用不大，讲这个原因主要用来辅助理解源码。看源码时，可以知道他是干什么.

元注解的种类(使用不多,了解,不用深入研究)

1. Retention //指定注解的作用范围，三种 SOURCE,CLASS,RUNTIME
2. Target //指定注解可以在哪些地方使用
3. Documented //指定该注解是否会在javadoc体现
4. Inherited //子类会继承父类注解

Retention注解

说明

只能用于修饰一个 Annotation定义，用于指定该 Annotation可以保留多长时间,@Rentention包含一个 RetentionPolicy类型的成员变量，使用@Rentention时必须为该vajue成员变量指定值:

@Retention的三种值

1. RetentionPolicy.SOURCE:编译器使用后，直接丢弃这种策略的注解
2. RetentionPolicy.CLASS:编译器将把注解记录在class文件中.当运行Java程序时,JVM不会保留注解。这是默认值
3. RetentionPolicy.RUNTIME:编译器将把注解记录在 class 文件中.当运行Java程序时,JVM会保留注解.程序可以通过反射获取该注解

@Target

基本说明

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

源码

@Documented
@Retention(RetentionPolicy.RUNTIME)//它的作用范围是RUNTIME
@Target(ElementType.ANNOTATION_TYPE)//这里的ANNOTATION TYPE 说明@Target只能修饰注解
public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();//可以简单看一下ElementType的取值//通过Enum 比如:TYPE等

}

@Documented

基本说明

@Documented:用于指定被该元 Annotation修饰的Annotation类将被javadoc工具提取成文档,即在生成文档时,可以看到该注解。

说明:定义为Documented的注解必须设置Retention值为RUNTIME。

案例

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD,LOCAL_VARIABLE, METHOD, PACKAGE,PARAMETER, TYPE)
public @interface Deprecated {//一个Deprecated 注解@Documented,则javadoc会看到Deprecated
}

@Inherited

被它修饰的Annotation将具有继承性.如果某个类使用了被@Inherited修饰的Annotation,则其子类将自动具有该注解

说明:实际应用中,使用较少，了解即可。

元注解:本身作用不大,讲这个原因希望编程看源码时,可以知道他是干什么。