文档章节

java中的注解

 钻天鹞子
发布于 2015/10/15 16:52
字数 1016
阅读 12
收藏 0
前言:

最近做项目时发现Spring框架运用了大量自定义注解,所以回过头来有必要深入了解和整理关于注解的知识。

注解是java在1.5版本引入的新特性,随后一些开源组件也引入此项特性,如Spring,Hibernate,Mybatis。JPA规范更是全注解式

的。以下用到的示例代码均来自于<<Java编程思想第四版>>。

一.什么是注解

注解也被称为元数据。我们可以在代码中添加信息,然后可以在需要的时候使用这些数据。通过在源代码级别保存注解,使得代码变得整洁便于维护。注解是语言级别的概念,享有编译期的类型检查保护。使用扩展的annotationAPI或者字节码工具类库,程序员拥有对源代码以及字节码强大的检查和操作能力。

二.定义注解

1.基本语法

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {}

没有元素的注解称为标记注解(marker  annotation),如以上定义的@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 UseCase {
  public int id();
  public String description() default "no description";
}

2.元注解

元注解负责注解其他注解。Java内置了四种元注解:

@Target

表示该注解可以用于什么地方。可能的ElementType参数包括:

CONSTRUCTOR:构造器的声明

FIELD:域声明(包括enum实例)

LOCAL_VARIABLE:局部变量声明

METHOD:方法声明

PACKAGE:包生明VM

PARAMETER:参数声明

TYPE:类、接口(包括注解类型)或enum声明

@Retention

表示需要在生么级别保存该注解信息。可选的RetentionPolicy参数包括: 

SOURCE:注解将被编译器丢弃。

CLASS:注解在class文件中可用,但会被VM丢弃。

RUNTIME: VM将在运行期也保留注解,因此可以通过反射机制读取注解的信息。

@Documented 将此注解包含在Javadoc中。
@Inherited 允许子类继承父类中的注解。

3.基本注解

Java同时内置了三种基本注解:

@Override 表示当前的方法定义将覆盖超类中的方法

@Deprecated 如果使用了注解为它的元素,编译器会发出警告信息

@SuppressWarnings 关闭编译器警告信息

4.注解中的元素

注解中的元素可用类型有:所有基本类型(int,float,boolean等),不允许包装类型,String,Class,enum,Annotation,以上类型的数组

默认值限制

  1. 注解中的元素不能有不确定的值。要么具有默认值,要么在使用注解时提供元素的值。

  2. 对于非基本类型的元素,无论是在使用注解时,还是在定义注解并设定元素默认值时,都不能为null。

注解不支持继承: 即不能使用关键字extends来继承某个@interface。

三.使用注解

 下面的PasswordUtils类中有三个方法使用了@UseCase

import java.util.List;

public class PasswordUtils {
  @UseCase(id = 47, description =
  "Passwords must contain at least one numeric")
  public boolean validatePassword(String password) {
    return (password.matches("\\w*\\d\\w*"));
  }
  @UseCase(id = 48)
  public String encryptPassword(String password) {
   return new StringBuilder(password).reverse().toString();
  }
  @UseCase(id = 49, description =
  "New passwords can't equal previously used ones")
  public boolean checkForNewPassword(
    List<String> prevPasswords, String password) {
    return !prevPasswords.contains(password);
  }
}
四.注解处理器

下面是一个简单的注解处理器,它读取PassWordUtils类,并使用反射机制查找@UseCase标记。提供一组id值用于测试,它会列出找到的用例和缺失的用例。

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class UseCaseTracker {
  public static void trackUseCases(List<Integer> useCases, Class<?> cl) {
    for(Method m : cl.getDeclaredMethods()) {
      UseCase uc = m.getAnnotation(UseCase.class);
      if(uc != null) {
        System.out.println("Found Use Case:" + uc.id() + " " + uc.description());
        useCases.remove(new Integer(uc.id()));
      }
    }
    for(int i : useCases) {
      System.out.println("Warning: Missing use case-" + i);
    }
  }
  public static void main(String[] args) {
    List<Integer> useCases = new ArrayList<Integer>();
    Collections.addAll(useCases, 47, 48, 49, 50);
    trackUseCases(useCases, PasswordUtils.class);
  }
} 

/* Output:
Found Use Case:47 Passwords must contain at least one numeric
Found Use Case:48 no description
Found Use Case:49 New passwords can't equal previously used ones
Warning: Missing use case-50
*/


© 著作权归作者所有

共有 人打赏支持
粉丝 2
博文 2
码字总数 1366
作品 0
海淀
私信 提问
Java注解教程:自定义注解示例,利用反射进行解析

Java注解能够提供代码的相关信息,同时对于所注解的代码结构又没有直接影响。在这篇教程中,我们将学习Java注解,如何编写自定义注解,注解的使用,以及如何使用反射解析注解。 注解是Java ...

哲别0
2017/10/23
0
0
Kotlin和Java混合开发必读:基本的互操作

在使用Kotlin和Java混合开发的时候,涉及到一些基本的互操作 一、属性的读写 1.Kotlin自动识别Java的属性的Getter和Setter 2.Java操作kotlin属性可以通过Getter和Setter的方式 二、空安全类型...

王木东
04/05
0
0
Spring Boot实战之基础回顾

本文作者: 吴伟祥 本文链接: https://wuweixiang.cn/2018/08/21/Spring-Boot实战之基础回顾/ 版权声明: 本博客所有文章除特别声明外均为原创,采用CC BY-NC-SA 4.0 许可协议。转载请在文章开...

吴伟祥
08/21
0
0
Java SE Annotations API学习

注解,元数据的一种形式,提供关于程序不是程序本身的一部分数据。注解对代码的操作没有直接影响。 注解有多用途,如: a、用于编译信息。通过编译器检测错误or抑制警告 b、编译时和部署时的...

Rksi5
2014/04/08
0
0
JAXB Annotation初步使用

JAXB(Java Architecture for XML Binding简称JAXB)允许Java开发人员将Java类映射为XML表示方式。JAXB提供两种主要特性:将一个Java对象序列化为XML,以及反向操作,将XML解析成Java对象。换...

秋风醉了
2014/07/02
0
0

没有更多内容

加载失败,请刷新页面

加载更多

Vue- 对象语法 v-bind:class与对象语法的使用

我们可以传给 v-bind:class 一个对象,以动态地切换 class 。 <div v-bind:class="{ active: isActive }"></div>//对象语法也就是在v-bind:class绑定一个对象的时候,里面的值将影响最终取值...

文文1
2分钟前
0
0
epoll中使用

1、一个线程epoll_wait时,另一个线程调用epoll_ctl是安全的。 2、使用edge触发,在socket有数据到来后,不收取数据,再次调用epoll_ctl将socket加入,仍会触发下一次动作。 asio用该方法来发...

gelare
30分钟前
1
0
PHP规范PSR2

PSR标准 - PSR-2 为了尽可能的提升阅读其他人代码时的效率,下面例举了一系列的通用规则,特别是有关于PHP代码风格的。 各个成员项目间的共性组成了这组代码规范。当开发者们在多个项目中合作...

geek土拨鼠
45分钟前
5
0
【极简】如何在服务器上安装SSL证书?

本文适合任何人了解,图形化操作。下面以腾讯云为例,并且服务器(linux)也安装了宝塔面板。 1.登陆腾讯云账号进入控制台,找到SSL的产品 2.按要求申请并填写表单,记住私钥密码 3.提交后,待...

皇冠小丑
54分钟前
1
0
深入理解编译器

深入理解编译器 原文出处 欢迎向Rust中文社区投稿,投稿地址,好文将在以下地方直接展示 1 Rust中文社区首页 2 Rust中文社区Rust文章栏目 3 知乎专栏Rust语言 编程语言是如何工作的 从内部理解...

krircc
56分钟前
1
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部