跳到主要内容

枚举类与注解

枚举类​

类的对象是有限个的，确定的可使用枚举

例如星期、性别、季节、支付方式等

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

==阿里云代码规范中不允许出现魔法值哦，如下==

//魔法值
if("男".equal(sex)){ //此时这里的男为魔法值，因为未进行定义
    return "这是个男生"
}

解决方法

//解决方法
final String MAN = "男"
if(MAN.equal(sex)){ //但是如果有很多个常量
    return "这是个男生"
}

但是这样的确符合规范了，那如果有很多个常量，或者其他的方法也要使用，岂不是很麻烦，那么，不如将性别定义为一个枚举类

public enum Sex {
    BOY(0,"男孩"),GIRL(1,"女孩");
    int code;
    String sex;
    Sex(int code, String sex){
        this.code=code;
        this.sex=sex;
    }
    public int getCode(){
        return code;
    }
    public String getSex(){
        return sex;
    }
}

而在代码中使用，则更为直观

int sex = sexService.getsex(id);//获取id值为id的用户的性别代码
if(Sex.Boy.getCode() == sex){
    这是男孩
}

同理，这样的操作更适合于管理员之类的定义，因为在项目中，我们经常要通过管理员不同，而去做不同的操作

关于枚举类的更多操作，请继续往下看

如何使用关键字enum定义枚举类​

//默认继承于Enum
public enum Season {
    SPRING("春天","春暖花开"),
    SUMMER("夏天","热"),
    AUTUMN("球天","落叶"),
    WINTER("冬天","冷");
    String seasonName;
    String seasonDesc;

    Season(String seasonName, String seasonDesc) {
        this.seasonDesc=seasonDesc;
        this.seasonName = seasonName;
    }
    public String getSeasonName() {
        return seasonName;
    }
    public String getSeasonDesc(){
        return seasonDesc;
    }
}

Enum类的主要方法​

方法作用
values获取枚举类中所有的对象
valueOf（String name）返回名称为name的枚举对象
ordinal()返回当前枚举对象的下标
name()返回当前枚举对象的名字(toString方法)
Season summer = Season.SUMMER;
System.out.println(summer.getSeasonName());
//获取此枚举类中所有常量
Season[] values = Season.values();
for(Season v:values) {
    System.out.println(v);
}
//根据提供的参数，返回同名的枚举类的对象名
Season winter = Season.valueOf("WINTER");
System.out.println(winter);
//获取当前常量的下标，即定义顺序
int ordinal = spring.ordinal();

实现接口的枚举类​

interface info{
    void show();
}
//每个枚举类对象单独实现接口，做自己的操作
public enum Season implements  info{
    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("这是冬天");
        }
    };
}

EnumSet​

专门为盛方枚举类型而设计的Set类型

例如:业务需求：有一批人，我们需要查看他是不是管理员

枚举类定义

public enum UserRole{
    ROLE_ROOT_ADMIN,//系统管理员
    ROLE_ORDER_ADMIN,//订单管理员
    ROLE_NORMAL //普通用户
}

业务代码

//定义一个管理员角色的专属集合
EnumSet<UserRole> userRoles = EnumSet.of(UserRole.ROLE_ROOT_ADMIN,UserRole.ROLE_ORDER_ADMIN);
//判断某个用户是否为管理员
Boolean isAdmin(User user){
    if(userRoles.contains(user.getUserRole()))
        return true;
    return false;
}

EnumMap​

业务需求：统计不同角色有多少人

Map<UserRole,Integer> userStatisticMap = new EnumMap<>(UserRole,Integer);
for(User user:userList) {
    //获取当前用户的角色的人数
    Integer num = userStatisticMap.get(user.getUserRole);
    //如果不为空，则num+1重新put
    if(null!=num){
        userStatisticMap.put(user.getUserRole(),num+1);
    //如果为空，则num为1后put进去
    }else{
        userStatisticMap.put(user.getUserRole(),1);
    }
}

注解​

注解(Annotation)概述​

Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加 载, 运行时被读取, 并执行相应的处理。通过使

用Annotation, 程序员 可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代 码分析工具、开发工具

和部署工具可以通过这些补充信息进行验证 或者进行部署

Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方 法, 成员变量, 参数, 局部变量的声明, 这些信息

被保存在Annotation 的 “name=value” 对中

框架=注解+反射+设计模式

常见的注解示例​

示例一：生成文档相关的注解​
注解作用
@author标明开发该类模块的作者，多个作者之间使用,分割
@version标明该类模块的版本
@see参考转向，也就是相关主题
@since从哪个版本开始增加的
@param对方法中某参数的说明，如果没有参数就不能写
@return对方法返回值的说明，如果方法的返回值类型是void就不能写
@exception对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写

其中

@param @return 和 @exception 这三个标记都是只用于方法的。

@param的格式要求：@param 形参名 形参类型 形参说明

@return 的格式要求：@return 返回值类型 返回值说明

@exception的格式要求：@exception 异常类型 异常说明

@param和@exception可以并列多个

示例二：编译时进行格式检查(JDK内置的三个基本注解)​
注解作用
@Override限定重写父类方法, 该注解只能用于方法
@Deprecated用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings抑制编译器警告

JDL中的元注解​

JDK 的元Annotation 用于修饰其他Annotation 定义

JDK5.0提供了4个标准的meta-annotation类型，分别是：

Retention​

@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命 周期, @Rentention 包含一个

RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值:

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

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

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

Target​

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

@Target 也包含一个名为 value 的成员变量。

取值取值
CONSTRUCTOR用于描述构造器PACKAGE用于描述包
FIELF用于描述域(属性)PARAMETER用于描述参数
LOCAL_VARIABLE用于描述局部变量TYPE用于描述类、接口或enum声明
METHOD用于描述方法

Documented​

用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。

默认情况下，javadoc是不包括注解的

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

Inherited​

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

有该注解。

比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以 继承父类类级别的注解

实际应用中，使用较少

自定义注解​

  • 定义新的 Annotation 类型使用 @interface 关键字​

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

  • Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其 方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能 是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、 以上所有类型的数组。

  • 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始 值可使用 default 关键字

  • 如果只有一个参数成员，建议使用参数名为value

  • 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认 值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value， 可以省略“value=”

  • 没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyAnnotation {
    String value() default "hello";
}

JDK1.8新特性​

类型注解​

JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个

在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。

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

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

0%