0
点赞
收藏
分享

微信扫一扫

Spring——spring常用注解原理


摘要

spring中注解本身没有功能的,就和 xml 一样。注解和 xml 都是一种元数据,元数据即解释数据的数据,这就是所谓配置。因此需要了解spring的常用注解的加载原理,本博文将介绍的spring中常用的注解类型和使用,同时将分析注解的加载和配置原理,帮助大家更好理解和使用spring的注解的功能。

一、spring常用注解

1.1 声明bean的注解

@Component 组件,没有明确的角色:​​@Component​​​ :通用的注解,可标注任意类为 ​​Spring​​​ 组件。如果一个 Bean 不知道属于哪个层,可以使用​​@Component​​ 注解标注。

@Service 在业务逻辑层使用(service层):对应服务层,主要涉及一些复杂的逻辑,需要用到 Dao 层。

@Repository 在数据访问层使用(dao层):对应持久层即 Dao 层,主要用于数据库相关操作

@Controller 在展现层使用,控制器的声明(C):对应 Spring MVC 控制层,主要用户接受用户请求并调用 Service 层返回数据给前端页面。

@​​RestController​​​;​​​@RestController​​​注解是​​@Controller和​​​@​​ResponseBody​​的合集,表示这是个控制器 bean,并且是将函数的返回值直 接填入 HTTP 响应体中,是 REST 风格的控制器。

单独使用 ​​@Controller​​​ 不加 ​​@ResponseBody​​​的话一般使用在要返回一个视图的情况,这种情况属于比较传统的 Spring MVC 的应用,对应于前后端不分离的情况。​​@Controller​​​ +​​@ResponseBody​​ 返回 JSON 或 XML 形式数据

1.2 注入bean的注解

@Autowired:由Spring提供:自动导入对象到类中,被注入进的类同样要被 Spring 容器管理比如:Service 类注入到 Controller 类中。

@Service
public class UserService {
……
}
@RestController
@RequestMapping("/users")
public class UserController {
@Autowired
private UserService userService;
}

@Inject:由JSR-330提供

@Resource:由JSR-250提供

都可以注解在set方法和属性上,推荐注解在属性上(一目了然,少写代码)

1.3 java配置类相关注解

@Configuration 声明当前类为配置类,相当于xml形式的Spring配置(类上)

@Bean 注解在方法上,声明当前方法的返回值为一个bean,替代xml中的方式(方法上)

@Configuration 声明当前类为配置类,其中内部组合了:一般用来声明配置类,可以使用 ​​@Component​​​注解替代,不过使用​​Configuration​​注解声明配置类更加语义化。

@Configuration
public class AppConfig {
@Bean
public TransferService transferService( {
return new TransferServiceImplO;
}
}

@Component注解,表明这个类是一个bean(类上)

@ComponentScan 用于对Component进行扫描,相当于xml中的(类上)

@WishlyConfiguration 为@Configuration与@ComponentScan的组合注解,可以替代这两个注解1.4

1.4 切面(AOP)相关注解

Spring支持AspectJ的注解式切面编程。

@Aspect 声明一个切面(类上)

使用@After、@Before、@Around定义建言(advice),可直接将拦截规则(切点)作为参数。

@After 在方法执行之后执行(方法上)

@Before 在方法执行之前执行(方法上)

@Around 在方法执行之前与之后执行(方法上)

@PointCut 声明切点

在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持(类上)

1.5 @Bean的属性支持

@Scope 设置Spring容器如何新建Bean实例(方法上,得有@Bean)

其设置类型包括:

  • Singleton (单例,一个Spring容器中只有一个bean实例,默认模式),
  • Protetype (每次调用新建一个bean),
  • Request (web项目中,给每个http request新建一个bean),
  • Session (web项目中,给每个http session新建一个bean),
  • GlobalSession(给每一个 global http session新建一个Bean实例)

@StepScope 在Spring Batch中还有涉及

@PostConstruct 由JSR-250提供,在构造函数执行完之后执行,等价于xml配置文件中bean的initMethod

@PreDestory 由JSR-250提供,在Bean销毁之前执行,等价于xml配置文件中bean的destroyMethod

1.6 @Value注解

@Value 为属性注入值(属性上)

支持如下方式的注入:

注入普通字符

@Value("Michael Jackson")
String name;

注入操作系统属性

@Value("#{systemProperties['os.name']}")
String osName;

注入表达式结果

@Value("#{ T(java.lang.Math).random()* 100 }")
String randomNumber;

注入其它bean属性

@Value("#{domeClass.name}")
String name;

注入文件资源

@Value("classpath:com/hgs/hello/test.txt")
String Resource file;

注入网站资源

@Value("http://www.javastack.cn")
Resource url;

注入配置文件

Value("${book.name}")
String bookName;

注入配置使用方法:

① 编写配置文件(test.properties)book.name=《三体》

② @PropertySource 加载配置文件(类上)

@PropertySource("classpath:com/hgs/hello/test/test.propertie")

③ 还需配置一个PropertySourcesPlaceholderConfigurer的bean。

1.7 环境切换

@Profile 通过设定Environment的ActiveProfiles来设定当前context需要使用的配置环境。(类或方法上)

@Conditional Spring4中可以使用此注解定义条件话的bean,通过实现Condition接口,并重写matches方法,从而决定该bean是否被实例化。(方法上)

1.8 异步相关

@EnableAsync配置类中,通过此注解开启对异步任务的支持,叙事性AsyncConfigurer接口(类上)

@Async 在实际执行的bean方法使用该注解来申明其是一个异步任务(方法上或类上所有的方法都将异步,需要@EnableAsync开启异步任务)

1.9 定时任务相关

@EnableScheduling 在配置类上使用,开启计划任务的支持(类上)

@Scheduled 来申明这是一个任务,包括cron,fixDelay,fixRate等类型(方法上,需先开启计划任务的支持)

1.10 @Enable*注解说明

这些注解主要用来开启对xxx的支持。

@EnableAspectJAutoProxy 开启对AspectJ自动代理的支持

@EnableAsync 开启异步方法的支持

@EnableScheduling 开启计划任务的支持

@EnableWebMvc 开启Web MVC的配置支持

@EnableConfigurationProperties 开启对@ConfigurationProperties注解配置Bean的支持

@EnableJpaRepositories 开启对SpringData JPA Repository的支持

@EnableTransactionManagement 开启注解式事务的支持

@EnableCaching 开启注解式的缓存支持

1.11 测试相关注解

@RunWith 运行器,Spring中通常用于对JUnit的支持

@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration 用来加载配置ApplicationContext,其中classes属性用来加载配置类

@ContextConfiguration(classes={TestConfig.class})

1.12 SpringMVC相关注解

@EnableWebMvc 在配置类中开启Web MVC的配置支持,如一些ViewResolver或者MessageConverter等,若无此句,重写WebMvcConfigurerAdapter方法(用于对SpringMVC的配置)。

@Controller 声明该类为SpringMVC中的Controller(也是单例的,在多线程下面可能存在问题 使用threadloacl这样的一种方式来实现)

@RequestMapping 用于映射Web请求,包括访问路径和参数(类或方法上):5 种常见的请求类型:

  • GET :请求从服务器获取特定资源。举个例子:​​GET /users​​​(获取所有学生):​​@GetMapping("users")​​​ 等价于​​@RequestMapping(value="/users",method=RequestMethod.GET)​
  • POST :在服务器上创建一个新的资源。举个例子:​​POST /users​​​(创建学生):​​@PostMapping("users")​​​ 等价于​​@RequestMapping(value="/users",method=RequestMethod.POST)​
  • PUT :更新服务器上的资源(客户端提供更新后的整个资源)。举个例子:​​PUT /users/12​​​(更新编号为 12 的学生):​​@PutMapping("/users/{userId}")​​​ 等价于​​@RequestMapping(value="/users/{userId}",method=RequestMethod.PUT)​
  • DELETE :从服务器删除特定的资源。举个例子:​​DELETE /users/12​​​(删除编号为 12 的学生):​​@DeleteMapping("/users/{userId}")​​​等价于​​@RequestMapping(value="/users/{userId}",method=RequestMethod.DELETE)​
  • PATCH :更新服务器上的资源(客户端提供更改的属性,可以看做作是部分更新),使用的比较少,这里就不举例子了。

@ResponseBody 支持将返回值放在response内,而不是一个页面,通常用户返回json数据(返回值旁或方法上):用于读取 Request 请求(可能是 POST,PUT,DELETE,GET 请求)的 body 部分并且Content-Type 为 application/json 格式的数据,接收到数据之后会自动将数据绑定到 Java 对象上去。系统会使用​​HttpMessageConverter​​​或者自定义的​​HttpMessageConverter​​将请求的 body 中的 json 字符串转换为 java 对象。

@RequestBody 允许request的参数在request体中,而不是在直接连接在地址后面。(放在参数前)

@PathVariable 用于接收路径参数,比如@RequestMapping(“/hello/{name}”)申明的路径,将注解放在参数中前,即可获取该值,通常作为Restful的接口实现方法。

@RestController 该注解为一个组合注解,相当于@Controller和@ResponseBody的组合,注解在类上,意味着,该Controller的所有方法都默认加上了@ResponseBody。

@ControllerAdvice 通过该注解,我们可以将对于控制器的全局配置放置在同一个位置,注解了@Controller的类的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上,这对所有注解了 @RequestMapping的控制器内的方法有效。

@ExceptionHandler:用于全局处理控制器里的异常

@InitBinder:用来设置WebDataBinder,WebDataBinder用来自动绑定前台请求参数到Model中。

@ModelAttribute:本来的作用是绑定键值对到Model里,在@ControllerAdvice中是让全局的@RequestMapping都能获得在此处设置的键值对。

@Required注解:这个注解表明bean的属性必须在配置的时候设置,通过一个bean定义的显式的属性值或通过自动装配,若@Required注解的bean属性未被设置,容器将抛出BeanInitializationException。

@Autowired注解:@Autowired注解提供了更细粒度的控制,包括在何处以及如何完成自动装配。它的用法和@Required一样,修饰setter方法、构造器、属性或者具有任意名称和/或多个参数的PN方法。

@Qualifier注解:当有多个相同类型的bean却只有一个需要自动装配时,将@Qualifier注解和@Autowire注解结合使用以消除这种混淆,指定需要装配的确切的bean。

二、Spring的@注解的加载原理

博文参考

举报

相关推荐

0 条评论