AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

spring学习笔记（六）自定义spring-boot-starter（2）

2022-11-10 130
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 上篇文章我们主要讲了spring自动装配的原理，我们知道了springboot在启动的时候会自动去读.factories文件，在factories文件中，autoConfiguration对应的就是我们程序启动时自己预加载的类，另外我也提到了另外一个比较核心的注解，即@ConditionOnxxx。详情点击https://blog.csdn.net/qq_41907991/article/details/88704448。

这篇文章我们主要分析下@ConditionOnxxx注解，以及自己实现一个starter。下面开始分析我们的@ConditionOnxxx注解。先看代码：

我们以@ConditionalOnMissingBean这个注解来分析原理：

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

很明显，上面的核心注解就是@Conditional注解，我们接下来分析这个注解，直接上代码看效果

package com.study.spring.condition.condition;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
/**
 * @Author: dmz
 * @Description:
 * @Date: Create in 23:16 2019/3/25
 */
public class CatCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return context.getEnvironment().getProperty("what").equals("cat");
    }
}
package com.study.spring.condition.condition;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
/**
 * @Author: dmz
 * @Description:
 * @Date: Create in 23:16 2019/3/25
 */
public class DogCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return context.getEnvironment().getProperty("what").equals("dog");
    }
}

上面这两个类，是我自定义的两个条件

package com.study.spring.condition.model;
import com.study.spring.condition.condition.CatCondition;
import org.springframework.context.annotation.Conditional;
import org.springframework.stereotype.Component;
/**
 * @Author: dmz
 * @Description:
 * @Date: Create in 23:19 2019/3/25
 */
@Component
@Conditional({CatCondition.class})
public class Cat {
    public Cat(){
        System.out.println("猫来了，喵喵喵~~");
    }
}
package com.study.spring.condition.model;
import com.study.spring.condition.condition.DogCondition;
import org.springframework.context.annotation.Conditional;
import org.springframework.stereotype.Component;
/**
 * @Author: dmz
 * @Description:
 * @Date: Create in 23:18 2019/3/25
 */
@Component
@Conditional({DogCondition.class})
public class Dog {
    public Dog(){
        System.out.println("dog 来了，汪汪汪~~~");
    }
}

主要是为了通过条件控制我们这两个类的加载

what:cat

这是配置文件中的内容

package com.study.spring.condition;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class ConditionApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConditionApplication.class, args);
    }
}

这是启动类

启动程序，可以看到程序打印：

经过上面的程序我相信大家对这个@conditional注解已经有了一定的了解

接下来我们来实现我们的自定义starter

pom文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.study.spring</groupId>
    <artifactId>starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>myAutoconfig-spring-boot-starter</name>
    <description>Demo project for Spring Boot</description>
    <packaging>jar</packaging>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <!--为了生成spring-configuration-metadata.json-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

整体项目结构如下

image.png

package com.study.spring.starter.AutoConfig;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
 * @author dmz
 * @date Create in 22:06 2019/3/23
 */
@Data
@ConfigurationProperties(prefix = "config")
public class Config {
    private String name;
    private Integer age;
}
package com.study.spring.starter.AutoConfig;
import com.study.spring.starter.service.MyService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
 * @author dmz
 * @date Create in 21:24 2019/3/23
 */
@Configuration
@EnableConfigurationProperties(Config.class)
@ConditionalOnClass(MyService.class)
public class MyAutoConfig {
    @Bean
    @ConditionalOnMissingBean(MyService.class)
    public MyService getMyService() {
        return new MyService();
    }
}
package com.study.spring.starter.service;
import com.study.spring.starter.AutoConfig.Config;
import org.springframework.beans.factory.annotation.Autowired;
/**
 * @author dmz
 * @date Create in 21:53 2019/3/23
 */
public class MyService {
    @Autowired
    private Config config;
    public void say() {
        System.out.println("自定义的starter来了,say:" + config.getName());
    }
}
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
 *保留启动类，主要是为了执行maven的命令，
 * 打包到我们的本地仓库
 */
@SpringBootApplication
public class StarterApplication{
    public static void main(String[] args) {
        SpringApplication.run(StarterApplication.class, args);
    }
}

spring.factories文件如下

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.study.spring.starter.AutoConfig.MyAutoConfig

测试代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.study.spring</groupId>
    <artifactId>starter-test</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>starter-test</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
         <!--引入我们的依赖-->
        <dependency>
            <groupId>com.study.spring</groupId>
            <artifactId>starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

启动类：

package com.study.spring.startertest;
import com.study.spring.starter.service.MyService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class StarterTestApplication implements ApplicationRunner {
    @Autowired
    private MyService myService;
    public static void main(String[] args) {
        SpringApplication.run(StarterTestApplication.class, args);
    }
    @Override
    public void run(ApplicationArguments args) throws Exception {
        myService.say();
    }
}

我们在测试项目中加了配置信息

image.png

运行结果如下：

  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.1.3.RELEASE)
2019-03-27 00:09:52.995  INFO 19468 --- [           main] c.s.s.s.StarterTestApplication           : Starting StarterTestApplication on DESKTOP-N88SU6M with PID 19468 (C:\Users\dell\Desktop\spring-master\starter-test\target\classes started by dell in C:\Users\dell\Desktop\spring-master)
2019-03-27 00:09:52.999  INFO 19468 --- [           main] c.s.s.s.StarterTestApplication           : No active profile set, falling back to default profiles: default
2019-03-27 00:09:53.416  INFO 19468 --- [           main] c.s.s.s.StarterTestApplication           : Started StarterTestApplication in 0.722 seconds (JVM running for 1.243)
自定义的starter来了,say:zhangsan
Process finished with exit code 0

验证成功

项目github地址：https://github.com/daimingzhi/spring.git

文章标签：
Java
Spring
关键词：
Spring自定义
Spring学习笔记
程序员DMZ
目录
相关文章
喜欢猪猪
|
9天前
|
前端开发 Java 开发者
Spring生态学习路径与源码深度探讨
【11月更文挑战第13天】Spring框架作为Java企业级开发中的核心框架，其丰富的生态系统和强大的功能吸引了无数开发者的关注。学习Spring生态不仅仅是掌握Spring Framework本身，更需要深入理解其周边组件和工具，以及源码的底层实现逻辑。本文将从Spring生态的学习路径入手，详细探讨如何系统地学习Spring，并深入解析各个重点的底层实现逻辑。
喜欢猪猪
35 9
iamzfh
|
29天前
|
前端开发 Java 数据库
SpringBoot学习
【10月更文挑战第7天】Spring学习
iamzfh
34 9
iamzfh
|
30天前
|
XML Java 数据格式
Spring学习
【10月更文挑战第6天】Spring学习
iamzfh
19 1
java冯坚持
|
1月前
|
Java 测试技术 开发者
springboot学习四：Spring Boot profile多环境配置、devtools热部署
这篇文章主要介绍了如何在Spring Boot中进行多环境配置以及如何整合DevTools实现热部署，以提高开发效率。
java冯坚持
56 2
java冯坚持
|
1月前
|
前端开发 Java 程序员
springboot 学习十五：Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
java冯坚持
84 1
java冯坚持
|
1月前
|
Java API Spring
springboot学习七：Spring Boot2.x 拦截器基础入门&实战项目场景实现
这篇文章是关于Spring Boot 2.x中拦截器的入门教程和实战项目场景实现的详细指南。
java冯坚持
25 0
springboot学习七：Spring Boot2.x 拦截器基础入门&实战项目场景实现
java冯坚持
|
1月前
|
Java API Spring
springboot学习六：Spring Boot2.x 过滤器基础入门&实战项目场景实现
这篇文章是关于Spring Boot 2.x中过滤器的基础知识和实战项目应用的教程。
java冯坚持
23 0
springboot学习六：Spring Boot2.x 过滤器基础入门&实战项目场景实现
java冯坚持
|
1月前
|
Java 关系型数据库 MySQL
springboot学习五：springboot整合Mybatis 连接 mysql数据库
这篇文章是关于如何使用Spring Boot整合MyBatis来连接MySQL数据库，并进行基本的增删改查操作的教程。
java冯坚持
64 0
springboot学习五：springboot整合Mybatis 连接 mysql数据库
java冯坚持
|
1月前
|
Java 关系型数据库 MySQL
springboot学习四：springboot链接mysql数据库，使用JdbcTemplate 操作mysql
这篇文章是关于如何使用Spring Boot框架通过JdbcTemplate操作MySQL数据库的教程。
java冯坚持
24 0
springboot学习四：springboot链接mysql数据库，使用JdbcTemplate 操作mysql
java冯坚持
|
1月前
|
Java 测试技术 Spring
springboot学习三：Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件
这篇文章介绍了Spring Boot中配置文件的语法、如何读取配置文件以及如何通过静态工具类读取配置文件。
java冯坚持
46 0
springboot学习三：Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件

热门文章

最新文章

  • 1
    Spring-boot+Dubbo应用启停源码分析
  • 2
    牛逼!这份神仙级Spring Cloud Alibaba全套笔记,几乎涵盖了所有操作
  • 3
    配置springmvc在其他类中（spring容器外）获取注入bean
  • 4
    Spring中注入基本类型
  • 5
    Initialization failed for 'https://start.spring.io' Please check URL, network and proxy settings.
  • 6
    Spring Cloud实战小贴士：Zuul统一异常处理（一）
  • 7
    Spring Boot Controller
  • 8
    转：spring配置文件中xsd引用问题
  • 9
    spring boot应用启动原理分析
  • 10
    Spring装配Bean---使用xml配置
  • 1
    Spring Boot框架在java领域的优势
    76
  • 2
    Spring事务管理嵌套事务详解 : 同一个类中，一个方法调用另外一个有事务的方法
    261
  • 3
    spring 事务控制 设置手动回滚 TransactionAspectSupport.currentTransactionStatus().setRollbackOnly()；
    116
  • 4
    面试一口气说出Spring的声明式事务@Transactional注解的6种失效场景
    119
  • 5
    nested exception is org.springframework.beans.factory.BeanCurrentlyInCreationException（Spring循环依赖问题）
    102
  • 6
    【spring cloud】注解@SpringCloudApplication和@SpringBootApplication的区别
    61
  • 7
    Spring Boot 2.x 嵌入式 Servlet 容器
    62
  • 8
    Spring Cloud微服务框架：构建高可用、分布式系统的现代架构
    183
  • 9
    Java技术栈中的核心组件：Spring框架
    52
  • 10
    基于SpringBoot+Vue+uniapp的公园管理系统的详细设计和实现(源码+lw+部署文档+讲解等)
    74

    • 相关课程

    更多
  • 全面讲解Spring Cloud Alibaba技术栈（知识精讲+项目实战）第一阶段
  • 精通Spring Cloud Alibaba
  • 微服务框架 Spring Cloud 快速入门
  • Java Web开发系列课程 - Spring框架入门
  • Spring Boot 2.5.x开发实战
  • Spring Cloud微服务架构设计与开发实战

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库

    • 相关实验场景

    更多
  • Spring-cloud-bus-rocketmq入门与实践
  • Spring-cloud-stream-binder-rocketmq入门与实践
  • Rocketmq-spring入门与实践
  • 从零搭建Spring Boot的Hello World
    • 下一篇
    阿里云OSS设置跨域访问