扫描注解指定路径

最新推荐文章于 2025-05-23 17:03:50 发布
最新推荐文章于 2025-05-23 17:03:50 发布
阅读量657 收藏 11
点赞数 25
文章标签： java 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/m0_49054880/article/details/146542240
版权

10.扫描注解

在 Spring Boot 中，@EnableConfigurationProperties 和 @ConfigurationPropertiesScan 是两个用于显式启用和管理 @ConfigurationProperties 类的注解。它们提供了更灵活的方式来注册和扫描 @ConfigurationProperties 类，尤其是在某些复杂场景或非标准的配置类路径下（非根包路径）。

@EnableConfigurationProperties

@EnableConfigurationProperties 注解用于显式启用 @ConfigurationProperties 的支持。它通常用于以下场景：

  • 当你没有使用 @SpringBootApplication 注解（它已经隐式启用了 @ConfigurationProperties 支持）。
  • 当你需要手动注册一个或多个 @ConfigurationProperties 类时。

使用 @EnableConfigurationProperties

假设你有一个 @ConfigurationProperties 类 MyAppProperties，但没有使用 @SpringBootApplication 注解，你可以通过在启动类加上 @EnableConfigurationProperties 来启用它。

MyAppProperties.java

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

@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {
    private String name;
    private int port;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getPort() {
        return port;
    }

    public void setPort(int port) {
        this.port = port;
    }
}

MainApplication.java

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

@SpringBootApplication
// 显式启用和管理 MyAppProperties.class
//@EnableConfigurationProperties( 待开启的类名.class)
// //@EnableConfigurationProperties({User.class})   另一种写法
@EnableConfigurationProperties(MyAppProperties.class)
public class MainApplication {
    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
    }
}

在这个例子中，@EnableConfigurationProperties 被用来显式注册 MyAppProperties 类。如果你的 @ConfigurationProperties 类没有被自动扫描到（例如，它不在组件扫描的路径下），这种方式非常有用。

@ConfigurationPropertiesScan

@ConfigurationPropertiesScan 是 Spring Boot 2.4 引入的一个注解，用于显式指定 @ConfigurationProperties 类的扫描路径。它类似于 @ComponentScan，但专门用于 @ConfigurationProperties 类。

使用 @ConfigurationPropertiesScan

假设你的 @ConfigurationProperties 类位于一个非标准的包路径下（不在根包路径），你可以使用 @ConfigurationPropertiesScan 来指定扫描路径。

MyAppProperties.java

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

@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {
    private String name;
    private int port;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getPort() {
        return port;
    }

    public void setPort(int port) {
        this.port = port;
    }
}

MainApplication.java

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.ConfigurationPropertiesScan;

@SpringBootApplication
@ConfigurationPropertiesScan("com.example.config") // 指定扫描路径
//   @ConfigurationPropertiesScan("包名") 
// @ConfigurationPropertiesScan (basePackages = {"com.yanyu"})
public class MainApplication {
    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
    }
}

在这个例子中，@ConfigurationPropertiesScan 被用来指定扫描路径 com.example.config，Spring Boot 会在这个包路径下查找带有 @ConfigurationProperties 注解的类并注册为 Bean。

总结

  • @EnableConfigurationProperties：用于显式启用 @ConfigurationProperties 支持，通常用于手动注册一个或多个 @ConfigurationProperties 类。
  • @ConfigurationPropertiesScan：用于显式指定 @ConfigurationProperties 类的扫描路径，类似于 @ComponentScan，但专门用于 @ConfigurationProperties 类。

在大多数情况下，如果你使用了 @SpringBootApplication 注解，Spring Boot 会自动启用 @ConfigurationProperties

支持并扫描默认的包路径。

如果你需要更灵活的控制，可以使用 @EnableConfigurationProperties 或 @ConfigurationPropertiesScan。

案例

@EnableConfigurationProperties

image-20250324232757778

User.java

package com.yanyu.bean2.pk1;

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

import java.util.Objects;

/**
 * @Author yanyu666_508200729@qq.com
 * @Date 2025/3/24 23:14
 * @description:
 */
@ConfigurationProperties(prefix = "user")
public class User {
    String name;
    Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        User user = (User) o;
        return Objects.equals(name, user.name) && Objects.equals(age, user.age);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, age);
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

启动类

package com.yanyu.bean2;

import com.yanyu.bean2.pk1.User;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

@SpringBootApplication
//  显示开启 `@ConfigurationProperties
//@EnableConfigurationProperties({User.class})
@EnableConfigurationProperties(User.class)

public class Bean2Application {

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

}

test

package com.yanyu.bean2;

import com.yanyu.bean2.pk1.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class Bean2ApplicationTests {
//	取出对象
	@Autowired
	User user;

	@Test
	void contextLoads() {
	}
	@Test
	void test1(){
		System.out.println(user);
	}

}

image-20250324232916700

@ConfigurationPropertiesScan

image-20250324233101121

User.java

package com.yanyu;

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

import java.util.Objects;

/**
 * @Author yanyu666_508200729@qq.com
 * @Date 2025/3/24 23:14
 * @description:
 */
@ConfigurationProperties(prefix = "user")
public class User {
    String name;
    Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        User user = (User) o;
        return Objects.equals(name, user.name) && Objects.equals(age, user.age);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, age);
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}


package com.yanyu.bean2;

import com.yanyu.User;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

@SpringBootApplication
//  显示开启 `@ConfigurationProperties
//@EnableConfigurationProperties({User.class})
//@EnableConfigurationProperties(User.class)
//@ConfigurationPropertiesScan(basePackages = {"同时指定扫描多个包下面的类",""})
@ConfigurationPropertiesScan(basePackages = {"com.yanyu"})
public class Bean2Application {

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

}

image-20250324233449134

11.处理第三方库对象

上面的例子都是在源代码中使用@ConfigurationProperties 注解，如果某个类需要在配置文件中提供数据，但

是没有源代码。此时@ConfigurationProperties 结合@Bean 一起在方法上面使用，利用 bean 去 映射信息到，符合 Javabean 规范的类中，再 利用 @ bean 把对象丢到 IOC 容器

  • 情景：
    • 没有源代码，只有 .class 或者 .class 打包未一个 . jar
    • 例如，引用MySQL驱动后，配置数据库的信息

某个值未 null

image-20250325002513183

no —> 换成 id 解决

image-20250325003420421

application.yml

phone:
  name: iqoo
  id: v1992


package com.yanyu.bean3.pk1;

import java.util.Objects;

/**
 * @Author yanyu666_508200729@qq.com
 * @Date 2025/3/25 0:28
 * @description:
 */
public class Phone {
    String name;
    String id;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getid() {
        return id;
    }

    public void setid(String id) {
        this.id = id;
    }

    @Override
    public String toString() {
        return "Phone{" +
                "name='" + name + '\'' +
                ", id='" + id + '\'' +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Phone phone = (Phone) o;
        return Objects.equals(name, phone.name) && Objects.equals(id, phone.id);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, id);
    }
}


package com.yanyu.bean3.pk1;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Service;

/**
 * @Author yanyu666_508200729@qq.com
 * @Date 2025/3/24 23:48
 * @description:
 */
@Configuration
public class PhoneConfig {
    /*在方法上使用  ConfigurationProperties
    和  bean
    *
    * */
//    把下面方法返回的对象，放到IOC 容器

//    把配置文件的内容，映射到  new Phone  对应的  符合  javabean 规范的类上
    @ConfigurationProperties(prefix = "phone")
    @Bean
    public Phone createPhone(){
        return new Phone();
    }
}


package com.yanyu.bean3;

import com.yanyu.bean3.pk1.Phone;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class Bean3ApplicationTests {
    @Autowired
    Phone phone;

    @Test
    void contextLoads() {
    }
    @Test
    void test1(){
    System.out.println(phone);
}

}

image-20250325003654368

问题：莫名其妙， no 一致 为 null ，no 改 id 就没事

2. 检查字段类型是否正确

确保配置文件中的属性值类型与字段类型匹配。如果字段类型是 Integer，配置文件中的值必须是一个整数；如果字段类型是 String，配置文件中的值必须是一个字符串。

示例

如果字段类型是 Integer，配置文件中的值必须是整数：

yaml复制

myapp:
  port: 8080  # 必须是整数

如果配置文件中的值是字符串（例如，port: "8080"），Spring 会尝试将其转换为 Integer，但如果值是无效的（例如，port: "abc"），字段将为 null。

通过注解扫描加载指定路径下的所有注解定义的规则类
天才小站
08-21 1638
通过注解，扫描加载指定路径下的所有注解定义的规则类，实现方法。 思想： 扫描注册，映射匹配。 优势： 解耦，代码易读，组件化等等 应用场景和具体实现大家可自行摸索。 以下为示例代码，提供思路，可自行修改。 方法一：扫描class文件，通过反射实例化对象，适合有状态对象。 import java.util.ArrayList; import java.util.List; imp...
JAVA——通过自定义注解实现每次程序启动时，自动扫描被注解的方法，获取其路径及访问该路径所需的权限并写入数据库
weixin_56039103的博客
09-20 3181
在需要扫描的微服务项目中新建一个自定义注解，因为这里定义的注解用于鉴权，因此给该注解取名叫做MyAccessControlAnnotation//@Retention--用于指定注解保留范围：SOURCE源码 --> CLASS字节码 --> RUNTIME运行 @Retention(RetentionPolicy . RUNTIME) //@Target--用于标记这个注解应该是哪种 Java 成员，METHOD用于放方法头上 @Target({
SpringBoot自定义配置文件路径
fhxyryxc的博客
12-23 853
在启动类中手动指定配置文件的加载路径： @SpringBootApplication @EnableDiscoveryClient public class NacosServerAppStarter { public static void main(String[] args) { String path = "spring.config.additional-location:classpath:/"; path += ",classpath:/dev/"; path += ",clas
【Spring IoC】深入解析 Spring 扫描路径机制：通过@SpringBootApplication源码解读 Spring 默认扫描路径及 @ComponentScan 显示指定扫描路径方法
OuO-1 的博客
03-24 655
【Spring IoC】深入解析 Spring 扫描路径机制：通过@SpringBootApplication源码解读 Spring 默认扫描路径及 @ComponentScan 显示指定扫描路径方法
【Spring Boot 对Bean扫描的几种方式】
qq_33545255的博客
12-06 1175
Spring Boot通过简化配置，使得Bean的扫描变得更加容易。通过注解，Spring Boot自动扫描启动类所在包及其子包中的Bean。如果需要自定义扫描路径，可以使用注解来指定。这些机制使得Spring Boot在微服务架构中非常受欢迎，因为它大大减少了配置的复杂性。
Springboot指定扫描路径
weixin_74261199的博客
02-24 3415
前提：配置类要在启动类所在包或子包下 ( 保证配置类要被扫描到 )
SpringBoot的默认包扫描路径
小志的博客
10-21 9595
目录一、SpringBoot如何读取到我们的配置类二、SpringBoot默认的包扫描路径 一、SpringBoot如何读取到我们的配置类 当我们编写配置类的时候，我们发现，并没有指定我们的配置类所在的位置，那么SpringBoot就可以读取到我们的配置类。那这是怎么做到的呢？ 在SpringBoot框架的源码中，已经提供了默认的包扫描路径，当然，也是支持我们通过application.yaml或者application.properties去做定制化修改（可以通过@ComponentScan或者scan
aop切点注解扫描路径
zchlove137的博客
06-19 2450
任意公共方法的执行： execution（public * *（..）） 任何一个名字以“set”开始的方法的执行： execution（* set*（..）） AccountService接口定义的任意方法的执行： execution（* com.xyz.service.AccountService.*（..）） 在service包中定义的任意方法的执行： execution（* com.xyz...
@SpringBootApplication注解上指定扫描路径
03-29
如果需要指定其他扫描路径，可以在@SpringBootApplication注解上使用@ComponentScan注解，例如： @SpringBootApplication @ComponentScan(basePackages = {"com.example.controller", "com.example.service"}) ...
通过java的反射技术获取，某个包路径下的类，并以表格形式打印类的属性注解注释及属性名称等
03-15
在给定的场景中，我们需要实现的功能是遍历指定包路径下的所有类，获取它们的属性信息，包括属性的注解和注释，并以表格形式输出。 首先，我们需要通过`Package.getPackage(String name)`方法获取指定包名的Package...
spring boot- 自定义配置文件路径、配置文件的加载顺序（--spring.config.additional-location 自定义配置文件路径）
西京刀客
12-21 2万+
SpringBoot配置文件 SpringBoot使用一个以application命名的配置文件作为默认的全局配置文件。支持properties后缀结尾的配置文件或者以yml/yaml后缀结尾的YAML的文件配置。 配置文件目录 SpringBoot配置文件存放位置以及读取顺序 参考URL: https://www.jianshu.com/p/780f83a40a90 配置文件目录 SpringB...
@SpringBootApplication的使用
码农
08-29 5万+
之前用户使用的是3个注解注解他们的main类。分别是@Configuration,@EnableAutoConfiguration,@ComponentScan。由于这些注解一般都是一起使用，spring boot提供了一个统一的注解@SpringBootApplication。 @SpringBootApplication = (默认属性)@Configuration + @EnableAut
springboot编程式指定默认的application.properties文件路径
CallMeV6
07-05 4468
解决方案一：编程式指定   Properties defaultProperties = new Properties(); InputStream in;     try {         in = new FileInputStream("E:/conf/application.properties"); defaultProperties.load(in); in.close();...
SpringBoot 启动类 @SpringBootApplication 注解 以及执行流程
热门推荐
殇莫忆的博客
07-31 20万+
@SpringBootApplication  : 是Sprnig Boot项目的核心注解，目的是开启自动配置   目录 @SpringBootApplication  : 是Sprnig Boot项目的核心注解，目的是开启自动配置 （一）、@ComponentScan 注解 （二）、@EnableAutoConfiguration 注解 （三）、@SpringBootConfigur...
Spring Boot的被@SpringBootApplication注解的App.java必须放在所有的RestController的根路径的package下
liushaoming
12-12 8846
Spring Boot的被@SpringBootApplication注解的App.java必须放在所有的RestController的根路径的package下 如下图。App.java 的package是com.frank.img.controller UserCardWriterController的package是com.frank.img.controller.writer
springboot启动类扫描路径
u012810057的博客
09-18 2万+
springboot启动类的默认扫描路径是该类所在的包下面的所有java类。如：启动类在“cn.com.test.app”包下，那么只有cn.com.test.app包下的类会被扫描加载。 如果需要加载的类不在启动类的同一包下，可以在启动类处，手动指定扫描包路径，如下： 如图：默认只能扫描app包下的类，如果要扫描controller、config、service等包，需要在启动类处指定扫...
Java 09Stream流与File类
asom12的博客
05-20 981
startWith(“张”)
canal实现mysql数据同步
最新发布
那些乐趣的博客
05-23 996
1、canal下载进入页面可以选择需要安装的版本下载canal.deployer-1.1.8.tar.gz和canal.admin-1.1.8.tar.gz2、mysql同步用户创建和授权在canal-admin解压文件的conf中有一个canal_manager.sql，导入到master数据库3、canal admin安装和启动把canal.admin-1.1.8.tar.gz上传到linux解压 tar -zvxf canal.admin-1.1.8.tar.gz。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

@yanyu666

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

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

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

打赏作者

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

抵扣说明：

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

余额充值