`

学习Spring必学的Java基础知识(5)----注解

 
阅读更多
引述要学习Spring框架的技术内幕,必须事先掌握一些基本的Java知识,正所谓“登高必自卑,涉远必自迩”。以下几项Java知识和Spring框架息息相关,不可不学(我将通过一个系列分别介绍这些Java基础知识,希望对大家有所帮助。):

[1] Java反射知识-->Spring IoC :http://www.iteye.com/topic/1123081
[2] Java动态代理-->Spring AOP :http://www.iteye.com/topic/1123293
[3] 属性编辑器,即PropertyEditor-->Spring IoC:http://www.iteye.com/topic/1123628
[4] XML基础知识-->Spring配置:http://www.iteye.com/topic/1123630
[5] 注解-->Spring配置:http://www.iteye.com/topic/1123823
[6] 线程本地变更,即ThreadLocal-->Spring事务管理:http://www.iteye.com/topic/1123824
[7] 事务基础知识-->Spring事务管理:http://www.iteye.com/topic/1124043
[8] 国际化信息-->MVC:http://www.iteye.com/topic/1124044
[9] HTTP报文-->MVC:http://www.iteye.com/topic/1124408



有必要对JDK 5.0新增的注解(Annotation)技术进行简单的学习,因为Spring 支持@AspectJ,而@AspectJ本身就是基于JDK 5.0的注解技术。所以学习JDK 5.0的注解知识有助于我们更好地理解和掌握Spring的AOP技术。

了解注解

对于Java开发人员来说,在编写代码时,除了源程序以外,我们还会使用Javadoc标签对类、方法或成员变量进行注释,以便使用Javadoc工具生成和源代码配套的Javadoc文档。这些@param、@return等Javadoc标签就是注解标签,它们为第三方工具提供了描述程序代码的注释信息。使用过Xdoclet的朋友,对此将更有感触,像Struts、Hibernate都提供了Xdoclet标签,使用它们可以快速地生成对应程序代码的配置文件。

JDK5.0注解可以看成是Javadoc标签和Xdoclet标签的延伸和发展。在JDK5.0中,我们可以自定义这些标签,并通过Java语言的反射机制中获取类中标注的注解,完成特定的功能。
注解是代码的附属信息,它遵循一个基本原则:注解不能直接干扰程序代码的运行,无论增加或删除注解,代码都能够正常运行。Java语言解释器会忽略这些注解,而由第三方工具负责对注解进行处理。第三方工具可以利用代码中的注解间接控制程序代码的运行,它们通过Java反射机制读取注解的信息,并根据这些信息更改目标程序的逻辑,而这正是Spring AOP对@AspectJ提供支持所采取的方法。

引用
很多东西的设计都必须遵循最基本的原则,为了防止机器人伤害人类,科幻作家阿西莫夫于1940年提出了“机器人三原则”:第一,机器人不能伤害人类;第二,机器人应遵守人类的命令,与第一条违背的命令除外;第三,机器人应能保护自己,与第一条违背的命令除外。这是给机器人赋予的伦理性纲领,机器人学术界一直将这三条原则作为机器人开发的准则。


一个简单的注解类

通常情况下,第三方工具不但负责处理特定的注解,本身还提供了这些注解的定义,所以我们通常仅需关注如何使用注解就可以了。但定义注解类本身并不困难,Java提供了定义注解的语法。下面,我们马上着手编写一个简单的注解类,如代码清单7-1所示:

代码清单7-1  NeedTest注解类
package com.baobaotao.aspectj.anno;
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.METHOD)//②声明可以使用该注解的目标类型
public @interface NeedTest {//③定义注解
	boolean value() default true;//④声明注解成员
}


Java新语法规定使用@interface修饰符定义注解类,如③所示,一个注解可以拥有多个成员,成员声明和接口方法声明类似,这里,我们仅定义了一个成员,如④所示。成员的声明有以下几点限制:

  • 成员以无入参无抛出异常的方式声明,如boolean value(String str)、boolean value() throws Exception等方式是非法的;
  • 可以通过default为成员指定一个默认值,如String level() default "LOW_LEVEL"、int high() default 2是合法的,当然也可以不指定默认值;
  • 成员类型是受限的,合法的类型包括原始类型及其封装类、String、Class、enums、注解类型,以及上述类型的数组类型。如ForumService value()、List foo()是非法的。


在①和②处,我们所看到的注解是Java预定义的注解,称为元注解(Meta-Annotation),它们被Java编译器使用,会对注解类的行为产生影响。@Retention(RetentionPolicy. RUNTIME)表示NeedTest这个注解可以在运行期被JVM读取,注解的保留期限类型在java.lang.annotation.Retention类中定义,介绍如下:

  • SOURCE:注解信息仅保留在目标类代码的源码文件中,但对应的字节码文件将不再保留;
  • CLASS:注解信息将进入目标类代码的字节码文件中,但类加载器加载字节码文件时不会将注解加载到JVM中,也即运行期不能获取注解信息;
  • RUNTIME:注解信息在目标类加载到JVM后依然保留,在运行期可以通过反射机制读取类中注解信息。
  •    Target(ElementType.METHOD)表示NeedTest这个注解只能应用到目标类的方法上,注解的应用目标在java.lang.annotation.ElementType类中定义:
  • TYPE:类、接口、注解类、Enum声明处,相应的注解称为类型注解;
  • FIELD:类成员变量或常量声明处,相应的注解称为域值注解;
  • METHOD:方法声明处,相应的注解称为方法注解;
  • PARAMETER:参数声明处,相应的注解称为参数注解;
  • CONSTRUCTOR:构造函数声明处,相应的注解称为构造函数注解;
  • LOCAL_VARIABLE:局部变量声明处,相应的注解称为局域变量注解;
  • ANNOTATION_TYPE:注解类声明处,相应的注解称为注解类注解,ElementType. TYPE包括ElementType.ANNOTATION_TYPE;
  • PACKAGE:包声明处,相应的注解称为包注解。


如果注解只有一个成员,则成员名必须取名为value(),在使用时可以忽略成员名和赋值号(=),如@NeedTest(true)。注解类拥有多个成员时,如果仅对value成员进行赋值则也可不使用赋值号,如果同时对多个成员进行赋值,则必须使用赋值号,如DeclareParents (value = "NaiveWaiter", defaultImpl = SmartSeller.class)。注解类可以没有成员,没有成员的注解称为标识注解,解释程序以标识注解存在与否进行相应的处理;此外,所有的注解类都隐式继承于java.lang.annotation.Annotation,但注解不允许显式继承于其他的接口。

我们希望使用NeedTest注解对业务类的方法进行标注,以便测试工具可以根据注解情况激活或关闭对业务类的测试。在编写好NeedTest注解类后,就可以在其他类中使用它了。

使用注解

我们在ForumService中使用NeedTest注解,标注业务方法是否需要测试,如代码清单7-2所示:

代码清单7-2  ForumService:使用注解
package com.baobaotao.aspectj.anno;
public class ForumService {
    @NeedTest(value=true) ①
	public void deleteForum(int forumId){
		System.out.println("删除论坛模块:"+forumId);
	}
    @NeedTest(value=false) ②
    public void deleteTopic(int postId){
		System.out.println("删除论坛主题:"+postId);
	}	
}


如果注解类和目标类不在同一个包中,需要通过import引用的注解类。在①和②处,我们使用NeedTest分别对deleteForum()和deleteTopic()方法进行标注。在标注注解时,可以通过以下格式对注解成员进行赋值:

引用
@<注解名>(<成员名1>=<成员值1>,<成员名1>=<成员值1>,...)


如果成员是数组类型,可以通过{}进行赋值,如boolean数组的成员可以设置为{true,false,true}。下面是几个注解标注的例子:

示例1,多成员的注解:
@AnnoExample(id= 2868724, synopsis = "Enable time-travel",
engineer = "Mr. Peabody",date = "4/1/2007")


示例2,一个成员的注解,成员名为value。可以省略成员名和赋值符号:

@Copyright("2011 bookegou.com All Right Reserved")


示例3,无成员的注解:

@Override


示例4,成员为字符串数组的注解:
@SuppressWarnings(value={"unchecked","fallthrough"})


示例5,成员为注解数组类型的注解:
@Reviews({@Review(grade=Review.Grade.EXCELLENT,reviewer="df"),      
           @Review(grade=Review.Grade.UNSATISFACTORY,reviewer="eg",              
                    comment="This method needs an @Override annotation")})


@Reviews注解拥有一个@Review注解数组类型的成员,@Review注解类型有三个成员,其中reviewer、comment都是String类型,但comment有默认值,grade是枚举类型的成员。

由于NeedTest注解的保留限期是RetentionPolicy.RUNTIME类型,因此当ForumService被加载到JVM时,仍就可通过反射机制访问到ForumService各方法的注解信息。

访问注解

前面提到过,注解不会直接影响程序的运行,但是第三方程序或工具可以利用代码中的注解完成特殊的任务,间接控制程序的运行。对于RetentionPolicy.RUNTIME保留期限的注解,我们可以通过反射机制访问类中的注解。

在JDK5.0里,Package、Class、Constructor、Method以及Field等反射对象都新增了访问注解信息的方法:<T extends Annotation>T getAnnotation(Class<T> annotationClass),该方法支持通过泛型直接返回注解对象。

下面,我们就通过反射来访问注解,得出ForumService 类中通过@NeedTest注解所承载的测试需求,如代码清单7-3所示:

代码清单7-3  TestTool:访问代码中的注解
package com.baobaotao.aspectj.anno;
import java.lang.reflect.Method;
public class TestTool {
	public static void main(String[] args) {
                
               //①得到ForumService对应的Class对象
		Class clazz = ForumService.class; 

                //②得到ForumSerivce对应的Method数组
		Method[] methods = clazz.getDeclaredMethods(); 

		System.out.println(methods.length);
		for (Method method : methods) {

                        //③获取方法上所标注的注解对象
			NeedTest nt = method.getAnnotation(NeedTest. class);
			if (nt != null) {
				if (nt.value()) {
					System.out.println(method.getName() + "()需要测试");
				} else {
					System.out.println(method.getName() + "()不需要测试");
				}
			}
		}
	}
}


在③处,通过方法的反射对象,我们获取了方法上所标注的NeedTest注解对象,接着就可以访问注解对象的成员,从而得到ForumService类方法的测试需求。运行以上代码,输出以下的信息:

引用
deleteForum()需要测试
deleteTopic()不需要测试


这些文章摘自于我的《Spring 4.x企业应用开发实战》,我将通过连载的方式,陆续在此发出。欢迎大家讨论。
  • 大小: 25.2 KB
分享到:
评论
1 楼 wslovenide 2013-01-21  

相关推荐

    学习Spring必学的Java基础知识(3)—PropertyEditor

    在深入学习Spring框架之前,掌握基础的Java知识是至关重要的,特别是关于`PropertyEditor`的部分。`PropertyEditor`是Java中用于类型转换的关键组件,它允许我们自定义数据类型的转换规则,这对于处理用户输入或者在...

    Spring基础知识汇总Java开发必看

    学习Spring基础知识对Java开发者至关重要,它能帮助你构建高效、可维护的后端应用,并为后续深入学习Spring全家桶打下坚实基础。在实际项目中,结合其他Spring模块和最佳实践,可以构建出满足现代企业需求的复杂系统...

    Java Spring学习路线.pdf

    上述提到的Spring学习路线涵盖了从基础到高级的多个方面,包括了IOC、AOP、JDBC模板的使用和事务管理等核心内容。掌握这些知识点对于高效开发高质量的Java后端应用至关重要。对于Java后台开发人员而言,深入学习和...

    spring-mvc-step-by-step中文版

    ### Spring MVC Step-by-Step中文版知识点概览 #### 一、Spring框架核心概念与组成部分 **1.... - **定义**:控制反转是一种...对于希望深入了解Spring MVC并具备一定Java基础的学习者来说,这份教程将是宝贵的资源。

    java学习计划2023-.zip

    在Java学习过程中,一个系统的学习计划能够帮助初学者...这个学习计划覆盖了从基础到进阶的全面Java知识体系,适合希望系统学习Java的人群。遵循这样的计划,开发者可以逐步提升技能,为从事Java开发工作做好充分准备。

    2020最新Java企业面试题汇总-1000多份.txt

    ### 一、Java基础知识 #### 1. Java语言特点 - **面向对象**:封装、继承、多态。 - **平台无关性**:通过JVM实现跨平台运行。 - **自动垃圾回收**:避免内存泄露问题。 #### 2. 数据类型 - **基本数据类型**:...

    《java学习》-Java学习过程中笔记的配套代码.zip

    10. **java-basic**:这部分是Java基础知识,涵盖了类、对象、封装、继承、多态等面向对象编程的核心概念,还有异常处理、I/O流、集合框架等Java SE的关键特性。 通过这个压缩包,学习者不仅可以理论学习,还能动手...

    【Java毕业设计】毕业设计前期学习java spring系列框架.zip

    本资源包“【Java毕业设计】毕业设计前期学习java spring系列框架.zip”可能是为了帮助学生在毕业设计阶段系统地学习和理解Spring框架的基础知识和核心概念。 Spring框架主要由以下几个部分组成: 1. **Spring ...

    JAVA笔试面试宝典--JAVA笔试面试必看

    一、Java基础 1. Java语法:理解基本的类、对象、接口、继承和多态等概念,熟悉构造器、方法重载和重写、访问修饰符的区别。 2. 面向对象编程:深入理解封装、继承和多态的含义,以及如何在实际项目中应用。 3. ...

    java面试笔试资料包括JAVA基础核心知识点深度学习Spring面试题等资料合集.zip

    java面试笔试资料包括JAVA基础核心知识点深度学习Spring面试题等资料合集: JAVA核心知识点整理-282页 Java与哈希算法.docx Java中Lambda表达式的使用.docx JAVA多线程之线程间的通信方式.docx Java注解详解.docx ...

    spring02-5

    本篇文章将详细讲解标题"spring02-5"所涉及的知识点,即如何通过注解在Spring框架中管理类。 首先,让我们了解什么是类的注解。在编程中,注解是一种元数据,它提供了有关代码的信息,但不会改变代码的行为。在...

    java学习路线图以及学习java要学习的东西

    在学习过程中,不断通过编写小程序、参与开源项目或解决实际问题来巩固所学知识。同时,阅读优秀的Java代码,参考设计模式,将理论知识转化为实践经验。 总的来说,Java学习不仅需要理解语法和概念,还需要通过大量...

    spring学习: spring mvc基础

    在IT行业中,Spring框架是Java...理解并掌握Spring MVC的基础知识,对于成为一名优秀的Java开发者是必不可少的。通过不断的实践和学习,你可以进一步提升在Spring MVC上的技能,构建出更加复杂且健壮的Web应用程序。

    java 学习资料大全

    一、Java基础知识 1. 类与对象:Java是一种面向对象的语言,学习Java首先要理解类的概念,它是创建对象的模板。对象则是程序中的具体实例,包含了数据和行为。 2. 变量与数据类型:Java有八种基本数据类型,包括整型...

    阿里巴巴Java开发手册、sql、Spring2.0、由浅入深学Java—基础、进阶与必做260题.pdf

    《由浅入深学Java—基础、进阶与必做260题.pdf》这本书可能是一个全面的Java学习资源,包含基础语法讲解、进阶概念介绍,并配以大量的练习题,帮助读者巩固知识。基础部分可能会涵盖变量、数据类型、流程控制等;...

    spring源码-2022-08-14spring源码spring源码spring源码

    - **依赖注入**:Spring如何通过XML、注解或Java配置实现bean的创建、初始化和装配。 - **AOP代理**:Spring如何使用JDK动态代理和CGLIB来实现AOP代理,以及切点表达式和通知的工作原理。 - **事件驱动**:Spring中...

    java常用技术整理-基础架构方面.rar

    这份"java常用技术整理-基础架构方面.rar"的压缩包文件很可能包含了一系列关于Java基础架构技术的文章、笔记或教程,旨在帮助开发者系统地学习和掌握这些知识。 首先,Java的基础架构涉及JVM(Java虚拟机)。JVM是...

    spring学习必备(中文)

    学习Spring的过程中,你需要理解Bean的生命周期、不同类型的注解如@Service、@Repository、@Controller、@Autowired等,以及如何配置和使用Spring的IoC容器。此外,Spring AOP的切点表达式、通知类型以及如何创建...

    Spring基础知识详解

    下面将对Spring的基础知识进行详细的解释。 1. **依赖注入(Dependency Injection,DI)**:Spring的核心特性,它允许开发者通过外部配置来管理对象及其依赖关系,而不是在代码中硬编码这些依赖。这样可以提高代码...

    编程学习总结 包括 Java基础、Java并发、JVM、MySQL、Redis、Spring、MyBatis、RocketMQ

    1. **Java基础**:Java的基础知识涵盖语法、类、对象、接口、异常处理、集合框架等。理解这些基本概念是进一步深入学习Java的前提。例如,了解如何声明变量、编写方法、创建类与对象,以及掌握集合类如ArrayList、...

Global site tag (gtag.js) - Google Analytics