文档章节

java中的注解

 钻天鹞子
发布于 2015/10/15 16:52
字数 1016
阅读 12
收藏 0
点赞 0
评论 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
海淀
Kotlin和Java混合开发必读:基本的互操作

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

王木东
04/05
0
0
Java注解教程:自定义注解示例,利用反射进行解析

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

哲别0
2017/10/23
0
0
Java SE Annotations API学习

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

Rksi5
2014/04/08
0
0
Java注解(Annotation)详解

Java注解(Annotation)详解 1.Annotation的概念 An annotation is a form of metadata, that can be added to Java source code. Classes, methods, variables, parameters and packages may......

幻海流心
05/23
0
0
JAXB Annotation初步使用

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

秋风醉了
2014/07/02
0
0
Java 8新特性探究(四)类型注解 复杂还是便捷

本文将介绍java 8的第二个特性:类型注解。 注解大家都知道,从java5开始加入这一特性,发展到现在已然是遍地开花,在很多框架中得到了广泛的使用,用来简化程序中的配置。那充满争议的类型注...

OSC闲人
2013/11/28
0
5
springmvc请求接收参数的几种方法

通过@PathVariabl注解获取路径中传递参数 转载请注明出处:springmvc请求接收参数的几种方法 代码下载地址:http://www.zuidaima.com/share/1751862044773376.htm JAVA [java] view plainco...

boonya
2014/10/23
0
0
对于spring实现bean信息定义目标-基于三种方法的思考

对于spring实现bean信息定义目标,spring提供了三种方式:基于XML,基于注解,以及基于java类 本人是使用的基于注解的形式比较多的,一直没有使用过基于xml和基于java类的,所以很多地方还是...

bosscheng
2013/04/24
0
0
Java 程序员必须掌握的 5 个注解!

自 JDK5 推出以来,注解已成为Java生态系统不可缺少的一部分。虽然开发者为Java框架(例如Spring的@Autowired)开发了无数的自定义注解,但编译器认可的一些注解非常重要。 在本文中,我们将...

Java的博客
07/01
0
0
【Spring reference】Spring基于java的配置

1、简述 spring reference写到: Java-based configuration: Starting with Spring 3.0, many features provided by the Spring JavaConfig project became part of the core Spring Framewo......

666B
2014/07/01
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

CDH的坑之Sqoop导出数据到MySQL

CDH的坑之Sqoop导出数据到MySQL 最近使用Sqoop从Hive导出数据到MySQL中,出现了一系列的问题,下面将这个问题记录一下,避免再度踩坑! 导出语句 sqoop export --connect jdbc:mysql://192....

星汉
8分钟前
0
0
Hyperledger Fabric 客户端开发三

前面两篇文章介绍了Hyperledger Fabric SDK并使用一个实例介绍如何通过SDK和Hyperledger Fabric Blockchain交互, 现在详细分析相关的过程。 首先看 enroll (登录) admin 过程。 'use stric...

十一月不远
9分钟前
0
0
PowerDesigner连接MySQL和逆向工程图

最近想梳理公司项目的表间关系,从项目后台管理系统的操作入手,以及代码的hibernate注解入手,都不算特别尽人意,于是最后还是鼓捣了一下PowerDesigner的逆向工程图,这样更直观一些。 想着...

Oo若离oO
9分钟前
0
0
威胁web应用安全的错误

一般绝大部分的web应用攻击都是没特定目标的大范围漏洞扫描,只有少数攻击确实是为入侵特定目标而进行的针对性尝试。这两种攻击都非常频繁,难以准确检测出来,许多网站的web应用防火墙都无法...

上树的熊
12分钟前
2
0
pypy2 install crypto error

install pycryptodome instead pip install pycryptodome

coord
16分钟前
0
0
Service Mesh所应对的8项挑战

Lori Macvittie 微服务架构是把双刃剑,我们享受它带来的开发速度(development velocity),却也不得不面对服务间通讯带来的复杂性问题。 目前大多数扩展容器化微服务的架构多是基于proxy-b...

好雨云帮
25分钟前
0
0
时间复杂度

1. 维基上的定义 在计算机科学中,算法的时间复杂度是一个函数,它定性描述该算法的运行时间。这是一个代表算法输入值的字符串的长度的函数。时间复杂度常用大O符号表述,不包括这个函数的低...

liuyan_lc
31分钟前
0
0
js中的~符

~是js里的按位取反操作符,~~就是执行两次按位取反,其实就是保持原值,但是注意虽然是原值,但是对布尔型变量执行这个操作,会转化成相应的数值型变量,也就是 ~~true === 1,~~false === 0...

JamesView
32分钟前
0
0
webpack安装

npm install --save-dev webpack-cli

Vincent-Duan
34分钟前
0
0
实时监听EditText内容变化

主要是addTextChangedListener方法的使用 aswerEdittext.addTextChangedListener(new TextWatcher() { //编辑框的内容发生改变之前的回调方法 @Override public void before...

王先森oO
37分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部