8 枚举类与注解

枚举enum
注解Annotation

javajavase
尚硅谷宋红康第10章_枚举类与注解.pdf

枚举enum

枚举类的使用

枚举类的理解：类的对象只有有限、确定个的时候的，我们称此类为枚举类
当需要定义一组常量时，强烈建议使用枚举类
如果枚举类中只一个对象，则可以作为单例模式的实现方式

枚举类的实现

JDK5.0以前需要自定义
JDK5.0后新增enum关键字用于定义枚举类

枚举类的属性

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

私有化构造器，保证不能在类的外部创建其对象；
在类的内部创建枚举类的示例。声明为：public static final；

对象如果有属性，应该声明为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 AUTUMN = new Season("秋天","秋高气爽");
 public static final Season WINTER = new Season("冬天","冰天雪地");
 // 4.其他诉求1：获取枚举类对象的属性
 public String getSeasonName() {
     return seasonName;
 }
 public String getSeasonDesc() {
     return seasonDesc;
 }
 // 4.其他诉求2：提供toString()
 @Override
 public String toString() {
     return "Season{" + "seasonName='" + seasonName + '\'' +
         ", seasonDesc='" + seasonDesc + '\'' + '}';
 }
}

JDK5新增enum枚举类

使用说明

使用enum定义的枚举类默认继承了java.lang.Enum类，因此不能再继承其他类
枚举类的构造器只能使用private权限修饰符，private可以省略
所有实例必须在枚举类中显式列出(“,”分隔“;”结尾)。列出的实例系统会自动添加public static final修饰
必须在枚举类的第一行声明枚举类对象

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

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;
    }
    public String getSeasonName() {
        return seasonName;
    }
    public String getSeasonDesc() {
        return seasonDesc;
    }
}

Enum类的常用方法

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

// toString():返回枚举类对象的名称
Season summer = Season.SUMMER;
System.out.println(summer.toString());    // SUMMER
System.out.println(Season.class.getSuperclass());    // java.lang.Enum;
// values():返回所的枚举类对象构成的数组
Season[] values = Season.values();
for(int i = 0;i < values.length; i++) {
    System.out.println(values[i]);
}
Thread.State[] values1 = Thread.State.values();
for (int i = 0; i < values1.length; i++) {
    System.out.println(values1[i]);
}
// valueOf(String objName):返回枚举类中对象名是objName的对象
Season winter = Season.valueOf("WINTER");
// 如果没objName的枚举类对象，则抛出非法数据异常：IllegalArgumentException
// Season winter = Season.valueOf("WINTER1");
System.out.println(winter);

enum枚举类实现接口

说明

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

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

interface Info{
  void show();
}
//使用enum关键字枚举类
enum Season implements Info{
  //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("大约在冬季");
      }
  };
  private final String seasonName;
  private final String seasonDesc;
  private Season1(String seasonName,String seasonDesc){
      this.seasonName = seasonName;
      this.seasonDesc = seasonDesc;
  }
  // 情况一：实现接口，在enum类中实现抽象方法
  // @Override
  // public void show() {
  //     System.out.println("这是一个季节");
  // }
}

注解Annotation

概述

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

常见Annotation示例
使用Annotation时要在其前面增加@符号，并把该Annotation当成个修饰符用于修饰它支持的程序元素

示例一：生成文档相关的注解
@author标明开发该类模块的作者，多个作者之间使用 , 分割
@version标明该类模块的版本
@create标明代码创建时间
@see参考转向，也就是相关主题
@since从哪个版本开始增加的
@param对方法中某参数的说明，如果没有参数就不能写
@return对方法返回值的说明，如果方法的返回值类型是void就不能写
@throws对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写
其中
@param @return @throws这三个标记都是只用于方法的
@param的格式要求：@param形参名形参类型形参说明
@return的格式要求：@return返回值类型返回值说明
@throws的格式要求：@throws异常类型异常说明
@param和@throws可以并列多个
```
/**
* @author cess
* @version 1.0
* @see Math.java
* @create 2019-06-26 16:56
*/
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：抑制编译器警告 ```java public static void mian (String [] args) { @SuppressWarning(“unused”) int a = 0; }

@Deprecated public Date(int year, int month, int date) { //Date类构造器已过时 this(year, month, date, 0, 0, 0); }

@Override public String toString(){ return “重写的toString方法”; }

<a name="257809006fdbb9828311137609968689"></a>
#### 示例三：跟踪代码依赖性，实现替代配置文件功能
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);
    }
}

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

测试方法的注解@BeforeClass @Before @Test @After @AfterClass
@Before与@BeforeClass的区别在于，@Before不止运行一次，它会在每个用例运行之前都运行一次。主要用于一些独立于用例之间的准备工作。比如两个用例都需要读取数据库里的用户A信息，但第一个用例会删除这个用户A，而第二个用例需要修改用户A。那么可以用@BeforeClass创建数据库连接。用@Before来插入一条用户A信息。

自定义注解

参照@SuppressWarnings定义

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

说明

如果注解有成员，在使用注解时，需要指明成员的值
自定义注解必须配上注解的信息处理流程(使用反射)才意义

自定义注解通常都会指明两个元注解：Retention、Target

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
  String[] value();
}

```java @MyAnnotation(value=”JavaSE”) 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);

} }

@Inherited @Repeatable(MyAnnotations.class) @Retention(RetentionPolicy.RUNTIME) @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) @interface MyAnnotation { String value() default “auguigu”; }

<a name="2da6128d91ec34ba61c466b8a60f6f1c"></a>
### 元注解
对现有的注解进行解释说明的注解<br />JDK5.0提供了4种元注解<br />**@Retention**
- 用于指定一个Annotation的生命周期，@Rentention包含一个 RetentionPolicy类型的成员变量，使用@Retention时必须为该value成员变量指定值：
   - **RetentionPolicy.SOURCE**：在源文件中有效(即源文件保留)，编译器直接丢弃这种策略的注释
   - **RetentionPolicy.CLASS**：在class文件中有效(即class保留)，当运行Java程序时，JVM不会保留注解。 这是默认值
   - **RetentionPolicy.RUNTIME**：在运行时有效(即运行时保留)，当运行Java程序时JVM会保留注释。
**只有声明为RUNTIME生命周期的注解，才能通过反射获取**<br />**@Target**
- 用于指定被修饰的Annotation能用于修饰哪些程序元素，不指定就哪都可以用
- @Target也包含一个名为value的成员变量
![](https://cdn.nlark.com/yuque/0/2020/png/1379492/1589556826511-fbb5c2ed-8786-4180-ab8f-54e8c50ad264.png#height=191&id=Xg2yj&margin=%5Bobject%20Object%5D&originHeight=390&originWidth=1174&originalType=binary&ratio=1&size=0&status=done&style=shadow&width=575)<br />**@Documented**
- 被@Documented修饰的Annotation类将被javadoc工具提取成文档，默认情况下javadoc是不包括注解的
- **定义为Documented的注解必须设置Retention值为RUNTIME**
**@Inherited**
- 被它修饰的Annotation将具有继承性
- 如果某个类使用了被@Inherited修饰的Annotation，则其子类将自动具有该注解
比如如把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解
- 实际应用中，使用较少
<a name="448994445bd815edd9a568afb1b72fd8"></a>
### 通过反射获取注解信息
JDK5在java.lang.reflect包下新增了AnnotatedElement接口, 该接口代表程序中可以接受注解的程序元素<br />当一个Annotation类型被定义为RetentionPolicy.RUNTIME后, 该注解才运行时可见, class文件被载入时保存在class文件中的Annotation才会被虚拟机读取<br />程序可以调用AnnotatedElement对象的如下方法来访问Annotation信息
```java
@Test
public void testGetAnnotation() {
    Class clazz = Student.class;
    Annotation[] annotations = clazz.getAnnotations();
    for(int i = 0; i < annotations.length; i++) {
        System.out.println(annotations[i]);
    }
}

JDK8.0中注解的新特性

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

在MyAnnotation上声明可重复注解，成员值为MyAnnotations.class
MyAnnotation的Target、Retention等元注解与MyAnnotations相同，且同时包含或不含Inherited ```java @Inherited @Retention(RetentionPolicy.RUNTIME) @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,}) public @interface MyAnnotations { MyAnnotation[] value(); }

@Inherited @Repeatable(MyAnnotations.class) @Retention(RetentionPolicy.RUNTIME) @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,}) public @interface MyAnnotation { String value() default “hello”; }

// jdk 8之前的写法： // @MyAnnotations({@MyAnnotation(value=”hi”),@MyAnnotation(value=”abc”)}) @MyAnnotation(value=”hi”) @MyAnnotation(value=”abc”) class Person{ private String name; private int age;

public Person() {
}
@MyAnnotation
public Person(String name, int age) {
    this.name = name;
    this.age = age;
}
@MyAnnotation
public void walk(){
    System.out.println("人走路");
}
public void eat(){
    System.out.println("人吃饭");
}

}

**类型注解**<br />**ElementType.TYPE_PARAMETER：**表示该注解能写在类型变量的声明语句中(如：注解可以修饰泛型)<br />**ElementType.TYPE_USE：**表示该注解能写在使用类型的任何语句中
```java
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, TYPE_PARAMETER, TYPE_USE})
public @interface MyAnnotation {
    String value() default "hello";
}
class Generic<@MyAnnotation T>{    // 需要@Target包含TYPE_PARAMETER
    public void show() throws @MyAnnotation RuntimeException {        // 需要TYPE_USE
        ArrayList<@MyAnnotation String> list = new ArrayList<>();    // 需要TYPE_USE
        int num = (@MyAnnotation int) 10L;                            // 需要TYPE_USE
    }
}

枚举enum

自定义枚举类

JDK5新增enum枚举类

Enum类的常用方法

enum枚举类实现接口

注解Annotation

概述

常见Annotation示例

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

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

自定义注解

JDK8.0中注解的新特性