08_Java枚举类与注解

一、枚举类

主要内容：

• 如何自定义枚举类
• 如何使用关键字enum定义枚举类
• Enum类的主要方法
• 实现接口的枚举类

1. 入门

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

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

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

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

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

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

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

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

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

1.1 枚举类的实现

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

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

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

1.2 枚举类的属性

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

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

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

2. 自定义枚举类

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

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

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

class Season{
    private final String SEASONNAME;//季节的名称
    private final String SEASONDESC;//季节的描述
    private Season(String seasonName,String seasonDesc){
    	this.SEASONNAME = seasonName;
    	this.SEASONDESC = seasonDesc;
    }
    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("冬天", "白雪皑皑");
}

3. 使用enum定义枚举类

3.1使用说明

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

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

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

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

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

public enum SeasonEnum {
    SPRING("春天","春风又绿江南岸"),
    SUMMER("夏天","映日荷花别样红"),
    AUTUMN("秋天","秋水共长天一色"),
    WINTER("冬天","窗含西岭千秋雪");
    
    private final String seasonName;
    private final String seasonDesc;
    private SeasonEnum(String seasonName, String seasonDesc) {
    	this.seasonName = seasonName;
    	this.seasonDesc = seasonDesc;
    }
    public String getSeasonName() {
    	return seasonName;
    }
    public String getSeasonDesc() {
    	return seasonDesc;
    }
}

3.2Enum类的主要方法

方法名	详细描述
values	返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
valueOf	传递枚举类型的 Class 对象和枚举常量名称给静态方法 valueOf，会得到与参数匹配的枚举常量。
toString	得到当前枚举常量的名称，你可以通过重写这个方法来使得到的结果更易读。
equals	在枚举类型中可以直接使用"=="来比较两个枚举常量是否相等。Enum提供的这个 equals() 方法，也是直接使用 "=="实现的。它的存在是为了在 Set、List 和 Map 中使用。注意，equals() 是不可变的。
hashCode	Enum 实现了 hashCode() 来和 equals() 保持一致。它也是不可变的。
getDeclaringClass	得到枚举常量所属枚举类型的 Class 对象。可以用它来判断两个枚举常量是否属于同一个枚举类型。
name	得到当前枚举常量的名称。建议优先使用 toString()。
ordinal	得到当前枚举常量的次序
compareTo	枚举类型实现了 Comparable 接口，这样可以比较两个枚举常量的大小 （按照声明的顺序排列）
clone	枚举类型不能被 Clone。为了防止子类实现克隆方法，Enum实现了一个仅抛出 CloneNotSupportedException 异常的不变 Clone()。

4. 实现接口的枚举类

• 和普通 Java 类一样，枚举类可以实现一个或多个接口
• 若每个枚举值在调用实现的接口方法呈现相同的行为方式，则只要统一实现该方法即可。
• 若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式, 则可以让每个枚举值分别来实现该方法

public class EnumTest1 {
    public static void main(String[] args) {
        for (Season season : Season.values()) {
            season.show();
        }
    }
}

interface Showable {
    void show();
}

enum Season implements Showable {
    SPRING {
        // 方式1：当每个枚举值需要实现的方法不同时，可以分别对每个实例进行方法实现
        @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("冬天就是白雪皑皑的");
        }
    };

    /**
     * 方式2：当每个枚举值调用实现的方法都一样时，可以统一实现该方法
     */
    // @Override
    // public void show() {
    //     System.out.println(this.name() + "来啦");
    // }
}

二、注解(Annotation)

主要内容：

• 注解(Annotation)概述

• 常见的Annotation示例

• 自定义Annotation

• JDK中的元注解

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

• JDK 8中注解的新特性

1. 注解(Annotation)概述

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

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

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

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

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

2. 常见的Annotation示例

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

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

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

@version 标明该类模块的版本

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

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

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

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

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

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

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

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

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

@param和@exception可以并列多个

package com.annotation.javadoc;
/**
* @author andy
* @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;
    }
}

2.2 示例二：在编译时进行格式检查(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(){
    	System.out.println("过时的方法");
    }
    @Override
    public String toString() {
    	return "重写的toString方法()";
    }
}

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

• 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);
	} 
}

<servlet>
	<servlet-name>LoginServlet</servlet-name>
	<servlet-class>com.servlet.LoginServlet</servlet-class>
</servlet>
<servlet-mapping>
	<servlet-name>LoginServlet</servlet-name>
	<url-pattern>/login</url-pattern>
</servlet-mapping>

• 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);
}

<!-- 配置事务属性 -->
<tx:advice transaction-manager="dataSourceTransactionManager" id="txAdvice">
    <tx:attributes>
    <!-- 配置每个方法使用的事务属性 -->
    <tx:method name="buyBook" propagation="REQUIRES_NEW" isolation="READ_COMMITTED" read-only="false" timeout="3" />
    </tx:attributes>
</tx:advice>

3. 自定义Annotation

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

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

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

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

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

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

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

注意：自定义注解必须配上注解的信息处理流程才有意义。

@MyAnnotation(value="我的注解")
public class MyAnnotationTest {
    public static void main(String[] args) {
    	Class clazz = MyAnnotationTest.class;
    	Annotation a = clazz.getAnnotation(MyAnnotation.class);
    	MyAnnotation m = (MyAnnotation) a;
    	String info = m.value();
    	System.out.println(info);
    }
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface MyAnnotation{
	String value() default "foo";
}

4. JDK中的元注解

• JDK 的元 Annotation 用于修饰其他 Annotation 定义
• JDK5.0 提供了4个标准的meta-annotation类型，分别是：
  • Retention
  • Target
  • Documented
  • Inherited

@Retention

只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Retention 包含一个 RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值:

• RetentionPolicy.SOURCE: 在源文件中有效（即源文件保留），编译器直接丢弃这种策略的

  注释

• RetentionPolicy.CLASS: 在class文件中有效（即class保留） ， 当运行 Java 程序时, JVM

  不会保留注解。 这是默认值

• RetentionPolicy.RUNTIME: 在运行时有效（即运行时保留），当运行 Java 程序时, JVM会保留注释。程序可以通过反射获取该注释。

public enum RetentionPolicy{
	SOURCE,
	CLASS,
	RUNTIME
}

@Retention(RetentionPolicy.SOURCE)
@interface MyAnnotation1{ }
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{ }

@Target

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

取值(ElementType)	描述
CONSTRUCTOR	用于描述构造器
FIELD	用于描述域
LOCAL_VARIABLE	用于描述局部变量
METHOD	用于描述方法
PACKAGE	用于描述包
PARAMETER	用于描述参数
TYPE	用于描述类、接口（包括注解类型）或enum声明

注意：包注解需要写在包内的package-info.java文件中

@MyAnnotation4(value = "456")
package com.welisit.annotation.test;

@Documented

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

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

@Inherited

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

• 比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解
• 实际应用中，使用较少

5. 利用反射获取注解信息

JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素。

当一个 Annotation 类型被定义为运行时 Annotation 后, 该注解才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取。

程序可以调用 AnnotatedElement对象的如下方法来访问 Annotation 信息

6. JDK8中注解的新特性

Java 8对注解处理提供了两点改进：可重复的注解及可用于类型的注解。此外，反射也得到了加强，在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。

6.1 可重复的注解

6.1.1 JDK8之前的写法

JDK8以前没有可重复的注解，只能通过容器注解的方式来实现

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Fruit {
    String value();
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface FruitContainer {
    Fruit[] value();
}

@FruitContainer({
        @Fruit("苹果"),
        @Fruit("梨子")
})
public class FruitTest {
    public static void main(String[] args) {
        Class<FruitTest> fruitTestClass = FruitTest.class;
        FruitContainer fruitContainer = fruitTestClass.getAnnotation(FruitContainer.class);
        Fruit[] fruits = fruitContainer.value();
        for (Fruit fruit : fruits) {
            System.out.println(fruit.value());
        }
    }
}

6.1.2 JDK8的写法

JDK8新增了@Repeatable注解，可以在同一地方多次使用同一类型的注解

@Retention(RetentionPolicy.RUNTIME)
public @interface FruitContainer {
    Fruit[] value();
}

@Retention(RetentionPolicy.RUNTIME)
@Repeatable(FruitContainer.class)
public @interface Fruit {
    String value();
}

@Fruit("苹果")
@Fruit("桃子")
public class FruitTest {
    public static void main(String[] args) {
        Class<FruitTest> fruitTestClass = FruitTest.class;
        FruitContainer fruitContainer = fruitTestClass.getAnnotation(FruitContainer.class);
        Fruit[] fruits = fruitContainer.value();
        for (Fruit fruit : fruits) {
            System.out.println(fruit.value());
        }
    }
}

6.2 可用于类型的注解

JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER、TYPE_USE。

在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。

ElementType.TYPE_PARAMETER

表示该注解能写在类型变量的声明语句中（如：泛型声明）。

public class TestTypeDefine<@TypeDefine() U> {
	private U u;
	public <@TypeDefine() T> void test(T t){
	}
}
@Target({ElementType.TYPE_PARAMETER})
@interface TypeDefine{
}

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 {
}