【Java编程】09_枚举类和注解

1. 枚举类

1.1 概述

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

• 星期：Monday(星期一)、…、Sunday(星期天)
• 性别：Man(男)、Woman(女)
• 季节：Spring(春节)…Winter(冬天)
• 支付方式：Cash（现金）、WeChatPay（微信）、Alipay(支付宝)BankCard(银行卡)、CreditCard(信用卡)
• 就职状态：Busy、Free、Vocation、Dimission
• 订单状态：Nonpayment（未付款）、Paid（已付款）、Delivered（已发货）、Return（退货）、Checked（已确认）Fulfilled（已配货）、
• 线程状态：创建、就绪、运行、阻塞、死亡

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

1.2 枚举类的使用

1）枚举类的实现

• JDK1.5之前需要自定义枚举类。
• JDK 1.5 新增的 enum 关键字用于定义枚举类。

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

2） 枚举类的属性

• 枚举类对象的属性不应允许被改动, 所以应该使用 private final 修饰。
• 枚举类的使用 private final 修饰的属性应该在构造器中为其赋值。
• 若枚举类显式的定义了带参数的构造器, 则在列出枚举值时也必须对应的传入参数。

1.3 自定义枚举类

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("冬天", "白雪皑皑");
}

1.4 使用enum定义枚举类

使用说明

• 使用 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;
	}
}

1.5 Enum类的主要方法

方法名	详细描述
values()	返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
valueOf(String str)	可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的“名字”。如不是，会有运行时异常：IllegalArgumentException。
toString()	得到当前枚举常量的名称。你可以通过重写这个方法来使得到的结果更易读。
equals	在枚举类型中可以直接使用"=来比较两个枚举常量是否相等。Enum·提供的这个equals0方法,也是直接使用"="实现的。它的存在是为了在Set, List和Map中使用。注意, equals()是不可变的。
hashCode	Enum实现了hashCode()来和equals)保持一致。它也是不可变的。
getDeclaringClass	得到枚举常量所属枚举类型的Class对象。可以用它来判断两个枚举常]量是否属于同一个枚举类型。
name	得到当前枚举常量的名称。建议优先使用toString() 。
ordinal	得到当前枚举常量的次序。
compareTo	枚举类型实现了Comparable接口,这样可以比较两个枚举常量的大小(按照声明的顺序排列)
clone	枚举类型不能被Clone。为了防止子夹实现克隆方法, Enum实现了一个仅抛出CloneNotSupportedException异常的不变Clone()。

1.6 实现接口的枚举类

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

2. 注解 (Annotation)

2.1 概述

  传统我们通过xml文本文件声明方式(如下图,但是XML比较繁琐且不易检查)，而现在最主流的开发都是基于注解方式，代码量少，框架可以根据注解去自动生成很多代码，从而减少代码量，程序更易读。例如最火爆的SpringBoot就完全基于注解技术实现。

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

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

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

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

  注解很厉害，它可以增强我们的java代码，同时利用反射技术可以扩充实现很多功能。它们被广泛应用于三大框架底层。未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

  注解设计非常精巧，初学时觉得很另类甚至多余，甚至垃圾。有了java代码干嘛还要有@注解呢？但熟练之后你会赞叹，它竟然可以超越java代码的功能，让java代码瞬间变得强大。大家慢慢体会吧。

2.2 常见的Annotation示例

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

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

@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 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(){
		System.out.println("过时的方法");
	}
	@Override
	public String toString() {
		return "重写的toString方法()";
	}
}

示例三：跟踪代码依赖性，实现替代配置文件功能
1） Servlet3.0提供了注解(annotation)，使得不再需要在web.xml文件中进行Servlet的部署。

java中使用注解

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

web.xml文件

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

2）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);
}

2.3 注解的分类

注解一共分为3大类:

• JDK自带注解
• 元注解
• 自定义注解

JDK注解

JDK注解的注解，就5个：

@Override 用来标识重写方法

@Deprecated 标记就表明这个方法已经过时了，但我就要用，别提示我过期

@SuppressWarnings(“deprecation”) 忽略警告

@SafeVarargs jdk1.7出现，堆污染，不常用

@FunctionallInterface jdk1.8出现，配合函数式编程拉姆达表达式，不常用

元注解

用来描述注解的注解，就5个：

@Target 注解用在哪里：类上、方法上、属性上等等
@Retention 注解的生命周期：源文件中、字节码文件中、运行中
@Inherited 允许子注解继承
@Documented 生成javadoc时会包含注解，不常用
@Repeatable 注解为可重复类型注解，可以在同一个地方多次使用，不常用

@Target ElementType…

描述注解存在的位置：

ElementType.TYPE 应用于类的元素
ElementType.METHOD 应用于方法级
ElementType.FIELD 应用于字段或属性(成员变量)
ElementType.ANNOTATION_TYPE 应用于注释类型
ElementType.CONSTRUCTOR 应用于构造函数
ElementType.LOCAL_VARIABLE 应用于局部变量
ElementType.PACKAGE 应用于包声明
ElementType.PARAMETER 应用于方法的参数

@Inherited

  被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
  比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解，实际应用中，使用较少。

@Documented:

  用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。
  定义为Documented的注解必须设置Retention值为RUNTIME。

@Retention RetentionPolicy…

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

  该注解定义了自定义注解被保留的时间长短,比如某些注解仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中； 编译在class文件中的注解可能会被虚拟机忽略，而另一些在class被装载时将被读取。

  为何要分字节码文件中有还是没有呢？如果没有时，反射技术就拿不到，从而就无法去识别处理。它的值一共3种:

RetentionPolicy.SOURCE: 在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
 
RetentionPolicy.CLASS: 在class文件中有效（即class保留） ， 当运行 Java 程序时, JVM 不会保留注解。 这是默认值
 
RetentionPolicy.RUNTIME: 在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。

自定义注解

• 定义新的 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 "smalldogegg";//成员变量，需要指定值
}

注意：注解的语法写法和常规java的语法写法不同

/*本类用于测试自定义注解*/
public class TestAnnotation { }

/*1.2 通过@Target注解表示此自定义注解可以使用的位置
* 注意:@Target注解使用时需要导包,我们通过"ElementType.静态常量值"的方式来指定
* 此自定义注解可以使用的位置
* 如果有多个值,可以使用"{ , }"的格式来写:@Target({ElementType.METHOD,ElementType.TYPE})*/
@Target({ElementType.METHOD,ElementType.TYPE,ElementType.FIELD})//表示此注解可以加在方法上
/*1.3通过@Retention注解表示自定义注解的生命周期
* 注意:@Retention使用时也需要导包,通过RetentionPolicy.静态常量值来指定此自定义注解的生命周期
* 也就是指自定义注解可以存在在哪个文件中:源文件中/字节码文件中/运行时有效
* 而且这三个值,只能3选1,不能同时写多个*/
@Retention(RetentionPolicy.SOURCE)

/*0.首先注意:自定义注解的语法与java不同,不要套用java的格式*/

//1.定义自定义主解,注解名是Test,并通过两个元注解表示此注解的作用位置和生命周期
/*1.注解定义要使用"@interface 注解名"的方式来定义*/
@interface Test{
    /*3.自定义注解还可以添加功能--给注解添加属性
    * 注意 int age();不是方法的定义,而是给自定义注解中定义age属性的语法
    * 如果为了使用注解时方便,还可以给属性指定默认值,这样就可以直接使用,格式:int age() default 0;
    * */
    //int age(); //给注解定义一个普通的属性age
    int age() default 0;
    /*4.注解中还可以添加功能-可以定义特殊属性value
    * 特殊属性的定义方式与别的属性相同,主要是使用方式不同
    * 使用此注解给属性赋值的时候,可以不用写成"@Test(value = "Apple")",
    * 格式可以简化"@Test("Apple")"直接写值
    * 但是自定义注解类中的赋予默认值不可以简写,如果自定义了默认值,可以不用赋值,直接使用*/
    String value() default "apple";
}

/*2.使用注解时,只要在指定的自定义注解名字前加上"@"即可使用此注解*/
//2.定义一个类用来测试自定义注解
//@Test
class TeatAnno{
    /*测试1:分别给TestAnno类/name属性/eat()都添加了@Test注解,只有方法上不报错
    * 结论:自定义注解能够加在什么位置,取决于@Target注解的值
    * 测试2:修改@Target注解的值:@Target({ElementType.METHOD,ElementType.TYPE,ElementType.FIELD})
    * 结论:注解@Test可以存在于多个位置,如果@Target有多个值,格式是"{ , }"
    * 原因:Target注解的源码:ElementType[] value();*/
    //@Test
    String name;
    /*测试3:当我们添加了注解的age属性时,@Test注解报错
    * 结论:当注解没有定义属性时,可以直接使用,如果有属性了,就需要给属性赋值
    * 测试4:给@Test注解的age属性赋值以后,就不报错了
    * 结论:给属性赋值的格式" @Test(age = 10)",注意,不能直接写10,这是错误格式
    * 测试5:给age属性赋予默认值后,可以不加属性值,直接使用注解,此时使用的就是age的默认值
    * */
    /*测试6:给特殊属性value赋值时可以简写,想当于value="apple"*/
    @Test/*测试7:因为已有默认值,所以不用给特殊属性赋值,直接使用@Test*/
    //@Test(age = 10)
    public void eat(){
        System.out.println("又到干饭时间啦~");
    }
}

利用反射获取注解信息

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

JDK8中注解的新特性

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

类型注解：

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

TYPE_PARAMETER
TYPE_USE

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

• ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语
  句中（如：泛型声明）。
• 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 {
}