枚举类的使用和注解总结
- 一、枚举类
- (一)概述
- (二)如何自定义枚举类?
- (三)JDK 5.0 新增使用enum定义枚举类
- (四)Enum类的常用方法
- (五)用Enum类定义的枚举类对象实现接口
- 二、注解
- (一)概述
- (二)注解的使用示例
- (三)自定义注解
- (四)元注解
- (五)如何获取注解信息:
- (六)JDK 8.0中注解的新特性
- 1.可重复注解
- 2.类型注解
一、枚举类
(一)概述
- 枚举类的理解:类的对象只有有限个,确定的。我们称此类为枚举类
- 当需要定义一组常量时,强烈建议使用枚举类
- 枚举类的实现:
JDK 5.0以前需要自定义
JDK 5.0后新增enum关键字用于定义枚举类- 如果枚举类中只一个对象,则可以作为单例模式的实现方式。
- 枚举类的属性:
枚举类对象的属性不应允许被改动,所以应该使用 private final修饰 枚举类的使用 private final修饰的属性应该在构造器中为其赋值 若枚举类显式的定义了带参数的构造器,则在列出枚举值时也必须对应的传入参数
(二)如何自定义枚举类?
步骤:
私有化构造器,保证不能在类的外部创建其对象;
在类的内部创建枚举类的示例。声明为:public static final;
对象如果有实例变量,应该声明为private final,并在构造器中初始化;
- 代码实例:
public class SeasonTest {
public static void main(String[] args) {
Season spring = Season.SPRING;
System.out.println(spring);
}
}
class Season{
//1.声明Season对象的属性:private final修饰
private final String seasonName;
private final String seasonDesc;
//2.私有化类的构造器,并给对象属性赋值
private Season(String seasonName,String seasonDesc){
this.seasonName = seasonName;
this.seasonDesc = seasonDesc;
}
//3.提供当前枚举类的多个对选哪个:public static final的
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("冬天","冰天雪地");
//4.其他诉求1:获取枚举类对象的属性
public String getSeasonName() {
return seasonName;
}
public String getSeasonDesc() {
return seasonDesc;
}
//5.其他诉求2:提供toString()方法
@Override
public String toString() {
return "Season{" +
"seasonName='" + seasonName + '\'' +
", seasonDesc='" + seasonDesc + '\'' +
'}';
}
}
(三)JDK 5.0 新增使用enum定义枚举类
使用说明:
- 使用enum定义的枚举类默认继承了java.lang.Enum类,因此不能再继承其他类
- 枚举类的构造器只能使用private权限修饰符
- 枚举类的所有实例必须在枚举类中显式列出(“,”分隔“;”结尾)。列出的实例系统会自动添加public static final修饰
- 必须在枚举类的第一行声明枚举类对象
代码实例:
//使用enum关键字枚举类
enum Season1 {
//1.提供当前枚举类的对象,多个对象之间用","隔开,末尾对象";"结束
SPRING("春天","春暖花开"),
SUMMER("夏天","夏日炎炎"),
AUTUMN("秋天","秋高气爽"),
WINTER("冬天","冰天雪地");
//2.声明Season对象的属性:private final修饰
private final String seasonName;
private final String seasonDesc;
//3.私化类的构造器,并给对象属性赋值
private Season1(String seasonName,String seasonDesc){
this.seasonName = seasonName;
this.seasonDesc = seasonDesc;
}
//4.其他诉求1:获取枚举类对象的属性
public String getSeasonName() {
return seasonName;
}
public String getSeasonDesc() {
return seasonDesc;
}
}
(四)Enum类的常用方法
- values()方法:返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
- valueOf(String str):可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的“名字”.如不是,会有运行时异常IllegalArgumentException
- toString():返回当前枚举类对象常量的名称
代码实例:
public class SeasonTest1 {
public static void main(String[] args) {
Season summer = Season.SUMMER;
//获得Season类的父类
System.out.println(Season.class.getSuperclass());//class java.lang.Enum
//调用toString()方法,返回当前枚举类对象常量的名称
System.out.println(summer.toString());//SUMMER
//values():返回枚举类型的对象数组。
Season[] values = Season.values();
for(int i = 0;i < values.length;i++){
System.out.println(values[i]);
}
//valueOf(String objName):返回与objName同名的枚举对象,找不到报IllegalArgumentException异常
Season winter = Season.valueOf("WINTER");
System.out.println(winter);//WINTER
}
}
enum Season{
//1.提供当前枚举类的对象,多个对象之间用“,”隔开,末尾对象“;“结束
SPRING("春天","春暖花开"),
SUMMER("夏天","夏日炎炎"),
AUTUMN("秋天","秋高气爽"),
WINTER("冬天","冰天雪地");
//2.声明Season对象的属性:private final修饰
private final String seasonName;
private final String seasonDesc;
//3.私有化类的构造器,并给对象属性赋值
private Season(String seasonName,String seasonDesc){
this.seasonName = seasonName;
this.seasonDesc = seasonDesc;
}
//4.其他诉求1:获取枚举类对象的属性
public String getSeasonName() {
return seasonName;
}
public String getSeasonDesc() {
return seasonDesc;
}
}
(五)用Enum类定义的枚举类对象实现接口
- 若每个枚举值在调用实现的接口方法呈现相同的行为方式,则只要统一实现该方法即可。
- 若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式,则可以让每个枚举值分别来实现该方法。
代码实例:
- 枚举类统一实现抽象方法
//枚举类统一实现抽象方法
public class SeasonTest1 {
public static void main(String[] args) {
Season summer = Season.SUMMER;
summer.show();//我是Season类的show()方法
}
}
interface Info{
void show();
}
enum Season implements Info{
//1.提供当前枚举类的对象,多个对象之间用“,”隔开,末尾对象“;“结束
SPRING("春天","春暖花开"),
SUMMER("夏天","夏日炎炎"),
AUTUMN("秋天","秋高气爽"),
WINTER("冬天","冰天雪地");
//2.声明Season对象的属性:private final修饰
private final String seasonName;
private final String seasonDesc;
//3.私有化类的构造器,并给对象属性赋值
private Season(String seasonName,String seasonDesc){
this.seasonName = seasonName;
this.seasonDesc = seasonDesc;
}
@Override
public void show() {
System.out.println("我是Season类的show()方法");
}
}
- 让枚举类的对象分别实现接口中的抽象方法
//让枚举类的对象分别实现接口中的抽象方法
public class SeasonTest1 {
public static void main(String[] args) {
Season summer = Season.SUMMER;
summer.show();//我是SUMMER对象的show()方法
Season spring = Season.SPRING;
spring.show();//我是SPRING对象的show()方法
}
}
interface Info{
void show();
}
enum Season implements Info{
//1.提供当前枚举类的对象,多个对象之间用“,”隔开,末尾对象“;“结束
SPRING("春天","春暖花开"){
@Override
public void show() {
System.out.println("我是SPRING对象的show()方法");
}
},
SUMMER("夏天","夏日炎炎"){
@Override
public void show() {
System.out.println("我是SUMMER对象的show()方法");
}
},
AUTUMN("秋天","秋高气爽"){
@Override
public void show() {
System.out.println("我是AUTUMN对象的show()方法");
}
},
WINTER("冬天","冰天雪地"){
@Override
public void show() {
System.out.println("我是WINTER对象的show()方法");
}
};
//2.声明Season对象的属性:private final修饰
private final String seasonName;
private final String seasonDesc;
//3.私有化类的构造器,并给对象属性赋值
private Season(String seasonName,String seasonDesc){
this.seasonName = seasonName;
this.seasonDesc = seasonDesc;
}
}
二、注解
(一)概述
- jdk 5.0 新增的功能
- Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation,程序员可以在不改变原逻辑的情况下, 在源文件中嵌入一些补充信息。
- Annotation可以像修饰符一样使用,可以用来修饰包、类、构造器、方法、成员变量、参数、局部变量的声明,这些信息被保存在Annotation的“name = value”对中。
- 在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE/Android 中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗 代码和XML配置等。
- 框架 = 注解 + 反射机制 + 设计模式
(二)注解的使用示例
- 生成文档相关的注解
@author,标明开发该类模块的作者,多个作者之间使用,分割
@version,标明该类模块的版本
@see,参考转向,也就是相关主题
@since,从哪个版本开始增加的
@param,对方法中某参数的说明,如果没有参数就不能写
@return,对方法返回值的说明,如果方法的返回值类型是void就不能写
@exception,对方法可能抛出的异常进行说明,如果方法没有用 throws显式抛出的异常就不能写
其中:@param @return和@exception这三个标记都是只用于方法的。
@param的格式要求:@param形参名形参类型形参说明
@return的格式要求:@return返回值类型返回值说明
@exception的格式要求:@exception异常类型异常说明
@param和@ exception可以并列多个
代码实例:
/**
* @author zb
* @project_name zb
* @package_name com.zb.java
* @create 2021-01-30 20:11
*/
public class AnnotationTest {
/**
*程序的主方法
* @param args 传入命令行参数
*/
public static void main(String[] args) {
}
/**
* 求圆形面积
* @param radius 所求面积的半径
* @return 面积值
*/
public static double getArea(double radius){
return Math.PI * radius * radius;
}
}
- 在编译时进行格式检查(JDK内置的三个基本注解)
@Override: 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的择
@SuppressWarnings: 抑制编译器警告
代码实例:
public class AnnotationTest{
public static void main (String [] args){
//抑制编译器警告
@SuppressWarnings("unused")
int a = 0;
}
@Deprecated
public void print(){
System.out.print("过时的方法");
}
@Override
public String toString(){
return "重写的toString方法";
}
}
- 跟踪代码依赖性,实现替代配置文件功能
(三)自定义注解
概述:
- 定义新的 Annotation 类型使用 @interface 关键字
- 自定义注解自动继承了java.lang.annotation.Annotation 接口
- Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String 类型 、Class 类型 、enum 类型 、Annotation 类型 、以上所有类型的 数组。
- 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
- 如果只有一个参数成员,建议使用参数名为value
- 如果定义的注解含有配置参数,那么使用时必须指定参数值,除非它有默认值。格式是“参数名 = 参数值”,如果只有一个参数成员,且名称为value,可以省略“value=”
- 没有成员定义的 Annotation称为标记; 包含成员变量的 Annotation 称为元数据 Annotation
说明:
如果注解有成员,在使用注解时,需要指明成员的值。
自定义注解必须配上注解的信息处理流程(使用反射)才意义。
自定义注解通过都会指明两个元注解:Retention、Targe
实例代码:
@MyAnnotation(value = "hello")//注解中加入default可以省略参数值
public class MyAnnotationTest {
public static void main(String[] args) {
}
}
//声明一个注解
@interface MyAnnotation{
String value() default "hello";
}
(四)元注解
元注解:对现有的注解进行解释说明的注解
JDK 5.0 提供的4种元注解:
- @Retention:
只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值:
1.RetentionPolicy.SOURCE:在源文件中有效(即源文件保留),编译器直接丢弃这种策略的注释2.RetentionPolicy.CLASS:在class文件中有效(即class保留),当运行 Java程序时, JVM不会保留注解。 这是默认值3.RetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当行运行Java 程序时, JVM会保留注解。程序可以通过反射获取该注解
- @Target
用于指定被修饰的 Annotation 能用于修饰哪些程序元素。@Target 也包含一个名为 value 的成员变量
- @Documented
用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下,javadoc是不包括注解的。定义为Documented的注解必须设置Retention值为RUNTIME
- @Inherited
被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解
(五)如何获取注解信息:
通过发射来进行获取、调用。
前提:要求此注解的元注解Retention中声明的生命周期状态为:RUNTIME.
(六)JDK 8.0中注解的新特性
可重复注解和类型注解
1.可重复注解
重复注解:即允许在同一申明类型(类,属性,或方法)前多次使用同一个类型注解。
- 在java8 以前,同一个程序元素前最多只能有一个相同类型的注解;如果需要在同一个元素前使用多个相同类型的注解,则必须使用注解“容器”。
@interface Authority {
String role();
}
@interface Authorities { //@Authorities注解作为可以存储多个@Authority注解的容器
Authority[] value();
}
class RepeatAnnotationUseOldVersion {
@Authorities({@Authority(role="Admin"), @Authority(role="Manager")})
public void doSomeThing(){
}
}
- java8 新增了重复注解,其使用方式为
@Repeatable(Authorities.class)
@interface Authority {
String role();
}
@interface Authorities {
Authority[] value();
}
class RepeatAnnotationUseNewVersion {
@Authority(role="Admin")
@Authority(role="Manager")
public void doSomeThing(){ }
}
不同的地方是,创建重复注解 Authority 时,加上@Repeatable,指向存储注解 Authorities,在使用时候,直接可以重复使用 Authority 注解。从上面例子看出,java 8里面做法更适合常规的思维,可读性强一点。但是,仍然需要定义容器注解。
总结:
1.在Authority上声明@Repeatable,成员值为Authorities.class
2.Authority的Target和Retention等元注解与Authorities相同。
2.类型注解
- JDK1.8之后,关于元注解@Target的参数类型ElementType枚举值多了两个:
TYPE_PARAMETER,TYPE_USE。
ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)。
ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中
代码实例:
@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 {
}