枚举类与注解

枚举类的使用

入门

  • 类的对象只有有限个，确定的。
  • 当定义一组常量时，强烈建议使用枚举类。
  • 枚举类的实现
    • JDK5.0之前，自定义枚举类。下面是一个demo：
      ```java public class SeasonTest { public static void main(String[] args) { Season spring=Season.SPRING; System.out.println(spring); }

}

//自定义枚举类 class Season{ //1.声明Season对象的属性 //注意：如果在一开始就进行赋值，因为是常量，所以属性后面不能变，如果是在构造器中赋值则属性可以进行改变。 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 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.其他诉求：获取枚举类对象的属性
  3. public String getSeasonName() {
  4.     return seasonName;
  5. }
  7. public String getSeasonDesc() {
  8.     return seasonDesc;
  9. }
  11. //4.其他诉求：提供toString方法
  13. @Override
  14. public String toString() {
  15.     return seasonName + '\t' +
  16.             ", " + seasonDesc + '\t' ;
  17. }

}

  2.    -  JDK5.0之后新增得enum关键字定义枚举类。  
  3. ```java
  4. package demo01;
  6. /**
  7.  * 使用enum关键字定义枚举类
  8.  */
  10. public class SeasonTest1 {
  11.     public static void main(String[] args) {
  12.         Season1 spring=Season1.SPRING;
  13.         System.out.println(spring);
  14.     }
  16. }
  17. //使用enum枚举类
  18. enum Season1{
  19.     //1.提供当前枚举类得对象，多个对象之间使用",“隔开，末尾对象”；“结束
  20.     SPRING("春天","春暖花开"),
  21.     SUMMER("夏天","夏日炎炎"),
  22.     AUTUMN("秋天","秋高气爽"),
  23.     WINTER("冬天","冰天雪地");
  25.     private final String seasonName;
  26.     private final String seasonDesc;
  28.     Season1(String seasonName, String seasonDesc) {
  29.         this.seasonName = seasonName;
  30.         this.seasonDesc = seasonDesc;
  31.     }
  33.     public String getSeasonName() {
  34.         return seasonName;
  35.     }
  37.     public String getSeasonDesc() {
  38.         return seasonDesc;
  39.     }
  41.     @Override
  42.     public String toString() {
  43.         return "Season1{" +
  44.                 "seasonName='" + seasonName + '\'' +
  45.                 ", seasonDesc='" + seasonDesc + '\'' +
  46.                 '}';
  47.     }
  48. }
  • 若枚举类只有一个对象，则可以作为一种单例模式的实现方式。
  • 枚举类的属性：
    • 枚举类对象的属性不应允许被改动，所以应该使用private final修饰。
    • 枚举类的使用private final修饰的属性应该在构造器中为其赋值。
    • 若枚举类显示的定义了带参数的构造器，则在列出枚举值时也必须对应的传入参数。

自定义枚举类

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

使用enum定义枚举类

  • 使用说明：
    • 使用enum定义的枚举类默认继承了Java.lang.Enum类，因此不能再继承其他类。
    • 枚举类的构造器只能使用private权限修饰符。
    • 枚举类的所有实例必须再枚举类中显示列出，规则在上方代码中给出。列出的实例系统会自动添加public static final修饰。
    • 必须在枚举类的第一行声明枚举类对象。

Enum类的主要方法

  • values()方法：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。demo： 

    1. Season1[] values=Season1.values();
    2.      for (int i = 0; i < values.length; i++) {
    3.          System.out.println(values[i]);
    4.      }

  • valueOf(String str)：可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的”名字“。如果不是，会有运行时异常。demo： 

    1. Season1 winter=Season1.valueOf("WINTER");
    2.      System.out.println(winter);

  • toString()：返回当前枚举类对象常量的名称。

实现接口的枚举类

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

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

    1. /实现接口中的方法。每个对象调用方法显示的内容相同。
    2.  @Override
    3.  public void show() {
    4.      System.out.println("这是一个季节！");
    5.  }

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

    1. SPRING("春天","春暖花开"){
    2.      @Override
    3.      public void show() {
    4.          System.out.println("春天来了！");
    5.      }
    6.  },

注解（Annotation）

注解（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当成一个修饰符使用。用于修饰支持它的程序元素。

示例一：

  1. [@author ](/author ) 标明开发该类模块的作者，多个作者之间使用,分割

@version 标明该类模块的版本

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

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

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

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

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

其中

  1. [@param ](/param ) [@return ](/return ) 和 [@exception ](/exception ) 这三个标记都是只用于方法的。 
  3. @param的格式要求：[@param ](/param ) 形参名 形参类型 形参说明 
  5. [@return ](/return ) 的格式要求：[@return ](/return ) 返回值类型 返回值说明 
  7. @exception的格式要求：[@exception ](/exception ) 异常类型 异常说明 
  9. @param和@exception可以并列多个
  1. package demo02;
  3. /**
  4.  * 注解的使用:
  5.  * @author 罗先生
  6.  * @version 15.0
  7.  */
  8. public class AnnotaionTest {
  9.     /**
  10.      * 程序的主方法，程序的入口
  11.      * @param args String[] 命令行参数
  12.      */
  13.     public static void main(String[] args) {
  14.         double area=getAreaa(3);
  15.         System.out.println(area);
  16.     }
  18.     /**
  19.      * 求圆面积的方法
  20.      * @param radius double 半径值
  21.      * @return double 圆的面积
  22.      */
  23.     public static double getAreaa(double radius){
  24.         return Math.PI*radius*radius;
  25.     }
  26. }

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

  • @Override: 限定重写父类方法, 该注解只能用于方法。
  • @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择。
  • @SuppressWarnings: 抑制编译器警告。

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

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

    1. @WebServlet("/login")
    2. public class LoginServlet extends HttpServlet {
    3. private static final long serialVersionUID = 1L;
    4. protected void doGet(HttpServletRequest request, HttpServletResponse response) throws
    5. ServletException, IOException { }
    6. protected void doPost(HttpServletRequest request, HttpServletResponse response) throws
    7. ServletException, IOException {
    8. doGet(request, response);
    9. } }
    1. <servlet> <servlet-name>LoginServlet</servlet-name> <servlet-class>com.servlet.LoginServlet</servlet-class>
    2. </servlet> <servlet-mapping> <servlet-name>LoginServlet</servlet-name> <url-pattern>/login</url-pattern>
    3. </servlet-mapping>

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

    1. @Transactional(propagation=Propagation.REQUIRES_NEW,
    2. isolation=Isolation.READ_COMMITTED,readOnly=false,timeout=3)
    3. public void buyBook(String username, String isbn) {
    4. //1.查询书的单价
    5. int price = bookShopDao.findBookPriceByIsbn(isbn);
    6. //2. 更新库存
    7. bookShopDao.updateBookStock(isbn);
    8. //3. 更新用户的余额
    9. bookShopDao.updateUserAccount(username, price); }
    1. <!-- 配置事务属性 --> <tx:advice transaction-manager="dataSourceTransactionManager" id="txAdvice">
    2. <tx:attributes>
    3. <!-- 配置每个方法使用的事务属性 --> <tx:method name="buyBook" propagation="REQUIRES_NEW"
    4. isolation="READ_COMMITTED" read-only="false" timeout="3" />
    5. </tx:attributes>
    6. </tx:advice>

自定义Annotation

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

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

  1. @MyAnnotation(value="尚硅谷")
  2. public class MyAnnotationTest {
  3. public static void main(String[] args) {
  4. Class clazz = MyAnnotationTest.class;
  5. Annotation a = clazz.getAnnotation(MyAnnotation.class);
  6. MyAnnotation m = (MyAnnotation) a;
  7. String info = m.value();
  8. System.out.println(info);
  9. } }
  10. @Retention(RetentionPolicy.RUNTIME)
  11. @Target(ElementType.TYPE)
  12. @interface MyAnnotation{
  13. String value() default "auguigu"; }

JDK中的元注解

  • JDK的元Annotation用于修饰其他Annotation定义。
  • JDK5.0提供了4个标准的meta-anotation类型，分别是：
    • Retention
    • Target
    • Documented
    • Inherited
  • @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注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解。
    • 实际应用中，使用较少。