SpringBoot学习——运行原理学习及自定义Starter pom

最新推荐文章于 2024-07-30 22:46:40 发布
最新推荐文章于 2024-07-30 22:46:40 发布
阅读量1w 收藏 7
点赞数 2
分类专栏： springboot 文章标签： spring-boot 原理
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/flygoa/article/details/68484439
版权

SpringBoot学习——运行原理学习及自定义Starter pom

项目下载

项目下载

运行原理

SpringBoot最大的特点就是提供了很多默认的配置，Spring4.x提供了基于条件来配置Bean的能力，SpringBoot就是通过这一原理来实现的。
那么我们如何来实现一个自定义的starter呢

自定义Starter pom

新建一个maven项目

参考SpringBoot学习——SpringBoot入门HelloWorld

总目录结构

修改pom.xml，添加相关依赖

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.pzr</groupId>
    <artifactId>spring-boot-starter-pzrhello</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <!-- 引用依赖的父包 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.1.RELEASE</version>
    </parent>
    <!-- 依赖包 -->
    <dependencies>
        <!-- spring boot 自动配置需要的包 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <!-- spring boot需要的包 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

    </dependencies>
</project>

添加属性配置类

package com.pzr.spring_boot_stater_pzrhello;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * 属性配置类
 * @author pzr
 *
 */
@ConfigurationProperties(prefix="hello")
public class HelloServiceProperties {
    private static final String MSG = "world";
    private String msg = MSG;
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }

}

代码说明：
使用@ConfigurationProperties注解来设置前缀，在application中通过hello.msg=来设置，若不设置，默认为hello.msg=world。

添加判断依据类

package com.pzr.spring_boot_stater_pzrhello;

/**
 * 判断依据类
 * @author pzr
 *
 */
public class HelloService {
    private String msg;

    public String sayHello(){
        return "Hello "+msg;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    };

}

代码说明
通过此类来调用msg，进行打印。

添加自动配置类

package com.pzr.spring_boot_stater_pzrhello;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 自动配置类
 * @author pzr
 *
 */
@Configuration
@EnableConfigurationProperties(HelloServiceProperties.class)
@ConditionalOnClass(HelloService.class)
@ConditionalOnProperty(prefix="hello",value="enabled",matchIfMissing=true)
public class HelloServiceAutoConfiguration {
    @Autowired
    private HelloServiceProperties helloServiceProperties;

    @Bean
    public HelloService helloService(){
        HelloService helloService = new HelloService();
        helloService.setMsg(helloServiceProperties.getMsg());
        return helloService;
    }



}

代码说明
1. @Configuration：使用该注解来说明该类是配置类，等价于xml中的beans
2. @EnableConfigurationProperties(HelloServiceProperties.class):开启属性注入，对注解配置Bean的支持
3. @ConditionalOnClass(HelloService.class)：条件注解，当类路径下有指定的类的条件下。
4. @ConditionalOnProperty(prefix=”hello”,value=”enabled”,matchIfMissing=true)：条件注解，指定的属性是否有指定的值。当设置hello=enabled,如果没有设置则默认为true，即为条件符合。假如我们将matchIfMissing设置为false，则当设置hello=enabled时，条件为false，则不会将该Bean加载进容器类，当使用@Autowired注入HelloService时会报错。

org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.pzr.spring_boot_stater_pzrhello.HelloService' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
  1. @Autowired：将属性配置类注入进来。
  2. @Bean：使用Java配置的方式来配置这个类，等价于xml中的bean。
  3. @ConditionalOnMissingBean(HelloService.class)：容器中没有这个Bean时，新建这个Bean。

注册配置

在src/main/resource下新建META-INFO/spring.factories文件。该文件可在spring-boot-1.5.1.RELEASE\spring-boot-autoconfigure\src\main\resources\META-INF下找到。
个人的只需要设置如下即可：

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.pzr.spring_boot_stater_pzrhello.HelloServiceAutoConfiguration

如果有多个，逗号分隔即可，如下：

# 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

同项目下使用

添加主方法

在当前项目下，添加MainApplication.java，用于测试之前写的starter是否成功

package com.pzr.spring_boot_stater_pzrhello;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
@SpringBootApplication
public class MainApplication {

    @Autowired
    HelloService helloService;

    @RequestMapping("/")
    public String index(){
        return helloService.sayHello();
    }

    public static void main(String[] args){
        SpringApplication.run(MainApplication.class, args);
    }
}

添加application.properties

在src/main/resources下添加application.properties配置文件

debug=true
hello.msg=1231231

debug是为了看到启动日志
hello.msg是我们自定义的打印内容

启动项目

结果如下：

打包使用

将项目打包并发到本地库

右键项目–>Run as–>Maven build..

输入clean install发到本地库

新建一个maven项目

修改pom文件

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>HelloConsumer</groupId>
    <artifactId>HelloConsumer</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <!-- 引用依赖的父包 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.1.RELEASE</version>
    </parent>
    <!--maven的插件 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <!-- 打成jar包后所执行的主函数 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <configuration>
                    <archive>
                        <manifest>
                            <addClasspath>true</addClasspath>
                            <mainClass>com.pzr.consumer.test.OfficialDemo</mainClass>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <!-- 依赖包 -->
    <dependencies>
        <!-- spring boot需要的包 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.pzr</groupId>
            <artifactId>spring-boot-starter-pzrhello</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

    </dependencies>
</project>

其中spring-boot-starter-pzrhello是我们刚刚打的包

添加MainApplication.java文件

package com.pzr.springbootautoconfig;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.pzr.spring_boot_stater_pzrhello.HelloService;


@RestController
@ComponentScan(basePackages={"com.pzr"})  
@SpringBootApplication
public class MainApplication {

    @Autowired
    HelloService helloService;

    @RequestMapping("/")
    public String index(){
        return helloService.sayHello();
    }

    public static void main(String[] args){
        SpringApplication.run(MainApplication.class, args);
    }
}

注意：如果不设置@ComponentScan(basePackages={“com.pzr”}) ，则会扫描不到com.pzr.spring_boot_stater_pzrhello下的bean,只会默认扫描所在类包下的所有目录。

添加application.properties

debug=true
hello.msg=pzrmsg

运行查看效果


从结果可以看出虽然spring-boot-starter-pzrhello包里也有application.properties文件，但是最终使用的是新项目中的application.properties文件的设置。

问题

  1. 无论我设不设置@ConditionalOnMissingBean(HelloService.class)，bean都会加载。
  2. 无论我在不在spring.factories中添加HelloServiceAutoConfiguration,配置都会生效。
  3. 在jar包使用时，如果不设置@ComponentScan(basePackages={“com.pzr”})将会报错，找不到bean。给注解是设置扫描位置的，可设置多个。
org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.pzr.spring_boot_stater_pzrhello.HelloService' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}

最近将会继续学习springboot，如果有大神能看到这篇笔记，希望能不吝赐教。

-贫寒豌豆
关注
专栏目录
SpringBoot--原理学习
冬日的暖阳
08-01 111
1、学习SpringBoot运行原理 1.1、pom.xml <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.3.2.RELEASE</version> <relativ
Spring-boot运行原理(Pom.xml)
qq_41359998的博客
08-30 223
Spring-boot运行原理(Pom.xml) Pom.xml 父依赖 其实它主要是依赖一个父项目，主要是管理项目的资源过滤及插件！ <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.2.5.RELEASE</version> &
Spring Boot的启动器Starter详解
热门推荐
chszs的专栏
01-30 8万+
Spring Boot的启动器Starter详解作者：chszs，未经博主允许不得转载。经许可的转载需注明作者和博客主页：http://blog.csdn.net/chszsSpring Boot应用启动器基本的一共有44种，具体如下：1）spring-boot-starter 这是Spring Boot的核心启动器，包含了自动配置、日志和YAML。2）spring-boot-starter-ac
SpringBoot（看这一篇就够了）
最新发布
m0_74436895的博客
07-30 1万+
Spring是一个非常优秀的轻量级框架，以IOC（控制反转）和AOP（面向切面）为思想内核，极大简化了JAVA企业级项目的开发。虽然Spring的组件代码是轻量级的，但它的配置却是重量级的。使用Spring进行项目开发需要在配置文件中写很多代码，所有这些配置都代表了开发时的损耗。除此之外，Spring项目的依赖管理也是一件耗时耗力的事情。在环境搭建时，需要分析要导入哪些库的坐标，而且还需要分析导入与之有依赖关系的其他库的坐标，一旦选错了依赖的版本，随之而来的不兼容问题就会严重阻碍项目的开发进度。比如Spri
自定义starter
weixin_67677668的博客
11-03 644
自定义starter
Spring Boot自动装配原理，SpringBootStarter
qq_44073614的博客
10-20 2845
Spring Boot Starter Spring Boot 大大简化了项目初始搭建以及开发过程，而这些都是通过Spring Boot 提供的starter来完成的。 starter介绍 springboot在配置上相比spring要简单许多，其核心在于spring-boot-starter，在使用spring boot来搭建一个项目时，只需要引入官方提供的starter，就可以直接使用，免去了各种配置。starter简单来讲就是引入了一些相关的依赖和一些初始化的配置 Spring 官方提供了很多star
1.从零开始学springboot-概念原理篇
CTO技术的博客
03-14 698
背景 公司统一技术栈，博主转型java，博主几年前从事过java web（ssh） &amp;amp; 安卓开发，所以有一定的底子，奈何时间太久了，忘的差不多了，所以边学习边记录 技术栈对比 基于目前的现状，基本上没什么选择，spring全家桶。早期还有不少基于Struts1&amp;amp;Struts2的项目，但是因为著名的RCE（远程代码执行）漏洞导致大批开发者远离。当然，基于一些历史原因，Struts还是...
SpringBoot基础-Starter原理
silly8543
01-18 138
SpringBoot基础-动手搭建starter及原理分析
SpringBoot学习笔记（一）——入门
qq_47102228的博客
03-11 198
SpringBoot2教程学习笔记1
SpringBoot——优势与自动装配原理
sduihoal的博客
05-27 705
一、SpringBoot自动装配原理 二、SpringBoot的配置 1. SpringBoot推荐使用.yaml来配置，与properties不同在于yml除了存储键值对外还可以存储对象。 三、
狂神说——SpringBoot学习
weixin_44543307的博客
12-06 5147
Springboot 学习笔记Springboot简介什么是微服务？ThymeleafDuridSpringboot整合mybatisSpringSecurity安全Shiroswagger定时任务springboot 整合分布式 dubbo+ zookeeper+ springbootDubboRPC（两大核心：通讯，序列化）Zookeeper总结 学习源码 spring官网 springboot官网 spring-security版本下载 狂神官网学习 也可以搜索B站 （狂神说） Springboot简
SpringBoot学习2——整合事务、HikariCP、druid、thymeleaf、Restful简单入门
zzhou——blog
02-27 470
文章目录0.学习目标1. 了解SpringBoot1.1.什么是SpringBoot1.2.为什么要学习SpringBoot1.3.SpringBoot的特点2.快速入门2.1.创建工程2.2.引入依赖2.3.编写HelloController2.4.启动测试2.5.详解2.5.1.启动器2.5.2.@EnableAutoConfiguration2.6.优化入门程序2.5.1.添加引导类2.5....
SpringBoot——基础入门
ouyangkq666的博客
02-23 656
一、SpringBoot2核心技术-基础入门 二、SpringBoot2入门 异常:This application has no explicit mapping for /error, so you are seeing this as a fallback. 三、了解自动配置原理 4、开发小技巧 1、Lombok 2、dev-tools 3、Spring Initailizr（项目初始化向导）
[SpringBoot] Spring Boot Starter
沫洺的博客
10-08 536
初识Spring Boot Starter
spring boot 的starter
jjavaboy的专栏
10-22 292
平时spring boot项目使用mybatis的可能很大概念都会见到引入依赖 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>xx.xx.xx</version> </dependency>
Spring Boot中的starter
金溪的博客
07-11 266
starter主要用来简化依赖用的，比如我们之前做mvc时需要引入日志组件，那么需要去找到log4j的版本，然后引入，现在有了starter之后，直接用这个后，log4j就自动引入了，也不用关心版本这些问题。   部分starters的依赖： Starter(Group ID: org.springframework.boot) 传递依赖于 spring-boot-starter-...
从零开始开发一个Spring Boot Starter
yxwb1253587469的博客
05-06 1865
原文地址：添加链接描述，添加链接描述 一.Spring Boot Starter简介 Starter是Spring Boot中的一个非常重要的概念，Starter相当于模块，它能将模块所需的依赖整合起来并对模块内的Bean根据环境（ 条件）进行自动配置。使用者只需要依赖相应功能的Starter，无需做过多的配置和依赖，Spring Boot就能自动扫描并加载相应的模块。 例如在Maven的依赖中加...
SpringBoot中的Starter
pan_junbiao的博客
03-25 995
1、了解Starter SpringBoot为了简化配置，提供了非常多的Starter。它先打包好与常用模块相关的所有JAR包，并完成自动配置，然后组装成Starter（如把Web相关的SpringMVC、容器等打包好后组装成 spring-boot-starter-web）。这使得在开发业务代码时不需要过多关注框架的配置，只需要关注业务逻辑即可。 SpringBoot提供了很多开箱即用的St...
【Spring Boot】Spring Boot 中的 Starter
书山有路，学海无涯。记录成长，追逐梦想
05-12 3746
Spring Boot 为了简化配置，提供了非常多的 Starter。它先打包好与常用模块相关的所有 JAR 包，并完成自动配置，然后组装成 Starter（如把 Web 相关的 Spring MVC、容器等打包好后组装成 spring-boot-starter-web）。这使得在开发业务代码时不需要过多关注框架的配置，只需关注业务逻辑即可。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

-贫寒豌豆

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值