项目架构知识点总结

fixAllenSun

于 2024-07-25 23:33:08 发布

阅读量550

点赞数 8

文章标签：架构 spring boot java

本文链接：https://blog.csdn.net/weixin_44823875/article/details/140676319

版权

项目架构知识点总结

【一】重要注解
【二】SpringApplication执行流程
【三】pom依赖引入jar包
【四】项目启动脚本命令

【一】重要注解

【1】@SpringBootApplication

在这里插入图片描述

通过这个结构，我们不难发现，SpringBoot将我们项目的启动类放在了classpath:/com/rain/abdemo01/下，而在这个路径及其子路径下，我们在后续的开发中还会接连定义些其他的需要注入到springboot容器中的组件

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
    @AliasFor(
        annotation = EnableAutoConfiguration.class
    )
    Class<?>[] exclude() default {};

    @AliasFor(
        annotation = EnableAutoConfiguration.class
    )
    String[] excludeName() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackages"
    )
    String[] scanBasePackages() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackageClasses"
    )
    Class<?>[] scanBasePackageClasses() default {};
}

归纳如下：
（1）@SpringBootApplication实质上是对@SpringBootConfiguration(即@Configuration)与@EnableAutoConfiguration以及@ComponentScan的组合注解。
（2）@SpringBootConfiguration(即@Configuration)表示被注解的启动类为SpringBoot应用的一个主配置类。
（3）@EnavleAutoConfiguration表示在这个主配置类上开启SpringBoot的自动配置。
（4）@ComponentScan则定义了SpringBoot容器的组件扫描规则。

springboot这么做的原因再结合对SpringBootApplication注解定义中的ComponentScan注解，我们便可知道，启动类的位置定义了springboot容器的包扫描位置，即启动类所在包及其子包。这更加凸显了springboot的"约定大于配置"的先进理念。
但是如果一定要修改启动类的位置，为了使程序中的其他所有组件被springboot容器扫描到，在技术上也可做如下配置，但是仅供参考，并不推荐。

（1）⭐️@ComponentScan 注解

@ComponentScan(excludeFilters = {
		@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })

（1）@ComponentScan这个注解在Spring中很重要，它对应XML配置中的元素，@ComponentScan的功能其实就是自动扫描并加载符合条件的组件（比如@Component和@Repository等）或者bean定义，最终将这些bean定义加载到IoC容器中。

我们可以通过basePackages等属性来细粒度的定制@ComponentScan自动扫描的范围，如果不指定，则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描。

注：所以SpringBoot的启动类最好是放在root package下，因为默认不指定basePackages。

（2）@ComponentScan告诉Spring 哪个packages 的用注解标识的类会被spring自动扫描并且装入bean容器。
例如，如果你有个类用@Controller注解标识了，那么，如果不加上@ComponentScan，自动扫描该controller，那么该Controller就不会被spring扫描到，更不会装入spring容器中，因此你配置的这个Controller也没有意义。

@ComponetScan注解的作用是为了进行组件的扫描，主要作用扫描当前包及其子包下被@Component，@Controller，@Service，@Repository注解标记的类并纳入到spring容器中进行管理。

（3）参数的作用

basePackageClasses：对basepackages()指定扫描注释组件包类型安全的替代。
 
excludeFilters：指定不适合组件扫描的类型。
 
includeFilters：指定哪些类型有资格用于组件扫描。
 
lazyInit：指定是否应注册扫描的beans为lazy初始化。
 
nameGenerator：用于在Spring容器中的检测到的组件命名。
 
resourcePattern：控制可用于组件检测的类文件。
 
scopedProxy：指出代理是否应该对检测元件产生，在使用过程中会在代理风格时尚的范围是必要的。
 
scopeResolver：用于解决检测到的组件的范围。
 
useDefaultFilters：指示是否自动检测类的注释

（2）⭐️@EnableAutoConfiguration 注解

@EnableAutoConfiguration 简单概括一下就是，借助@Import的支持，收集和注册特定场景相关的bean定义。

（1）@EnableScheduling是通过@Import将Spring调度框架相关的bean定义都加载到IoC容器。
（2）@EnableMBeanExport是通过@Import将JMX相关的bean定义加载到IoC容器。

而@EnableAutoConfiguration也是借助@Import的帮助，将所有符合自动配置条件的bean定义加载到IoC容器，仅此而已！

@EnableAutoConfiguration作为一个复合Annotation,其自身定义关键信息如下：
在这里插入图片描述
其中，最关键的要属@Import(AutoConfigurationImportSelector.class)，借助AutoConfigurationImportSelector，@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器。

（3）自动配置幕后英雄：SpringFactoriesLoader详解
SpringFactoriesLoader属于Spring框架私有的一种扩展方案，其主要功能就是从指定的配置文件META-INF/spring.factories加载配置。

在这里插入图片描述
配合@EnableAutoConfiguration使用的话，它更多是提供一种配置查找的功能支持，即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfigure.EnableAutoConfiguration作为查找的Key，获取对应的一组@Configuration类

在这里插入图片描述
上图就是从SpringBoot的autoconfigure依赖包中的META-INF/spring.factories配置文件中摘录的一段内容，可以很好地说明问题。

所以，@EnableAutoConfiguration自动配置的魔法骑士就变成了：从classpath中搜寻所有的META-INF/spring.factories配置文件，并将其中org.springframework.boot.autoconfigure.EnableutoConfiguration对应的配置项通过反射（Java Refletion）实例化为对应的标注了@Configuration的JavaConfig形式的IoC容器配置类，然后汇总为一个并加载到IoC容器。

（3）⭐️@SpringBootConfiguration 注解

@SpringBootConfiguration继承自@Configuration，二者功能也一致，标注当前类是配置类，并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中，并且实例名就是方法名。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
@Indexed
public @interface SpringBootConfiguration {
    @AliasFor(
        annotation = Configuration.class
    )
    boolean proxyBeanMethods() default true;
}

当我们在项目中使用了 @Indexed 之后，编译打包的时候会在项目中自动生成METAINT/spring.components文件。根据该文件进行扫描注入，可以提高效率，相当于为为扫描的类创建了索引文件，只需要一次io就能完成全部类的扫描。
当Spring应用上下文执行ComponentScan扫描时，META-INT/spring.components将会被CandidateComponentsIndexLoader 读取并加载，转换为CandidateComponentsIndex对象，这样的话@ComponentScan不在扫描指定的package，而是读取CandidateComponentsIndex对象，从而达到提升性能的目的。

简单点说，使用了@Indexed注解后，原来@ComponentScan可能需要扫描非常多的类，现在只需要在启动后对spring.components进行一次io，将类路径写入文件，后续将只需要读取文件即可获得所有类路径

proxyBeanMethods属性是是否为被注解的类修饰的属性每次都去ioc容器里获取它的代理类，默认为true开启，设置为false关闭后，每次获取这个类的实例会创建一个新的对象且不由IOC容器进行管理

（4）@Inherited 注解

关于java中元注解Inherited 的使用说明

首先解释下元注解，就是用来中声明注解类型时需要使用到的注解。

Inherited作用是，使用此注解声明出来的自定义注解，在使用此自定义注解时，如果注解在类上面时，子类会自动继承此注解，否则的话，子类不会继承此注解。这里一定要记住，使用Inherited声明出来的注解，只有在类上使用时才会有效，对方法，属性等其他无效。
在这里插入图片描述
声明的此注解使用了Inherited元注解，表示此注解用在类上时，会被子类所继承

（5）@Documented 注解

Documented注解表明这个注释是由 javadoc记录的，在默认情况下也有类似的记录工具。如果一个类型声明被注释了文档化，它的注释成为公共API的一部分。

（6）@Retention() 注解

RetentionPolicy这个枚举类型的常量描述保留注释的各种策略，它们与元注释(@Retention)一起指定注释要保留多长时间

（7）@Target() 注解

ElementType 这个枚举类型的常量提供了一个简单的分类：注释可能出现在Java程序中的语法位置（这些常量与元注释类型(@Target)一起指定在何处写入注释的合法位置）

（8）总结

因为spring默认情况下只能扫描到我们项目启动类下的组件，但是对于项目引入的jar包文件我们就必须手动扫描，springboot通过读取jar包文件下的META-INF/spring.factories文件，将其中指定的需要装配的类读取到IOC容器中，从而使得非spring官方的组件也能够不修改原有代码的情况下，只需要增加一部分自动装配的文件配置和自动装配类，即可完成与springboot的整合，充分体现了Java中SPI的设计理念

【2】@SpringBootApplication的参数

@SpringBootApplication（scanBasepackages=“包名”）
放在类上，声明这是一个SpringBoot应用，该类会有一个main方法作为Boot程序的开始。

拓展：
（1）scanBasepackages可以重新定义这个SpringBoot覆盖的范围，默认是本包及其子包
（2）该注解=>@SpringBootConfiguration+@EnableAutoConfiguration+@ComponentScan

【3】@MapperScan

（1）@Mapper注解的使用

先看看@Mapper
作用：在接口类上添加了@Mapper，在编译之后会生成相应的接口实现类。添加位置：接口类上面，代码如下所示：

@Mapper
public interface StudentMapper {
   //todo
}

（2）@MapperScan注解的使用

作用：指定要变成实现类的接口所在的包，包下面的所有接口在编译之后都会生成相应的实现类。添加位置：是在Springboot启动类上面添加

@SpringBootApplication
@MapperScan("cn.mybatis.mappers")
public class SpringbootMybatisDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootMybatisDemoApplication.class, args);
    }
}

添加@MapperScan(“cn.mybatis.mappers”)注解以后，cn.mybatis.mappers包下面所有的接口类，在编译之后都会生成相应的实现类

在不使用@MapperScan前，我们需要直接在Mapper类上面添加注解@Mapper，这种方式要求每一个Mapper类都需要添加此注解，非常麻烦，属于重复劳动。通过使用@MapperScan注解，可以让我们不用为每个Mapper类都添加@Mapper注解。

【二】SpringApplication执行流程

（1）如果我们使用的是SpringApplication的静态run方法，那么，这个方法里面首先要创建一个SpringApplication对象实例，然后调用这个创建好的SpringApplication的实例方法。在SpringApplication实例初始化的时候，它会提前做几件事情：

根据classpath里面是否存在某个特征类（org.springframework.web.context.ConfigurableWebApplicationContext）来决定是否应该创建一个为Web应用使用的ApplicationContext类型。

使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationContextInitializer。

使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationListener。

推断并设置main方法的定义类。

（2）SpringApplication实例初始化完成并且完成设置后，就开始执行run方法的逻辑了，方法执行伊始，首先遍历执行所有通过SpringFactoriesLoader可以查找到并加载的SpringApplicationRunListener。调用它们的started()方法，告诉这些SpringApplicationRunListener，“嘿，SpringBoot应用要开始执行咯！”。

（3）创建并配置当前Spring Boot应用将要使用的Environment（包括配置要使用的PropertySource以及Profile）。

（4）遍历调用所有SpringApplicationRunListener的environmentPrepared()的方法，告诉他们：“当前SpringBoot应用使用的Environment准备好了咯！”。

（5）如果SpringApplication的showBanner属性被设置为true，则打印banner。【banner：英文广告横幅，在这里面指的是运行时输出的SpringBoot，还可以进行修改】

（6）根据用户是否明确设置了applicationContextClass类型以及初始化阶段的推断结果，决定该为当前SpringBoot应用创建什么类型的ApplicationContext并创建完成，然后根据条件决定是否添加ShutdownHook，决定是否使用自定义的BeanNameGenerator，决定是否使用自定义的ResourceLoader，当然，最重要的，将之前准备好的Environment设置给创建好的ApplicationContext使用。【ShutdownHook ：停止服务】

（7）ApplicationContext创建好之后，SpringApplication会再次借助Spring-FactoriesLoader，查找并加载classpath中所有可用的ApplicationContext-Initializer，然后遍历调用这些ApplicationContextInitializer的initialize（applicationContext）方法来对已经创建好的ApplicationContext进行进一步的处理。

（8）遍历调用所有SpringApplicationRunListener的contextPrepared()方法。

（9）最核心的一步，将之前通过@EnableAutoConfiguration获取的所有配置以及其他形式的IoC容器配置加载到已经准备完毕的ApplicationContext。

（10）遍历调用所有SpringApplicationRunListener的contextLoaded()方法。

（11）调用ApplicationContext的refresh()方法，完成IoC容器可用的最后一道工序。

（12）查找当前ApplicationContext中是否注册有CommandLineRunner，如果有，则遍历执行它们。

（13）正常情况下，遍历执行SpringApplicationRunListener的finished()方法、（如果整个过程出现异常，则依然调用所有SpringApplicationRunListener的finished()方法，只不过这种情况下会将异常信息一并传入处理）

【三】pom依赖引入jar包

【四】项目启动脚本命令

fixAllenSun

关注

8
点赞
踩
15

收藏

觉得还不错? 一键收藏
0
评论
项目架构知识点总结

因为spring默认情况下只能扫描到我们项目启动类下的组件，但是对于项目引入的jar包文件我们就必须手动扫描，springboot通过读取jar包文件下的META-INF/spring.factories文件，将其中指定的需要装配的类读取到IOC容器中，从而使得非spring官方的组件也能够不修改原有代码的情况下，只需要增加一部分自动装配的文件配置和自动装配类，即可完成与springboot的整合，充分体现了Java中SPI的设计理念。
复制链接

扫一扫