9 枚举和注解
# 9 枚举和注解
9.1先看一个需求
要求创建季节(Season)对象，请设计并完成。Enumeration01.java
class Season{//类
private String name;
private String desc;//描述
//构造器
//getXX
//setXX
}
代码
代码
package com.ming;
/**
*@author 明
*@version 1.0
*/
public class Enumeration01 {
public static void main(String[] args) {
Season spring = new Season("春天", "温暖");
Season summer = new Season("夏天","炎热");
Season autumn = new Season("秋天","凉爽");
Season winter = new Season("冬天","寒冷");
//因为对于季节而言，它的对象（具体值），是固定的4个，不会有更多
//上面的设计不能体现固定的4个对象
//因此这样设计不好====> 枚举类:一个一个 举：例举,即把具体的对象一个一个例举出来的类
//就称为枚举类
}
}
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;
}
}
9.2 分析问题
9..2.1 创建 Season 对象有如下特点
- 季节的值是有限的几个值(spring, summer, autumn, winter)
- 只读，不需要修改。
9.3 解决方案-枚举
- 枚举对应英文(enumeration, 简写 enum)
- 枚举是一组常量的集合。
- 可以这里理解：枚举属于一种特殊的类，里面只包含一组有限的特定的对象。
9.4 枚举的二种实现方式
- 自定义类实现枚举
- 使用 enum 关键字实现枚举
9.5 自定义类实现枚举-应用案例
-
不需要提供 setXxx 方法，因为枚举对象值通常为只读
-
对枚举对象/属性使用 final + static 共同修饰，实现底层优化。
-
枚举对象名通常使用全部大写，常量的命名规范。
-
枚举对象根据需要，也可以有多个属性 //Enumeration02.java
代码:
package com.ming;
/**
*@author 明
*@version 1.0
*/
public class Enumeration02 {
public static void main(String[] args) {
System.out.println(Season.AUTUMN);
}
}
//演示自定义枚举实现
class Season{//类
private String name;
private String desc;
//定义了四个对象
public final static Season SPRING = new Season("春天", "温暖");
public final static Season SUMMER = new Season("夏天","炎热");
public final static Season AUTUMN = new Season("秋天","凉爽");
public final static Season WINTER = new Season("冬天","寒冷");
//1.构造器私有，目的：防止直接new
//2.去掉setXxx方法，防止属性被修改
//3.在Season内部，直接创建固定的对象
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 + '\'' +
'}';
}
}
9.6 自定义类实现枚举-小结
9.6.1 小结：进行自定义类实现枚举，有如下特点：
- 构造器私有化
- 本类内部创建一组对象[四个 春夏秋冬]
- 对外暴露对象 (通过为对象添加 public final static 修饰符)
- 可以提供 get 方法，但是不要提供 set
9.7 enum 关键字实现枚举-快速入门
9.7.1 说明
使用 enum 来实现前面的枚举案例，看老师演示，主要体会和自定义类实现枚举不同的地方。Enumeration03.
代码
package com.ming;
/**
* @author 明
* @version 1.0
*/
public class Enumeration03 {
public static void main(String[] args) {
System.out.println(Season.AUTUMN);
}
}
//演示使用enum关键字来实现枚举类
enum Season2{//类
//如果使用了enum 来实现枚举类
//1.使用关键字enum来代替class
//2.public final static Season SPRING = new Season("春天", "温暖");直接使用
// SPRING("春天", "温暖") 解读 常量名(实参列表)
//3.如果有多个常量（对象）， 使用 , 间隔即可
//4.如果使用enum枚举要求将定义常量对象，写在最前面
//5.如果我们使用的是无参构造器，则可以省略()
SPRING("春天", "温暖"),SUMMER("夏天","炎热"),AUTUMN("秋天","凉爽")
,WINNER("冬天","寒冷"),WHAT;
private String name;
private String desc;
//定义了四个对象
// public final static Season SPRING = new Season("春天", "温暖");
// public final static Season SUMMER = new Season("夏天","炎热");
// public final static Season AUTUMN = new Season("秋天","凉爽");
// public final static Season WINTER = new Season("冬天","寒冷");
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 + '\'' +
'}';
}
}
9.7.2 enum 关键字实现枚举注意事项
- 当我们使用 enum 关键字开发一个枚举类时,默认会继承 Enum 类, 而且是一个 final 类[如何证明],老师使用具来演示
- 传统的 public static final Season2 SPRING = new Season2("春天", "温暖"); 简化成 SPRING("春天", "温暖"), 须知道, 它调用的是哪个构造器.
- 如果使用无参构造器 创建 枚举对象, 则实参列表和小括号都可以省略
- 当有多个枚举对象时, 使用,间隔, 最后有一个分号结尾
- 枚举对象必须放在枚举类的行首.
Hello.java javac 编译=> Hello.class
Hello.java <=javap反编译 Hello.class
9.8 enum关键字实现枚举-课堂练习
下面代码是否正确,并说明表示的含义?
enum Gender{ //l1min
BOY,GIRL; //这里其实就是调用Gender类的无参构造器
}
- 上面语法是ok
- 有一个枚举类Gender, 没有属性。
- 有两个枚举对象BOY,GIRL,使用的无参构造器创建.
下面代码输出什么?EnumExercise01.java
package com.ming;
/**
* @author 明
* @version 1.0
*/
public class EnumExercise01 {
public static void main(String[] args) {
Gender2 boy = Gender2.BOY;//OK
Gender2 boy2 = Gender2.BOY;//OK
System.out.println(boy);//输出BOY //本质就是调用 Gender2 的父类Enum的 toString()
// public String toString() {
// return name;
// }
System.out.println(boy2 == boy); //True
}
}
enum Gender2{ //父类 Enum 的toString
BOY , GIRL;
}
9.9 enum 常2用方法说明
说明：使用关键字 enum 时，会隐式继承 Enum 类，这样我们就可以使用 Enum 类相关的方法。[看下源码定义
public abstract class Enum<E extends Enum<E>>
implements Comparable<E>, Serializable {
}
9.10 enum 常用方法应用实例
我们一起来举例说明 enum 常用的方法的使用，对 Season2 测试.EnumMethod.java
- toString:Enum 类已经重写过了，返回的是当前对象名,子类可以重写该方法，用于返回对象的属性信息
- name: 返回当前对象名(常量名)，子类中不能重写
- ordinal: 返回当前对象的位置号，默认从 0 开始
- values: 返回当前枚举类中所有的常量
- valueOf: 将字符串转换成枚举对象，要求字符串必须为已有的常量名，否则报异常!
- compareTo: 比较两个枚举常量，比较的就是编号!
- 代码
package com.ming;
/**
* @author 明
* @version 1.0
*/
public class EnumMethod {
public static void main(String[] args) {
//以Season2为例，枚举类，来演示各种方法
Season2 autumn = Season2.AUTUMN;
//输出枚举对象的名字
System.out.println(autumn.name());
//ordinal() 输出的是该枚举对象的次序/编号，从0开始编号
System.out.println(autumn.ordinal());
//从反编译可以看出values方法，返回Season2[]
Season2[] values = Season2.values();
for (Season2 season : values) {
System.out.println(season);
}
//valueOf：将字符串转换成枚举对象，要求字符串必须已有的常量名，否则报异常
//执行流程
//1.根据你输入的“AUTUMN”到Season的枚举对象去查找
//2.如果找到了，就返回，如果没有找到就报错
Season2 autumn1 = Season2.valueOf("AUTUMN");
System.out.println("autumn1 = "+autumn1.name());
//compareTo：比较两个枚举常量，比较的就是编号
//解读
//1. 就是把 Season2.AUTUMN 枚举对象的编号 和 Season2.SUMMER枚举对象的编号比较
//2. 看看结果
System.out.println(Season2.AUTUMN.compareTo(Season2.SUMMER));
}
}
课堂完成EnumExercise02.java 声明Week枚举类，其中包含星期一至星期日的定义；MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY, SATURDAY,SUNDAY; 使用values返回所有的枚举数组,并遍历
package com.ming;
/**
* @author 明
* @version 1.0
*/
public class EnumExercise02 {
public static void main(String[] args) {
System.out.println("===所有的星期信息如下==");
for(Week day:Week.values()){
System.out.println(day);
}
}
}
enum Week{
MONDAY("星期一"),TUESDAY("星期二"),WEDNESDAY("星期三"),THURSDAY("星期四"),FRIDAY("星期五"),SATURDAY("星期六"),SUNDAY("星期日");
private String day;
private Week(){}
private Week(String day) {
this.day = day;
}
public String getDay() {
return day;
}
@Override
public String toString() {
return day;
}
}
9.11 enum 实现接口
EnumDetail.java
- 使用 enum 关键字后，就不能再继承其它类了，因为 enum 会隐式继承 Enum，而 Java 是单继承机制。
- 枚举类和普通类一样，可以实现接口，如下形式。
enum 类名 implements 接口 1，接口 2{} - 代码
package com.ming;
/**
* @author 明
* @version 1.0
*/
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;
@Override
public void playing() {
System.out.println("播放音乐~~~");
}
}
9.12注解的理解
- 注解(Annotation)也被称为元数据(Metadata)，用于修饰解释包、类、方法、属性、构造器、局部变量等数据信息。
- 和注释一样，注解不影响程序逻辑，但注解可以被编译或运行，相当于嵌入在代码中的补充信息。
- 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替java EE旧版中所遗留的繁冗代码和XML配置等。
9.13基本的Annotation介绍
使用Annotation时要在其前面增加@符号，并把该Annotation当成一个修饰符使用。用于修饰它支持的程序元素
三个基本的Annotation:
- @Override: 限定某个方法，是重写父类方法，该注解只能用于方法
- @Deprecated: 用于表示某个程序元素(类，方法等)已过时
- @SuppressWarnings: 抑制编译器警告
9.14基本的Annotation应用案例
9.14.1 @Override注解的案例Override_java
package com.ming.annotation;
/**
* @author 明
* @version 1.0
*/
public class Override_ {
}
class Father{
public void fly(){
System.out.println("Father fly~~");
}
}
class Son extends Father{
//1. @Override 注解放在fly方法上，表示子类的fly方法时重写了父类的fly
//2. 这里如果没有写@Override 还是重写了父类fly
//3. 如果你写了@Override注解，编译器就会去检查该方法是否真的重写了父类的
// 方法，如果重写了则编译通过，如果没有构成重写，则编译报错
//4. 看看 @Override的定义
// 解读： 如果发现 @interface 表示一个 注解类
/*
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
*/
@Override
public void fly(){
System.out.println("Son fly~~");
}
}
Override 使用说明
- @Override 表示指定重写父类的方法（从编译层面验证），如果父类没有 fly 方法，则会报错
- 如果不写@Override 注解，而父类仍有 public void fly(){}，仍然构成重写
- @Override 只能修饰方法，不能修饰其它类，包，属性等等
- 查看@Override 注解源码为 @Target(ElementType.METHOD),说明只能修饰方法
- @Target 是修饰注解的注解，称为元注解,记住这个概念.
9.14.2@Deprecated注解的案例Deprecated_.java
@Deprecated:用于表示某个程序元素(类,方法等)已过时
代码
package com.ming.annotation;
/**
* @author 明
* @version 1.0
*/
public class Deprecated_ {
public static void main(String[] args) {
System.out.println(A.n2);
}
}
//1. @Deprecated修饰某个元素，表示该元素已经过时了
//2. 即不再推荐使用，但是仍然可以使用
//3. 查看 @Deprecated 注解类的源码
//4. 可以修饰方法，类，字段, 包, 参数 等等
//5. @Deprecated 可以做版本升级过渡使用
/*
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}
*/
@Deprecated
class A{
public int n1 = 10;
@Deprecated
public static int n2 = 20;
public void hi(){
}
}
@Deprecated的说明
- 用于表示某个程序元素(类, 方法等)已过时
- 可以修饰方法，类，字段, 包, 参数 等等
- @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
- @Deprecated 的作用可以做到新旧版本的兼容和过渡
9.14.3 @SuppressWarnings 注解的案例 SuppressWarnings_.java
@SuppressWarnings: 抑制编译器警告
package com.ming.annotation;
import java.util.ArrayList;
import java.util.List;
/**
* @author 明
* @version 1.0
*/
public class SuppressWarnings_ {
//1. 当我们不希望看到这些警告的时候，可以使用 SuppressWarnings注解来抑制警告信息
//2. 在{""} 中，可以写入你希望抑制(不显示)警告信息
//3. 可以指定的警告类型有
// 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，抑制与未用的程式码及停用的程式码相关的警告
//4. 关于SuppressWarnings 作用范围是和你放置的位置相关
// 比如 @SuppressWarnings放置在 main方法，那么抑制警告的范围就是 main
// 通常我们可以放置具体的语句, 方法, 类.
//5. 看看 @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();
}
*/
@SuppressWarnings({"all"})
public static void main(String[] args) {
List list = new ArrayList();
list.add("aa");
list.add("bb");
list.add("cc");
int i;
System.out.println();
}
}
● @SuppressWarnings 注解的案例
说明各种值
- unchecked 是忽略没有检查的警告
- rawtypes 是忽略没有指定泛型的警告(传参时没有指定泛型的警告错误)
- unused 是忽略没有使用某个变量的警告错误
- @SuppressWarnings 可以修饰的程序元素为, 查看@Target
- 生成@SupperssWarnings 时, 不用背, 直接点击左侧的黄色提示, 就可以选择(注意可以指定生成的位置)
9.15JDK 的元 Annotation(元注解， 了解)
9.15.1 元注解的基本介绍
JDK 的元 Annotation 用于修饰其他 Annotation
元注解：本身作用不大，讲这个原因希望同学们，看源码时，可以知道他是干什么.
9.15.2 元注解的种类 (使用不多，了解，不用深入研究)
- Retention //指定注解的作用范围，三种 SOURCE,CLASS,RUNTIME
- Target // 指定注解可以在哪些地方使用
- Documented //指定该注解是否会在 javadoc 体现
- Inherited //子类会继承父类注解
9.15.3 @Retention 注解
说明
只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 可以保留多长时间,@Retention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Retention 时必须为该 value 成员变量指定值:
@Retention 的三种值
- RetentionPolicy.SOURCE: 编译器使用后，直接丢弃这种策略的注释
- RetentionPolicy.CLASS: 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注解。这是默认值
- RetentionPolicy.RUNTIME:编译器将把注解记录在 class 文件中. 当运行 Java 程序时,JVM 会保留注解. 程序可以通过反射获取该注解
一个@Retention的案例
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE) //这个就是@retention的取值
public @interface Override {
}
@Retention的源码
简单看一下即可.
说明: Override的作用域在SOURCE,当编译器编译时生效,不会写入到.class文件,也不会再runtime(运行时)生效
简单看一下即可.
说明: Override的作用域在SOURCE,当编译器编译时生效,不会写入到.class文件,也不会再runtime(运行时)生效
9.15.4 @Target
基本说明
用于修饰Annotation定义,用于指定被修饰的Annotation能用于修饰哪些程序元素.@Target也包含一个名为value的成员变量。
看一个案例
//Deprecated.class
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {}
@Target的源码说明
@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等
}
9.15.5 @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
}
@Document源码
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}
9.15.6 @Inherited注解
被它修饰的Annotation将具有继承性.如果某个类使用了被@Inherited修饰的Annotation,则其子类将自动具有该注解
说明: 实际应用中, 使用较少, 了解即可。
元注解: 本身作用不大, 讲这个原因希望同学们, 看源码时, 可以知道他是干什么.
浙公网安备 33010602011771号