十二:列举和注释
————————————————
免责声明:本文在CSDN博主“lsqstudy”原创文章的基础上进行修改,符合CC 4.0 BY-SA版权协议。
原文:https://blog.csdn.net/PorkBird/article/details/113666542
01、枚举类
1.0、枚举类的概述
1.一个类中对象的数量是有限的,这是肯定的。我们称这个类为枚举类。例子如下:
星期:星期一,…,星期日
性别:男(男)、女(女)
季节:春天…冬天
支付方式:现金(现金)、微信(微信)、支付宝(支付宝)、银行卡(银行卡)、信用卡(信用卡)
状态:忙、闲、职、离职
订单状态:未付款、已付款、已交货、已退货、已检查、已履行,
线程状态:已创建、就绪、正在运行、已阻止、已死亡。
2.当需要定义一组常数时,强烈建议使用枚举类。
3.如果枚举只有一个对象,它可以用作单例模式的实现。
4.如何定义枚举类
方法1:在JDK1.5之前,需要自定义枚举类。
方法2:JDK 1.5中的新枚举关键字用于定义枚举类。
5.枚举类的属性
不允许改变枚举类对象的属性,所以应该使用私有的最终装饰。
应该在构造函数中为用private final修饰的枚举类的属性赋值。
如果枚举类显式定义了带有参数的构造函数,则在列出枚举值时也必须使用相应的传入参数。
1.1、自定义枚举类
1.自定义枚举类的步骤:
1.声明Season对象的属性:private最终装饰。
2.将类的构造函数私有化,并为对象的属性赋值(如果构造函数没有私有化,可以在外部任意调整,对象不多)
3.提供当前枚举类的多个对象:公共静态final
4.其他需求:例如获取枚举对象的属性并提供toString()
公共课程内容
公共静态void main(String[]args){ 0
季节春天=季节。春天;//类。静态变量(spring),将获得的变量分配给季节类型的SPRING。
system . out . println(spring);
}
}
//自定义枚举类
班级季{
//1.声明季节对象的属性:私有最终装饰。
私有最终字符串seasonName
私有最终字符串seasonDesc
//2.将类的构造函数私有化,并为对象的属性赋值(如果构造函数没有私有化,可以在外部任意调整,对象不多)
私人季节(字符串季节名称,字符串季节)
this.seasonName=seasonName
this.seasonDesc=seasonDesc
}
//3.提供当前枚举类的多个对象:公共静态final。
公众最终季节春天=新季节(‘春天’‘万物复苏’);
公众最终季节夏季=新季节(‘夏季’‘烈日’);
公共静态翅片
al 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 + '\'' +
'}';
}
}
1.2、使用enum关键字定义枚举类
1.使用说明
- 使用enum定义的枚举类默认继承了java.lang.Enum类,因此不能再继承其他类
- 枚举类的构造器只能使用private 权限修饰符
- 枚举类的所有实例必须在枚举类中显式列出(, 分隔; 结尾)。列出的实例系统会自动添加public static final 修饰
- 必须在枚举类的第一行声明枚举类对象
2.JDK 1.5 中可以在switch 表达式中使用Enum定义的枚举类的对象作为表达式, case 子句可以直接使用枚举值的名字, 无需添加枚举类作为限定。p 503
/**
* 使用enum关键字定义枚举类
* 说明:定义的枚举类默认继承于java.lang.Enum类
*/
public class SeasonTest1 {
public static void main(String[] args) {
Season1 summer = Season1.SUMMER;
System.out.println(summer.toString());//SUMMER,输出的是对象的名,因为其父类重写了toString()
System.out.println(Season1.class.getSuperclass());//输出Season1的父类
}
}
//使用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 + '\'' +
// '}';
// }
}
1.3、Enum类中的常用方法
1.Enum类的常用方法:
- toString():返回当前枚举类对象的名称
- values()方法:返回所有的枚举类 对象 构成的数组。该方法可以很方便地遍历所有的枚举值。
- valueOf(String str):可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的“名字”。如不是,会有运行时异常:
IllegalArgumentException
。
public class SeasonTest1 {
public static void main(String[] args) {
Season1 summer = Season1.SUMMER;//类.静态变量(SUMMER),把得到的这个变量赋给Season1类型的summer
//1.方法1:toString():
System.out.println(summer.toString());
//2.方法2:values():返回所有的枚举类 对象 构成的数组
Season1[] values = Season1.values();
for(int i = 0;i values.length;i++){
System.out.println(values[i]);
}
System.out.println("*************************");
//线程的状态State是枚举类。State是Thread类的内部类
Thread.State[] values1 = Thread.State.values();
for(int i = 0;i values1.length;i++){
System.out.println(values1[i]);
}
//3.方法3:valueOf(String objName):返回枚举类中 对象名是objName 的对象。
Season1 winter = Season1.valueOf("WINTER");
//如果没有objName的枚举类对象,则抛异常:IllegalArgumentException
// Season1 winter1 = Season1.valueOf("WINTER1");
System.out.println(winter);
}
}
//使用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 + '\'' +
// '}';
// }
}
1.4、使用enum关键字定义的枚举类 实现接口
1.情况一:实现接口,在enum类中实现抽象方法(和普通类实现接口一样)
2.情况二:让枚举类的对象 分别实现 接口中的抽象方法
public class SeasonTest1 {
public static void main(String[] args) {
//values():返回所有的枚举类对象构成的数组
Season1[] values = Season1.values();
for(int i = 0;i values.length;i++){
values[i].show(); //春天在哪里 宁夏 秋天不回来 大约在冬季(中间有换行)
}
//valueOf(String objName):返回枚举类中对象名是objName的对象。
Season1 winter = Season1.valueOf("WINTER");
winter.show();//大约在冬季
}
}
interface Info{
void show();
}
//使用enum关键字枚举类
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.声明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;
}
// @Override
// public void show() {
// System.out.println("这是一个季节");
// }
}
02、注解(Annotation)
2.1、注解(Annotation)概述
1.从JDK 5.0
开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)。
2.Annotation
其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
3.Annotation
可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在Annotation 的“name=value” 对中。
4.在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE/Android中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
5.未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以上都是基于注解的,Hibernate3.x以后也是基于注解的,现在的Struts2有一部分也是基于注解的了,注解是一种趋势,一定程度上可以说:框架= 注解+ 反射+ 设计模式。
6.通过反射获取注解信息 ---到反射内容时系统讲解
2.2、Annotation的使用示例
1.使用Annotation 时要在其前面增加@ 符号, 并把该Annotation 当成一个修饰符使用。用于修饰它支持的程序元素
2.示例一:生成文档相关的注解
- @author 标明开发该类模块的作者,多个作者之间使用,分割
- @version 标明该类模块的版本
- @see 参考转向,也就是相关主题
- @since 从哪个版本开始增加的
- @param对方法中某参数的说明,如果没有参数就不能写
- @return 对方法返回值的说明,如果方法的返回值类型是void就不能写
- @exception 对方法可能抛出的异常进行说明,如果方法没有用throws显式抛出的异常就不能写
- 注意:
- @param @return 和 @exception这三个标记都是只用于方法的。
- @param的格式要求:@param 形参名 形参类型 形参说明
- @return的格式要求:@return 返回值类型 返回值说明
- @exception的格式要求:@exception 异常类型 异常说明
- @param 和 @exception可以并列多个
3.示例二:在编译时进行格式检查(JDK内置的三个基本注解)
- @Override: 限定重写父类方法, 该注解只能用于方法
- @Deprecated: 用于表示所修饰的元素(类,方法,构造器,属性等)已过时。通常是因为所修饰的结构危险或存在更好的选择
- @SuppressWarnings: 抑制编译器警告
4.示例三:跟踪代码依赖性,实现替代配置文件功能
- Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。
- spring框架中关于“事务”的管理
import java.util.ArrayList;
import java.util.Date;
/**
* 注解的使用
*
* 1. Annocation的使用示例
* 示例一:生成文档相关的注解
* 示例二:在编译时进行格式检查(JDK内置的三个基本注解)
* @Override: 限定重写父类方法, 该注解只能用于方法
* @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
* @SuppressWarnings: 抑制编译器警告
*
* 示例三:跟踪代码依赖性,实现替代配置文件功能
*/
public class AnnotationTest {
public static void main(String[] args) {
Person p = new Student();
p.walk();
Date date = new Date(2020, 10, 11);//已过时,但是依旧能用(为了兼容以前的项目)
System.out.println(date);
@SuppressWarnings("unused")//unused,代表num没有使用
int num = 10;
@SuppressWarnings({ "unused", "rawtypes" })//rawtypes代表ArrayList类声明的时候有泛型,但是实例化的时候没有用泛型
ArrayList list = new ArrayList();
}
}
class Person{
private String name;
private int age;
public Person() {
super();
}
public Person(String name, int age) {
this.name = name;
this.age = age;
}
public void walk(){
System.out.println("人走路");
}
}
interface Info{
void show();
}
class Student extends Person implements Info{
@Override
public void walk() {
System.out.println("学生走路");
}
@Override
public void show() {
}
}
2.3、如何自定义注解
1.如何自定义注解:参照@SuppressWarnings定义
-
① 注解声明为:@interface
-
② 内部定义成员,通常使用value表示
-
③ 可以指定成员的默认值,使用default定义
-
④ 如果自定义注解没有成员,表明是一个标识作用。
2.说明:
-
如果注解有成员,在使用注解时,font color='red'需要指明成员的值/font。
-
自定义注解必须配上注解的信息处理流程(使用反射)才有意义。
-
自定义注解font color='red'通过都会指明两个元注解/font:Retention、Target
//MyAnnotation注解:
public @interface MyAnnotation {
String value(); //value是一个属性,不是方法
//String value() default "hello"; //定义Annotation的成员变量时为其指定初始值(使用default关键字)
}
------------------------------------------------------------------------------------------------------------
//AnnotationTest类:
public class AnnotationTest {
public static void main(String[] args) {
}
}
//自定义注解的使用:可以放在类上面
@MyAnnotation(value = "hello")
class Person{
}
2.4、jdk中4个基本的元注解的使用
一、元Annotation:对现有的注解进行解释说明的注解
1.JDK
的 元Annotation 用于修饰其他 Annotation 定义
2.JDK5.0
提供了4个标准的 meta-annotation 类型,分别是:
Retention
Target
Documented
Inherited
3.元数据的理解:对现有数据进行修饰的数据叫做元数据。 例如:String name = “atguigu”
;
- “atguigu”是真实的数据,String 和 name 可以看作是对“atguigu”的修饰,String表示数据的类型,name是给数据起了一个名字
- 一定程度上,如果把“atguigu”看作数据的话,可以把String 和 name 看作是元数据
二、具体介绍@Retention:
1.@Retention: 只能用于修饰一个Annotation定义, 用于指定该Annotation 的生命周期, @Rentention包含一个RetentionPolicy类型的成员变量, 使用@Rentention时必须为该value 成员变量指定值:
- RetentionPolicy.SOURCE:在源文件中有效(即源文件保留),编译器直接丢弃这种策略的注释
- RetentionPolicy.CLASS:在class文件中有效(即class保留),当运行Java 程序时, JVM 不会保留注解。(这是默认值)
- RetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当运行Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。
2.@Retention:指定所修饰的 Annotation 的生命周期:SOURCE、CLASS(默认行为)、RUNTIME
- 只有声明为RUNTIME生命周期的注解,才能通过反射获取。
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* @author bai
* @create 2021-10-31-9:29
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value();
}
三、具体介绍@Target:
1.@Target: 用于修饰Annotation 定义, 用于指定被修饰的Annotation 能用于修饰哪些程序元素。@Target 也包含一个名为value 的成员变量。
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
//@Target指明它所修饰的注解能够修饰{}里面的这些结构
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value();
}
剩下两种元注解@Documented、@Inherited出现的频率较低
四、具体介绍@Documented:
1.@Documented: 用于指定被该元Annotation 修饰的Annotation 类将被 javadoc 工具提取成文档。默认情况下,javadoc是不包括注解的。
- 定义为Documented的注解必须设置Retention值为RUNTIME。
2.@Documented:表示所修饰的注解在被 javadoc 解析时,保留下来。(比如说注解@Deprecated)
五、具体介绍@Inherited:
1.@Inherited: 被它修饰的Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
- 比如:如果把标有 @Inherited注解 的自定义的注解标注在类级别上,子类则可以继承父类类级别的注解
- 实际应用中,使用较少
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
//@Inherited表明它所修饰的注解具有继承性了
@Inherited
//@Target表明它所修饰的注解能够修饰{}里面的这些结构
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value();
}
-----------------------------------------------------------------------------------------------
//@Inherited表明它所修饰的注解具有继承性了,例如:
//自定义注解的使用:可以放在类上面
@MyAnnotation(value = "hello")
class Person{
}
class Student extends Person{ //子类Student就继承了父类的注解:@MyAnnotation(value = "hello")
}
2.5、利用反射获取注解信息
1.概述
- JDK 5.0 在java.lang.reflect包下新增了AnnotatedElement接口, 该接口代表程序中可以接受注解的程序元素
- 当一个Annotation 类型被定义为运行时Annotation 后, 该注解才是运行时可见, 当class文件被载入时保存在class 文件中的Annotation 才会被虚拟机读取
- 程序可以调用AnnotatedElement对象的如下方法来访问Annotation 信息
2.如何获取注解信息:通过反射来进行获取、调用
- 前提:要求此注解的元注解Retention 中声明的生命周期状态为:RUNTIME
2.6、jdk8新特性
Java 8对注解处理提供了两点改进:可重复的注解及可用于类型的注解。此外,反射也得到了加强,在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。
2.6.1、jdk8
新特性:可重复注解
- ① 在MyAnnotation上声明@Repeatable,成员值为MyAnnotations.class
- ② MyAnnotation的@Target、@Retention、@Inherited等元注解与MyAnnotations相同。
1.jdk8之前实现可重复注解:
//MyAnnotation注解:
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
@Inherited
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value();
}
------------------------------------------------------------------------------------------
//MyAnnotations注解:
public @interface MyAnnotations {
MyAnnotation[] value();
}
------------------------------------------------------------------------------------------
//AnnotationTest类:
public class AnnotationTest {
public static void main(String[] args) {
}
}
@MyAnnotations({@MyAnnotation(value="hi"), @MyAnnotation(value="hello")}) //自定义注解的使用
class Person{
}
2.jdk8中的可重复注解:
//MyAnnotation注解:
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
@Repeatable(MyAnnotations.class)
@Inherited
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value();
}
------------------------------------------------------------------------------------------
//MyAnnotations注解:
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
@Inherited
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotations {
MyAnnotation[] value();
}
------------------------------------------------------------------------------------------
//AnnotationTest类:
public class AnnotationTest {
public static void main(String[] args) {
}
}
@MyAnnotation(value="hi") //可重复注解
@MyAnnotation(value="hello")
class Person{
}
2.6.2、jdk8
新特性:类型注解
1.JDK1.8
之后,关于元注解@Target的参数类型ElementType
枚举值多了两个:TYPE_PARAMETER、TYPE_USE
2.在Java8之前,注解只能是在声明的地方所使用,Java8开始,注解可以应用在任何地方。
ElementType.TYPE_PARAMETER
:表示该注解能写在类型变量的声明语句中(如:泛型声明)。ElementType.TYPE_USE
:表示该注解能写在使用类型的任何语句中。
//MyAnnotation注解:
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
@Inherited
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, TYPE_PARAMETER, TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value() default "hi";
}
------------------------------------------------------------------------------------------
//AnnotationTest类:
public class AnnotationTest {
public static void main(String[] args) {
}
}
//1.TYPE_PARAMETER:用注解去修饰泛型的类型
class Generic@MyAnnotation T{
//2.TYPE_USE:表示该注解能写在使用类型的任何语句中
public void show() throws @MyAnnotation RuntimeException{
ArrayList@MyAnnotation String list = new ArrayList();
int num = (@MyAnnotation int) 10L;
}
}
内容来源网络,如有侵权,联系删除,本文地址:https://www.230890.com/zhan/114080.html