枚举与注解
枚举的使用
1. 枚举简介
- 类的对象只有有限个,确定的。举例如下:
星期:Monday(星期一)、......、Sunday(星期天)
性别:Man(男)、Woman(女)
季节:Spring(春节)......Winter(冬天)
支付方式:Cash(现金)、WeChatPay(微信)、Alipay(支付宝)、BankCard(银行卡)、CreditCard(信用卡)
就职状态:Busy、Free、Vocation、Dimission
订单状态:Nonpayment(未付款)、Paid(已付款)、Delivered(已发货)、 Return(退货)、Checked(已确认)Fulfilled(已配货)、
线程状态:创建、就绪、运行、阻塞、死亡 - 当需要定义一组常量时,强烈建议使用枚举类
- 枚举类的实现
JDK1.5之前需要自定义枚举类
JDK 1.5 新增的 enum 关键字用于定义枚举类
若枚举只有一个对象, 则可以作为一种单例模式的实现方式。 - 枚举类的属性
枚举类对象的属性不应允许被改动, 所以应该使用 private final 修饰
枚举类的使用 private final 修饰的属性应该在构造器中为其赋值
若枚举类显式的定义了带参数的构造器, 则在列出枚举值时也必须对应的传入参数
2. 如何自定义枚举类(jdk 5.0之前)
- 私有化类的构造器,保证不能在类的外部创建其对象
- 在类的内部创建枚举类的实例。声明为:public static final
- 对象如果有实例变量,应该声明为 private final,并在构造器中初始化
- 其他诉求:获取枚举对象的属性
//自定义枚举类
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("冬天", "冰天雪地");
//4. 其他诉求:获取枚举对象的属性
public String getSeasonName() {
return seasonName;
}
public String getSeasonDesc() {
return seasonDesc;
}
@Override
public String toString() {
return "Season{" +
"seasonName='" + seasonName + '\'' +
", seasonDesc='" + seasonDesc + '\'' +
'}';
}
}
public class SeasonTest {
public static void main(String[] args) {
System.out.println(Season.AUTUMN);//Season{seasonName='秋天', seasonDesc='秋高气爽'}
}
}
3. 如何使用关键字(jdk 5.0) enum定义枚举类
- 使用说明
使用 enum 定义的枚举类默认继承了java.lang.Enum
类,因此不能再继承其他类
枚举类的构造器只能使用 private 权限修饰符
枚举类的所有实例必须在枚举类中显式列出(, 分隔 ; 结尾)。列出的实例系统会自动添加 public static final 修饰
必须在枚举类的第一行声明枚举类对象 - JDK 1.5 中可以在 switch 表达式中使用 Enum 定义的枚举类的对象作为表达式, case 子句可以直接使用枚举值的名字, 无需添加枚举类作为限定。
- 使用步骤
- 提供当前枚举类的多个对象 : 多个对象之间用 逗号 隔开,末尾对象 分号 结束
- 声明 自定义枚举类的 属性
- 私有化类的构造器,并给对象属性赋值
- 其他诉求:获取枚举对象的属性
//自定义枚举类
enum Season1 {
//1. 提供当前枚举类的多个对象 : 多个对象之间用 逗号 隔开,末尾对象 分号 结束
SPRING("春天", "春暖花开"),
SUMMER("夏天", "夏日炎炎"),
AUTUMN("秋天", "秋高气爽"),
WINTER("冬天", "冰天雪地");
//2. 声明 Season1 属性
private final String seasonName;
private final String seasonDesc;
//3. 私有化类的构造器,并给对象属性赋值
private Season1(String seasonName, String seasonDesc) {
this.seasonName = seasonName;
this.seasonDesc = seasonDesc;
}
//4. 其他诉求:获取枚举对象的属性
public String getSeasonDesc() {
return seasonDesc;
}
public String getSeasonName() {
return seasonName;
}
}
public class SeasonTest1 {
public static void main(String[] args) {
System.out.println(Season1.WINTER);//WINTER
System.out.println(Season1.class.getSuperclass());//class java.lang.Enum
}
}
4. Enum(jdk 1.5 )类的主要方法
java.lang public abstract class Enum<E extends Enum<E>> extends Object implements Comparable<E>, Serializable
protected Enum(String name,int ordinal)唯一的构造函数。 程序员无法调用此构造函数。
它由编译器响应枚举类型声明发出的代码使用。
protected Object clone() 枚举类型不能被 Clone.为了防止子类实现克隆方法,
Enum实现了一个抛出CloneNotSupportedException异常的不变 Clone()。
int compareTo(E o) 枚举类型实现了 Comparable 接口,这样可用比较两个枚举常量的大小(按照声明的顺序排序)。
boolean equals(Object other) 在枚举类型中可用直接使用 "=="来比较两个枚举常量是否相等。
Enum提供这个 equals()方法,也是直接使用 "=="实现的.它的存在是为了在 set,list和map中使用.注意equals()是不可变的.
protected void finalize() 枚举类不能有finalize方法。
Class<E> getDeclaringClass() 得到枚举常量所属枚举类型的 Class对象.可用用它来判断两个枚举常量是否属于同一个枚举类型。
int hashCode() Enum实现了 hashCode()来和 equals()保持一致.它也是不可变的。
String name() 返回此枚举常量的名称,与其枚举声明中声明的完全相同。
int ordinal() 返回此枚举常数的序数(其枚举声明中的位置,其中初始常数的序数为零)。
String toString() 得到当前枚举常量的名称。你可以通过从写这个方法来使得到的结果更易读.
static <T extends Enum<T>> T valueOf(Class<T> enumType, String name) 传递枚举类型的 Class对象和枚举常量名称
给静态方法 valueOf,会得到与参数匹配的枚举常量。
values(); 返回枚举类型的对象数组.该方法可用很方便的遍历所有的枚举值.
valueOf(String str); 可用把一个字符串转为对应的枚举类对象.要求字符串必须是枚举对象的 "名字".如果不是,会有运行时异常
IllegalArgumentException.
toString(); 返回当前枚举对象常量的名称
- Methods inherited from class java.lang.Object : getClass, notify, notifyAll, wait, wait, wait
5. 实现接口的枚举类
- 和普通 Java 类一样,枚举类可以实现一个或多个接口
- 若每个枚举值在调用实现的接口方法呈现相同的行为方式,则只要统一实现该方法即可。
- 若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式,则可以让每个枚举值分别来实现该方法
//情况1: 实现接口,在 enum类中实现抽象方法
//情况2: 让枚举的对象分别实现接口中的抽象方法
interface Info {
void show();
}
//自定义枚举类
enum Season1 implements Info {
//1. 提供当前枚举类的多个对象 : 多个对象之间用 逗号 隔开,末尾对象 分号 结束
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("大约在冬季");
}
};
//2. 声明 Season1 属性
private final String seasonName;
private final String seasonDesc;
//3. 私有化类的构造器,并给对象属性赋值
private Season1(String seasonName, String seasonDesc) {
this.seasonName = seasonName;
this.seasonDesc = seasonDesc;
}
//5. 其他诉求:获取枚举对象的属性
public String getSeasonDesc() {
return seasonDesc;
}
public String getSeasonName() {
return seasonName;
}
/*@Override
public void show() {
System.out.println("这是一个季节");
}*/
}
//调用 :Season1.AUTUMN.show();
习题
- 什么是枚举类?枚举类的对象声明的修饰符都有那些?
枚举类;类中的对象的个数都是确定的,有限个
private final (No)
public static final (yes)
注解的使用
1. 注解(Annotation)概述
- 从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)
- Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
- Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation的 “name=value” 对中。
- 在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE/Android中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替 JavaEE旧版中所遗留的繁冗代码和 XML配置等。
- 未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以上都是基于注解的,Hibernate3.x以后也是基于注解的,现在的Struts2有一部分也是基于注解的了,注解是一种趋势,一定程度上可以说:框架 = 注解 + 反射 + 设计模式。
2. 常见的Annotation示例
-
使用 Annotation 时要在其前面增加 @ 符号, 并把该Annotation 当成一个修饰符使用。用于修饰它支持的程序元素
-
示例一:生成文档相关的注解
- @author 标明开发该类模块的作者,多个作者之间使用,分割
- @version 标明该类模块的版本
- @see 参考转向,也就是相关主题
- @since 从哪个版本开始增加的
- @param 对方法中某参数的说明,如果没有参数就不能写
- @return 对方法返回值的说明,如果方法的返回值类型是void就不能写
- @exception 对方法可能抛出的异常进行说明,如果方法没有用throws显式抛出的异常就不能写其中
@param @return 和@exception 这三个标记都是只用于方法的。 @param的格式要求:@param 形参名形参类型 形参说明
@return 的格式要求:@return 返回值类型返回值说明
@exception的格式要求:@exception 异常类型异常说明
@param和@exception可以并列多个
-
示例二:在编译时进行格式检查(JDK内置的三个基本注解)
@Override: 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings: 抑制编译器警告
-
示例三:跟踪代码依赖性,实现替代配置文件功能
Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。
3. 自定义Annotation
- 定义新的Annotation 类型使用@interface 关键字
- 自定义注解自动继承了
java.lang.annotation.Annotation
接口 - Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
- 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用default 关键字
- 如果只有一个参数成员,建议使用参数名为value
- 如果定义的注解含有配置参数,那么使用时必须指定参数值,除非它有默认值。格式是“参数名 = 参数值”,如果只有一个参数成员,且名称为value,可以省略“value=”
- 没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据Annotation
- 注意:自定义注解必须配上注解的信息处理流程(反射)才有意义。
//1. 注解声明为 @interface
public @interface MyAnnotation {
//2. 内部定义成员,通常使用 value表示
//3. 可用指定成员的默认值,使用 default定义
//4. 如果自定义注解没有成员,表明是一个表示作用
String vale() default "hello";
}
//5. 如果注解有成员,在使用注解时,需要指明成员的值.
//@MyAnnotation(vale = "hello")
@MyAnnotation
class test {
public static void main(String[] args) {
}
}
4. JDK中的元注解
- JDK 的元Annotation(对现有的注解进行说明的注解) 用于修饰其他Annotation 定义
- JDK5.0提供了4个标准的meta-annotation类型,分别是:
Retention 指定所修饰的 Annotation的声明周期
Target 用于指定被修饰的 Annotation能用于修饰那些程序元素
Documented 所修饰的注解被 javadoc解析时,被保留下来
Inherited 被它修饰的 Annotation将具有继承性(通过反射获取获取注解信息)
元数据的理解:
String name = “atguigu”;
-
@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值:
RetentionPolicy.SOURCE:在源文件中有效(即源文件保留),编译器直接丢弃这种策略的注释
RetentionPolicy.CLASS:在class文件中有效(即class保留) , 当运行 Java 程序时, JVM不会保留注解。 这是默认值
RetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。
-
@Target: 用于修饰Annotation 定义, 用于指定被修饰的Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。
取值(element type) 描述 constructor 用于描述构造器 field 用于描述域 local_varibable 用于描述局部变量 method 用于描述方法 package 用于描述包 parameter 用于描述参数 type 用于描述类,接口(包括注解类型)或者 enum声明 -
@Documented: 用于指定被该元Annotation 修饰的Annotation 类将被javadoc 工具提取成文档。默认情况下,javadoc是不包括注解的。
定义为Documented的注解必须设置Retention值为RUNTIME。 -
@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
比如:如果把标有 @Inherited注解的自定义的注解标注在类级别上,子类则可以继承父类类级别的注解
实际应用中,使用较少
5. 利用反射获取注解信息
- JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素
- 当一个Annotation 类型被定义为运行时Annotation 后, 该注解才是运行时可见, 当 class 文件被载入时保存在 class 文件中的Annotation 才会被虚拟机读取
- 程序可以调用AnnotatedElement对象的如下方法来访问Annotation 信息
6. JDK 8中注解的新特性
- Java 8对注解处理提供了两点改进:可重复的注解及可用于类型的注解。此外,反射也得到了加强,在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。
- 可重复注解
- 在 MyAnnotation 上声明 @Repeatable,成员值为 MyAnnotations.class
- MyAnnotation的 Target和 Retention等元注解于和 MyAnnotations 相同.
jdk8 之前的写法
jdk8//1. 注解声明为 @interface public @interface MyAnnotation { //2. 内部定义成员,通常使用 value表示 //3. 可用指定成员的默认值,使用 default定义 //4. 如果自定义注解没有成员,表明是一个表示作用 String vale() default "hello"; } //5. 如果注解有成员,在使用注解时,需要指明成员的值. @interface MyAnnotations { MyAnnotation[] value(); } @MyAnnotations({@MyAnnotation(vale = "b"), @MyAnnotation(vale = "a")}) class Test { }
//1. 注解声明为 @interface @Repeatable(MyAnnotations.class) public @interface MyAnnotation { //2. 内部定义成员,通常使用 value表示 //3. 可用指定成员的默认值,使用 default定义 //4. 如果自定义注解没有成员,表明是一个表示作用 String vale() default "hello"; } //5. 如果注解有成员,在使用注解时,需要指明成员的值. @interface MyAnnotations { MyAnnotation[] value(); } @MyAnnotation(vale = "123") @MyAnnotation(vale = "abc") class Test { }
- 类型注解
- JDK1.8之后,关于元注解 @Target的参数类型 ElementType 枚举值多了两个:TYPE_PARAMETER,TYPE_USE。
- 在Java 8之前,注解只能是在声明的地方所使用,Java8开始,注解可以应用在任何地方。
ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)。
ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。
class TestTypeDefine<@TypeDefine() U> { private U u; public <@TypeDefine() T> void test(T t) { } } @Target({ElementType.TYPE_PARAMETER}) @interface TypeDefine { }
习题
- 什么是远看注解?说说 retention 和 target元注解的作用
元注解;对现有的注解进行解释说明的注解
retention;指明修饰的注解的声明周期,source class runtime - 利用注解和反射给对象重写 toString
import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; import java.lang.reflect.Field; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.Date; public class Demo04UseAnnotation { public static void main(String[] args) { // TODO Auto-generated method stub Teacher t1 = new Teacher(1001, "呵呵", 23, new Date(), 10000f); System.out.println(t1); } /** * 利用反射 重写toString * * @param obj * @return */ public static String toString(Object obj) { StringBuilder stb = new StringBuilder(""); //获取一个字符串:类名和字段名通过反射动态从注解中获取 //获取字节码文件对象 Class cla = obj.getClass(); //获取类上的注解:@MyClassAnnotation if (!cla.isAnnotationPresent(MyClassAnnotation.class)) { throw new RuntimeException("类上必须有注解:MyClassAnnotation"); } MyClassAnnotation classAnno = (MyClassAnnotation) cla.getDeclaredAnnotation(MyClassAnnotation.class); //获取注解的属性:className String className = classAnno.className(); stb.append(className + " ["); //获取字段上的所有注解:@MyFieldAnnotation Field[] fields = cla.getDeclaredFields(); for (Field field : fields) { field.setAccessible(true); Object fieldValue; try { fieldValue = field.get(obj); } catch (Exception e) { throw new RuntimeException(e); }//获取对象属性的值 MyFieldAnnotation fieldAnno = field.getDeclaredAnnotation(MyFieldAnnotation.class); String fieldName = fieldAnno.fieldName(); stb.append(fieldName + "=" + fieldValue + ","); } stb.deleteCharAt(stb.lastIndexOf(",")); stb.append("]"); return stb.toString(); } /** * 利用反射使用 set 方法给对象赋值 * * @param obj */ public static void setDefaultValue(Object obj) { //1. 获取所有方法上的注解: MyMethodAnnotation(fieldType,fieldValue) //2. 把注解的属性值 转为指定的类型传递给当前方法 //3. 调用方法 Class<?> clazz = obj.getClass(); Method[] array = clazz.getDeclaredMethods(); for (Method method : array) { method.setAccessible(true); //获取方法上的注解 if (method.isAnnotationPresent(MyMethodAnnotation.class)) { MyMethodAnnotation mma = method.getDeclaredAnnotation(MyMethodAnnotation.class); //获取注解的 fieldValue属性和 fieldType的属性 String fieldValue = mma.fieldValue(); Class fieldType = mma.fieldType(); //把字符串转为指定的类型 Object value = str2obj(fieldValue, fieldType); try { method.invoke(obj, value); } catch (IllegalAccessException | InvocationTargetException e) { e.printStackTrace(); } } } } private static Object str2obj(String str, Class type) { if(type==int.class||type==Integer.class){ return Integer.parseInt(str); } if(type==short.class||type==Short.class){ return Short.parseShort(str); } if(type==byte.class||type==Byte.class){ return Byte.parseByte(str); } if(type==long.class||type==Long.class){ return Long.parseLong(str); } if(type==float.class||type==Float.class){ return Float.parseFloat(str); } if(type==double.class||type==Double.class){ return Double.parseDouble(str); } if(type==boolean.class||type==Boolean.class){ return Boolean.parseBoolean(str); } if(type==char.class||type==Character.class){ return str.charAt(0); } if(type==Date.class){ try { return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").parse(str); } catch (ParseException e) { throw new RuntimeException(e); } } return str; } } @Target(ElementType.TYPE)//只能作用于于类上 @Retention(RetentionPolicy.RUNTIME) //注解会被jvm解析 @interface MyClassAnnotation { String className(); } @Target(ElementType.METHOD)//只能作用于于方法上 @Retention(RetentionPolicy.RUNTIME) //注解会被jvm解析 @interface MyMethodAnnotation { String fieldValue(); Class fieldType(); } @Target(ElementType.FIELD)//只能作用于于成员变量上 @Retention(RetentionPolicy.RUNTIME) //注解会被jvm解析 @interface MyFieldAnnotation { String fieldName(); } @MyClassAnnotation(className = "老师") class Teacher { @MyFieldAnnotation(fieldName = "工号") private int tid; @MyFieldAnnotation(fieldName = "名字") private String tname; @MyFieldAnnotation(fieldName = "年龄") private int tage; @MyFieldAnnotation(fieldName = "生日") private Date tbirthday; @MyFieldAnnotation(fieldName = "工资") private float tsalary; @Override public String toString() { //return "Teacher [tid=" + tid + ", tname=" + tname + ", tage=" + tage + ", tbirthday=" + tbirthday + ", tsalary=" // + tsalary + "]"; //使用中文:类名和字段名通过反射动态从注解中获取 // return "老师 [工号=" + tid + ",名字=" + tname + ", 年龄=" + tage + ", 生日=" + tbirthday + ", 工资=" // + tsalary + "]"; return Demo04UseAnnotation.toString(this); } public Teacher(int tid, String tname, int tage, Date tbirthday, float tsalary) { super(); this.tid = tid; this.tname = tname; this.tage = tage; this.tbirthday = tbirthday; this.tsalary = tsalary; } public Teacher() { //调用无参数的构造方法时:获取所有set方法上的注解:把注解中的值设置给当前方法 Demo04UseAnnotation.setDefaultValue(this); } public int getTid() { return tid; } @MyMethodAnnotation(fieldType = int.class, fieldValue = "1001") public void setTid(int tid) { this.tid = tid; } public String getTname() { return tname; } @MyMethodAnnotation(fieldType = String.class, fieldValue = "无名氏") public void setTname(String tname) { this.tname = tname; } public int getTage() { return tage; } @MyMethodAnnotation(fieldType = int.class, fieldValue = "34") public void setTage(int tage) { this.tage = tage; } public Date getTbirthday() { return tbirthday; } @MyMethodAnnotation(fieldType = Date.class, fieldValue = "1989-11-12 11:12:13") public void setTbirthday(Date tbirthday) { this.tbirthday = tbirthday; } public float getTsalary() { return tsalary; } @MyMethodAnnotation(fieldType = float.class, fieldValue = "3000") public void setTsalary(float tsalary) { this.tsalary = tsalary; } }