【framework】spring-注解(annotation)

简介:

近来发现把写博客当成任务了。呵呵,调整下了下心态:我在这里写,只是希望你看到,能有所帮助。

spring注解的发展史

在spring2.5的官方指导里指出,spring从2.0开始引入了一些用于配置的annotation, 包括 @Transactional, @Required and @PersistenceContext/@PersistenceUnit.

然而我在一篇文章里,看到spring注解从1.2开始便有了,于是我不得不回头去查阅了下spring相关文档。得出如下结论:

1. spring1.0: 从1.0开始就在对元数据问题出谋划策,没有正式引入注解。但有了SOURCE级别的元数据支持

2. spring1.2: 在1.2的时候是java1.5的发布,并且面对要兼容1.3,1.4版本的问题,但已经有了基于java5.0的注解如: @ManagedResource,基本无关注。 aspectJ 在该版本中仍在建设过程中,还停留在aspect。

3. spring2.0 :有了比较多的注解,包括AspectJ已经采用了注解方法,并且支持xml配置

4. spring2.5: 引入了用于配置的完整的Annotation集合: @Autowired,以及对JSR-250注解@Resource, @PostConstruct and @PreDestroy的支持

5. spring3.0: 注解已经非常的丰富,spring的 JavaConfig项目已经加入到spring框架中,这意味着将直接支持如@Configuration,@Bean,@Value等标签

6. spring3.1: 对@Configuration有所增强,充实。 

认识注解:

我相信大家接触注解(annotation),最早应该是@Override,@Deprecated,@Suppress Warnings,就算接触不多,也没关系,我这里尽量系统的说一遍。

1. 注解:也被叫做 元数据(其实我觉得更是元数据的一种表现形式),为代码添加信息提供了一种形式化的方法,在稍后的某个时候用到这些数据

2. 元数据: 用于描述数据的数据(MetaDate),翻译成信息的信息会跟更好理解,举例来说:我这边文章就是一些数据,或者信息,而对这个文章的标题,时间,关键字,都可以称为元数据

3. 注解是元数据与源代码结合在一起,但不保存在外部文档(如xml)的趋势下催生的

阴暗的说,其实你知道上面这些也没大用,反正能写能用就成,下面介绍注解的格式 

注解的格式

注意: 注解本身不做任何事

注解可以与其他任何修饰符共同作用于方法,例如public,static或者void。从语法角度看,注解的使用方式与修饰符使用几乎一模一样。

为何说几乎,举例:

有方法:

  public void create(int i){}
和 注解
  @Test, @Test1

可以如下写法:

1.


  
  
  1. @Test  
  2. public void create(int i){} 

2.


  
  
  1. public @Test void create(int i){}  

  
  
  1. @Test public void create(int i){}   
  2. //注意不能放在void的后面 

3.


  
  
  1. public void create(@Test int i){}  

4.


  
  
  1. @Test@Test1  
  2. public void create(int i){}  
  3. //注解以@分隔,与空白符包括行(row) 无关 

 java中自定义一个注解和应用:

只举一个简单例子,算是入门。但对你理解spring注解将会是个不错的过渡,至少你能感觉到,注解原来这么简单。

例子:


  
  
  1. import java.lang.annotation.*;   
  2. @Target(ElementType.METHOD)//注解只能用于方法   
  3. @Retention(RetentionPolicy.RUNTIME)//注解在运行期也保留,可以通过反射读取注解信息   
  4. public @interface Scholar {   
  5.     public int id();   
  6.     public String descrition() default "no description";   
  7. }  
  8.  

建立一个类TestScholar 来应用@Scholar

代码:


  
  
  1. //@Scholar(id=1)//Scholar只能用于方法
  2. public class TestScholar {   
  3.     @Scholar(id=1)   
  4.     public void test() {};   
  5. } 

  效果图:
image
通过上面的例子,对注解算是有些认识。注意:
1. @Target如果你是第一次接触,不要急,下面有讲解
2. 你需要注意 注解的方式很像接口,字段定义需要加小括号
3. 注解可以有缺省,如果缺省(default),则可以不赋值

元注解

记得元数据的解释吗?是的,元注解专职负责注解其他注解 

元注解

参数

说明

@Target

  表示注解可用于什么地方
  CONSTRUCTOR 构造器的声明
  FIELD 域声明(包括enum实例)
  LOCAL_VARIABLE 局部变量声明
  METHOD 方法声明
  PACKAGE 包声明
  PARAMETER 参数声明
  TYPE 类,接口(包括注解)或者enum声明

@Retention

 

表示需要什么级别保存该注解信息

  SOURCE 注解将被编译器丢弃
  CLASS 注解在class文件中可用,会被VM丢弃
  RUNTIME VM在运行期被保留,可以通过反射机制读取注解

@Documented

 

将此注解包含在Javadoc中

@Inherited

 

允许子类集成父类中的注解

 注解类型

所有基本类型(int,float,boolean等)
String

Class
enum
Annotation
以上类型的数组

 

读取注解的内容:

通过反射机制,都会有getAnnotation()方法

如方法(Method)的: 


  
  
  1. for(Method m : of.getDeclaredMethods())  
  2. Scholar scholar = m.getAnnotation(Scholar.class)  

如果是初学,可能要去专门学习下,呵呵,这里只是为了给spring做个入门。


spring2.5 注解

spring2.5算是一个里程碑的版本,而注解2个比较大的改革便是:
1. Annotation驱动的bean配置
2. 对Spring MVC的支持

分别讲解一下:

1.Annotation驱动的bean配置

1.1 基于注解(Annotation-based)的配置

要使注解可用,您必须使用 Java 5 (Tiger)或更新的版本,以使得可以访问源代码层次的注解。这些注解可以被注册为独立 bean 的定义,但它们也可以被隐式地注册,通过基于 XML 的配置方式,如下例(请注意包含 'context' 命名空间):


  
  
  1. <?xml version="1.0" encoding="UTF-8"?> 
  2. <beans xmlns="http://www.springframework.org/schema/beans" 
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  4.        xmlns:context="http://www.springframework.org/schema/context" 
  5.        xsi:schemaLocation="http://www.springframework.org/schema/beans   
  6.            http://www.springframework.org/schema/beans/spring-beans-2.5.xsd  
  7.            http://www.springframework.org/schema/context  
  8.            http://www.springframework.org/schema/context/spring-context-2.5.xsd"> 
  9. <context:annotation-config/>     
  10.   <!--注意:xmlns:context="http://www.springframework.org/schema/context" -->        
  11.   <!--(隐式注册 post-processors 包括了
  12. AutowiredAnnotationBeanPostProcessor,
  13. CommonAnnotationBeanPostProcessor,
  14. PersistenceAnnotationBeanPostProcessor,也包括了前面提到的 RequiredAnnotationBeanPostProcessor。) -->
  15. </beans> 

1.2 @Autowired

引用些官方例子:

1)@Autowired 注解可以用于“传统的”setter 方法,如下例:


  
  
  1. public class SimpleMovieLister {  
  2.     private MovieFinder movieFinder;  
  3.     @Autowired  
  4.     public void setMovieFinder(MovieFinder movieFinder) {  
  5.         this.movieFinder = movieFinder;  
  6.     }  
  7.     // ...  
  8. } 

2)这个注解也可以用于以属性为参数/多个参数的方法


  
  
  1. public class MovieRecommender {  
  2.     private MovieCatalog movieCatalog;  
  3.     private CustomerPreferenceDao customerPreferenceDao;  
  4.  
  5.     @Autowired  
  6.     public void prepare(MovieCatalog movieCatalog,  
  7.             CustomerPreferenceDao customerPreferenceDao) {  
  8.         this.movieCatalog = movieCatalog;  
  9.         this.customerPreferenceDao = customerPreferenceDao;  
  10.     } 
  11. // ...  
  12. } 

3)@Autowired注解甚至可以用于构造器与字段:


  
  
  1. public class MovieRecommender {  
  2.     @Autowired  
  3.     private MovieCatalog movieCatalog;  
  4.     private CustomerPreferenceDao customerPreferenceDao;  
  5.     @Autowired  
  6.     public MovieRecommender(CustomerPreferenceDao customerPreferenceDao) {  
  7.         this.customerPreferenceDao = customerPreferenceDao;  
  8.     } 
  9. // ...  
  10. } 

4)也可以一种提供来自ApplicationContext的特殊类型的所有 beans,注解字段或者方法,例如:


  
  
  1. public class MovieRecommender {  
  2.     @Autowired  
  3.     private MovieCatalog[] movieCatalogs;   
  4.     // ...  
  5. } 

5)这同样适用于集合类型:


  
  
  1. public class MovieRecommender {  
  2.     private Set<MovieCatalog> movieCatalogs;  
  3.  
  4.     @Autowired  
  5.     public void setMovieCatalogs(Set<MovieCatalog> movieCatalogs) {  
  6.         this.movieCatalogs = movieCatalogs;  
  7.     }   
  8.     // ...  
  9. }  

注意:在缺省情况下,当出现0个候选的 beans时自动连接将失败;缺省行为把连接方法,构造器,字段假设为 required 的依赖。这样的行为如下所示:


  
  
  1. public class SimpleMovieLister {  
  2.     private MovieFinder movieFinder;  
  3.  
  4.     @Autowired(required = false)  
  5.     public void setMovieFinder(MovieFinder movieFinder) {  
  6.         this.movieFinder = movieFinder;  
  7.     }   
  8.     // ...  
  9. }  

1.3 基于注解的微调

1)有多个实例,需要筛选出一个,可以通过Qualifier注解


  
  
  1. public class MovieRecommender {  
  2.     @Autowired  
  3.     @Qualifier("mainCatalog")  
  4.     private MovieCatalog movieCatalog;   
  5.     // ...  
  6. } 

2)@Qualifier注解也能够被指定为构造器的参数或者方法的参数:


  
  
  1. public class MovieRecommender {  
  2.     private MovieCatalog movieCatalog;  
  3.     private CustomerPreferenceDao customerPreferenceDao;  
  4.  
  5.     @Autowired  
  6.     public void prepare(@Qualifier("mainCatalog") MovieCatalog movieCatalog,  
  7.             CustomerPreferenceDao customerPreferenceDao) {  
  8.         this.movieCatalog = movieCatalog;  
  9.         this.customerPreferenceDao = customerPreferenceDao;  
  10.     }   
  11.     // ...  
  12. } 

2.对Spring MVC的支持

Spring 2.5 为MVC 控制器引入了一种基于Annotation(注解)的编程模型, 使用@RequestMapping, @RequestParam, @ModelAttribute等等注解。 

1.要实现控制器@Controller自动探测

加入配置


  
  
  1. <!--package是要扫描的包-->
  2. <context:component-scan base-package="org.springframework.samples.petclinic.web"/> 

2.一个实例


  
  
  1. @Controller  
  2. @RequestMapping("/editPet.do")  
  3. @SessionAttributes("pet")  
  4. public class EditPetForm {  
  5.     private final Clinic clinic;  
  6.  
  7.     @Autowired  
  8.     public EditPetForm(Clinic clinic) {  
  9.         this.clinic = clinic;  
  10.     }  
  11.  
  12.     @ModelAttribute("types")  
  13.     public Collection<PetType> populatePetTypes() {  
  14.         return this.clinic.getPetTypes();  
  15.     }  
  16.  
  17.     @RequestMapping(method = RequestMethod.GET)  
  18.     public String setupForm(@RequestParam("petId") int petId, ModelMap model) {  
  19.         Pet pet = this.clinic.loadPet(petId);  
  20.         model.addAttribute("pet", pet);  
  21.         return "petForm";  
  22.     }  
  23.  
  24.     @RequestMapping(method = RequestMethod.POST)  
  25.     public String processSubmit(@ModelAttribute("pet") Pet pet,  
  26.             BindingResult result, SessionStatus status) {  
  27.         new PetValidator().validate(pet, result);  
  28.         if (result.hasErrors()) {  
  29.             return "petForm";  
  30.         } else {  
  31.             this.clinic.storePet(pet);  
  32.             status.setComplete();  
  33.             return "redirect:owner.do?ownerId=" + pet.getOwner().getId();  
  34.         }  
  35.     }  
  36. } 

spring2.5 对注解的2个主要关注点已经阐述,但是随着注解的大量应用,spring可能融入一些其他的框架,如AspectJ ,都会有自己的注解,需要大家了解并且注意,但是他并不是与spring-framework实际相关。

收尾

我想这些东西,很多人都应该写过,这里就不反复阐述。我写文章的目的,是为spring3新特征和加强(包括注解)做铺垫,有时间就写写。










本文转自 wws5201985 51CTO博客,原文链接:http://blog.51cto.com/yjplxq/976539,如需转载请自行联系原作者
目录
相关文章
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
1059 0
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
1911 128
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
1354 1
使用Spring的@Retryable注解进行自动重试
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
841 12
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
1041 2
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
863 0
探索Spring Boot的@Conditional注解的上下文配置
|
智能设计 Java 测试技术
Spring中最大化@Lazy注解,实现资源高效利用
本文深入探讨了 Spring 框架中的 `@Lazy` 注解,介绍了其在资源管理和性能优化中的作用。通过延迟初始化 Bean,`@Lazy` 可显著提升应用启动速度,合理利用系统资源,并增强对 Bean 生命周期的控制。文章还分析了 `@Lazy` 的工作机制、使用场景、最佳实践以及常见陷阱与解决方案,帮助开发者更高效地构建可扩展、高性能的 Spring 应用程序。
551 0
Spring中最大化@Lazy注解,实现资源高效利用
|
安全 IDE Java
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
本文介绍了如何在 Spring 应用程序中使用 Project Lombok 的 `@Data` 和 `@FieldDefaults` 注解来减少样板代码,提升代码可读性和可维护性,并探讨了其适用场景与限制。
445 0
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
|
Java 测试技术 编译器
@GrpcService使用注解在 Spring Boot 中开始使用 gRPC
本文介绍了如何在Spring Boot应用中集成gRPC框架,使用`@GrpcService`注解实现高效、可扩展的服务间通信。内容涵盖gRPC与Protocol Buffers的原理、环境配置、服务定义与实现、测试方法等,帮助开发者快速构建高性能的微服务系统。
2106 0
|
XML Java 测试技术
使用 Spring 的 @Import 和 @ImportResource 注解构建模块化应用程序
本文介绍了Spring框架中的两个重要注解`@Import`和`@ImportResource`,它们在模块化开发中起着关键作用。文章详细分析了这两个注解的功能、使用场景及最佳实践,帮助开发者构建更清晰、可维护和可扩展的Java应用程序。
589 0