Springboot 核心注解和基本配置解读

news2024/12/23 10:41:29

目录

1. Springboot 入门与原理

1.1 Springboot 简介

1.1.1 什么是Springboot

1.1.2 Springboot 主要优点

1.2 Springboot 相关注解

1.2.1 元注解

 1.2.1.1 @Target

1.2.1.2 @Retention

1.2.2 @Configuration

1.2.3 @Import

1.2.3.1 直接注入

1.2.3.2 实现 ImportSelector 注入

1.2.3.3 实现 ImportBeanDefinitionRegistrar 接口 注入

1.2.4 @Conditional

1.2.5 @ImportResource和@ConfigurationProperties

1.2.6 @PropertySource+@Value

1.2.7 @SpringBootApplication


1. Springboot 入门与原理

1.1 Springboot 简介

1.1.1 什么是Springboot

开发一个web应用,从最初开始接触Servlet结合Tomcat, 跑出一个HelloWolrld程序,是要经历特别多的步骤; 后来就用了框架Struts,再后来是SpringMVC,到了现在的SpringBoot,SpringBoot就是一个JavaWeb的开发框架,和SpringMVC类似,对比其他
JavaWeb框架的好处,官方说是简化开发,约定大于配置, 能迅速的开发web应用,几行代码开发一个http接口。

所有的技术框架的发展似乎都遵循了一条主线规律:从一个复杂应用场景衍生 一种规范框架,人们只需要进行各种配置而不需要自己去实现它,这时候强大的配置功能成了优点;发展到一定程度之后,人们根据实际生产应用情况,选取其中实用功能和设计精华,重构出一些轻量级的框架;之后为了提高开发效率,嫌弃原先的各类配置过于麻烦,于是开始提倡“约定大于配置”,进而衍生出一些一站式的解决方案。


随着 Spring 不断的发展,涉及的领域越来越多,项目整合开发需要配合各种各样的文件,慢慢变得不那么易用简单,违背了最初的理念,甚至人称配置地狱。Spring Boot 正是在这样的一个背景下被抽象出来的开发框架,目的为了让大家更容易的使用 Spring 、更容易的集成各种常用的中间件、开源软件。

Spring Boot 基于 Spring 开发,Spirng Boot 本身并不提供 Spring 框架的核心特性以及扩展功能,只是用于快速、敏捷地开发新一代基于 Spring 框架的应用程序。也就是说,它并不是用来替代 Spring 的解决方案,而是和 Spring 框架紧密结合用于提升 Spring 开发者体验的工具。Spring Boot 以约定大于配置的核心思想,默认帮我们进行了很多设置,多数 Spring Boot 应用只需要很少的 Spring 配置。同时它集成了大量常用的第三方库配置(例如 Redis、MongoDB、Jpa、RabbitMQ、Quartz 等等),SpringBoot 应用中这些第三方库几乎可以零配置的开箱即用。

简单来说就是SpringBoot其实不是什么新的框架,它默认配置了很多框架的使用方式,就像maven整合了所有的jar包,spring boot整合了所有的框架 。

1.1.2 Springboot 主要优点

  • 为所有Spring开发者更快的入门
  • 开箱即用,提供各种默认配置来简化项目配置
  • 内嵌式容器简化Web项目
  • 没有冗余代码生成和XML配置的要求

1.2 Springboot 相关注解

1.2.1 元注解

Java元注解是包括: @Retention、@Target、@Documented、@Inherited等。如下图:

 1.2.1.1 @Target

@Target用于指定注解的作用范围,它的取值包括:


 

1.2.1.2 @Retention

@Retention用于指定注解的生命周期,它的取值包括:

1.2.2 @Configuration

添加了 @Configuration 的类是 SpringBoot 的配置类,这个配置类等价于 Spring 的 beans.xml 配置文件;在配置类中可以使用 @Bean 注解定义 Bean 对象。配置类中调用 Bean 对象定义方法可得到对应 Bean 对象,即使多次调用,返回的是同一个对象。

@Configuration
public class MyConfiguration {
    @Bean
    public User user(){
        return new User();
    }
}

进入 @Configuration 注解,发现该注解除了 value 属性,还有一个 proxyBeanMethods 属性,且默认值为 true。该配置表示添加了 @Configuration 的配置类中的所有方法都是代理对象方法,代理对象调用 方法,SpringBoot 总会检查 该方法返回的 User 对象在容器中是否已经存在,如果存在就直接返回容器中的 Bean 对象。代码如下:打印结果一直为true。

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(DemoApplication.class, args);
        MyConfiguration myconfiguration = run.getBean("myConfiguration", MyConfiguration.class);
        System.out.println(myconfiguration.user()==myconfiguration.user());
    }
}

1.2.3 @Import

@Import是可以通过配置来控制是否注入该Bean,也可以通过条件来控制注入哪些Bean到Spring容器中。

1.2.3.1 直接注入

在@Configuration标注的类上使用@Import引入了一个类后,就会把该类注入容器中。类似于@Service,@Component等注解。代码如下:

@Configuration
@Import({User.class})
public class MyConfiguration {

}

1.2.3.2 实现 ImportSelector 注入

通过ImportSelector的使用通过开关来控制注入哪些Bean,来实现动态的Bean对象的注入。

设置接口:

public interface FatherInterface {
    void test();
}

设置接口实现类:

public class A implements FatherInterface{
    @Override
    public void test() {
        System.out.println("执行了A");
    }
}
public class B implements FatherInterface {
    @Override
    public void test() {
        System.out.println("执行了B");
    }
}

定义ImportSelector实现类

public class MySelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        Map<String, Object> annotationAttributes = importingClassMetadata.getAnnotationAttributes(Switch.class.getName());
//获取目标元素上某注解的属性值
        String value = (String) annotationAttributes.get("value");
        if(value.equals("A"))
            //将A类Bean对象注入Spring容器
            return new String[]{A.class.getName()};
        else
            //将B类Bean对象注入Spring容器
            return new String[]{B.class.getName()};

    }
}

定义Switch注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(MySelector.class)
public @interface Switch {
    String value() default "";
}

测试代码如下

@SpringBootApplication
@Switch(value = "A")
public class DemoApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(DemoApplication.class, args);
        A bean1 = run.getBean(A.class);
        System.out.println(bean1);
        B bean2 = run.getBean(B.class);
        System.out.println(bean2);

    }
}

测试结果如下:


 

 将value值改为字符串B,然后就会在Spring容器中可以获得B类Bean对象,获得不了A类Bean对象,然后我们就可以进行动态的添加Bean对象。

1.2.3.3 实现 ImportBeanDefinitionRegistrar 接口 注入

当配置类实现了ImportBeanDefinitionRegistrar 接口,你就可以自定义往容器中注册想注入的Bean。

这个接口相比与 ImportSelector 接口的主要区别就是,ImportSelector接口是返回一个类,你不能对这个类进行任何操作,但是ImportBeanDefinitionRegistrar 是可以自己注入 BeanDefinition,可以添加属性之类的。

通过实现ImportBeanDefinitionRegistrar的方式来完成注入。

public class MyBeanRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(User.class).addPropertyValue("username", "admin")
                .addPropertyValue("password", "132")
                .getBeanDefinition();
        registry.registerBeanDefinition("myuser",beanDefinition);
    }
}

测试代码

@SpringBootApplication
@Import(MyBeanRegistrar.class)
public class DemoApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(DemoApplication.class, args);
        User myuser = run.getBean("myuser", User.class);
        System.out.println(myuser);

    }
}

1.2.4 @Conditional

@Conditional 注解是用来匹配只有满足所有指定条件才能将Bean注册到Spring上下文中。例如:当某jar包在类路径下,自动配置一个或多个bean,这就是根据特定条件控制Bean的创建行为,这样就可以利用这个特性进行一些自动配置。

如下图:

 除此之外我们还可以自定义条件控制Bean对象的创建。代码如下:

自定义MyConditon类

public class MyCondition implements Condition {
    
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        //此处编写业务逻辑
        return true;
    }
//true为通过,false为不通过不能创建bean
}


Configuration类代码

@Configuration

//@ConditionalOnMissingBean(name = "hello")
//@EnableConfigurationProperties(User.class)
public class MyConfiguration {

    @Bean
    @Conditional(MyCondition.class)
    public User user(){
        return new User();
    }

}

1.2.5 @ImportResource和@ConfigurationProperties

@ImportResource主要用于原生配置文件引入。SpringBoot是全注解开发,对于一些使用配置文件项目,SpringBoot可以通过@ImportResource将配置文件中的内容引入SpringBoot项目中,不需要将配置文件中的内容一个一个的按照注解的方式改动。主要用于使用xml文件向容器装配组件。这部分本作者用的不多,代码故在此省略。

有时候有这样子的情景,我们想把配置文件的信息,读取并自动封装成实体类,这样子,我们在代码里面使用就轻松方便多了,这时候,我们就可以使用@ConfigurationProperties,它可以把同类的配置信息自动封装成实体类,主要用于Bean对象的属性注入。

在application.yml文件中配置如下:

user:
  username: admin
  password: 123

自定义User类

@Component
@ConfigurationProperties(prefix = "user")
public class User {
    private String username;
    private String password;

}

这里必须要加@Component组件,因为只有Spring容器中的Bean对象才能使用Springboot的强大功能。这里也可以不加@Component组件,在Configuration中添加如下:

@Configuration
@EnableConfigurationProperties(User.class)
public class MyConfiguration {
}

1.2.6 @PropertySource+@Value

SpringBoot默认能够读取resources目录下的application配置文件,当我们的配置文件不在全局配置文件中,该如何使用呢?
@PropertySource+@Value可以读取其它配置文件内容。

新建test.yml,内容如下:

user:
  username: admin

自定义MyUser类读取配置文件内容

@Component
@PropertySource({"test.yml"})
public class MyUser {
    @Value("${user.username}")
    public String username;
}

1.2.7 @SpringBootApplication

run函数传入的当前启动类的字节码,最重要的是传入了@SpringBootApplication,点开它,就能发现它是一个复合注解,有多个注解组成,如下图:

@SpringBootConfiguration

该注解源码,会发现本质是@Configuration,定义该类是个配置类,功能等同于xml配置文件。@Configuration和@Bean,两个注解合作创建一个简单的Spring配置类,可以用来代替响应的xml配置文件可以理解为创建了IOC容器了。如下图:

@ComponentScan

这个注解对应的是Spring的XML配置中的ComponentScan,也就是自动扫描并加载符合条件的组件,将他们加载到IOC容器中。也可以通过basePackages等属性来细粒度的定制@ComponentScan自动扫描的范围,默认扫描引导类所在的包以及子包。

@EnableAutoConfiguration

点开源码发现本质是@Import如下图:

  • @EnableAutoConfiguration也是借助@Import的帮助,将所有符合自动配置条件的bean定义加载到IOC容器。@EnbaleAutoConfiguration会根据类路径中的jar依赖为项目进行自动配置,如:添加了spring-boot-starter-web,就会自动添加Tomcat和SpringMVC的依赖,springboot会对Tomcat和SpringMVC进行自动配置。
  • springboot是如何完成自动配置的呢?
    • 启动类的run方法执行,传入SpringBootApplication注解的字节码
    • 这个注解是个复合注解,其中有一个EnableAutoConfiguration
    • 这个EnableAutoConfiguration中又有一个Import注解,这个注解可以用来导入其他类
    • 通过这个Import,导入的是AutoConfigurationImportSelector,这个类内部有一个方法selectImports。这个方法会扫描所有jar包下的spring.factories文件,解析其中的配置(key=value的键值对形式),创建对应的类到Spring容器中。

总结

在Springboot程序运行的时候:
1.SpringBoot先加载所有的自动配置类xxAutoConfiguration
2.每个自动配置类按照条件进行生效,默认都会绑定配置文件指定的值。从xxProperties里面拿。xxProperties和配置文件进行了绑定。
3.生效的配置类就会给容器中装配很多组件。
4.只要容器中有这些组件,相当于这些功能就有了。
5.我们可以定制化配置
   1.用户直接自己@Bean替换底层的组件。
   2.用户去看这个组件是获取的配置文件什么值就去修改。在application全局配置文件中进行修改。

这就是Springboot中的约定大于配置。

至此本篇文章到此结束。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/671833.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Python基础语法2(超详细举例)

生活就是这样&#xff0c;有的时候即便你尽了最大努力&#xff0c;但依然无法得偿所愿 但是&#xff0c;难道向上攀爬的那条路不是比站在顶峰更令人热血澎湃吗&#xff1f; 文章目录 一、转义符 二、变量的赋值规则 三、数据类型 四、操作符 1.除法 2.幂运算 3.布尔运算…

读营销策划心得

读营销策划心得篇1 过去的一年可算是我工作上另一个转折点&#xff0c;更是一个新的开始。特别是自今年6月份接手营销策划工作&#xff0c;不知不觉&#xff0c;已有半年。回忆这一年的工作经历&#xff0c;有艰辛、有成长、有收获、更有前景。这一年既包含了太多的艰辛与不易&…

Redis【入门篇】---- 初始 Redis

Redis【入门篇】---- 初始 Redis 1. 认识NoSQL1. 结构化与非结构化2. 关联与非关联3. 查询方式4. 事务5. 总结 2. 认识Redis3. 安装Redis1. 依赖库2. 上传安装包并解压3. 启动4. 默认启动5. 指定配置启动6. 开机自启动 4. Redis桌面客户端1. Redis命令行客户端2. 图形化桌面客户…

2023年最新企业网盘排名!一文掌握各大企业网盘优缺点

近年来&#xff0c;企业网盘已经成为一个越来越流行的工具&#xff0c;为企业寻求简化他们的文件协作过程。由于团队成员分散在不同的位置和设备上&#xff0c;网盘提供了一种安全有效的方式来存储、共享和协作文件&#xff0c;为企业提供了一系列的好处&#xff0c;包括&#…

赚钱的底层模式和破局思路

赚钱的逻辑是什么&#xff0c;哪些价值观念的区别&#xff0c;让不同人在赚钱这件事情上产生巨大的差别&#xff1f; 如果从第一性原理出发&#xff0c;个体赚钱有哪些模式&#xff0c;以及如何优化&#xff1f; 一、出卖时间 本质上所有的赚钱方式都是出卖时间&#xff0c;…

车载开发中,蓝牙通信需要学习那些核心技术点?

车载蓝牙通信是指在汽车内部或车辆与外部设备之间使用蓝牙技术进行数据传输和通信。蓝牙5.0是现代蓝牙技术的最新版本&#xff0c;它引入了一系列新功能和改进&#xff0c;提供了更快的数据传输速度、更长的传输距离、更稳定的连接和更低的能耗。 那么车载蓝牙通信需要学习那些…

RabbitMQ实现延时消息的两种方法

RabbitMQ实现延时消息的两种方法 1、死信队列 1.1消息什么时候变为死信(dead-letter) 消息被否定接收&#xff0c;消费者使用basic.reject 或者 basic.nack并且requeue 重回队列属性设为false。消息在队列里得时间超过了该消息设置的过期时间&#xff08;TTL&#xff09;。消…

java 设计模式--创建者模式

参考&#xff1a;Java常见设计模式总结 概念 概念理解一&#xff1a;将复杂对象的创建过程分解在不同的方法中&#xff0c;不同的创建过程组装成不同对象。对象的创建与产品本身分离开&#xff0c;使得对象的创建过程更加清晰。例如&#xff1a;旅游套餐售卖场景。 一个套餐大…

@DateTimeFormat与@JsonFormat不完全解析

目录 前言测试代码DateTimeFormat不加任何注解的情况普通请求JSON请求 JsonFormat普通请求JSON请求 其他方式&#xff08;InitBinder&#xff09;结论源码地址 前言 一直以来对DateTimeFormat与JsonFormat 比较模糊&#xff0c;容易搞忘&#xff0c;今天就做个笔记&#xff0c…

【MySQL 利器之 mysqldump】

文章目录 前言一、mysqldump二、环境三、使用步骤1.服务器与服务器间直接同步2.导出到sql文件3.sql文件导入 总结使用方式 1 服务器间直连方式同步&#xff1a;使用中间SQL 文件方式&#xff1a;datax&#xff1a; 前言 1.随着服务器环境改造&#xff0c;新旧数据库环境更换&a…

微流控压力控制器和微流控注射泵的性能比较

摘要&#xff1a;针对微流控技术中的压力和流量控制&#xff0c;本文介绍了目前常用的两类装置&#xff1a;注射泵和压力泵&#xff0c;重点介绍了这两种装置的性能特点&#xff0c;并对这两种压力控制装置进行了简要的分析对比。分析结论是压力泵将逐渐替代注射泵的应用&#…

Addressable CRC设置详解

设置 Asset Bundle的CRC设置中有三个选项&#xff1a; Disable&#xff1b; Enable,InClude Cached; Enable,Excludeing Cached; 修改后实际改的是这里的选项&#xff1a; Disable 设置为Disable&#xff0c;实际上是将BundledAssetGroupSchema类的UseAssetBundleCrc参数设…

软考:软件工程:软件设计,总体设计,详细设计,耦合内聚流程图,NS图,PAD图,判定树判定图。

软考&#xff1a;软件工程: 提示&#xff1a;系列被面试官问的问题&#xff0c;我自己当时不会&#xff0c;所以下来自己复盘一下&#xff0c;认真学习和总结&#xff0c;以应对未来更多的可能性 关于互联网大厂的笔试面试&#xff0c;都是需要细心准备的 &#xff08;1&#…

【吃透网络安全】2023软考网络管理员考点网络安全(二)网络攻击详解

涉及知识点 黑客的攻击手段介绍&#xff0c;常见的网络攻击&#xff0c;软考网络管理员常考知识点&#xff0c;软考网络管理员网络安全&#xff0c;网络管理员考点汇总。 后面还有更多续篇希望大家能给个赞哈&#xff0c;这边提供个快捷入口&#xff01; 第一节网络管理员考…

多版本管理node.js

多版本管理node.js 1. 安装2. 配置使用2.1 修改node源2.2 常用命令 在Windows 计算机上管理node.js的多个安装版本。 这是朋友推荐的&#xff0c;就是自己在升级node的时候给搞崩了&#xff0c; 不得不提升效率&#xff0c;于是发现了这个好工具&#xff0c;可以反过来理解&…

金蝶云星空RCE漏洞复现

0x01 产品简介 金蝶云星空是一款云端企业资源管理&#xff08;ERP&#xff09;软件&#xff0c;为企业提供财务管理、供应链管理以及业务流程管理等一体化解决方案。金蝶云星空聚焦多组织&#xff0c;多利润中心的大中型企业&#xff0c;以 “开放、标准、社交”三大特性为数字…

端午安康,节日送祝福

端午节是在中国农历的五月份&#xff0c;今年是&#xff08;公历&#xff09;&#xff16;月22日&#xff0c;它是中国最古老的节日 之一&#xff0c;已经有两千多年的历史。The Duanwu or Dragon Boat Festival, is generally celebrated on the fifth month of the Chinese l…

(自定义包导包失败一万次的经验)ModuleNotFoundError: No module named ‘xxx‘

导自定义的包遇到的问题 首先我列一下我的目录结构 |-src|-__init__.py|-Dao|-insertData.py|-pojo|-DataBaseDao|-everyData我现在在我的insertData.py通过from src.pojo import DataBaseDao,everyData导包,在pycharm中可以正常运行,但是在控制台运行失败,提示 ModuleNotFo…

移植微雪例程-2.6寸双色墨水屏到ESP32IDF中

微雪官网&#xff1a;E-Paper ESP32 Driver Board - Waveshare Wiki 去微雪官网&#xff0c;把墨水屏的例程下下来。 我这个使用的是2.6寸的双色墨水屏。 下载下来之后&#xff0c;然后移植到IDF上面。 移植epd2in13bc-demo这个例程。将EPD_2in13bc.h这个头文件中的宽&#…

2022年广西壮族自治区第二届职业技能大赛“网络安全项目”比赛任务书

2022年广西壮族自治区第二届职业技能大赛 “网络安全项目”比赛任务书 一、竞赛时间 总计&#xff1a;12小时 竞赛阶段 竞赛阶段 任务阶段 竞赛任务 竞赛时间 分值 A A-1 登录安全加固 240分钟 350分 A-2 本地安全策略配置 A-3 流量完整性保护 A-4 事件监控…