本文从以下几点浅谈一下Java注解
一、注解的定义
二、自定义注解示例
三、元注解
四、注解元素
一、注解的定义
1、元数据
元数据是用于描述数据的数据,通俗讲,就是描述代码之间的关系,或者是代码与其他外部资源(如:数据库表)之间的内在联系的数据。
2、注解的定义
Java5引入注解,注解也被成为元数据,在代码中添加信息提供了一种形式化的方法,使我们可以在稍后的某个时刻非常方便的使用这些数据。
3、注解的引入
使用Annotation之前,XML被广泛的应用于描述元数据。不知何时开始一些应用开发人员和架构师发现XML的维护越来越糟糕了。他们希望使用一些和代码紧耦合的东西,而不是像XML那样和代码是松耦合的(在某些情况下甚至是完全分离的)代码描述。如果你在Google中搜索“XML vs annotations”,会看到许多关于这个问题的辩论。最有趣的是XML配置其实就是为了分离代码和配置而引入的。上述两种观点可能会让你很疑惑,两者观点似乎构成了一种循环,但各有利弊。
二、自定义注解示例
1、代码示例
package net.oschina.tkj.chapter20; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 注解类 * * @author Freedom * */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface UseCase { public int id(); public String description() default "no description"; }
package net.oschina.tkj.chapter20; import java.util.List; /** * 使用UseCase注解 * * @author Freedom * */ public class PasswordUtils { @UseCase(id = 47, description = "password must contain at last one numeric") public boolean validatePwd(String pwd) { return pwd.matches("\\w*\\d"); } @UseCase(id = 48) public String encryptPassword(String pwd) { return new StringBuilder(pwd).reverse().toString(); } @UseCase(id = 49, description = "new pwd can not equal used one.") public boolean checkNewPwd(List<String> list, String pwd) { return !list.contains(pwd); } }
2、通过示例理解注解
(1) 在注解中,一般会包含一些元素来表示某些值。当分析处理注解时,程序或者工具可以利用这些值。注解的元素看起来就像接口方法,唯一的区别就是可以为其指定默认值。
(2)没有元素的注解成为标记注解。
三、元注解
1、元注解
@Target
表示注解可以用在什么地方。可能的ElemenType参数如下:
(1)CONSTRUCTOR:构造器声明
(2)FIELD:域声明(包括enum实例)
(3)LOCAL_VARIABLE:局部变量声明
(4)METHOD:方法声明
(5)PACKAGE:包声明
(6)PARAMETER:参数声明
(7)TYPE:类、接口(包括注解类型或enum声明)
@Retention
表示在什么级别保存该注解信息(注解的声明周期)。可选的参数RetentionPolicy 如下:
(1)SOURCE:注解将被编译器丢弃。
(2)CLASS:注解在class文件中可用,但会被JVM丢弃。
(3)RUNTIME:JVM在运行时期也保留注解,因此可以通过反射机制读取注解的信息。
@Documented
将此注解包含在Javadoc中。
@Inherited
允许子类继承父类中的注解。
四、注解元素
1、注解元素(注解中的成员)的类中
(1)所有的8个基本数据类型(int ,float,booelan 等)
(2)String
(3)Class
(4)enum
(5)Annotation
(6)数组
1.1、注意
①如果使用上述类型以外的类型,编译器会报错。
②也不允许使用基本类型的包装类型。
③注解也可以作为元素类型,意味着注解可以嵌套注解。
2、注解中默认值限制
(1)注解中元素不能有不确定的值,换句话说,元素要么具有默认值,要么在使用注解时提供默认值。
(2)对于非基本类型的元素,无论是在源代码中声明时,或者是在注解接口中定义默认值时,都不能以NULL作为其值。
(3)在注解的声明中,所有元素都存在,并且都具有相应的值。为了变现元素的存在或者缺失的状态,自定义一些值,例如空字符串或者负数,表示元素不存在。
3、注解处理器
定义了自己的注解并将其应用在业务逻辑的方法上。现在我们需要写一个用户程序调用我们的注解。这里我们需要使用反射机制。
3.1注解处理器代码示例
package net.oschina.tkj.chapter20; import java.lang.reflect.Method; import java.util.ArrayList; import java.util.Collections; import java.util.List; /** * 注解处理器,处理PasswordUtils * * @author Freedom * */ public class UseCaseTracker { public static void main(String[] args) { List<Integer> useCases = new ArrayList<Integer>(); Collections.addAll(useCases, 47, 48, 49, 50); trackUseCase(useCases, PasswordUtils.class); } public static void trackUseCase(List<Integer> useCases, Class cl) { for (Method m : cl.getMethods()) { UseCase uc = m.getAnnotation(UseCase.class); if (null != uc) { System.out.println("found @UseCase id: " + uc.id() + " description: " + uc.description()); useCases.remove(new Integer(uc.id())); } } for (int i : useCases) { System.out.println("Warning:Misssing use case-" + i); } } }
3.2、注解中小插曲
注解在使用其中的元素的时候都是以名-值的形式,如下示例比较特殊。
如果注解中只有一个属性,可以直接命名为“value”,使用时无需再标明属性名。
1
2
3
4
5
6
|
@interface Author{
String value(); } @Author ( "freedom" )
public void someMethd() {
} |
4、小结
4.1、注解优点:
(1)提供完整的描述程序所需要的信息,而这些信息无法用java来表达;
(2)注解可以用来生成描述文件,甚至是新的类定义,并且有助于减轻编写“样板”代码的负担;
(3)更加简洁易懂的以及编译期的类型检查。
4.2、注解注意点
(1)属性可以被多个注解类型注解,但是同一个注解类型不能重复使用
(2)注解不支持继承
4.3、注解的声明周期
一个注解可以有三个生命周期,它默认的生命周期是保留在一个CLASS文件,但它也可以由一个@Retetion的元注解指定它的生命周期。
(1)java源文件
当在一个注解类前定义了一个@Retetion(RetentionPolicy.SOURCE)的注解,那么说明该注解只保留在一个源文件当中,当编译器将源文件编译成class文件时,它不会将源文件中定义的注解保留在class文件中。(2) class文件中
当在一个注解类前定义了一个@Retetion(RetentionPolicy.CLASS)的注解,那么说明该注解只保留在一个class文件当中,当加载class文件到内存时,虚拟机会将注解去掉,从而在程序中不能访问。
(3) 程序运行期间
当在一个注解类前定义了一个@Retetion(RetentionPolicy.RUNTIME)的注解,那么说明该注解在程序运行期间都会存在内存当中。此时,我们可以通过反射来获得定义在某个类上的所有注解。
至此,文中只为个人理解,欢迎大家批评指正......
相关推荐
java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解代码java注解...
### Eclipse Java注释模板知识点详解 #### 一、概述 在进行Java开发的过程中,良好的代码注释习惯不仅能帮助自己快速回顾代码逻辑,还能方便其他开发者理解代码意图,从而提高整个团队的工作效率。Eclipse作为一款...
Java注解是Java编程语言中的一个重要特性,它允许在代码中添加元数据,为编译器、解释器或任何其他工具提供额外的信息。在Java Web服务(WebService)开发中,注解的应用极大地简化了服务的创建和配置。本文将深入...
Java注解是Java编程语言中的一个重要特性,它们提供了一种元数据的方式,允许程序员在代码中插入信息,这些信息可以被编译器或运行时环境用于处理代码。注解不仅简化了开发,还增强了代码的可读性和维护性。本资料...
除了上述框架特定的注解,还有一些通用的Java注解,如@Override表明方法重写父类方法,@Deprecated标记已废弃的方法,@ SuppressWarnings抑制编译器警告。理解并熟练运用这些注解,能够提升代码质量,减少出错可能性...
Java注解是Java编程语言中的一个重要特性,它允许程序员在代码中嵌入元数据,这些元数据可以被编译器或运行时环境用来执行各种任务,例如代码分析、验证、生成代码、部署等。注解提供了更加灵活和可扩展的方式来处理...
Java注解是Java编程语言中的一个重要特性,它提供了一种元数据的方式,允许程序员在代码中插入额外的信息,这些信息可以被编译器或者运行时环境用来执行特定的任务。注解在现代Java开发中扮演了不可或缺的角色,尤其...
java注解和反射的个人学习笔记
本文将深入探讨Java注释的类型、用途,以及如何创建和使用注释模板,以帮助您和您的团队提升代码质量。 1. **Java注释类型**: - **单行注释**:以`//`开头,常用于快速添加临时性的注释或简单的解释。 - **多行...
Java注解是自JDK1.5版本引入的一种元数据机制,它允许程序员在源代码的各个层次(类、方法、变量等)嵌入信息,这些信息可以被编译器或者运行时系统用来进行各种处理。注解简化了配置文件的使用,提高了代码的可读性...
Java注解是Java编程语言中的一个重要特性,它允许程序员在代码中嵌入元数据(metadata),这些元数据不直接影响程序的执行,但可以被编译器或运行时环境用来进行各种处理,如验证、动态代理、持久化、资源管理等。...
本篇文章将深入探讨Java注解的使用及其在实际开发中的应用。 首先,我们了解Java注解的基本结构。一个注解以`@`符号开头,后面跟着注解类型,如`@Override`或`@Deprecated`。注解可以带有参数,参数以键值对的形式...
Java注解(Annotation)是Java语言的一个重要特性,它为元数据提供了强大的支持。元数据是一种描述数据的数据,它提供了一种安全的方式,使我们可以在不改变程序代码本身的情况下,向编译器或运行时环境提供额外的...
Java注解(Annotation)是Java语言的一个重要特性,它为元数据提供了一种结构化的方式。元数据是在程序代码中包含的关于程序本身的信息,但这些信息并不直接影响程序的执行。注解允许开发者向编译器、JVM或工具提供...
Java注解、反射、字节码和类加载机制是Java编程中的核心概念,它们在实际开发中扮演着重要角色。让我们深入探讨这些知识点。 **Java注解(Annotation)**: Java注解是一种元数据,它提供了在编译时或运行时处理代码的...
超级好用的 java 注释模板,吐血总结,整理。吐血总结,整理。
在本教程中,我们将深入探讨如何使用Spring 4框架,特别是其基于Java注解的配置方式,来构建一个高效、可维护的系统。Spring 4是Java企业级应用开发的首选框架,它提供了广泛的功能,包括依赖注入、AOP(面向切面...
Eclipse作为一款强大的Java集成开发环境(IDE),提供了许多便捷的功能,其中之一就是“Eclipse Java 注释模板”。通过配置和使用这些模板,程序员可以快速地为代码添加注释,提高代码的可读性和维护性。下面我们将...