JavaEE基础第10章枚举类与注解

最新推荐文章于 2022-04-22 19:08:48 发布

养个小橘猫

最新推荐文章于 2022-04-22 19:08:48 发布

阅读量251

点赞数 1

分类专栏：笔记文章标签： java-ee java 开发语言

本文链接：https://blog.csdn.net/lxl_15139204961/article/details/122682807

版权

笔记专栏收录该内容

43 篇文章 5 订阅

订阅专栏

第10章枚举类与注解

枚举类

概念

一、枚举类的使用

1.枚举类的理解：类的对象只有有限个，确定的。我们称此类为枚举类

2.当需要定义一组常量时，强烈建议使用枚举类（有意识的在这种情况下去使用枚举类）

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

使用（定义）

二、如何定义枚举类

方式一：jdk5.0之前，自定义枚举类

方式二：jdk5.0及之后，可以使用enum关键字定义枚举类

方式一：自定义枚举类(比较繁琐，用的更多的还是方式二)

1.声明Season对象的属性：private final修饰

2.私有化类的构造器，并给对象属性赋值.

3.提供当前枚举类的多个对象：public static final的。

4.其他诉求1：获取枚举类对象的属性（getter方法）

其他诉求2：提供toString()

public class SeasonTest {
    public static void main(String[] args) {
        Season autumn = Season.AUTUMN;
        System.out.println(autumn);
    }
}


//自定义枚举类
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 + '\'' +
                '}';
    }
}

方式二：使用enum关键字定义枚举类

说明：定义的枚举类默认继承于java.lang.Enum类

1.提供当前枚举类的多个对象，多个对象之间用“，”隔开，末尾对象用“；”结束

2.声明Season对象的属性：private final修饰

3.私有化类的构造器，并给对象属性赋值.

4.其他诉求1：获取枚举类对象的属性

由于定义的枚举类默认继承于java.lang.Enum类，而Enum类中已经重写了toString方法，打印的是枚举对象名，故可以不需要重写toString方法，当然也可以重写输出其他内容。

注意：

使用 enum 定义的枚举类默认继承了 java.lang.Enum类，因此不能再继承其他类

必须在枚举类的第一行声明枚举类对象

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

注意：enum定义的枚举类中对象后面的括号是可以不写的。（不需要的时候就不用写）。当使用toString()输出时，若没有重写该方法则用的是其父类Enum类中的重写的toString()方法，输出的是对象的名称。 构造器，属性等不需要的都可以不写，如下面就是一个完整的枚举类。

enum Season1{ 	
	SPRING,SUMMER,AUTUMN,WINTER;
}

还可参考线程状态的枚举类如下：

    public enum State {
        NEW,
        RUNNABLE,
        BLOCKED,
        WAITING,
        TIMED_WAITING,
        TERMINATED;
    }

public class SeasonTest1 {
    public static void main(String[] args) {
        Season1 spring = Season1.SPRING;
        System.out.println(spring);//SPRING
        System.out.println(Season1.class.getSuperclass());
    }
}
//使用enum关键字枚举类
//说明：定义的枚举类默认继承于java.lang.Enum类
enum Season1{

    //1.提供当前枚举类的多个对象，多个对象之间用“，”隔开，末尾对象用“；”结束
    SPRING("春天","春暖花开"),
    SUMMER("夏天","夏日炎炎"),
    AUTUMN("秋天","秋高气爽"),
    WINTER("冬天","冰天雪地");

    //2.声明Season对象的属性：private final修饰
    private final String seasonName;//名称
    private final String seasonDesc;//描述

    //3.私有化类的构造器，并给对象属性赋值.(私有化构造器的目的是不让外面通过构造器创建对象)
    private Season1(String seasonName,String seasonDesc){
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }

    //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 + '\'' +
                '}';
    }*/
}

Enum类的主要方法

toString()返回当前枚举类对象常量的名称
values()返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
valueOf(String objName):返回枚举类中对象名是objName的对象(如果没有objName的枚举类对象，则抛异常IllegalArgumentException)

        Season1 spring = Season1.SPRING;
        //toString()返回当前枚举类对象常量的名称
        System.out.println(spring);
        
        //values()返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。
        Season1[] season1s = Season1.values();
        for (int i = 0; i < season1s.length; i++) {
            System.out.println(season1s[i]);
        }

        //valueOf(String objName):返回枚举类中对象名是objName的对象
        Season1 winter = Season1.valueOf("WINTER");
        System.out.println(winter);//WINTER

        //如果没有objName的枚举类对象，则抛异常IllegalArgumentException
        Season1 winter1 = Season1.valueOf("WINTER1");
        System.out.println(winter1);

枚举类实现接口的情况

使用enum关键字定义的枚举类实现接口的情况

情况一：实现接口，在enum类中实现抽象方法

//定义接口
interface Info{
    void show();
}

//实现接口重写方法
enum Season1 implements Info{
     @Override
    public void show() {
        System.out.println("这是一个季节");
    }
}

情况二：让枚举类的对象分别实现接口中的抽象方法

    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("冬季");
        }
    };

注解

注解的使用：

1.理解Annotation：

①jdk5.0新增功能

②Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。

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

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

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

注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

使用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 Mao
*	@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: 抑制编译器警告

    @Test
    public void test4(){
        //不加这个注解当下面没有用到这个变量时IDE会将字体显示为灰色，当用到时显示正常。加上这个注解之后相当于换了一种方式进行提示，即便后面没有用到字体也会显示正常。
        @SuppressWarnings("unused")
        int num = 10;
//        System.out.println(num);
		//rawtypes表示泛型
        @SuppressWarnings({"unused","rawtypes"})
        ArrayList list = new ArrayList();
    }

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

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框架中关于“事务”的管理。同样不使用注解就用配置文件（麻烦）

自定义注解

注解里面的String value()是属性，可不是方法。

如何自定义注解：参照@SuppressWarnings定义

1.注解声明为：@interface

2.内部定义成员，通常使用value表示

3.可以指定成员的默认值，使用default定义

4.如果自定义注解没有成员，表明是一个标识作用。如@override

5.如果注解有成员，在使用注解时，需要指明成员的值。如果有默认值则括号里可以不写，表示默认值，如需修改则显式指明；如果没有默认值则必须指定，否则编译不通过。格式是“参数名 = 参数值”。如果只有一个参数成员，且名称为value，可以省略“value=”

自定义注解自动继承了java.lang.annotation.Annotation接口

Annotation 的成员变量类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。

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

public @interface MyAnnotation {
    String value() default "睡觉";
}

    @MyAnnotation(value = "睡觉")//此时的注解值没有任何意义
    public void sleep(){

    }

元注解

JDK 的元Annotation 用于修饰其他Annotation 定义。（简而言之，元注解就是修饰其他注解的注解）

元注解：对现有的注解进行解释说明的注解。

类似的还有元数据：String name = “Mao”; 对数据进行修饰的数据就是元数据。

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

jdk提供的四种元注解：

Retention：指定所修饰的Annotation的生命周期：(不指明就是默认的CLASS)

SOURCE / CLASS(默认行为) / RUNTIME

SOURCE ：在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释

CLASS：在class文件中有效（即class保留），当运行 Java 程序时, JVM不会保留注解。这是默认值

RUNTIME：在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Dywe5X5Z-1643084120831)(C:\Users\Mao\AppData\Roaming\Typora\typora-user-images\image-20220124213606452.png)]

只有声明为RUNTIME生命周期的注解，才能通过反射获取。

@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
}

Target：用于指定被修饰的Annotation能用于修饰哪些程序元素。

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

TYPE表示可以修饰Class, interface (including annotation type), or enum declaration

FIELD表示可以修饰Field declaration (includes enum constants)

等等…（具体可查询@Target源码）

以下两个出现的频率较低：

Documented：表示所修饰的注解在被javadoc解析时，保留下来。默认情况下，javadoc是不包括注解的。定义为Documented的注解必须设置Retention值为RUNTIME。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}

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

通过反射获取注解信息----- > 到反射内容时系统讲解。

JDK8新特性可重复注解

jdk8及之后：

可重复注解：

1.在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class

2.MyAnnotation的Target和Retention等元注解与MyAnnotations相同。（也就是说MyAnnotation有哪些注解，MyAnnotations也必须有哪些注解且必须一模一样。换句话说就是二者的注解除@Repeatable外，其余注解必须完全一样，否则报异常。比如MyAnnotation还有@Inherited，那么MyAnnotations也必须有@Inherited注解）。这是一个值得注意的地方

//MyAnnotation注解类
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
public @interface MyAnnotation {
    String value() default "睡觉";
}

//MyAnnotations注解类，成员变量是MyAnnotation的数组
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
public @interface MyAnnotations {
    MyAnnotation[] value();
}

//之后就可以使用重复注解了
    @MyAnnotation(value = "睡觉")
    @MyAnnotation(value = "吃饭")
    public void sleep(){

    }

jdk8之前要声明为重复注解需要声明一个数组

//MyAnnotation注解类
public @interface MyAnnotation {
    String value() default "睡觉";
}


//MyAnnotations注解类，成员变量是MyAnnotation的数组
public @interface MyAnnotations {
    MyAnnotation[] value();
}

	//利用数组这一个变量实现重复注解
    @MyAnnotations({@MyAnnotation(value = "睡觉"),@MyAnnotation(value = "吃饭")})
    public void sleep(){

    }

JDK8新特性类型注解

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

@Target(value={TYPE_PARAMETER })
public @interface MyAnnotation {
    String value() default "睡觉";
}

//加上TYPE_PARAMETER，之后就可以在泛型里面加注解了
class Generic<@MyAnnotation T>{

}

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

@Target(value={TYPE_PARAMETER ,TYPE_USE})
public @interface MyAnnotation {
    String value() default "睡觉";
}


//加上TYPE_USE之后，就可以在其他地方加注解了
class Generic<@MyAnnotation T>{
    public void sleep() throws @MyAnnotation RuntimeException{
        ArrayList<@MyAnnotation String> list = new ArrayList();

        int num = (@MyAnnotation int) 10L;
    }
}