@ConditionalOnClass的编译问题，用示例让你明白！

已于 2024-01-11 14:16:14 修改
阅读量1.2k 收藏 28
点赞数 18
文章标签： java 开发语言
于 2024-01-11 13:51:52 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lp1302190871/article/details/135526818
版权
文章探讨了如何在SpringBoot中使用@ConditionalOnClass注解进行条件性配置，以及如何通过Maven的optional标签管理依赖，确保即使类不存在也能通过编译，同时实现代理自动配置的功能。
摘要由CSDN通过智能技术生成

问题

在学习@ConditionalOnClass注解时，我有个百思不得其解的问题，如以下内容

package com.example.child.config;

import com.example.parent.model.Test;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnClass(value = Test.class)
public class TestConfig {
    public TestConfig() {
        System.out.println("config实例化");
    }
}

在这里插入图片描述

现在类路径中没有Test这个类，那肯定编译都通不过，所以@Test(value = {Test.class})那肯定需要有Test类，那么Test类肯定在类路径下，一旦有Test类，TestConfig肯定被实例化，那这么配置有什么意义，你是不是有这个疑问？

其实就是通过maven的一些配置让包能通过编译，实际上不让文件进入包中。

spring中的应用

在这里插入图片描述

spring中如何做到这种项目中没有SecurityEvaluationContextExtension类，但是却通过编译的。

我看看一看spring-boot的依赖关系
在这里插入图片描述
在这里插入图片描述
其实就是通过maven配置optional达到的效果，optional允许我们将某些依赖项声明为可选。了解optional可以看看我的另一篇文章，optional详解

示例

我建了三个项目，分别为parent-maven，maven-child，springTest来实践@ConditionalOnClass怎么做到自动配置。

parent-maven

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>parent-maven</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>parent-maven</name>
    <description>parent-maven</description>
    <properties>
        <java.version>8</java.version>
    </properties>
     <dependencies>
    </dependencies>
</project>

Test代码

package com.example.parent.model;

public class Test {
    public Test() {
        System.out.println("Test实例化");
    }
}

该项目中新建了一个Test类，pom文件中什么依赖都没引入。

打包

在这里插入图片描述

安装到maven仓库

maven-child

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

pom文件

parent-mavenparent-maven<optional>true</optional><?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>maven-child</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>maven-child</name>
    <description>maven-child</description>
    <properties>
        <java.version>8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot</artifactId>
            <version>2.2.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-test</artifactId>
            <version>2.2.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>parent-maven</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
            <version>2.2.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.2.0.RELEASE</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

<optional>true</optional>这一句特别重要，将parent-maven设置为可选的。

TestConfig代码

package com.example.child.config;

import com.example.parent.model.Test;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnClass(value = Test.class)
public class TestConfig {
    public TestConfig() {
        System.out.println("config实例化");
    }
}

TestConfig是我的配置文件类，我想的是当我类路径下有Test时我就加载这个配置文件，没有时我就不加载，当然这个项目时会被打包为一个jar供别的项目使用。

打包

在这里插入图片描述

安装到maven仓库

springTest

现在就是重点，我想动态的去加载TestConfig配置文件，当引入依赖时就去配置，像spring的很多自动配置一样。

springTest是一个springBoot项目。

在这里插入图片描述

pom文件

maven-childmaven-child<?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 https://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.2.0.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>springTest</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>springTest</name>
	<description>springTest</description>
	<properties>
		<java.version>8</java.version>
		<maven.compiler.source>8</maven.compiler.source>
		<maven.compiler.target>8</maven.compiler.target>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<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.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>2.1.1</version>
		</dependency>
		<dependency>
			<groupId>com.github.shyiko</groupId>
			<artifactId>mysql-binlog-connector-java</artifactId>
			<version>0.21.0</version>
		</dependency>
		<dependency>
			<groupId>com.example</groupId>
			<artifactId>maven-child</artifactId>
			<version>0.0.1-SNAPSHOT</version>
		</dependency>
	</dependencies>

	<build>

		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

我现在引入了maven-child依赖，该依赖中有TestConfig配置文件，当类路径中有Test类时会自动配置。

在这里插入图片描述

启动spring

在这里插入图片描述

从图中没有看到打印“config实例化”，所以TestConfig配置类没有被加载。

注意：spring启动时需要需要扫到TestConfig类，这点很重要。
在这里插入图片描述

现在我想要自动配置怎么办，这是我们就得显示的加上 parent-maven依赖。

在这里插入图片描述
在这里插入图片描述
在启动spring
在这里插入图片描述
成功加载配置文件，spring很多自动配置就是这样做的，都看到这儿点个赞再走吧。

下雨天u
关注
  • 18
    点赞
  • 踩
  • 28
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
SpringBoot，写完老板又让我转回后端
林高禄
02-04 1997
SpringBoot1：SpringBoot基础入门1-1：什么是SpringBoot1-2：什么是微服务 1：SpringBoot基础入门 1-1：什么是SpringBoot 什么是Spring        Spring是一个开源框架，2003年兴起的一个轻量级的Java开发框架，作者：Rod Johnson。        Spring是为了解决企
Sqlite3编译及使用示例代码
08-22
这篇资源提供的是SQLite3的编译工程和使用示例，非常适合初学者快速上手。 SQLite3的编译过程通常涉及以下步骤： 1. **获取源码**：首先，你需要从SQLite3的官方网站（https://www.sqlite.org/download.html）下载...
@ConditionalOnClass注解分析
热门推荐
雪落南城的博客
03-07 9万+
Spring中为Kafka提供了一个自动配置类 KafkaAutoConfiguration 在类上有一个注解 @ConditionalOnClass(KafkaTemplate.class) 这个注解通俗的说就是Spring工程中引用了Kafka的包 才会构建这个bean 官方解释： /** * {@link Conditional} that only matches wh...
@ConditionalOnClass编译问题
a14654的博客
06-23 957
@ConditionOnClass的编译问题
Redis怎么学?有这篇文章就足够了！
南迪叶先森
10-16 867
Redis怎么学?有这篇文章就足够了！ 官方网站：https://redis.io/ 中文官网：http://www.redis.cn/ 下载和安装（Linux） 1、下载获取安装包( 地址：https://redis.io 2、安装 前提是以及安装的c环境： # yum install gcc-c++ 检查是后安装成功 # gcc -v # make && make install 1、通过ftp工具将redis安装包上传到远程Linux服务器/usr/local/tmp文件夹
Spring源码深度解析(郝佳)-Spring 常用注解使用及源码解析
黄裳博客
06-18 1067
  我们在看Spring Boot源码时，经常会看到一些配置类中使用了注解，本身配置类的逻辑就比较复杂了，再加上一些注解在里面，让我们阅读源码更加难解释了，因此，这篇博客主要对配置类上的一些注解的使用以及实现原理做分析，从而让阅读源码更加简单一点。   Spring boot 集成mybatis时，就有一个非常重要的配置类MybatisAutoConfiguration，这个类上配置了一堆注解，如下 @org.springframework.context.annotation.Configuration
Spring Boot 核心编程思想-第一部分-读书笔记
阿飞云漫步
08-01 1061
怕什么真理无穷进一步有近一步的欢喜说明本文是Spring Boot核心编程思想记录的笔记，书籍地址：Spring Boot编程思想（核心篇）：本书已经简单读过一遍，在第一遍读的时候发现里面...
一份12W+字数的踩坑总结，覆盖前端、后端、运维三个维度，一步一个脚印，我们一起成长！（实时更新）
avengerEug的博客
04-03 7301
文章目录1.1 Css/Scss1.1.1 层叠性1.1.2 继承性1.1.3 优先级1.1.4 backgroud设置背景图片样式顺序决定是否生效1.1.5 Vue在元素中要使用当前vue对象的属性作为图片路径显示在 background-image: url() css上解决办法1.1.6 div里面的内容如何垂直居中1.1.7 RGBA1.1.8 块级元素1.1.9 行级元素1.1.10 行内块元素1.1.11 行高1.1.12 浮动1.2 Java Script1.2.1 Object.assig.
注解---
m0_53979787的博客
02-21 5162
@DS注解的使用，动态数据源，事务： 首先，引入jar包： <dependency> <groupId>com.baomidou</groupId> <artifactId>dynamic-datasource-spring-boot-starter</artifactId> <version>2.5.4</version> </dependency> 然后，在Springboot的application
一：SpringBoot自动配置原理、自定义starter
Xx__WangQi的博客
03-25 497
目录 1、SpringBoot的自动配置原理 一、简介 二、原理 2、自定义starter 一、简介 二、如何自定义starter 3、自定义starter实例 4、测试自定义starter 1、SpringBoot的自动配置原理 一、简介 不知道大家第一次搭SpringBoot环境的时候，有没有觉得非常简单。无须各种的配置文件，无须各种繁杂的pom坐标，一个main方法，就能run起来了。与其他框架整合也贼方便，使用EnableXXXXX注解就可以搞起来了！ 所以今天来学习一.
使用webpack4编译并压缩ES6代码的方法示例
01-19
然后其实该引擎会将自己写的代码打包在一个js文件中，所以也就只有一个js文件是没有压缩的，所以我就想到了自己使用webpack单独对这个文件进行压缩，并将ES6语法编译成ES5，做低版本浏览器的兼容。 第一步安装...
android开发实践之ndk编译命令简单示例
01-04
Android提供了NDK工具，用来编译native代码（c/c++），该工具配置好了相关的交叉编译环境和工具链，只需要你简单地编写几个.mk文件即可将你的c/c++代码编译为Android的java工程/Android手机可以识别、加载和运行的库...
Sublime Text 3 实现C++代码的编译和运行示例
12-31
在数据结构代码的编写中，我选用了优秀的编辑器Sublime Text 3，但是在实现C++代码的编译和运行上费了一番周折，接下来我贴出C++编译系统的代码，供各位参考。 编译后是在弹出的CMD命令行窗口运行的，因为若在...
Cython编译python为so 代码加密示例
12-23
1. 编译出来的so比网上流传的其他方法小很多。 2. language_level 是python的主版本号，如果python版本是2.x,目前的版本Cython需要人工指定language_level. 3. python setup.py build_ext –inplace 执行脚本 4. ...
【C#】找不到属性集方法。get只读属性用了反射设置setValue肯定报错
小5聊的博客
06-26 1844
找不到属性集方法。get只读属性用了反射设置setValue肯定报错
配置系统PATH环境变量
最新发布
06-29 645
PATH环境变量在操作系统中起着非常重要的作用，特别是在命令行或脚本中执行程序时，系统会根据PATH环境变量中定义的路径查找可执行文件。当用户在命令行或脚本中输入一个命令时，系统会根据PATH环境变量中定义的路径依次查找对应的可执行文件，如果找到则执行。本文详细介绍了如何配置系统的PATH环境变量，包括在Windows和Linux系统中的操作步骤。在Linux系统中，可以通过编辑shell配置文件来配置PATH环境变量，常用的shell配置文件包括.bashrc、.bash_profile等。
解决Java中的数组越界异常的技术
weixin_44627014的博客
06-26 852
通过本文的讨论，我们了解了如何有效地处理Java中的数组越界异常。预防异常的发生，合理使用异常处理机制以及考虑使用集合类来替代数组，是确保Java应用程序稳定性和可靠性的关键步骤。
基于weixin小程序智慧物业系统的设计
ing65768的博客
06-27 486
管理员账户功能包括：系统首页，个人中心，管理员管理，用户管理，员工管理，房屋管理，缴费管理，车位管理，报修管理。主要技术：Java,Spring,mybatis,mysql,jquery,html。工作人员账号功能包括：系统首页，维修管理，维修指派，公告管理，轮播图信息。服务器：SpringBoot自带 apache tomcat。JDK版本：Java JDK1.8。数据库可视化工具： navicat。数据库版本： mysql5.7。开发工具：IDEA(推荐)开发系统：Windows。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值