Java的自定义注解使用实例
概念
Java有五个元注解,自动继承java.lang.annotation.Annotation。
什么是元注解,可以理解为其他普通注解进行解释说明
@Target 该注解的使用范围,限定应用场景。枚举类 ElemenetType 中
- TYPE:类,接口
- FIELD:字段,枚举的常量
- METHOD:函数(方法)
- PARAMETER:参数
- CONSTRUCTOR:构造函数
- ANNOTATION_TYPE:注解类型
- LOCAL_VARIABLE:局部变量
- PACKAGE:包
@Retention 该注解的生存周期,相当于时间戳。枚举类型 RetentionPolicy 中
- SOURCE:在源文件中有效,编译后会被丢弃(如@Override,@Deprecated)
- CLASS:在class文件中有效,在jvm丢弃
- RUNTIME:在运行时有效,class文件保留,jvm运行时保留(很多框架运用反射调用)
@Documented
javadoc文档生成工具的使用
@Inherited
允许子类继承父类中的注解。
@Repeatable
同一种注解可多次使用
作用
- 注释,解释,通过代码的标识元数据生成doc文档;
- 使用反射,通过代码标识的元数据对代码进行分析;
- 编译检查,通过代码标识的元数据让编译器进行基本检查。
实例
定义一个普通的注解,
public @interface Test
{ }
使用我们自定义的注解
@Test
public class Person
{
@Test
private String name; @Test
private int age; @Test
public void say()
{
System.out.println("Hello,Java Annotation");
}
}
@Target(ElementType.PACKAGE) 注解作用的目标>包
这个注解要理解什么是友好声明类和包常量,包中有很多的内部访问的类或常量,就可以统一的放到友好声明类中,这样就方便,而且集中管理,减少friendly类到处游走的情况。
可以参考这个 https://www.cnblogs.com/DreamDrive/p/5428573.html
import java.lang.annotation.ElementType;
@Target(ElementType.PACKAGE)
public @interface Test
{
}
@Test
package test; class Person
{ private String name; private int age; public void say()
{
System.out.println("Hello,Java Annotation");
}
}
@Target(ElementType.CONSTRUCTOR) 注解作用的目标>构造函数
package test; import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Target(ElementType.CONSTRUCTOR)
public @interface Test
{ }
package test; public class Person
{ private String name; private int age;
@Test
public Person()
{ } public void say()
{
System.out.println("Hello,Java Annotation");
}
}
其他范围就不一一列举,都是相同的。
@Retention(RetentionPolicy.RUNTIME) 生存周期
代码运行时动态获取注解的信息
package test; import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.CONSTRUCTOR)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test
{ }
package test; public class Person
{ private String name; private int age;
@Test
public Person()
{ } public void say()
{
System.out.println("Hello,Java Annotation");
}
}
注解的属性-->成员变量
方法名是成员变量的的名字,变量的类型是他的返回值。
package test; import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test
{
public int age() default ; public String name() default ""; public String className();
}
package test; import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method; @Test(age = 15,name = "zhangsan",className = "高三(3)班")
public class Person
{ private String name; private int age; public Person()
{ } private void say()
{
System.out.println("Hello,Java Annotation");
}
}
既然给了注解,我们要做的工作必然是要提取注解上面的内容,要拿到这些注解就要用到反射。
package test; import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method; @Test(age = 15,name = "zhangsan",className = "高三(3)班")
public class Person
{private String name; private int age; public Person()
{ } private void say()
{
System.out.println("Hello,Java Annotation");
} public static void main(String[] args)
{
boolean hasAnnotation = Person.class.isAnnotationPresent(Test.class); if (hasAnnotation)
{
Test test = Person.class.getAnnotation(Test.class); System.out.println("age:" + test.age());
System.out.println("name:" + test.name());
System.out.println("className:" + test.className());
}
}
}
输出结果
age:15
name:zhangsan
className:高三(3)班
对于类的属性和方法,都是同样的道理。
成员注解
package test; import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; @Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Field
{
public String name();
}
函数注解
package test; import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; @Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Method
{
public String say();
}
Person类
package test; import java.lang.annotation.Annotation; @Test(age = 15,name = "zhangsan",className = "高三(3)班")
public class Person
{
@Field(name = "lisi")
private String name; private int age; public Person()
{ }
@Method(say = "hello")
private void say()
{
System.out.println("Hello,Java Annotation");
} public static void main(String[] args)
{
boolean hasAnnotation = Person.class.isAnnotationPresent(Test.class); if (hasAnnotation)
{
Test test = Person.class.getAnnotation(Test.class); System.out.println("age:" + test.age());
System.out.println("name:" + test.name());
System.out.println("className:" + test.className());
} try
{
java.lang.reflect.Field field = Person.class.getDeclaredField("name"); field.setAccessible(true); Field check = field.getAnnotation(Field.class); if (check != null)
{
System.out.println("check value:" + check.name());
} java.lang.reflect.Method method = Person.class.getDeclaredMethod("say"); if (method != null)
{
Annotation[] ans = method.getAnnotations();
for (int i = 0; i < ans.length; i++)
{
System.out.println("method annotation:" + ans[i].annotationType().getSimpleName());
}
} } catch (NoSuchFieldException e)
{
e.printStackTrace();
}catch (Exception e){
e.printStackTrace();
} }
}
输出
age:15
name:zhangsan
className:高三(3)班
check value:lisi
method annotation:Method
可以看出我们获取了注解上的值,现在都没有实际意义,我们可以用注解来做些什么?
这些我没办法给出确切答案,只能说根据各人需求去合理利用注解。
实例
注解参数赋值
@Test注解
package test; import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface Test
{
String value();
}
Person类属性赋值
package test; import org.apache.poi.ss.formula.functions.T; import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method; public class Person
{
@Test("zhangsan")
private String name; @Test("15")
private int age; public Person()
{ } private void say()
{
System.out.println("Hello,Java Annotation");
} @Override
public String toString()
{
return "name = " + name + "\n" + "age = " + age;
} public static void main(String[] args)
{
Person person = new Person();
try
{
//取得成员变量的值
Field field = Person.class.getDeclaredField("name");
//打开权限
field.setAccessible(true);
//判断属性是否有注解
if (field.isAnnotationPresent(Test.class))
{
//获取属性上的注解值
Test test = field.getAnnotation(Test.class);
String name = test.value();
//赋值
field.set(person,name);
} Field field1 = Person.class.getDeclaredField("age");
field1.setAccessible(true);
if (field1.isAnnotationPresent(Test.class))
{
Test test = field1.getAnnotation(Test.class);
int age = Integer.valueOf(test.value());
field1.set(person,age);
}
System.out.println(person); }catch (Exception e)
{
e.printStackTrace();
} }
}
输出
name = zhangsan
age = 15
用注解去检查函数等等。。
lz不善于用语言表达,所以可能有很多人没看懂,可以看下
一个大佬讲解的注解说明(简单易懂)
https://blog.csdn.net/briblue/article/details/73824058
Java的自定义注解使用实例的更多相关文章
- Java实现自定义注解开发
Java实现自定义注解开发 一直都对注解开发挺好奇的,最近终于有时间自己实践了一把,记录一下 万一后期会用到呢 哈哈哈 首先我们了解一下自定义注解的标准示例,注解类使用 @interface 关键字修 ...
- java自定义注解知识实例及SSH框架下,拦截器中无法获得java注解属性值的问题
一.java自定义注解相关知识 注解这东西是java语言本身就带有的功能特点,于struts,hibernate,spring这三个框架无关.使用得当特别方便.基于注解的xml文件配置方式也受到人们的 ...
- 注解:java 自定义注解应用实例
本例子旨在使用自定义注解为实体打上标记,为自动生成 sql 提供依据,模拟 hibernate 的注解,至于注解的原理自己搜吧 1.定义 Table 注解 package test; import j ...
- [转] Java @interface 自定义注解
[From] http://blog.csdn.net/afterlife_qiye/article/details/53748973 1. 注解的好处 注解可以替代配置文件完成对某些功能的描述,减少 ...
- Java Annotation自定义注解详解
在开发过程中总能用到注解,但是从来没有自己定义过注解.最近赋闲在家,研究整理了一番,力求知其然知其所以然. 本文会尝试描述什么是注解,以及通过一个Demo来说明如何在程序中自定义注解.Demo没有实际 ...
- Java利用自定义注解、反射实现简单BaseDao
在常见的ORM框架中,大都提供了使用注解方式来实现entity与数据库的映射,这里简单地使用自定义注解与反射来生成可执行的sql语句. 这是整体的目录结构,本来是为复习注解建立的项目^.^ 好的,首先 ...
- Java基于自定义注解的面向切面的实现
目的:实现在任何想要切的地方添加一个注解就能实现面向切面编程 自定义注解类 @Target({ElementType.PARAMETER, ElementType.METHOD}) @Retentio ...
- java学习--自定义类的实例的大小比较和排序
我们知道Object类有一个equals方法,用于比较两个对象是否相等 我们只要在自定义类中重写了equals方法(若不重写就是比较两个实例的地址,相当于==)就可以用来比较该类的两个实例是否相等 问 ...
- java/springboot自定义注解实现AOP
java注解 即是注释了,百度解释:也叫元数据.一种代码级别的说明. 个人理解:就是内容可以被代码理解的注释,一般是一个类. 元数据 也叫元注解,是放在被定义的一个注解类的前面 ,是对注解一种限制. ...
随机推荐
- Android Studio 插件开发详解二:工具类
转载请标明出处:http://blog.csdn.net/zhaoyanjun6/article/details/78112856 本文出自[赵彦军的博客] 在插件开发过程中,我们按照开发一个正式的项 ...
- There is No Alternative~最小生成树变形
Description ICPC (Isles of Coral Park City) consist of several beautiful islands. The citizens reque ...
- codeforces——961B. Lecture Sleep
本文为博主原创文章,未经允许不得转载. 我在csdn也同步发布了此文,链接 https://blog.csdn.net/umbrellalalalala/article/details/7989196 ...
- window.open打开新窗体并用post方式传参
function openPostWindow(url,data,name){ //url要跳转到的页面,data要传递的数据,name显示方式(可能任意命名) var tempForm = docu ...
- C++内存深入理解
转载地址:http://www.cnblogs.com/DylanWind/archive/2009/01/12/1373919.html 前部分原创,转载请注明出处,谢谢! class Base ...
- build.gradle使用gradle.property中定义的字段及乱码问题的解决
gradle.property文件可以用来定义一些字段 而这些字段可以被build.gradle文件引用到 例如:给大家贴出来一个gradle.property文件 # Project-wide Gr ...
- 关于springboot的定时器配置
关于springboot的定时器: 比较重要的两个注解: @EnableScheduling:标注启动定时任务. @Scheduled(fixedRate = 1000 * 30) 定义某个定时任务 ...
- PHP访问数据库配置通用方法
提取一种对数据库配置的通用方式 目的是通过通用类访问配置文件的方式,提供对数据库连接的动态获取和设置,使开发时和生产应用时都能够提供灵活的.简化的.解耦的操作方式.比如在配置文件中配置好两套数据库访问 ...
- C++关于Union使用的部分总结
说明:未加说明,struct均指C++语言中的struct(可以有成员函数,可以定义访问属性) 1 什么是Union? (1)与class,struct相似用于定义数据结构:union 可以说是一种特 ...
- ORACLE 快速启动监听及相关服务程序
windows7 系统下,鼠标移至任务栏右键启动任务管理器->选择服务->点击右下角服务选项 ->选中名称,键盘输入O(大写),快速找到ORACLE相关服务进程 ->将所有的O ...