【转】 java自定义注解

java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。
注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。

1、元注解

元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四种。

1.1、@Retention: 定义注解的保留策略

@Retention(RetentionPolicy.SOURCE) //注解仅存在于源码中，在class字节码文件中不包含

@Retention(RetentionPolicy.CLASS) // 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，

@Retention(RetentionPolicy.RUNTIME) // 注解会在class字节码文件中存在，在运行时可以通过反射获取到

1.2、@Target：定义注解的作用目标

其定义的源码为：

[java] view plaincopy

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
ElementType[] value();
}

@Target(ElementType.TYPE) //接口、类、枚举、注解

@Target(ElementType.FIELD) //字段、枚举的常量

@Target(ElementType.METHOD) //方法

@Target(ElementType.PARAMETER) //方法参数

@Target(ElementType.CONSTRUCTOR) //构造函数

@Target(ElementType.LOCAL_VARIABLE)//局部变量

@Target(ElementType.ANNOTATION_TYPE)//注解

@Target(ElementType.PACKAGE) ///包

由以上的源码可以知道，他的elementType 可以有多个，一个注解可以为类的，方法的，字段的等等

1.3、@Document：说明该注解将被包含在javadoc中

1.4、@Inherited：说明子类可以继承父类中的该注解

2、java 注解的自定义

下面是自定义注解的一个例子

[java] view plaincopy

@Documented
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Yts {
public enum YtsType{util,entity,service,model}
public YtsType classType() default YtsType.util;
}

[java] view plaincopy

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Inherited
public @interface HelloWorld {
public String name()default "";
}

@Retention(RetentionPolicy.RUNTIME)

定义的这个注解是注解会在class字节码文件中存在，在运行时可以通过反射获取到。

@Target({ElementType.TYPE,ElementType.METHOD})

因此这个注解可以是类注解，也可以是方法的注解

这样一个注解就自定义好了，当然注解里面的成员可以为基本的数据类型，也可以为数据，Object等等

3 注解是定义好了，那么怎么来得到，解析注解呢？

java的反射机制可以帮助，得到注解，代码如下：

[java] view plaincopy

public class ParseAnnotation {
public void parseMethod(Class clazz) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, SecurityException, NoSuchMethodException, InstantiationException{
Object obj = clazz.getConstructor(new Class[]{}).newInstance(new Object[]{});
for(Method method : clazz.getDeclaredMethods()){
HelloWorld say = method.getAnnotation(HelloWorld.class);
String name = "";
if(say != null){
name = say.name();
method.invoke(obj, name);
}
Yts yts = (Yts)method.getAnnotation(Yts.class);
if(yts != null){
if(YtsType.util.equals(yts.classType())){
System.out.println("this is a util method");
}else{
System.out.println("this is a other method");
}
}
}
}
@SuppressWarnings("unchecked")
public void parseType(Class clazz) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException{
Yts yts = (Yts) clazz.getAnnotation(Yts.class);
if(yts != null){
if(YtsType.util.equals(yts.classType())){
System.out.println("this is a util class");
}else{
System.out.println("this is a other class");
}
}
}
}

前一个方法是解析得到方法注解的，后一个方法是得到类注解的

以下是测试方法类

[java] view plaincopy

@Yts(classType =YtsType.util)
public class SayHell {
@HelloWorld(name = " 小明 ")
@Yts
public void sayHello(String name){
if(name == null || name.equals("")){
System.out.println("hello world!");
}else{
System.out.println(name + "say hello world!");
}
}
}

[html] view plaincopy

public static void main(String[] args) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, SecurityException, NoSuchMethodException, InstantiationException {
ParseAnnotation parse = new ParseAnnotation();
parse.parseMethod(SayHell.class);
parse.parseType(SayHell.class);
}

转载于:https://www.cnblogs.com/sunson/p/3166975.html

【转】 java自定义注解相关推荐

java 自定义注解_两步实现Java自定义注解
什么是注解? 注解就是为容器提供元数据,例如@Controller 注解则是标记了该Bean需要交给Spring容器进行管理. 那么我们怎么去实现自个的注解,也就是自定义注解呢? 一.自定义一个注解( ...
java自定义注解实现前后台参数校验
其实是可以通过@Constraint来限定自定义注解的方法. @Constraint(validatedBy = xxxx.class) 下面是我做的 java自定义注解实现前后台参数校验的代码示例 ...
java自定义注解类
一.前言今天阅读帆哥代码的时候,看到了之前没有见过的新东西, 比如java自定义注解类,如何获取注解,如何反射内部类,this$0是什么意思? 于是乎,学习并整理了一下. 二.代码示例 import ...
java 自定义注解实现不同对象之间的拷贝（支持大小写、驼峰转换）
java 自定义注解实现不同对象之间的拷贝(支持大小写.驼峰转换) 1.需求要实现两个属性名称完全不同的对象之间的拷贝.具体如下原对象 /*** 原实体*/ @Data public class ...
Java 自定义注解及使用场景
文章目录 1 什么是注解(Annotation) 2 元注解 2.1 @Target 2.2 @Retention 2.3 @Repeatable 2.4 @Inherited 示例1 反射获取注解 ...
java中注解动态传参_Java自定义注解源码+原理解释（使用Java自定义注解校验bean传入参数合法性）...
Java自定义注解源码+原理解释(使用Java自定义注解校验bean传入参数合法性)java 前言:因为前段时间忙于写接口,在接口中须要作不少的参数校验,本着简洁.高效的原则,便写了这个小工具供本身使 ...
Java 自定义注解简单使用
Java 自定义注解简单使用文章目录 Java 自定义注解简单使用第一步:在 pom.xml 下引入反射框架第二步:自定义注解第三步:写两个测试实体类第四步:写个工具类扫描被注解的类(核心) ...
springboot项目中自定义注解的使用总结、java自定义注解实战（常用注解DEMO）
初学spring的时候使用注解总觉得使用注解很神奇,加一个注解就能实现想要的功能,很好奇,也想自己根据需要写一些自己实现的自定义注解.问题来了,自定义注解到底是什么?肯定会有人和我一样有这个疑惑,我根 ...
java 自定义注解教程_Java注解教程及自定义注解
Java注解提供了关于代码的一些信息,但并不直接作用于它所注解的代码内容.在这个教程当中,我们将学习Java的注解,如何定制注解,注解的使用以及如何通过反射解析注解. Java1.5引入了注解,当前许 ...
数据脱敏——基于Java自定义注解实现日志字段脱敏
上文说了数据过敏主要有两个思路:第一个就是在序列化实体之前先把需要脱敏的字段进行处理,之后正常序列化:第二个就是在实体序列化的时候,对要脱敏的字段进行处理. 脱敏实现思路这里探讨第一种方法,用基于自 ...

【转】 java自定义注解

【转】 java自定义注解相关推荐

最新文章

热门文章