java注解前世今生

<h4>前序:</h4>
很开心下了班以后坐在电脑前面写这篇文章。注解Annotation我们常常见到jdk中的@override、@Deprecated、@SuppressWarnings 还有我本人认为非常优秀的开源项目spring中的IOC的@controller、@autowired和AOP的@Around @Before @After还有hibernate等我就不都枚举了。既然用的地方这么多所以我们就还是有必要揭开它的面纱看看它到底是怎么玩的。
<h4>1、属性全解</h4>
Java中提供了四种元注解,专门负责注解其他的注解,分别如下:
<pre>@Retention @Target @Documented @Inheried </pre>
先拿@override 的源码来作为一个切入点:
<pre>
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
</pre>
@Target:说明了Annotation所修饰的对象范围,取值在一个枚举ElementType中,查看源码(局限于1.7。since1.8以后又新增了2个)
<pre>
public enum ElementType {
TYPE, 用于描述类、接口(包括注解类型) 或enum声明
FIELD, 成员变量、对象、属性(包括enum实例)
METHOD, 方法声明
PARAMETER, 参数声明
CONSTRUCTOR, 构造器声明
LOCAL_VARIABLE, 局部变量声明
ANNOTATION_TYPE, 元注解,有兴趣的可以看看@Retention、@Target、@Documented、@Inheried的@Target(ElementType.ANNOTATION_TYPE)都是如此
PACKAGE 包声明
}
</pre>
@Retention:表示需要在什么级别保存该注释信息(生命周期)。可选的RetentionPoicy参数包括:
<pre>
public enum RetentionPolicy {
SOURCE, 停留在java源文件,编译器被丢掉
CLASS, 停留在class文件中,但会被JVM丢弃(默认)
RUNTIME 内存中的字节码,JVM将在运行时也保留注解,因此可以通过反射机制读取注解的信息,所以我们自己开发注解的话一般都是RUNTIME,这样的话就可以通过注解来搞搞
}
</pre>
@Documented:一个简单的Annotations标记注解,表示是否将注解信息添加在java文档中。这个我们实际使用的会相对很少,因为我们大多会用在功能实现上。

@Inherited:指定Annotation具有继承性,上个例子:
<pre>
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface InheritedDemo {
}
//父类使用了Inherited注解
@InheritedDemo
public class Father {
}
//子类验证对于InheritedDemo注解是否有传递性
public class Child extends Father {
public static void main(String[] args) {
//输出为true
System.out.println(Child.class.isAnnotationPresent(InheritedDemo.class));
}
}
</pre>
<h4>2、编写自己的注解</h4>
记得最早期的时候在一家金融公司有用到注解的一个场景是,定义类中的每个属性的名称、类型及描述,好吧我们就开始着手写代码吧:
<pre>
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FieldDesc {
//定义数据类型枚举
enum DataType{String,Integer,Long,Boolean,Double};
//名称
String name() ;
//数据类型
DataType dataType();
//中文描述
String desc() default "";
}
</pre>
<pre>
public class AnnationStudent {
@FieldDesc(name = "id", dataType = DataType.Integer, desc = "id")
private int id;
@FieldDesc(name = "name", dataType = DataType.String, desc = "名称")
private String name;
@FieldDesc(name = "age", dataType = DataType.Integer, desc = "年龄")
private int age;
@FieldDesc(name = "telNo", dataType = DataType.String, desc = "手机号码")
private String telNo;
public static void main(String[] args) {
Field[] fieldList = AnnationStudent.class.getDeclaredFields();
if (ArrayUtils.isNotEmpty(fieldList)) {
for (Field field : fieldList) {
Annotation[] annotationList = field.getAnnotations();
if (ArrayUtils.isNotEmpty(annotationList))
for (Annotation annotation : annotationList) {
if (annotation instanceof FieldDesc) {
FieldDesc desc = (FieldDesc) annotation;
System.out.println(desc.name() + " ### " + desc.dataType() + " ### " + desc.desc());
}
}
}
}
}
}


输出结果为:
id ### Integer ### id
name ### String ### 名称
age ### Integer ### 年龄
telNo ### String ### 手机号码
</pre>
这应该是一个完整的注解过程了吧。还有一个小技巧就是当我们给注解的属性赋值时,如果里面有个value属性,我们使用注解时可以不指定名称,自动会指定到value赋值:
<pre>
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
String value() default "";
String name() default "";
}
@Test("dadawd")
public class TE { <b>编译通过,如果Test 没有叫value的属性时编译会报错</b>
}
</pre>
这点在spring中的注解里面很常见。
<h4>3、谈谈注解在类似hibernate等框架中的应用</h4>
也许不一定是hibernate,但它们定义pojo实体的实现思想是一样的:
<pre>
@Entity
@Database(name="TestDB")
@Table(name="test_table")
public class TestEntity {
@Id
@Column(name="ID")
@GeneratedValue(strategy = GenerationType.AUTO)
@Type(value=Types.BIGINT)
private Long iD;</br>
@Column(name="Name")
@Type(value=Types.String)
private Long name;</br>
@Column(name="SourceType")
@Type(value=Types.INTEGER)
private Integer sourceType;</br>
public Long getiD() {
return iD;
}
public void setiD(Long iD) {
this.iD = iD;
}
public Long getName() {
return name;
}
public void setName(Long name) {
this.name = name;
}
public Integer getSourceType() {
return sourceType;
}
public void setSourceType(Integer sourceType) {
this.sourceType = sourceType;
}
}
</pre>
如何使用定义的@Database、@Table呢?
<pre>
//<b>获取数据库名</b>
public String getDatabaseName() {
Database db = clazz.getAnnotation(Database.class);
if (db != null && db.name() != null)
return db.name();
throw new RuntimeException("The entity must configure Database annotation.");
}
//<b>获取表名</b>
public String getTableName() {
Table table = clazz.getAnnotation(Table.class);
if (table != null && table.name() != null)
return table.name();
Entity entity = clazz.getAnnotation(Entity.class);
if ( entity != null && (!entity.name().isEmpty()) )
return entity.name();
return clazz.getSimpleName();
}
</pre>
这就是注解的使用所在。
<h4>4、结束语</h4>
我所理解的注解就是打标签下定义,比如我们常说某人是屌丝、高富帅、白富美,当知道某人是高富帅你又能反向推断出来是长的高、有钱、又帅这么一类人。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容

  • 本文章涉及代码已放到github上annotation-study 1.Annotation为何而来 What:A...
    zlcook阅读 29,119评论 15 116
  • 什么是注解(Annotation):Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和...
    九尾喵的薛定谔阅读 3,141评论 0 2
  • 在我走过的二十多个春去秋来的日子里,我每天都在寻找一样珍贵的东西。它并不是什么金银珠宝,也并非山珍海味,它却是一种...
    高楼休独依阅读 452评论 1 4
  • 怎么能够忘怀 六十八年的风雨不改 历经磨难征程不退 先辈相携背靠背 脊梁撑住天地 不愿天黑 刻不容缓不能再等待 举...
    缘起缘落是哀愁阅读 114评论 0 0
  • 古文今读: 【原文】 怨在不舍小过.患在不预定谋 【译文】 怨恨产生在对小的过失耿耿于怀,抓住不放。也是格局问题,...
    清静道人阅读 296评论 0 0