Day46（枚举类，enum，Enum类方法，注解，常见的注解示例，自定义注解，元注解）

枚举类

枚举类的使用

主要内容:

• 如何自定义枚举类

• 如何使用关键字enum定义枚举类

• Enum类的主要方法

• 实现接口的枚举类

类的对象只有有限个，确定的。举例如下：

• 星期：Monday(星期一)、…、Sunday(星期天)

• 性别：Man(男)、Woman(女)

• 季节：Spring(春节)…Winter(冬天)

• 支付方式：Cash（现金）、WeChatPay（微信）、Alipay(支付宝)、BankCard(银行卡)、CreditCard(信用卡)

• 就职状态：Busy、Free、Vocation、Dimission

• 订单状态：Nonpayment（未付款）、Paid（已付款）、Delivered（已发货）、Return（退货）、Checked（已确认）Fulfilled（已配货）、

• 线程状态：创建、就绪、运行、阻塞、死亡

当需要定义一组常量时，强烈建议使用枚举类

枚举类的实现

• JDK1.5之前需要自定义枚举类

• JDK 1.5 新增的enum 关键字用于定义枚举类

若枚举只有一个对象, 则可以作为一种单例模式的实现方式。

枚举类的属性

• 枚举类对象的属性不应允许被改动, 所以应该使用private final 修饰

• 枚举类的使用private final 修饰的属性应该在构造器中为其赋值

• 若枚举类显式的定义了带参数的构造器, 则在列出枚举值时也必须对应的传入参数

自定义枚举类

1.私有化类的构造器，保证不能在类的外部创建其对象

2.在类的内部创建枚举类的实例。声明为：public static final

3.对象如果有实例变量，应该声明为private final，并在构造器中初始化

//自定义枚举类
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 FALL = new Season("秋天","爽");
    public static final Season WINTER = new Season("冬天","冷");
    //4.其他诉求1：获取枚举类对象的属性
    public String getSeasonName() {
        return seasonName;
    }
    public String getSeasonDesc() {
        return seasonDesc;
    }
    //4.其他诉求1：提供toString()
    @Override
    public String toString() {
        return "Season{" +
                "seasonName='" + seasonName + '\'' +
                ", seasonDesc='" + seasonDesc + '\'' +
                '}';
    }
}

使用enum定义枚举类

使用说明

• 使用enum定义的枚举类默认继承了java.lang.Enum类，因此不能再继承其他类

• 枚举类的构造器只能使用private 权限修饰符

• 枚举类的所有实例必须在枚举类中显式列出(, 分隔; 结尾)。列出的实例系统会自动添加public static final 修饰

• 必须在枚举类的第一行声明枚举类对象

JDK5 中可以在switch 表达式中使用Enum定义的枚举类的对象作为表达式, case 子句可以直接使用枚举值的名字, 无需添加枚举类作为限定。

//使用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 static void main(String[] args) {
    Season1 spring = Season1.SPRING;
    //toString():返回枚举类对象的名称
    System.out.println(spring.toString());//SPRING
    //values():返回所的枚举类对象构成的数组
    Season1[] seaArr = Season1.values();
    for (int i = 0; i < seaArr.length; i++) {
        System.out.print(seaArr[i]+"\t");
        if (i == seaArr.length -1){
            System.out.println();
        }
    }//SPRING  SUMMER AUTUMN WINTER
    //valueOf(String objName):返回枚举类中对象名是objName的对象。
    Season1 winter = Season1.valueOf("WINTER");
    System.out.println(winter);//WINTER
    //如果没objName的枚举类对象，则抛异常：IllegalArgumentException
    Season1 win = Season1.valueOf("WIN");
    System.out.println(win);//Exception in thread "main" java.lang.IllegalArgumentException
}

实现接口的枚举类

和普通Java 类一样，枚举类可以实现一个或多个接口

若每个枚举值在调用实现的接口方法呈现相同的行为方式，则只要统一实现该方法即可。

若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式, 则可以让每个枚举值分别来实现该方法

interface InfoSea{
    void show();
}
//使用enum关键字枚举类
enum Season1 implements InfoSea{
    //1.提供当前枚举类的对象，多个对象之间用","隔开，末尾对象";"结束
    SPRING("春天","暖"){
//让枚举类的对象分别实现接口中的抽象方法
        @Override
        public void show() {
            System.out.println("这是春天");
        }
    },
    SUMMER("春天","暖"){
        @Override
        public void show() {
            System.out.println("这是夏天");
        }
    },
    AUTUMN("春天","暖"){
        @Override
        public void show() {
            System.out.println("这是秋天");
        }
    },
    WINTER("春天","暖"){
        @Override
        public void show() {
            System.out.println("这是冬天");
        }
    };

注解(Annotation)

主要内容：

• 注解(Annotation)概述

• 常见的Annotation示例

• 自定义Annotation

• JDK中的元注解

• 利用反射获取注解信息（在反射部分涉及）

• JDK 8中注解的新特性

注解(Annotation) 概述

• 从JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)

• Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

• Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在Annotation 的“name=value” 对中。

• 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。

• 未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架= 注解+ 反射+ 设计模式。

常见的Annotation示例

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

示例一：生成文档相关的注解

@author标明开发该类模块的作者，多个作者之间使用,分割

@version标明该类模块的版本

@see参考转向，也就是相关主题

@since从哪个版本开始增加的

@param对方法中某参数的说明，如果没有参数就不能写

@return对方法返回值的说明，如果方法的返回值类型是void就不能写

@exception对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写

其中

​ @param@return和@exception这三个标记都是只用于方法的。

​ @param的格式要求：@param形参名形参类型形参说明

​ @return的格式要求：@return返回值类型返回值说明

​ @exception的格式要求：@exception异常类型异常说明

​ @param和@exception可以并列多个

packagecom.annotation.javadoc;
/**
* @author shkstart
* @version 1.0
* @see Math.java
*/
public class JavadocTest {
/**
* 程序的主方法，程序的入口
* @param args String[] 命令行参数
*/
public static void main(String[] args) {
}
 
/**
* 求圆面积的方法
* @param radius double 半径值
* @return double 圆的面积
*/
public static double getArea(double radius){
return Math.PI* radius* radius;
	}
}

示例二：在编译时进行格式检查(JDK内置的三个基本注解)

• @Override: 限定重写父类方法, 该注解只能用于方法

• @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择

• @SuppressWarnings: 抑制编译器警告

package com.annotation.javadoc;
public class AnnotationTest{
public static void main(String[] args) {
@SuppressWarnings("unused")
int a= 10;
}
@Deprecated
public void print(){//print有删除线
System.out.println("过时的方法");
}
@Override
public String toString() {
return"重写的toString方法()";
	}
}

示例三：跟踪代码依赖性，实现替代配置文件功能

Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。

@WebServlet("/login")
public class LoginServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
protected void doGet(HttpServletRequest  request, HttpServletResponse response) throws ServletException, IOException {}
protected void doPost(HttpServletRequest  request, HttpServletResponse response) throws ServletException, IOException {
doGet(request, response);
}}

spring框架中关于“事务”的管理

@Transactional(propagation=Propagation.REQUIRES_NEW,
isolation=Isolation.READ_COMMITTED,readOnly=false,timeout=3)
public void buyBook(String username,String isbn){
//1.查询书的单价
int price=bookShopDao.findBookPriceByIsbn(isbn);
//2.更新库存
bookShopDao.updateBookStock(isbn);
//3.更新用户的余额
bookShopDao.updateUserAccount(username,price);
}

自定义Annotation

• 定义新的Annotation类型使用@interface关键字

• 自定义注解自动继承了java.lang.annotation.Annotation接口

• Annotation的成员变量在Annotation定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。

• 可以在定义Annotation的成员变量时为其指定初始值,指定成员变量的初始值可使用default关键字

• 如果只有一个参数成员，建议使用参数名为value

• 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名=参数值”，如果只有一个参数成员，且名称为value，可以省略“value=”

• 没有成员定义的Annotation称为标记;包含成员变量的Annotation称为元数据Annotation

注意：自定义注解必须配上注解的信息处理流程才有意义。10.2.2 常见的Annotation示例

public @interface MyAnnotation {
         String value() default "hello";
         }

JDK 中的元注解

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 的成员变量。

@Documented:

用于指定被该元Annotation 修饰的Annotation 类将被javadoc工具提取成文档。默认情况下，javadoc是不包括注解的。

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

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

• 比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解

• 实际应用中，使用较少