第三章 springboot -- 第一节 SpringBoot启动注解 ( @SpringBootApplication )

2024-05-01 09:08
文章标签 java 启动 springboot 第三章 spring 注解 第一节 springbootapplication

本文主要是介绍第三章 springboot -- 第一节 SpringBoot启动注解 ( @SpringBootApplication )，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

SpringBoot 启动注解 @SpringBootApplication 相关知识整理

一、启动类使用

我们可以通过SpringBoot官方网站 https://start.spring.io/创建一个基础的SpringBoot项目
如下示例为 tysite-spark 项目的启动类部分代码

package org.items.tysite;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;@SpringBootApplication  (1)
public class StartApplication extends SpringBootServletInitializer {@Overrideprotected SpringApplicationBuilder configure(SpringApplicationBuilder application) {return application.sources(StartApplication.class);}public static void main(String[] args) {SpringApplication.run(StartApplication.class, args);}
}

本章节主要介绍 @SpringBootApplication 注解的都做了那些事情，前面的文章已经介绍过注解的基础知识，本文将忽略基础知识部分的讲解

二、@SpringBootApplication 详解

@SpringBootApplication注解，主要包含@SpringBootConfiguration 、@EnableAutoConfiguration 和@ComponentScan 三个注解

注解源码如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration    (1)
@EnableAutoConfiguration    (2)
@ComponentScan(excludeFilters = {@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })    (3)
public @interface SpringBootApplication {
……
}

（1）@SpringBootConfiguration： 该注解继承自 @Configuration，两者功能一致，标注当前类是一个配置类。
注解源码如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
……
}

其下可以通过@Bean标注将方法返回的类对象依赖注入到Spring容器中。

需要注意的是，虽然@Configuration继承自@Component，但@Configuration采用CGLIB的动态代理功能，使 @Bean注释的方法都会被动态代理，调用时通过BeanFactory返回相同的对象。即 @Configuration注解是单例模式，@Component注解是多例模式。

（2）@EnableAutoConfiguration ：spring的自动装配注解，该注解会根据项目添加的jar包依赖项，完成对项目依赖的自动装配。
注解源码如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";Class<?>[] exclude() default {};String[] excludeName() default {};
}

@EnableAutoConfiguration注解默认会扫描 spring-boot-autoconfigure:xxx.RELEASE.jar包下META-INF/spring.factories文件中，所有org.springframework.boot.autoconfigure.EnableAutoConfiguration值中对应的*Configuration类，并根据类上的条件注解判定结果，将符合条件的配置类加载到spring容器中。·
代码片段如下：

……
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.cloud.CloudServiceConnectorsAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
……

注意：如果项目要剔除某个依赖的自动装配，可以通过本注解的exclude 属性，设置要剔除的配置类即可。(使用上面auto Configure 中的类命名)， 示例如下：

@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class}) // -> 禁止数据源自动装配

启动spring时，若开启DEBUG模式，可以在启动日志的CONDITIONS EVALUATION REPORT中查看到项目模块的装配情况
自动装配日志内容截图
注意：
1、@EnableAutoConfiguration通过资源导入注解(@Import(AutoConfigurationImportSelector.class))，将``类引入到启动类中

2、配置类加载规则，通过扫描SpringBoot自动配置包内spring-boot-autoconfigure-*.RELEASE.jar/META-INF/spring.factories文件中org.springframework.boot.autoconfigure.EnableAutoConfiguration属性所配置的所有*AutoConfiguration类，进行装载。在扫描到*AutoConfiguration类时，所有类中的@ConditionalOn*注解生效，判断其所需的类是否存在（或生效），以决定是否装载对应配置。

参考资料：
https://www.cnblogs.com/leihuazhe/p/7743479.html
https://blog.csdn.net/mapleleafforest/article/details/87273213

（3）@ComponentScan ： 配置组件自动扫描的指令，以便提供与XML配置<context:component-scan base-package="org.example"/> 相同的功能，继承于@ComponentScans注解。

注解源码如下：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Repeatable(ComponentScans.class)
public @interface ComponentScan {@AliasFor("basePackages")String[] value() default {};@AliasFor("value")String[] basePackages() default {};Class<?>[] basePackageClasses() default {};Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;Class<? extends ScopeMetadataResolver> scopeResolver() default AnnotationScopeMetadataResolver.class;ScopedProxyMode scopedProxy() default ScopedProxyMode.DEFAULT;String resourcePattern() default    ClassPathScanningCandidateComponentProvider.DEFAULT_RESOURCE_PATTERN;boolean useDefaultFilters() default true;Filter[] includeFilters() default {};Filter[] excludeFilters() default {};boolean lazyInit() default false;@Retention(RetentionPolicy.RUNTIME)@Target({})@interface Filter {FilterType type() default FilterType.ANNOTATION;@AliasFor("classes")Class<?>[] value() default {};@AliasFor("value")Class<?>[] classes() default {};String[] pattern() default {};}
}

从注解源码中，可以看到@ComponentScan注解的一些重要属性

  • value() 和 basePackages
    属性 互为别名，用于指定@ComponentScan注解扫描的包路径，若不设置则默认从@ComponentScan注释的类开始向下扫描。
  • boolean useDefaultFilters() default true;
    属性 标记是否启用默认过滤规则，该规则用于扫描@Component，@Repository，@Service，@Controller 注解注释的类。
  • includeFilters 属性指定特定扫描规则，通常此时关闭默认扫描规则。
  • excludeFilters 属性用于排除特定扫描规则。
  • @Filter 内部注解可以配合 excludeFilters 或 includeFilters 实现 排除 或 增加 某个过滤规则

1、@ComponentScan 常用应用示例：

  1. @ComponentScan(“org.items.tysite”)
    扫描 [org.items.tysite] 包下的所有默认注解，如@Controller、@Service、@Component等
  2. @ComponentScan(basePackageClasses = ThymeleofController.class, useDefaultFilters = false)
    扫描 指定的 ThymeleofController 类
  3. @ComponentScan(value = “org.items.tysite”, includeFilters = { @Filter(type = FilterType.ANNOTATION, value = Component.class) }, useDefaultFilters = false)
    只扫描 [org.items.tysite] 包下，由 @Component注解注释的类
  4. @ComponentScan(value = “org.items.tysite”, excludeFilters = { @Filter(type = FilterType.ANNOTATION, value = Component.class) })
    扫描 [org.items.tysite] 包下，除@Component注解之外的所有默认规则注解
  5. @ComponentScan(value = “org.items.tysite”, includeFilters = { @Filter(type = FilterType.CUSTOM, value = CustomTypeFilter.class) }, useDefaultFilters = false)
    扫描 [org.items.tysite] 包下，基于CustomTypeFilter 自定义规则加载Bean

2、自定义策略使用案例
以上面示例5的配置作为配置样例,通过实现TypeFilter接口，创建自定义的策略，并通过@Configuration 配置 @ComponentScan

@Configuration
@ComponentScan(value = "org.items.tysite", includeFilters = { @Filter(type = FilterType.CUSTOM, value = CustomTypeFilter.class) }, useDefaultFilters = false)
public class CustomComponentScanConfiguration { }

public class CustomTypeFilter implements TypeFilter {@Overridepublic boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {ClassMetadata classMetadata = metadataReader.getClassMetadata();String className = classMetadata.getClassName();if (CommonConsts.class.getName().equals(className)) {System.out.println("成功加载类 ["+CommonConsts.class.getName()+"]");return true;} else {return false;}}
}

注意： 项目使用 @SpringBootApplication 的注解扫描时，以上示例无法生效。因为 @SpringBootApplication注解中排除了 FilterType.CUSTOM 自定义的扫描规则 (详见注解源码)。如果我们的项目中需要使某个类或注解注释不被注入时，可以通过继承TypeExcludeFilter类并重写match方法实现。

match 方法的 MetadataReader 参数，可以获取到扫描对象 类信息、注解信息、以及资源信息，可以根据以上信息判断要注入的类

  //获取扫描到的类注解信息AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();//获取扫描到的类信息ClassMetadata classMetadata = metadataReader.getClassMetadata();//获取扫描到的类资源信息Resource resource = metadataReader.getResource();

参考资料：
https://docs.spring.io/spring/docs/5.1.8.RELEASE/spring-framework-reference/core.html#beans-scanning-autodetection

https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/context/TypeExcludeFilter.html#match-org.springframework.core.type.classreading.MetadataReader-org.springframework.core.type.classreading.MetadataReaderFactory-

https://blog.csdn.net/luojinbai/article/details/85877956

这篇关于第三章 springboot -- 第一节 SpringBoot启动注解 ( @SpringBootApplication )的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/951280。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
MySQL数据库宕机，启动不起来，教你一招搞定！

MySQL数据库宕机，启动不起来，教你一招搞定！

作者介绍：老苏，10余年DBA工作运维经验，擅长Oracle、MySQL、PG、Mongodb数据库运维（如安装迁移，性能优化、故障应急处理等）公众号：老苏畅谈运维欢迎关注本人公众号，更多精彩与您分享。 MySQL数据库宕机，数据页损坏问题，启动不起来，该如何排查和解决，本文将为你说明具体的排查过程。 查看MySQL error日志 查看 MySQL error日志，排查哪个表（表空间
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2