Java高级(12) 枚举类与注解

最新推荐文章于 2021-09-10 00:00:45 发布

Fishman.

最新推荐文章于 2021-09-10 00:00:45 发布

阅读量249

点赞数

分类专栏： Java高级文章标签： java

本文链接：https://blog.csdn.net/weixin_45851256/article/details/118027481

版权

Java高级专栏收录该内容

3 篇文章 0 订阅

订阅专栏

Java高级（十二）-- 枚举类与注解

枚举类

类的对象只有有限个，且确定的时候我们称之为枚举类

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

枚举类的实现

方式一：JDK 1.5之前，需要自定义枚举类；步骤如下：

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

方式二：JDK 1.5 新增的 enum 关键字用于定义枚举类

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

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

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

public class EnumTest {
    public static void main(String[] args) {
        // 方式一
        Season spring = Season.SPRING;
        System.out.println(spring);

        // 方式二
        Season1 summer1 = Season1.SUMMER;
        System.out.println(summer1);
    }
}

// 方式二：enum关键字定义枚举类
// 定义的枚举类默认继承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.其他诉求：Getter、toString
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }
}

// 方式一：自定义枚举类
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("Spring", "春暖花开");
    public static final Season SUMMER = new Season("Summer", "夏日炎炎");
    public static final Season AUTUMN = new Season("Autumn", "秋高气爽");
    public static final Season WINTER = new Season("Winter", "寒冬凌烈");

    // 4. 其他诉求，获取枚举类对象的属性值
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

    @Override
    public String toString() {
        return "Season{" +
                "seasonName='" + seasonName + '\'' +
                ", seasonDesc='" + seasonDesc + '\'' +
                '}';
    }
}

枚举类的使用

Enum类的主要方法

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

public class EnumTest {
    public static void main(String[] args) {
        // values()
        Thread.State[] values = Thread.State.values();
        for (int i = 0; i < values.length; i++) {
            System.out.println(values[i]);
        }

        // valueOf()
        Thread.State runnable = Thread.State.valueOf("RUNNABLE");
        System.out.println(runnable.toString());
    }
}

枚举类实现接口

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

public class EnumTest {
    public static void main(String[] args) {
        PayStatement checked = PayStatement.CHECKED;
        PayStatement fulfilled = PayStatement.FULFILLED;
        PayStatement aReturn = PayStatement.RETURN;

        checked.show();
        fulfilled.show();
        aReturn.show();
    }
}

interface Info{
    void show();
}

// 枚举类实现接口
enum PayStatement implements Info{
    // 无属性的枚举类，可以不写括号
    UNPAID,

    PAID,

    DELIVERED,
    // 特殊情况，可以在枚举对象中重写接口中需要实现的方法供此对象调用
    RETURN {
        @Override
        public void show(){
            System.out.println("Need to return back");
        }
    },

    CHECKED,

    FULFILLED;

    // 所有枚举类共同使用
    @Override
    public void show(){
        System.out.println("Payment:" + this.toString());
    }
}

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

使用示例

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

@author 标明开发该类模块的作者，多个作者之间使用,分割

@version 标明该类模块的版本

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

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

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

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

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

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: 抑制编译器警告

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方法()"; 
    } 
}

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

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

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

自定义注解

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

注意：自定义注解必须配上注解的信息处理流程（使用反射）才有意义

public class AnnotationTest {
    @MyAnnotation(value= "hi")
    @MyAnnotation("annotation")
    public void show(){}
}

@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.PARAMETER})
@interface MyAnnotation {
    String value() default "Hello";
}

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.PARAMETER})
@interface MyAnnotations{
    MyAnnotation[] value();
}

元注解

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

JDK 的元 Annotation 用于修饰其他 Annotation 定义，JDK5.0提供了4个标准的 meta-annotation 类型，分别是：

Retention
Target
Documented
Inherited

@Retention

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

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

public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     *
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

@Target

@Target：用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量

// 其中可以使用下述的指定值
public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

@Documented

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。默认情况下，javadoc 是不包括注解的

注意：定义为Documented的注解必须设置Retention值为RUNTIME

@Inherited

@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解

利用反射获取注解信息

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

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

JDK8中注解的新特性

类型注解

JDK 1.8之后，关于元注解 @Target 的参数类型 ElementType 枚举值多了两个：TYPE_PARAMETER、TYPE_USE。在Java 8之前，注解只能是在声明的地方所使用，Java 8开始，注解可以应用在任何地方：

**ElementType.TYPE_PARAMETER：**表示该注解能写在类型变量的声明语句中（如：泛型声明）
**ElementType.TYPE_USE：**表示该注解能写在使用类型的任何语句中

// 注解在方法中使用
@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 { }

可重复注解

Java 8之前，不能进行重复注解，因此，要定义另一成员变量为该注解数组的注解，用于替代重复注解；Java 8之后，便可以通过使用 @Repeatable(MyAnnotations.class) 的形式，使得 MyAnnotation 可以重复注解：

声明 MyAnnotations 注解，其中成员变量设置为 MyAnnotation[ ] 数组
在 MyAnnotation 上声明 @Repeatable ，成员值为 MyAnnotations.class
MyAnnotation 的 @Target 和 @Retention 等元注解要与 MyAnnotations 相同

public class AnnotationTest {
    public static void main(String[] args) {

    }
    // jdk1.8之前重复注解的写法
    @MyAnnotations({@MyAnnotation("hi"), @MyAnnotation("hello")})
    public void test(){}
	// jdk1.8后，可重复注解的写法
    @MyAnnotation("hi")
    @MyAnnotation("annotation")
    public void show(){}
}

// jdk1.8后，可重复注解的写法
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.PARAMETER})
@interface MyAnnotation {
    String value() default "Hello";
}

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.PARAMETER})
@interface MyAnnotations{
    MyAnnotation[] value();
}

Fishman.

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Java高级(12) 枚举类与注解

Java高级（十二）-- 枚举类与注解枚举类类的对象只有有限个，且确定的时候我们称之为枚举类当需要定义一组常量时，强烈建议使用枚举类枚举类的实现方式一：JDK 1.5之前，需要自定义枚举类；步骤如下：私有化类的构造器，保证不能在类的外部创建其对象在类的内部创建枚举类的实例，声明为：public static final对象如果有实例变量，应该声明为 private final ，并在构造器中初始化方式二：JDK 1.5 新增的 enum 关键字用于定义枚举类以此方式定义的枚举类
复制链接

扫一扫