java 通过类注解扫描获得对象 java通过注解获取枚举值

转载

mob64ca141275de 2023-09-27 22:34:04

文章标签 java 通过类注解扫描获得对象 java System 枚举类成员变量 文章分类 Java 后端开发

一、枚举类

JDK1.5之前需要自定义枚举类

枚举类对象的属性不应允许被改动, 所以应该使用 private final 修饰
若枚举只有一个成员, 则可以作为一种单例模式的实现方式

public class TestSeason {
	public static void main(String args[]){
		Season spring = Season.SPRING;
		System.out.println(spring);
		spring.show();
		System.out.println(spring.getSeasonName());
	}
}

//枚举类
class Season {
	// 1.提供类的属性，声明为private final
	private final String seasonName;
	private final String seasonDesc;
	// 2.声明为final的属性，在构造器中初始化
	private Season(String seasonName,String seasonDesc){
		this.seasonName = seasonName;
		this.seasonDesc = seasonDesc;
	}
	// 3.通过公共的方法来调用属性
	public String getSeasonName(){
		return seasonName;
	}
	public String getSeasonDesc(){
		return seasonDesc;
	}
	// 4.创建为类的对象:将类的对象声明为 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","白雪皑皑");
	
	@Override
	public String toString() {
		return "Season [seasonName=" + seasonName + ", seasonDesc=" + seasonDesc + "]";
	}
	public void show(){
		System.out.println("这是一个季节");
	}
}

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

必须在枚举类的第一行声明枚举类对象。
使用 enum 定义的枚举类默认继承了 java.lang.Enum 类。
列出的实例系统会自动添加 public static final 修饰。

枚举类的主要方法：
values()方法：

返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。

valueOf(String str)：

可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的“名字”。如不是，会有运行时异常。

若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式, 则可以让每个枚举值分别来实现该方法。

public class TestSeason1 {
	public static void main(String args[]){
		Season1 spring = Season1.SPRING;
		System.out.println(spring);
		spring.show();
		System.out.println(spring.getSeasonName());
		
		//1.values()
		Season1 seasons[] = Season1.values();
		for(int i=0; i < seasons.length; i++){
			System.out.println(seasons[i]);
		}
		//2.valueOf(String name) 要求传入的形参name是枚举类对象的名字。否则，报java.lang.IllegalArgumentException异常
		String str = "SPRING";
		Season1 sea = Season1.valueOf(str);
		System.out.println(sea);
		
		Thread.State states[] = Thread.State.values();
		for(int i=0; i<states.length; i++){
			System.out.println(states[i]);
		}
	}
}

interface Info{
	void show();
}

//枚举类
enum Season1 implements Info{
	SPRING("spring","春暖花开"){
		public void show(){
			System.out.println("春天在哪里？");
		}
	},
	SUMMER("summer","夏日炎炎"){
		public void show(){
			System.out.println("生如夏花");
		}
	},
	AUTUMN("autumn","秋高气爽"){
		public void show(){
			System.out.println("秋天是分手的季节");
		}
	},
	WINTER("winter","白雪皑皑"){
		public void show(){
			System.out.println("冬天里的一把火");
		}
	};
	
	private final String seasonName;
	private final String seasonDesc;
	
	private Season1(String seasonName,String seasonDesc){
		this.seasonName = seasonName;
		this.seasonDesc = seasonDesc;
	}
	public String getSeasonName(){
		return seasonName;
	}
	public String getSeasonDesc(){
		return seasonDesc;
	}
	
	@Override
	public String toString() {
		return "Season [seasonName=" + seasonName + ", seasonDesc=" + seasonDesc + "]";
	}

//	public void show(){
//		System.out.println("这是一个季节");
//	}
}

二、注解Annotation

从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是 Annotation(注解)。
Annotation 其实就是代码里的特殊标记, 这些标记可以在 编译, 类加载, 运行时 被读取, 并执行相应的处理. 通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。
Annotation 可以像修饰符一样被使用, 可用于修饰（包、类,、构造器, 、方法、成员变量、参数、局部变量）的声明, 这些信息被保存在 Annotation 的 “name=value” 对中。
Annotation 能被用来为程序元素(类, 方法, 成员变量等) 设置元数据。
注解对代码的运行效果没有直接影响，由编译器决定该执行哪些操作。

基本的 Annotation

使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成一个修饰符使用。用于修饰它支持的程序元素
三个基本的 Annotation:
@Override: 限定重写父类方法, 该注释只能用于方法
@Deprecated: 用于表示某个程序元素(类, 方法等)已过时
@SuppressWarnings: 抑制编译器警告

自定义 Annotation

定义新的 Annotation 类型使用 @interface 关键字
Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明. 其方法名和返回值定义了该成员的名字和类型.
可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字

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

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

JDK 的元 Annotation

JDK 中的元Annotation用于修饰其他Annotation定义
JDK提供了专门在注解上的注解类型，分别是：

@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 可以保留多长时间（注解的生命周期）, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值:

RetentionPolicy.SOURCE：在源文件中有效，被编译器丢弃。
RetentionPolicy.CLASS：在编译器生成的字节码文件中有效，但在运行时会被处理类文件的 JVM 丢弃。 这是默认值
RetentionPolicy.RUNTIME：到运行时都有效。这也是注解生命周期中最常用的一种策略，它允许程序通过反射的方式访问注解，并根据注解的定义执行相应的代码。

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

截止到 Java 9，注解的类型一共有 11 种，定义在 ElementType 枚举中：
1）TYPE：用于类、接口、注解、枚举
2）FIELD：用于字段（类的成员变量），或者枚举常量
3）METHOD：用于方法
4）PARAMETER：用于普通方法或者构造方法的参数
5）CONSTRUCTOR：用于构造方法
6）LOCAL_VARIABLE：用于变量
7）ANNOTATION_TYPE：用于注解
8）PACKAGE：用于包
9）TYPE_PARAMETER：用于泛型参数
10 TYPE_USE：用于声明语句、泛型或者强制转换语句中的类型
11）MODULE：用于模块

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。定义为Documented的注解必须设置Retention值为RUNTIME。
@Inherited: 被它修饰的 Annotation 将具有继承性.如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解。实际应用中，使用较少

Annotation应用Demo

我们要利用注解实现一个自定义序列化工具类，有注解的对象的属性才被序列化进去。

自定义注解类：

/**
 * 作用：用来标记对象在序列化成 JSON 的时候要不要包含这个字。
 * JsonField 注解的生命周期是 RUNTIME，也就是运行时有效。
 * JsonField 注解装饰的目标是 FIELD，也就是针对字段的(类的成员变量)。
 * 创建注解需要用到 @interface 关键字。
 * JsonField 注解有一个参数，名字为 value，类型为 String，默认值为一个空字符串(它允许我们可以直接使用 @JsonField，而无需指定参数的名和值)。
 */

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface JsonField {
    public String value() default "";
}

实体类：

@Data
@AllArgsConstructor
public class Writer {
    
    private int age;

    @JsonField("writerName")
    private String name;

    @JsonField
    private String bookName;
}

序列化工具类：

public class JsonSerializer {

    public static String serialize(Object object) throws IllegalAccessException {
        Class<?> objectClass = object.getClass();
        Map<String, String> jsonElements = new HashMap<>();
        // 获取对象声明的所有字段
        for (Field field : objectClass.getDeclaredFields()) {
            // 将反射对象的可访问性设置为 true,防止private 字段无法获取
            field.setAccessible(true);
            if (field.isAnnotationPresent(JsonField.class)) {
                jsonElements.put(getSerializedKey(field), (String) field.get(object));
            }
        }
        return toJsonString(jsonElements);
    }

    /**
     * 获取字段上注解的值，如果注解的值是空的，则返回字段名
     * @param field
     * @return
     */
    private static String getSerializedKey(Field field) {
        String annotationValue = field.getAnnotation(JsonField.class).value();
        if (annotationValue.isEmpty()) {
            return field.getName();
        } else {
            return annotationValue;
        }
    }

    private static String toJsonString(Map<String, String> jsonMap) {
        String elementsString = jsonMap.entrySet()
            .stream()
            .map(entry -> "\"" + entry.getKey() + "\":\"" + entry.getValue() + "\"")
            .collect(Collectors.joining(","));
        return "{" + elementsString + "}";
    }

}

测试入口：

public class JsonFieldTest {

    public static void main(String[] args) throws IllegalAccessException {
        Writer cmower = new Writer(16,"无关风月","Java从入门到放弃");
        System.out.println(JsonSerializer.serialize(cmower));
    }
}

运行结果：

{"bookName":"Java从入门到放弃","writerName":"无关风月"}

从结果上来看：

1）Writer 类的 age 字段没有装饰 @JsonField 注解，所以没有序列化。

2）Writer 类的 name 字段装饰了 @JsonField 注解，并且显示指定了字符串“writerName”，所以序列化后变成了 writerName。

3）Writer 类的 bookName 字段装饰了 @JsonField 注解，但没有显式指定值，所以序列化后仍然是 bookName。

参考：

不吹牛逼，撸个注解有什么难的

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。

上一篇：架构探险从零开始写分布式服务框架分布式架构常用的框架

下一篇：java 注解属性list添加默认值 java注解的属性

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章

官方博客	全部文章	热门标签	班级博客
了解我们	网站地图	意见反馈

鸿蒙开发者社区	51CTO学堂
51CTO	软考资讯