10-枚举类与注解

10—枚举类与注解

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之前需要自定义枚举类
  • JDK1.5新增的enum关键字用于定义枚举类
• 若枚举只有一个对象，则可作为一种单例模式的实现方式
• 枚举类的属性
  • 枚举类对象的属性应不允许被改动，所以应该使用private final修饰
  • 枚举类的使用private final修饰的属性应该在构造器中为其赋值
  • 若枚举类显示的定义了带参数的构造器，则在列出枚举值时也必须对应的传入参数

1.2 自定义枚举类

1. 私有化类的构造器，保证不能在类的外部创建其对象
2. 在类的内部创建枚举类的实例。声明为：public static final
3. 对象如果有实例变量，应该声明为private final，并在构造器中初始化

package 枚举;

public class SeasonTest {
    public static void main(String[] args) {
        Season season =Season.SPRING;
        System.out.println(season);
    }
}
//自定义枚举类
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;
    }

    @Override
    public String toString() {
        return "Season{" +
                "seasonName='" + seasonName + '\'' +
                ", seasonDesc='" + seasonDesc + '\'' +
                '}';
    }
}

Season{seasonName=’春天’, seasonDesc=’春暖花开’}

1.3 使用enum定义枚举类

• 使用说明
  • 使用enum定义的枚举类默认继承了java.lang.Enum类，因此不能再继承其他类
  • 枚举类的构造器只能使用private权限修饰符
  • 枚举类的所有实例必须在枚举类中显示列出(,分隔 ;结尾)。列出的实例系统会自动添加public static final修饰
• JDK1.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;
	}
}

1.4 Enum类的主要方法

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

• Enum类的主要方法
  • values()返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值
  • valueOf(String str)可以把一个字符串转化为对应的枚举类对象。要求字符串必须是枚举对象的“名字”。如不是，会有运行时异常：IllegalArgumentException
  • toStirng()返回当前枚举类对象常量的名称

package 枚举;

public class SeasonEnumTest {
    public static void main(String[] args) {
        SeasonEnum seasonEnum = SeasonEnum.AUTUMN;
        System.out.println(seasonEnum);//返回枚举类对象的名称AUTUMN
        System.out.println("——————————");
        //values()返回所有的枚举对象构成的数组
        SeasonEnum[] values = SeasonEnum.values();
        for (SeasonEnum sea :
                values) {
            System.out.println(sea);
        }
        //valueOf(String objName):返回枚举类中对象名时objName的对象
        System.out.println("——————————");
        SeasonEnum winter = SeasonEnum.valueOf("WINTER");
        System.out.println(winter);
    }
}

enum SeasonEnum{
    //1.提供当前枚举类的对象，多个对象之间使用","隔开，末尾对象";"结束
    SPRING("春天","春意盎然"),
    SUMMER("夏天","夏炎酷暑"),
    AUTUMN("秋天","秋风习习"),
    WINTER("冬天","冬日黑裘");

   //2.声明Season对象属性：private final修饰
    private final String seasonName;
    private final String seasonDesc;

    //3.私有化类的构造器
    private SeasonEnum(String seasonName, String seasonDesc){
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }

    //4.其他诉求：获取枚举类对象的属性
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }
}

AUTUMN
——————————
SPRING
SUMMER
AUTUMN
WINTER
——————————
WINTER

1.5 实现接口的枚举类

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

package 枚举;

public class EnumAndInterfaceTest {
    public static void main(String[] args) {
        EnumAndInterface1 e1 = EnumAndInterface1.AUTUMN;
        e1.show();
        EnumAndInterface2 e2 = EnumAndInterface2.SPRING;
        e2.show();
    }
}

enum EnumAndInterface1 implements Info{
    AUTUMN("秋天"),
    WINTER("冬天");
    private final String seasonName;

    EnumAndInterface1(String seasonName) {
        this.seasonName = seasonName;
    }

    @Override
    public void show() {
        System.out.println("方式一：直接实现接口的方法");
    }
}

enum EnumAndInterface2 implements Info{
    SPRING("春天"){
        @Override
        public void show() {
            System.out.println("方式二：在枚举值里实现该方法，当前枚举值为\"SPRING\"");
        }
    },
    SUMMER("夏天"){
        @Override
        public void show() {
            System.out.println("方式二：在枚举值里实现该方法，当前枚举值为\"SUMMER\"");
        }
    };

    private final String seasonName;

    private EnumAndInterface2(String seasonName){
        this.seasonName = seasonName;
    }
}

方式一：直接实现接口的方法
方式二：在枚举值里实现该方法，当前枚举值为”SPRING”

2.注解的使用

• 注解(Annotation)概述
• 常见的Annotation示例
• 自定义Annotation
• JDK中的元注解
• 利用反射获取注解信息（在反射部分涉及）
• JDK 8中注解的新特性

2.1 注解(Annotation)概述

• 从JDK5.0开始，Java增加了对元数据(MetaData)的支持，也就是Annotation(注解)
• Annotation其实就是代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。通过使用Annotation，程序员可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署
• Annotation可以像修饰符一样被使用，可以用于修饰包，类，构造器，方法，成员变量，参数，局部变量声明，这些信息被保存在Annotation的”name = value”对中
• 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等
• 未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 涉及模式

2.2 常见的Annotation示例

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

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

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

  • @version标明开发类的模板

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

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

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

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

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

  • @param @return 和 @exception 这三个标记都是只用于方法的。 @param的格式要求：@param 形参名 形参类型 形参说明 @return 的格式要求：@return 返回值类型 返回值说明 @exception的格式要求：@exception 异常类型 异常说明 @param和@exception可以并列多个

  • 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：抑制编译器警告
    
      * ```java
        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方法()";
        	}
        }
    

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

  • 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>

2.3 自定义Annotation

• 定义新的Annotation类型使用@interface关键字
• 自定义注解自动继承了java.lang.annotation.Annotation接口
• Annotation的成员变量在Annotation定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型：Strign类型、Class类型、enum类型、Annotation类型、以上所有类型的数组
• 可以在定义Annotationi的成员变量时为其指定初始值，指定成员变量的初始值可以使用default关键字
• 如果只有一个参数成员，建议使用参数名为value
• 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非他有默认的值。格式是”参数名 = 参数值”，如果只有一个参数成员，且名称为value，可以省略”value=”
• 没有成员定义的Annotation称为标记；包含成员变量的Annotation称为元数据Annotation

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

package 注解;
/*
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {

     * The set of warnings that are to be suppressed by the compiler in the
     * annotated element.  Duplicate names are permitted.  The second and
     * successive occurrences of a name are ignored.  The presence of
     * unrecognized warning names is <i>not</i> an error: Compilers must
     * ignore any warning names they do not recognize.  They are, however,
     * free to emit a warning if an annotation contains an unrecognized
     * warning name.
     *
     * <p> The string {@code "unchecked"} is used to suppress
     * unchecked warnings. Compiler vendors should document the
     * additional warning names they support in conjunction with this
     * annotation type. They are encouraged to cooperate to ensure
     * that the same names work across multiple compilers.
     * @return the set of warnings to be suppressed

    String[] value();
            }

 */
public @interface MyAnnotation {
    /*
    参考@SuppressWarnings进行定义
    ①注解声明为：@interface
    ②内部定义成员，通常使用value表示
    ③可以指定成员的默认值，使用default定义
    ④如果自定义注解没有成员，表明是一个标识作用
    如果注解有成员，在使用注解时，需要指明成员的值，自定义注解必须配上注解信息处理流程（使用反射）才有意义
     */
    /*
    Annoation的成员变量在Annotation定义中以无参数方法的形式来声明。
    其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型：
    String、Class、enum、Annotation和以上所有类型的数组
     */
    String value() default "xiong";
}

2.4 JDK中的元注解

• JDK的元Annotation用于修饰其他的Annotation定义
• JDK5.0提供了4个标准的meta-annotation类型，分别是：
  • Retention
  • Target
  • Documented
  • Inherited
• @Retention：只能用于修饰一个Annotation定义，用于指定该Annotation的生命周期，@Rention包含一个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注解的之定义的注解标注在类级别上，子类可以继承父类级别的注解
  • 实际应用中，使用较少

package 注解;

import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.LOCAL_VARIABLE;

/*
JDK提供的四种元注解
元注解：对现有的注解进行解释说明的注解
Retention:指定所修饰的Annotation的声明周期。SOURCE/CLASS(默认行为)/RUNTIME
          只有声明为RUNTIME生命周期的注解才能通过反射获取
Target:用于指定被修饰的Annotation能用于修饰哪些程序元素
Documented:表示所修饰的注解被javadoc解析时，保留下来
Inherited:被它所修饰的Annotation将具有继承性

通过反射来获得注解信息
 */
@Inherited
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyMetaAnnotation {
    String[] value();
}

2.5 利用反射获取注解信息

• JDK5.0在java.lang.reflect包下新增了AnnotatedElement接口，该接口代表程序中可以接收注解的程序元素
• 当一个Annotation类型被定义为运行时Annotation后，该注解才是运行时可见，当class文件被载入时保存在class文件中的Annotation才会被虚拟机读取
• 程序可以调用AnnotatedElement对象的如下方法来访问Annotation信息

package 注解;

import org.junit.Test;

import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Date;

public class AnnotationTest {
    public static void main(String[] args) {
       
    }
    @Test
    public void testGetAnnotation(){
        //使用反射获取Student上的注解，来验证元注解的继承性
        Class<Student> studentClass = Student.class;
        Annotation[] annotations = studentClass.getAnnotations();
        for (int i = 0; i < annotations.length; i++) {
            System.out.println(annotations[i]);//@注解.MyMetaAnnotation(value=[xiong])
        }
    }
}
@MyMetaAnnotation("xiong")
class Person{
}

interface Info{
    void show();
}

class Student extends Person implements Info{
    @Override
    public void show() {

    }
}

2.6 JDK8中注解的新特性

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

可重复注解

package 注解;

import java.lang.annotation.*;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.LOCAL_VARIABLE;

@Repeatable(MyMetaAnnotationArrays.class)
//@Inherited
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyMetaAnnotation {
    String value();
}

package 注解;

import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
//@Inherited
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyMetaAnnotationArrays {
   MyMetaAnnotation[] value();
}

package 注解;

import org.junit.Test;

import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Date;

public class AnnotationTest {
    @Test
    public void testGetAnnotation1(){
        Class<Person> personClass = Person.class;
        Annotation[] annotations = personClass.getAnnotations();
        for (int i = 0; i < annotations.length; i++) {
            System.out.println(annotations[i]);
            //@注解.MyMetaAnnotationArrays(value=[@注解.MyMetaAnnotation(value=xiong), @注解.MyMetaAnnotation(value=zhuo)])
        }
    }
}
//重复注解：jdk8之前
//创建一个新的自定义注解，包含成员变量MyMetaAnnotation的数组,
//@MyMetaAnnotationArrays({@MyMetaAnnotation("hello"),@MyMetaAnnotation("hello")})
//jdk8之后
@MyMetaAnnotation("xiong")
@MyMetaAnnotation("zhuo")
class Person{
   }

}

类型注解

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

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

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

  • ElementType.TYPE_USE表示该注解能写在使用类型的任何语句在中

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

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