乐趣区

关于后端:Java枚举和注解

jiezi

先看一个需要

要求创立节令(Season) 对象，请设计并实现。

class Season{// 类
    private String name;
    private String desc;// 形容
    // 结构器
    //getXX
    //setXX
}

对于节令而已，他的对象(具体值)，是固定的四个，不会有更多。个别的类设计类的思路，不能体现节令是固定的四个对象。采纳枚举类。

  • 节令的值是无限的几个值(spring, summer, autumn, winter)
  • 只读，不须要批改。

因为不能存在如下的状况：

autumn.setName("XXX"); // 批改了秋天的名字

枚举

  1. 枚举对应英文(enumeration, 简写 enum)
  2. 枚举是一组常量的汇合。
  3. 能够这里了解：枚举属于一种非凡的类，外面只蕴含一组无限的特定的对象。

枚举的二种实现形式

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

自定义类实现枚举 - 利用案例

1. 不须要提供 setXxx 办法，因为枚举对象值通常为只读.

2. 对枚举对象 / 属性应用 final + static 独特润饰，实现底层优化.（final 和 static 搭配应用能够不导致类加载, 效率更高）

3. 枚举对象名通常应用全副大写，常量的命名标准.

4. 枚举对象依据须要, 也能够有多个属性

package com.hspedu.enum_;

public class Enumeration02 {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 SUMMER = new Season("夏天", "酷热");


    //1. 将结构器私有化, 目标避免 间接 new
    //2. 去掉 setXxx 办法, 避免属性被批改
    //3. 在 Season 外部，间接创立固定的对象
    //4. 优化，能够退出 final 修饰符（static 会导致类加载，避免这种状况，final 和 static 搭配应用能够不导致类加载, 效率更高）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 关键字实现枚举 - 疾速入门

package com.hspedu.enum_;

public class Enumeration03 {public static void main(String[] args) {System.out.println(Season2.AUTUMN);
        System.out.println(Season2.SUMMER);
    }
}
// 演示应用 enum 关键字来实现枚举类
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("春天", "和煦") 解读 常量名(实参列表)
    //3. 如果有多个常量(对象)，应用 , 号距离即可
    //4. 如果应用 enum 来实现枚举，要求将定义常量对象，写在后面
    //5. 如果咱们应用的是无参结构器，创立常量对象，则能够省略 ()
    SPRING("春天", "和煦"), WINTER("冬天", "凛冽"), AUTUMN("秋天", "凉快"),
    SUMMER("夏天", "酷热"), What();

    private String name;
    private String desc;// 形容

    private Season2() {// 无参结构器}

    private Season2(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 类, 而且是一个 final 类，应用 javap 工具来演示。

  2. 传统的 public static final Season2 SPRING = new Season2(“ 春天 ”, “ 和煦 ”); 简化成 SPRING(“ 春天 ”, “ 和煦 ”)，这里必须晓得，它调用的是哪个结构器。
  3. 如果应用无参结构器创立枚举对象，则实参列表和小括号都能够省略。
  4. 当有多个枚举对象时，应用，距离，最初有一个分号结尾。
  5. 枚举对象必须放在枚举类的行首。

enum 罕用办法阐明

阐明：应用关键字 enum 时，会隐式继承 Enum 类, 这样咱们就能够应用 Enum 类相干的办法。

enum 罕用办法利用实例

  1. toString:Enum 类曾经重写过了，返回的是以后对象名, 子类能够重写该办法，用于返回对象的属性信息。
  2. name：返回以后对象名（常量名），子类中不能重写。
  3. ordinal：返回以后对象的地位号，默认从 0 开始。
  4. values：返回以后枚举类中所有的常量。
  5. valueOf：将字符串转换成枚举对象，要求字符串必须为已有的常量名，否则报异样！
  6. compareTo：比拟两个枚举常量，比拟的就是编号（前减后编号）！
package com.hspedu.enum_;

public class EnumMethod {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：将字符串转换成枚举对象，要求字符串必须为已有的常量名，否则报异样
        // 执行流程
        //1. 依据你输出的 "AUTUMN" 到 Season2 的枚举对象去查找
        //2. 如果找到了，就返回，如果没有找到，就报错
        Season2 autumn1 = Season2.valueOf("AUTUMN");
        System.out.println("autumn1=" + autumn1);
        System.out.println(autumn == autumn1); // T

        //compareTo：比拟两个枚举常量，比拟的就是编号
        //1. 就是把 Season2.AUTUMN 枚举对象的编号 和 Season2.SUMMER 枚举对象的编号比拟
        //2. 看看后果
        /*
        源码：public final int compareTo(E o) {return self.ordinal - other.ordinal;}
        Season2.AUTUMN 的编号[2] - Season2.SUMMER 的编号[3]
         */
        System.out.println(Season2.AUTUMN.compareTo(Season2.SUMMER));

        // 补充了一个加强 for
//        int[] nums = {1, 2, 9};
//        // 一般的 for 循环
//        System.out.println("===== 一般的 for=====");
//        for (int i = 0; i < nums.length; i++) {//            System.out.println(nums[i]);
//        }
//        System.out.println("===== 加强的 for=====");
//        // 执行流程是 顺次从 nums 数组中取出数据，赋给 i, 如果取出结束，则退出 for
//        for(int i : nums) {//            System.out.println("i=" + i);
//        }
    }
}

enum 实现接口

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

  2. 枚举类和一般类一样，能够实现接口，如下模式。

    enum 类名 implements 接口 1，接口 2{}
    package com.hspedu.enum_;

public class EnumDetail {public static void main(String[] args) {Music.CLASSICMUSIC.playing();
 }
}
class A {

}

//1. 应用 enum 关键字后，就不能再继承其它类了，因为 enum 会隐式继承 Enum，而 Java 是单继承机制
//enum Season3 extends A {
//
//}
//2.enum 实现的枚举类，依然是一个类，所以还是能够实现接口的.
interface IPlaying {public void playing();
}
enum Music implements IPlaying {
 // 枚举类，CLASSICMUSIC 相当于一个对象
 CLASSICMUSIC;
 @Override
 public void playing() {System.out.println("播放好听的音乐...");
 }
}

注解的了解

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

根本的 Annotation 介绍

应用 Annotation 时要在其后面减少 @ 符号, 并把该 Annotation 当成一个修饰符应用。用于润饰它反对的程序元素。

三个根本的 Annotation:

  1. @Override: 限定某个办法，是重写父类办法, 该注解只能用于办法。
  2. @Deprecated: 用于示意某个程序元素 (类, 办法等) 已过期。
  3. @SuppressWarnings: 克制编译器正告。

根本的 Annotation 利用案例

@Override

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

补充阐明: 源码中 @interface 不是 interface 接口，是注解类是 jdk5.0 之后退出的，示意一个注解类。

1.@ Override 示意 指定重写父类的办法(从编译层面验证)，如果父类没有 fly 办法，则会报错。

2. 如果不写 @Override 注解, 而父类仍有 public void fly，依然形成重写。

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 的作用能够做到新旧版本的兼容和过渡

@SuppressWarnings

@SuppressWarnings: 克制编译器正告

  1. unchecked 是疏忽没有查看的正告
  2. rawtypes 是疏忽没有指定泛型的正告(传参时没有指定泛型的正告谬误)
  3. unused 是疏忽没有应用某个变量的正告谬误
  4. @SuppressWarnings 能够润饰的程序元素为, 查看 @Target
  5. 生成 @SupperssWarnings 时，不必背，间接点击左侧的黄色提醒，就
    能够抉择(留神能够指定生成的地位)

属性介绍以及阐明

all，克制所有正告
boxing，克制与封装 / 拆装作业相干的正告
cast，克制与强制转型作业相干的正告
dep-ann，克制与淘汰正文相干的正告
deprecation，克制与淘汰的相干正告
fallthrough，克制与 switch 陈说式中脱漏 break 相干的正告
finally，克制与未传回 finally 区块相干的正告
hiding，克制与暗藏变数的区域变数相干的正告
incomplete-switch，克制与 switch 陈说式(enum case) 中脱漏我的项目相干的正告
javadoc，克制与 javadoc 相干的正告
nls，克制与非 nls 字串文字相干的正告
null，克制与空值剖析相干的正告
rawtypes，克制与应用 raw 类型相干的正告
resource，克制与应用 Closeable 类型的资源相干的正告
restriction，克制与应用不倡议或禁止参照相干的正告
serial，克制与可序列化的类别脱漏 serialVersionUID 栏位相干的正告
static-access，克制与动态存取不正确相干的正告
static-method，克制与可能宣告为 static 的办法相干的正告
super，克制与置换办法相干但不含 super 呼叫的正告
synthetic-access，克制与外部类别的存取未最佳化相干的正告
sync-override，克制因为置换同步办法而脱漏同步化的正告
unchecked，克制与未查看的作业相干的正告
unqualified-field-access，克制与栏位存取不合格相干的正告
unused，克制与未用的程式码及停用的程式码相干的正告

package com.hspedu.annotation_;

import java.util.ArrayList;
import java.util.List;
@SuppressWarnings({"rawtypes", "unchecked", "unused"})
public class SuppressWarnings_ {

    //1. 当咱们不心愿看到这些正告的时候，能够应用 SuppressWarnings 注解来克制正告信息
    //2. 在 {""} 中，能够写入你心愿克制(不显示) 正告信息
    //3. 对于 SuppressWarnings 作用范畴是和你搁置的地位相干
    //   比方 @SuppressWarnings 搁置在 main 办法，那么克制正告的范畴就是 main
    //   通常咱们能够搁置具体的语句, 办法, 类.

    //4.  看看 @SuppressWarnings 源码
    //(1) 搁置的地位就是 TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE
    //(2) 该注解类有数组 String[] values() 设置一个数组比方 {"rawtypes", "unchecked", "unused"}
    /*
        @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
            @Retention(RetentionPolicy.SOURCE)
            public @interface SuppressWarnings {String[] value();}
     */
    public static void main(String[] args) {List list = new ArrayList();
        list.add("jack");
        list.add("tom");
        list.add("mary");
        int i;
        System.out.println(list.get(1));

    }

    public void f1() {//        @SuppressWarnings({"rawtypes"})
        List list = new ArrayList();


        list.add("jack");
        list.add("tom");
        list.add("mary");
//        @SuppressWarnings({"unused"})
        int i;
        System.out.println(list.get(1));
    }
}

JDK 的元 Annotation(元注解)

JDK 的元 Annotation 用于润饰其余 Annotation。

元注解的品种

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

@Retention

只能用于润饰一个 Annotation 定义, 用于指定该 Annotation 能够保留多长时间, @Rentention 蕴含一个 RetentionPolicy 类型的成员变量, 应用 @Rentention 时必须为该 value 成员变量指定值: @Retention 的三种值

  1. RetentionPolicy.SOURCE: 编译器应用后，间接抛弃这种策略的正文
  2. RetentionPolicy.CLASS: 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注解。这是默认值
  3. RetentionPolicy.RUNTIME: 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 会保留注解. 程序能够通过反射获取该注解。
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE) // 编译器编译时失效，不会写入到 class 文件中
public @interface Override {}

@Target

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

@Documented
@Retention(RetentionPolicy.RUNTIME) // 作用范畴 RUNTIME
@Target(ElementType.ANNOTATION_TYPE) // 只能润饰注解
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 的取值
}
public enum ElementType {/** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

@Documented

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

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

@Inherited

被它润饰的 Annotation 将具备继承性。如果某个类应用了被 @Inherited 润饰的 Annotation, 则其子类将主动具备该注解。

文章和代码曾经归档至【Github 仓库：https://github.com/timerring/java-tutorial】或者公众号【AIShareLab】回复 java 也可获取。

退出移动版