Spring Boot 运行原理 - 核心注解

https://www.jianshu.com/p/23f504713b94

核心注解

打开上面任意一个AutoConfiguration文件,一般都有下面的条件注解,在spring-boot-autoconfigure-1.5.3.RELEASE.jar的org.springframework.boot.autoconfigure.condition包下条件注解如下:

  • @ConditionalOnBean:当前容器有指定Bean的条件下。
  • @ConditionalOnClass:当前类路径下有指定的类的条件下。
  • @ConditionalOnExpression:基于SpEL表达式作为判断条件。
  • @ConditionalOnJava:基于JVM版本作为判断条件。
  • @ConditionalOnJndi:在JNDI存在的条件下查找指定的位置。
  • @ConditionalOnMissingBean:当容器里没有指定Bean的情况下。
  • @ConditionalOnMissingClass:当类路径下没有指定的类的条件下。
  • @ConditionalOnNotWebApplication:当前项目不是WEB项目的条件下。
  • @ConditionalOnProperty:指定属性是否有指定的值。
  • @ConditionalOnResource:类路径是否有指定的值。
  • @ConditionalOnSingleCandidate:当指定Bean在容器中只有一个,或者虽然有多个但 是指定首选的Bean。
  • @ConditionalOnWebApplication:当前项目是WEB项目的条件下。

这些注解都组合了@Conditional元注解,只是使用了不同的条件(Conditional),Spring 条件注解(@Conditional)我们介绍过根据不同条件创建不同Bean。

简单分析一下@ConditionalOnWebApplication注解:

package org.springframework.boot.autoconfigure.condition;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.context.annotation.Conditional;

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnWebApplicationCondition.class)
public @interface ConditionalOnWebApplication {
}

从源码我们可以看出,此注解使用的条件是OnWebApplicationCondition类,下面我们看看这个类是怎么构造的:

package org.springframework.boot.autoconfigure.condition;

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.util.ClassUtils;
import org.springframework.util.ObjectUtils;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.StandardServletEnvironment;

@Order(Ordered.HIGHEST_PRECEDENCE + 20)
class OnWebApplicationCondition extends SpringBootCondition {

    private static final String WEB_CONTEXT_CLASS = "org.springframework.web.context."
            + "support.GenericWebApplicationContext";

    @Override
    public ConditionOutcome getMatchOutcome(ConditionContext context,
            AnnotatedTypeMetadata metadata) {
        boolean webApplicationRequired = metadata
                .isAnnotated(ConditionalOnWebApplication.class.getName());
        ConditionOutcome webApplication = isWebApplication(context, metadata);

        if (webApplicationRequired && !webApplication.isMatch()) {
            return ConditionOutcome.noMatch(webApplication.getMessage());
        }

        if (!webApplicationRequired && webApplication.isMatch()) {
            return ConditionOutcome.noMatch(webApplication.getMessage());
        }

        return ConditionOutcome.match(webApplication.getMessage());
    }

    private ConditionOutcome isWebApplication(ConditionContext context,
            AnnotatedTypeMetadata metadata) {

        if (!ClassUtils.isPresent(WEB_CONTEXT_CLASS, context.getClassLoader())) {
            return ConditionOutcome.noMatch("web application classes not found");
        }

        if (context.getBeanFactory() != null) {
            String[] scopes = context.getBeanFactory().getRegisteredScopeNames();
            if (ObjectUtils.containsElement(scopes, "session")) {
                return ConditionOutcome.match("found web application ‘session‘ scope");
            }
        }

        if (context.getEnvironment() instanceof StandardServletEnvironment) {
            return ConditionOutcome
                    .match("found web application StandardServletEnvironment");
        }

        if (context.getResourceLoader() instanceof WebApplicationContext) {
            return ConditionOutcome.match("found web application WebApplicationContext");
        }

        return ConditionOutcome.noMatch("not a web application");
    }

}

从isWebApplication方法可以看出,判断条件是:

  1. GenericWebApplicationContext是否在类路径中;
  2. 容器中是否有名为session的scope;
  3. 当前容器的Enviroment是否为StandardServletEnvironment;
  4. 当前的ResourceLoader是否是WebApplicationContext(ResourceLoader是ApplicationContext的顶级接口之一);
  5. 我们需要构建ConditionOutcome类的对象来帮助我们,最终通过ConditionOutcome.isMatch方法返回值来确定条件。

原文地址:https://www.cnblogs.com/kelelipeng/p/11994024.html

时间: 2024-11-05 18:40:49

Spring Boot 运行原理 - 核心注解的相关文章

Spring Boot 运作原理

Spring Boot 运作原理 1.Spring Boot 简介 SpringBoot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程.该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置.通过这种方式,Boot致力于在蓬勃发展的快速应用开发领域(rapid application development)成为领导者.SpringBoot并不是要成为Spring平台里面众多"Foundation"层项目的替代者.S

Spring Boot启动原理解析

Spring Boot启动原理解析http://www.cnblogs.com/moonandstar08/p/6550758.html 前言 前面几章我们见识了SpringBoot为我们做的自动配置,确实方便快捷,但是对于新手来说,如果不大懂SpringBoot内部启动原理,以后难免会吃亏.所以这次博主就跟你们一起一步步揭开SpringBoot的神秘面纱,让它不在神秘. 正文 我们开发任何一个Spring Boot项目,都会用到如下的启动类 从上面代码可以看出,Annotation定义(@Sp

spring boot启动原理步骤分析

spring boot最重要的三个文件:1.启动类 2.pom.xml 3.application.yml配置文件 一.启动类->main方法 1.spring boot通过fat jar方式用jdk命令java -jar jarname.jar启动的. fat jar就是包含被引用jar包的jar,因为会包含很多jar包,所以称为fat,肥胖. 2.spring  boot通过static void main方法启动,main方法是java程序总是最先运行的地方,这个是由jvm虚拟机决定的.任

spring boot 运行提示:No active profile set, falling back to default profiles: default

spring boot 运行提示:Process finished with exit code 1 经检查发现是由于在application.properties配置文件中将某些自定义配置项移除了,但是代码中没有删掉,导致以上错误发生. 例如,配置文件中原先存在: jszs.path=/oracle/grgzpt-test/ 代码中存在以下应用:@Value("${jszs.path}")private String jszsPath; 将配置文件中的jszs.path=/oracl

spring boot Controller中使用注解@RequestBody遇到的一个问题

spring boot Controller中使用注解@RequestBody遇到的一个问题总结: 通过@RequestBody接收实体对象,如代码所示 @PostMapping(value = "addtype")public Object addAppType(@RequestBody AppType appType) throws Exception{ return JsonData.buildSuccess();} 用postman测试接口时, 首先选择post请求 然后Hea

spring boot中mybatis使用注解进行模糊查询

小白一枚,spring boot 2.0.5在使用mybatis进行注解模糊查询时遇到一些低级的错误,现记录下来错误示例:"select * from user where name like \""#{name}\""这个错误报Parameter index out of range (1 > number of parameters, which is 0): 经过百度查询其它的得到这条sql语句,虽然能查出来,但是是全部数据都查出来了"

spring boot 启动原理剖析

准备 SpringBoot为我们做的自动配置,确实方便快捷,若不大明白SpringBoot内部启动原理,以后难免会吃亏,所以这次博主就跟你们一起一步步揭开SpringBoot的神秘面纱,让它不再神秘. 旅程开始 开发任何一个SpringBoot项目,都会用到如下启动类: @SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(A

Spring Boot高频面试题:Spring Boot执行原理

之前一篇文章Spring Boot快速入门文章中,我们已经体会到Spring Boot的神器,不再像之前Spring那样需要繁琐的XML,甚至几秒钟就能搭建出Spring的项目骨架.接下来我们简单分析Spring Boot的基本原理,让我们揭开它神秘的面纱吧. 1 @SpringBootApplication 首先,我从引导类开始 /** * Spring Boot引导类 * 一点教程网 - www.yiidian.com */ @SpringBootApplication public cla

Spring Boot 中使用 @Transactional 注解配置事务管理

事务管理是应用系统开发中必不可少的一部分.Spring 为事务管理提供了丰富的功能支持.Spring 事务管理分为编程式和声明式的两种方式.编程式事务指的是通过编码方式实现事务:声明式事务基于 AOP,将具体业务逻辑与事务处理解耦.声明式事务管理使业务代码逻辑不受污染, 因此在实际使用中声明式事务用的比较多.声明式事务有两种方式,一种是在配置文件(xml)中做相关的事务规则声明,另一种是基于 @Transactional 注解的方式.本文将着重介绍基于 @Transactional 注解的事务管