Spring Framework模式注解

模式注解是一种用于声明在应用中扮演“组件”角色的注解。如 Spring Framework 中的 @Repository 标注在任何类上 ,用

于扮演仓储角色的模式注解。

模式注解(角色注解)

Spring Framework 注解 场景说明
@Component 通用组件模式注解
@Controller Web 控制器模式注解
@Service 服务模式注解
@Repository 数据仓储模式注解
@Configuration 配置类模式注解

在Spring中进行装配context:component-scan 方式

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-
context.xsd">
<!-- 激活注解驱动特性 -->
<context:annotation-config />
<!-- 找寻被 @Component 或者其派生 Annotation 标记的类(Class),将它们注册为 Spring Bean -->
<context:component-scan base-package="com.imooc.dive.in.spring.boot" />
</beans>

在Spring中基于Java注解配置方式

@ComponentScan(basePackages = "com.imooc.dive.in.spring.boot")
public class SpringConfiguration {
...
}

实战:自定义模式注解

@Component 模式注解具有“派生性”和“层次性”,我们能够自定义创建Bean注解

第一步:自定义SpringBean注解

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface MyServiceAnnotation {
String value() default "";
}

第二步:将注解作用在自定义Bean上

@MyServiceAnnotation(value = "testBean")
public class TestBean { }

第三步:测试是否可以从Spring容器中获取到自定义Bean

@SpringBootApplication
public class Main {
public static void main(String[] args) {
ConfigurableApplicationContext run = SpringApplication.run(Main.class, args);
TestBean testBean = run.getBean("testBean", TestBean.class);
System.out.println("testBean" + testBean.toString());
run.close();
}
}

Spring Framework@Enable模块装配

Spring Framework 3.1 开始支持”@Enable 模块驱动“。所谓“模块”是指具备相同领域的功能组件集合, 组合所形成一个独立的单元。比如 Web MVC 模块、AspectJ代理模块、Caching(缓存)模块、JMX(Java 管 理扩展)模块、Async(异步处理)模块等。

@Enable 注解模块举例

框架实现 @Enable 注解模块 激活模块
Spring Framework @EnableWebMvc Web MVC 模块
Spring Framework @EnableTransactionManagement 事务管理模块
Spring Framework @EnableCaching Caching 模块
Spring Framework @EnableMBeanExport JMX 模块
Spring Framework @EnableAsync 异步处理模块
Spring Framework @EnableWebFlux Web Flux 模块
Spring Framework @EnableAspectJAutoProxy AspectJ 代理模块
Spring Boot @EnableAutoConfiguration 自动装配模块
Spring Boot @EnableManagementContext Actuator 管理模块
Spring Boot @EnableConfigurationProperties 配置属性绑定模块
Spring Boot @EnableOAuth2Sso OAuth2 单点登录模块
......

@Enable实现方式

  • 注解驱动方式
  • 接口编程方式

实战:自定义@Enable注解驱动实现方式

第一步:实现自定义注解@EnableMyBean

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(MyBeanConfig.class)
public @interface EnableMyBean {
}

PS:注意@Import(MyBeanConfig.class),将导入MyBeanConfig配置类的相关Bean

第二步:创建MyBeanConfig配置类

@Configuration
public class MyBeanConfig {
@Bean(name = "hello")
public String hello() {
return "word";
}
}

第三步:在应用中测试使用@EnableMyBean

@SpringBootApplication(scanBasePackages = "com.jimisun.learnspringboot.three")
@EnableMyBean
public class Main {
public static void main(String[] args) {
ConfigurableApplicationContext context =
new SpringApplicationBuilder(Main.class)
.web(WebApplicationType.NONE)
.run(args);
String bean = context.getBean("hello", String.class);
context.close(); }
}

实战:自定义@Enable接口实现方式

第一步:实现自定义注解@EnableMyBean

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(MyBeanConfigSelector.class)
public @interface EnableMyBean {
}

PS:注意@Import(MyBeanConfigSelector.class)导入的类和@Enable注解驱动导入的不一样,这里导入的是一个实现了ImportSelector接口的类

public class MyBeanConfigSelector implements ImportSelector {

    @Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
return new String[]{new MyBeanConfig().getClass().getName()};
}
}

PS:在MyBeanConfigSelector类中我们可以自定义复杂的逻辑,这里我们仅仅简单返回MyBeanConfig配置类。

第三步:创建MyBeanConfig配置类

@Configuration
public class MyBeanConfig {
@Bean
public String hello() {
return "word";
}
}

第四步:在应用中测试使用@EnableMyBean

@SpringBootApplication(scanBasePackages = "com.jimisun.learnspringboot.four")
@EnableMyBean
public class Main {
public static void main(String[] args) {
ConfigurableApplicationContext context =
new SpringApplicationBuilder(Main.class)
.web(WebApplicationType.NONE)
.run(args);
String bean = context.getBean("hello", String.class);
context.close(); }
}

PS:其实@Enable接口的实现方式和@Enable注解实现方式是基本一样的,只不过多了一个步骤,方便我们更灵活地进行编写逻辑。

Spring Framework条件装配

从 Spring Framework 3.1 开始,允许在 Bean 装配时增加前置条件判断

Spring 注解 场景说明 起始版本
@Profile 配置化条件装配 3.1
@Conditional 编程条件装配 4.0

实战:自定义@Profile 配置化条件装配

第一步:自定义创建某服务不同的@Profile实现类

public interface UserService {
void println();
}
@Service
@Profile("vip")
public class VipUserservice implements UserService {
@Override
public void println() {
System.out.println("I am VIP User");
}
}
@Service
@Profile("common")
public class CommonUserservice implements UserService {
@Override
public void println() {
System.out.println("I am Common User");
}
}

第二步:在构建Spring容器指定配置

@ComponentScan(basePackages = "com.jimisun.learnspringboot.two")
public class Main { public static void main(String[] args) {
ConfigurableApplicationContext run = new SpringApplicationBuilder(Main.class).
web(WebApplicationType.NONE).
profiles("vip").
run(args);
UserService bean = run.getBean(UserService.class);
bean.println();
run.close();
}
}

实战:自定义@Conditional 编程条件装配

第一步:创建一个自定义注解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({MyOnConditionProperty.class})
public @interface MyConditionOnPropertyAnnotion {
String prefix() default "";
}

PS:注意@Conditional注解,将会找到MyOnConditionProperty类的matches方法进行条件验证

第二步:创建该注解的条件验证类,该类实现Condition接口

public class MyOnConditionProperty implements Condition {

    @Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
Map<String, Object> annotationAttributes =
annotatedTypeMetadata.getAnnotationAttributes(MyConditionOnPropertyAnnotion.class.getName());
String prefix = String.valueOf(annotationAttributes.get("prefix"));
return prefix.equals("pass");
}
}

第三步:在Spring应用中应用条件装配

@SpringBootApplication
public class Main { @Bean(name = "hello")
@MyConditionOnPropertyAnnotion(prefix = "pass")
public String hello() {
return "word";
} public static void main(String[] args) {
ConfigurableApplicationContext context =
new SpringApplicationBuilder(Main.class)
.web(WebApplicationType.NONE)
.run(args);
String bean = context.getBean("hello", String.class);
context.close(); }
}

PS:本例自定义的MyConditionOnPropertyAnnotion在应用中装配的时候可以指定prefix值,该值将会在实现了Condition借口的matches进行条件验证,如果验证通过,则在Spring容器中装配该Bean,反之则不装配。

SpringBoot 自动装配

在 Spring Boot 场景下,基于约定大于配置的原则,实现 Spring 组件自动装配的目的。其中底层使用了一系列的Spring Framework手动装配的方法来构成Spring Boot自动装配。

自定义SpringBoot自动装配

  1. 激活自动装配 - @EnableAutoConfiguration
  2. 实现自动装配 - XXXAutoConfiguration
  3. 配置自动装配实现 - META-INF/spring.factories

第一步 :激活自动装配 - @EnableAutoConfiguration

@EnableAutoConfiguration
public class Main {
public static void main(String[] args) {
ConfigurableApplicationContext context =
new SpringApplicationBuilder(Main.class)
.web(WebApplicationType.NONE)
.run(args);
String bean = context.getBean("hello", String.class);
context.close(); }
}

第二步:实现自动装配 - XXXAutoConfiguration

@Configuration
@EnableMyBean
public class HelloWordAutoConfiguration {
}

PS:这里使用了上面我们创建的@EnableMyBean,这个注解会注入一个名为“hello"的Bean

第三步:配置自动装配实现 - META-INF/spring.factories

在ClassPath目录下创建META-INF文件夹再创建spring.factories文件

#配置自己的自动装配Bean
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.jimisun.learnspringboot.five.HelloWordAutoConfiguration

最后:运行测试第一步中的Main方法,看是否能获取到名为“hello”的Bean

本章总结

本章我们主要了解了Spring Framework的模式注解装配,@Enable装配和条件装配。对于SpringBoot的自动装配我们仅仅做了一下演示,遵循SpringBoot装配的三个步骤,我们就可以运行SpringBoot的自动装配。但是对于SpringBoot为什么要遵循这三个步骤?自动装配的原理?我们不知所以然,所以下一章节我们仍然以SpringBoot的自动装配为主题,对SpringBoot的底层源码做剖析。

该教程所属Java工程师之SpringBoot系列教程,本系列相关博文目录 Java工程师之SpringBoot系列教程前言&目录

一步步从Spring Framework装配掌握SpringBoot自动装配的更多相关文章

  1. Spring Boot之从Spring Framework装配掌握SpringBoot自动装配

    Spring Framework模式注解 模式注解是一种用于声明在应用中扮演“组件”角色的注解.如 Spring Framework 中的 @Repository 标注在任何类上 ,用于扮演仓储角色的 ...

  2. SpringBoot启动流程分析(五):SpringBoot自动装配原理实现

    SpringBoot系列文章简介 SpringBoot源码阅读辅助篇: Spring IoC容器与应用上下文的设计与实现 SpringBoot启动流程源码分析: SpringBoot启动流程分析(一) ...

  3. SpringBoot学习(三)探究Springboot自动装配

    目录 什么是自动装配 何时自动装配 原理分析 注:以下展示的代码springboot的版本为2.0.3版.因源码过长,大家选择展开代码 ㄟ( ▔, ▔ )ㄏ 什么是自动装配 自动装配还是利用了Spri ...

  4. springboot自动装配

    Spring Boot自动配置原理 springboot自动装配 springboot配置文件 Spring Boot的出现,得益于“习惯优于配置”的理念,没有繁琐的配置.难以集成的内容(大多数流行第 ...

  5. springboot自动装配(1)---@SpringBootApplication注解怎么自动装配各种组件

    1.对于springboot个人认为它就是整合了各种组件,然后提供对应的自动装配和启动器(starter) 2.@SpringBootApplication注解其实就是组合注解,通过它找到自动装配的注 ...

  6. springboot自动装配(3)---条件注解@Conditional

    之前有说到springboot自动装配的时候,都是去寻找一个XXXAutoConfiguration的配置类,然而我们的springboot的spring.factories文件中有各种组件的自动装配 ...

  7. SpringBoot自动装配原理解析

    本文包含:SpringBoot的自动配置原理及如何自定义SpringBootStar等 我们知道,在使用SpringBoot的时候,我们只需要如下方式即可直接启动一个Web程序: @SpringBoo ...

  8. springboot自动装配redis在pool下偶尔出现连接异常的问题

    jedis pool的配置其实是采用 org.apache.commons.pool2.impl.GenericObjectPoolConfig类的配置项. jedis 2.9版本代码如下: pack ...

  9. springboot自动装配原理

    最近开始学习spring源码,看各种文章的时候看到了springboot自动装配实现原理.用自己的话简单概括下. 首先打开一个基本的springboot项目,点进去@SpringBootApplica ...

随机推荐

  1. nginx-(/usr/local/nginx/conf/nginx.conf)更改配置文件

    user www www; worker_processes ; error_log /usr/local/nginx/logs/error.log info ; pid /var/run/nginx ...

  2. POJ3368Frequent values[RMQ 游程编码]

    Frequent values Time Limit: 2000MS   Memory Limit: 65536K Total Submissions: 17581   Accepted: 6346 ...

  3. Javascript 面向对象编程初探(一)--- 封装

    Javascript是一种基于对象(object-based)的语言,你遇到的所有东西几乎都是对象.但是,它又不是一种真正的面向对象编程(OOP)语言,因为它的语法中没有class(类). 那么,如果 ...

  4. 解密FFmpeg播放状态控制内幕

    上一篇文章(http://my.oschina.net/u/2336532/blog/400790)我们解决了在FFmpeg下如何处理H264和AAC的扩展数据,根据解出的NALU长度恢复了H264的 ...

  5. Querying CRM data with LINQ

    http://www.powerxrm.com/querying-crm-data-with-linq/ 如果不喜欢看SDK中的示例,这篇里面讲的非常详细,值得一看.

  6. NOIP2013提高组 T2 火柴排队

    一开始看也想不到这居然要用到逆序对,归并排序. 先来看看题目: 涵涵有两盒火柴,每盒装有 n 根火柴,每根火柴都有一个高度. 现在将每盒中的火柴各自排成一列, 同一列火柴的高度互不相同, 两列火柴之间 ...

  7. Springboot整合druid

    目录 Springboot整合druid application.yml DruidConfig 数据监控地址:http://localhost:8080/druid Springboot整合drui ...

  8. 在Linux安装ASP.NET Core运行时环境

    我使用的是Centos7 ,其它的Linux请参考微软文档   微软官方介绍文档:                                https://www.microsoft.com/n ...

  9. chrome不能浏览任何网页,提示配置proxy,Ubuntu

    自从在Ubuntu安装virtualbox以后,我的chrome浏览器就不能上网了,提示我检查proxy信息, 后面设置了noproxy就ok啦. 不用使用命令,一次设置,终身有效. 首先,安装gks ...

  10. 第 8 章 容器网络 - 050 - 创建 overlay 网络

    在 host1 中创建 overlay 网络 ov_net1: docker network create -d overlay ov_net1 -d overlay 指定 driver 为 over ...