【Java枚举类与注解】——一篇文章读懂枚举类与注解

Love The Way You Lie 2023-10-07 22:20 52阅读 0赞

#### 文章目录 ####

*  2.枚举
 *   *  2.1概述
     *  2.2定义格式
     *  2.3枚举的特点
     *  2.4枚举的方法
 *  3.注解
 *   *  3.1概述
     *  3.2自定义注解
     *  3.3 元注解

## 2.枚举 ##

### 2.1概述 ###

为了间接的表示一些固定的值，Java就给我们提供了枚举，是指将变量的值一一列出来，变量的值只限于列举出来的值的范围内。

### 2.2定义格式 ###

*  格式

public enum s {
        
    枚举项1,枚举项2,枚举项3;
    }
    注意: 定义枚举类要用关键字enum

*  示例代码

// 定义一个枚举类，用来表示春，夏，秋，冬这四个固定值
    public enum Season {
        
    	SPRING,SUMMER,AUTUMN,WINTER;
    }

### 2.3枚举的特点 ###

*  特点
    
     *  所有枚举类都是 Enum 的子类
     *  我们可以通过“枚举类名.枚举项名称”去访问指定的枚举项
     *  每一个枚举项其实就是该枚举的一个对象
     *  枚举也是一个类，也可以去定义成员变量
     *  枚举类的第一行上必须是枚举项，最后一个枚举项后的分号是可以省略的，但是如果枚举类有其他的东西，这个分号就不能省略。建议不要省略
     *  枚举类可以有构造器，但必须是 private的，它默认的也是 private的。枚举项的用法比较特殊：枚举（‘’‘’）；
     *  枚举类也可以有抽象方法，但是枚举项必须重写该方法
 *  示例代码

public enum Season {
        
        SPRING("春"){
        
    
            //如果枚举类中有抽象方法
            //那么在枚举项中必须要全部重写
            @Override
            public void show() {
        
                System.out.println(this.name);
            }
        },
        SUMMER("夏"){
        
            @Override
            public void show() {
        
                System.out.println(this.name);
            }
        },
        AUTUMN("秋"){
        
            @Override
            public void show() {
        
                System.out.println(this.name);
            }
        },
        WINTER("冬"){
        
            @Override
            public void show() {
        
                System.out.println(this.name);
            }
        };
        public String name;
    
        //空参构造
       // private Season(){}
    
        //有参构造
        private Season(String name){
        
            this.name= name;
        }
    
        //抽象方法
        public abstract void show();
    }

public class EnumDemo {
        
        public static void main(String[] args) {
        
            /*
            1.所有枚举类都是 Enum 的子类
            2.我们可以通过“枚举类名.枚举项名称”去访问指定的枚举项
            3.每一个枚举项其实就是该枚举的一个对象
            4.枚举也是一个类，也可以去定义成员变量
            5.枚举类的第一行上必须是枚举项，最后一个枚举项后的分号是可以省略的，
                但是如果枚举类有其他的东西，这个分号就不能省略。建议不要省略
            6.枚举类可以有构造器，但必须是 private 的，它默认的也是 private的。
                枚举类的用法比较特殊：枚举("");
            7.枚举类也可以有抽象方法，但是枚举项必须重写该方法。
             */
    
            //第二个特点的演示
            //2.我们可以通过“枚举类名.枚举项名称”去访问指定的枚举项
            System.out.println(Season.SPRING);
            System.out.println(Season.SUMMER);
            System.out.println(Season.AUTUMN);
            System.out.println(Season.WINTER);
    
            //第三个特点的演示
            //3.每一个枚举项其实就是该枚举的一个对象
            Season spring = Season.SPRING;
    
    
    
        }
    }

### 2.4枚举的方法 ###

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>String name()</td> 
   <td>获取枚举项的名称</td> 
  </tr> 
  <tr> 
   <td>int ordinal()</td> 
   <td>返回枚举项在枚举类中的索引值</td> 
  </tr> 
  <tr> 
   <td>int compareTo(E o)</td> 
   <td>比较两个枚举项，返回的是索引值的差值</td> 
  </tr> 
  <tr> 
   <td>String toString()</td> 
   <td>返回枚举常量的名称</td> 
  </tr> 
  <tr> 
   <td>static T valueOf(Class type,String name)</td> 
   <td>获取指定枚举类中的指定名称的枚举值</td> 
  </tr> 
  <tr> 
   <td>values()</td> 
   <td>获得所有的枚举项</td> 
  </tr> 
 </tbody> 
</table>

*  示例代码

public enum Season {
        
    	SPRING,SUMMER,AUTUMN,WINTER;
    }
    
    public class EnumDemo {
        
        public static void main(String[] args) {
        
            // String name() 获取枚举项的名称
            String name = Season.SPRING.name();
            System.out.println(name);
            System.out.println("--------------------");
    
            // int ordinal() 返回枚举项在枚举类中的索引值
    
            int index1 = Season.SPRING.ordinal();
            int index2 = Season.SUMMER.ordinal();
            int index3 = Season.AUTUMN.ordinal();
            int index4 = Season.WINTER.ordinal();
    
            System.out.println(index1);
            System.out.println(index2);
            System.out.println(index3);
            System.out.println(index4);
    
            // int compareTo(E o)比较两个枚举项，返回的值是索引值的差值
            int result = Season.SPRING.compareTo(Season.WINTER);
            System.out.println(result); // -3
            System.out.println("------------------");
    
            // String toString()  返回枚举常量的名称
            String s = Season.SPRING.toString();
            System.out.println(s);
    
            // static <T> valueOf(Class<T> type,String name)
            //获取指定枚举类中的指定名称的枚举值
            Season spring = Enum.valueOf(Season.class, "SPRING");
            System.out.println(spring);
            System.out.println(Season.SPRING);
            System.out.println(Season.SPRING==spring);
    
    
            //values()  获取所有的枚举项
            Season[] values = Season.values();
            for (Season value : values) {
        
                System.out.println(value);
            }
    
        }
    }

## 3.注解 ##

### 3.1概述 ###

*  概述  
    对我们的程序进行标注和解释
 *  注解和注释的区别
    
     *  注释：给程序员看的
     *  注解：给编译器看的
 *  使用注解进行配置的优势  
    代码更加简洁，方便

### 3.2自定义注解 ###

*  格式

public @interface 注解名称 {
        
    	public 属性类型 属性名() default 默认值 ;
    }

*  属性类型
    
     *  基本数据类型
     *  String
     *  Class
     *  注解
     *  枚举
     *  以上类型的一维数组
 *  代码演示

public @interface Anno2 {
        
    }
    
    public enum Season {
        
        SPRING,SUMMER,AUTUMN,WINTER;
    }
    
    public @interface Anno1 {
        
    
        //定义一个基本类型的属性
        int a() default 23;//权限修饰符 public 可以省略，因为权限修饰符只能是 public
    
        //定义一个 String 类型的属性
        public String name() default "itheima"; //不想给默认值 default 也是可以省略的
    
        //定义一个 Class 类型的属性
        public Class clazz() default Anno2.class;
    
        //定义一个注解类型的属性
        public Anno2 anno() default @Anno2;
    
        //定义一个枚举类型的属性
        public Season season() default Season.SPRING;
    
        //以上类型的 一维数组
        //int 数组
        public int[] arr() default  {
        1,2,3,4,5};
    
        //枚举数组
        public Season[] seasons() default {
        Season.SPRING,Season.SUMMER};
    
        //value。后期我们在使用注解的时候，如果我们只需要给注解的 value 属性赋值。
        //那么 value就可以省略
        public String value();
    }
    
    
    //在使用注解的时候如果注解里面的属性没有指定默认值。
    //那么我们就需要手动给出注解属性的设置值。
    //@Anno1(name = "HCX")
    @Anno1("abc")
    public class AnnoDemo {
        
    }

*  注意  
    如果只有一个属性需要赋值，并且属性的名称是 value,则value可以省略，直接定义值即可。
 *  自定义注解案例
    
     *  需求  
        自定义一个注解@Test,用于指定类的方法上,如果某一个类的方法上使用了该注解,就执行该方法
     *  实现步骤
    
    1.  自定义一个注解Test,并在类中的某几个方法上加上注解
    2.  在测试类中,获取注解所在的类的Class对象
    3.  获取类中所有的方法对象
    4.  遍历每一个方法对象,判断是否有对应的注解
    
     *  代码实现

//表示Test这个注解的存活时间
    @Retention(value = RetentionPolicy.RUNTIME)
    public @interface Test {
        
    }
    
    public class UseTest {
        
    
        //没有使用Test注解
        public void show(){
        
            System.out.println("UseTest....show....");
        }
    
        //使用Test注解
        @Test
        public  void method(){
        
            System.out.println("UseTest...method...");
        }
    
        //使用 Test注解
        @Test
        public void function(){
        
            System.out.println("UseTest...function...");
        }
    }
    
    public class AnnoDemo {
        
        public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, InvocationTargetException {
        
            //1.通过反射获取UseTest类的字节码文件对象
            Class clazz = Class.forName("com.itheima.myanno3.UseTest");
    
            //创建对象
            UseTest useTest = (UseTest)clazz.newInstance();
    
            //2.通过反射获取这个类里面所有的方法对象
            Method[] methods = clazz.getDeclaredMethods();
    
            //3.遍历数组，得到每一个方法对象
            for (Method method : methods) {
        
                //method依次表示每一个方法对象。
                //isAnnotationPresent(Class<? extends Annotation> annotationClass)
                //判断当前方法上是否有指定的注解
                //参数：注解的字节码文件对象
                //返回值：布尔结果。 true 存在  false  不存在
                if(method.isAnnotationPresent(Test.class)){
        
                    method.invoke(useTest);
                }
            }
        }
    }

### 3.3 元注解 ###

*  概述  
    元注解就是描述注解的注解
 *  元注解介绍

<table> 
 <thead> 
  <tr> 
   <th>元注解名</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Target</td> 
   <td>指定了注解能在哪里使用</td> 
  </tr> 
  <tr> 
   <td>@Retention</td> 
   <td>可以理解为保留时间(生命周期)</td> 
  </tr> 
  <tr> 
   <td>@Inherited</td> 
   <td>表示修饰的自定义注解可以被子类继承</td> 
  </tr> 
  <tr> 
   <td>@Documented</td> 
   <td>表示该自定义注解，会出现在API文档里面。</td> 
  </tr> 
 </tbody> 
</table>

*  示例代码

@Target({
        ElementType.FIELD,ElementType.TYPE,ElementType.METHOD})  //指定注解使用的位置(成员变量，类，方法)
    @Retention(RetentionPolicy.RUNTIME)  //指定了该注解的存活时间。，不写的话，该注解只能存在于源码阶段，也就是Java文件
                  //当我们将这个Java文件编译成字节码（class）文件，这个注解就会消失
    @Inherited//指定该注解可以被继承
    public @interface Anno {
        
    }
    
    @Anno
    public class Person {
        
    }
    
    public class Student extends Person {
        
        public void show(){
        
            System.out.println("student.....show......");
        }
    }
    
    public class StudentDemo {
        
        public static void main(String[] args) throws ClassNotFoundException {
        
            //获得到 Student 类的字节码文件对象
            Class clazz = Class.forName("com.itheima.myanno4.Student");
            //获取注解。
            boolean result = clazz.isAnnotationPresent(Anno.class);
            System.out.println(result);
        }
    }

*  运行结果  
    ![在这里插入图片描述][3695ee62ed994e0290754bd24a3ec969.png]  
    注意：如果运行结果为 true,则表明注解被继承下来，如果返回值为 false,则表示注解没有被继承下来。

[3695ee62ed994e0290754bd24a3ec969.png]: https://img-blog.csdnimg.cn/3695ee62ed994e0290754bd24a3ec969.png