@Configuration和@ConfigurationProperties

最新推荐文章于 2024-10-08 11:49:48 发布
最新推荐文章于 2024-10-08 11:49:48 发布
阅读量954 收藏 8
点赞数 18
分类专栏： Spring 文章标签： java spring boot 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43349479/article/details/140434968
版权

@EnableFeignClients注解可以加在任意的带有@Configuration注解的配置类上吗？

@EnableFeignClients 注解用于启用 Spring Cloud Feign 客户端。它通常放置在 Spring Boot 应用程序的主类上，但也可以放置在任何带有 @Configuration 注解的类上。

使用 @EnableFeignClients

1. 在主类上使用

通常情况下，@EnableFeignClients 注解放置在 Spring Boot 应用程序的主类上：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableFeignClients
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}
2. 在其他配置类上使用

你也可以将 @EnableFeignClients 注解放置在任何带有 @Configuration 注解的类上：

import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableFeignClients
public class FeignConfig {
    // 其他配置
}

配置 Feign 客户端

无论你将 @EnableFeignClients 放置在哪个类上，你都需要配置 Feign 客户端接口。例如：

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

@FeignClient(name = "example-client", url = "http://example.com")
public interface ExampleClient {

    @GetMapping("/api/data")
    String getData(@RequestParam("param") String param);
}

配置扫描包

如果你的 Feign 客户端接口不在默认的扫描包路径下，你可以通过 @EnableFeignClients 注解的 basePackages 属性来指定扫描包路径：

import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableFeignClients(basePackages = "com.example.feignclients")
public class FeignConfig {
    // 其他配置
}

示例项目结构

以下是一个完整的示例项目结构，展示如何在配置类上使用 @EnableFeignClients 注解：

主应用程序类
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}
Feign 配置类
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableFeignClients(basePackages = "com.example.feignclients")
public class FeignConfig {
    // 其他配置
}
Feign 客户端接口
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

@FeignClient(name = "example-client", url = "http://example.com")
public interface ExampleClient {

    @GetMapping("/api/data")
    String getData(@RequestParam("param") String param);
}

总结

  • @EnableFeignClients 注解可以放置在任何带有 @Configuration 注解的类上。
  • 确保配置类被 Spring 扫描到，以便 @EnableFeignClients 生效。
  • 使用 basePackages 属性指定 Feign 客户端接口所在的包路径。

可以在任意带有 @Configuration 注解的类上使用 @EnableFeignClients 注解，并正确配置和使用 Feign 客户端。

@ConfigurationProperties

@ConfigurationProperties 是 Spring Boot 提供的一个注解，用于将外部配置文件（如 application.properties 或 application.yml）中的属性映射到 Java 类中。它通常与 @Component 或 @Configuration 注解一起使用，以便 Spring 容器能够管理这个配置类。

使用步骤

1. 添加依赖

确保你的项目中包含 Spring Boot 的依赖。如果你使用的是 Maven 项目，可以在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>
2. 定义配置类

使用 @ConfigurationProperties 注解定义一个配置类，并指定前缀。这个前缀对应于配置文件中的属性前缀。

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

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {

    private String name;
    private int timeout;

    // Getters and Setters

    public String getName() {
        return name;
    }

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

    public int getTimeout() {
        return timeout;
    }

    public void setTimeout(int timeout) {
        this.timeout = timeout;
    }
}
3. 配置文件

在 application.properties 或 application.yml 文件中定义属性：

application.properties
app.name=MyApp
app.timeout=30
application.yml
app:
  name: MyApp
  timeout: 30
4. 使用配置类

在需要使用这些配置的地方，可以通过依赖注入的方式获取配置类的实例：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    private final AppConfig appConfig;

    @Autowired
    public MyService(AppConfig appConfig) {
        this.appConfig = appConfig;
    }

    public void printConfig() {
        System.out.println("App Name: " + appConfig.getName());
        System.out.println("Timeout: " + appConfig.getTimeout());
    }
}

高级用法

1. 嵌套属性

你可以在配置类中定义嵌套属性：

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

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {

    private String name;
    private int timeout;
    private Database database = new Database();

    public static class Database {
        private String url;
        private String username;
        private String password;

        // Getters and Setters

        public String getUrl() {
            return url;
        }

        public void setUrl(String url) {
            this.url = url;
        }

        public String getUsername() {
            return username;
        }

        public void setUsername(String username) {
            this.username = username;
        }

        public String getPassword() {
            return password;
        }

        public void setPassword(String password) {
            this.password = password;
        }
    }

    // Getters and Setters for name and timeout

    public String getName() {
        return name;
    }

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

    public int getTimeout() {
        return timeout;
    }

    public void setTimeout(int timeout) {
        this.timeout = timeout;
    }

    public Database getDatabase() {
        return database;
    }

    public void setDatabase(Database database) {
        this.database = database;
    }
}

在配置文件中定义嵌套属性：

application.properties
app.name=MyApp
app.timeout=30
app.database.url=jdbc:mysql://localhost:3306/mydb
app.database.username=root
app.database.password=secret
application.yml
app:
  name: MyApp
  timeout: 30
  database:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: secret
2. 校验属性

你可以使用 javax.validation 注解来校验配置属性：

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

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {

    @NotNull
    private String name;

    @Min(1)
    private int timeout;

    // Getters and Setters

    public String getName() {
        return name;
    }

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

    public int getTimeout() {
        return timeout;
    }

    public void setTimeout(int timeout) {
        this.timeout = timeout;
    }
}

在 Spring Boot 主类中启用校验：

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

@SpringBootApplication
@EnableConfigurationProperties(AppConfig.class)
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

总结

  • @ConfigurationProperties 注解用于将外部配置文件中的属性映射到 Java 类中。
  • 可以与 @Component 或 @Configuration 注解一起使用，以便 Spring 容器能够管理这个配置类。
  • 支持嵌套属性和属性校验。

通过这些步骤，可以在 Spring Boot 项目中正确使用 @ConfigurationProperties 注解来管理配置属性。

你这个代码我看不懂
关注
专栏目录
spring boot中@ConfigurationProperties 与 @Value区别以及用法
psjasf1314的博客
12-29 1168
Value（“”）介绍：用来指定bean中某一个属性的值，它的值可以是字面量，从配置文件获取的值，spel表达式person.last-name=张三。
Java 中springboot常用注解@Configuration，@Bean及@ConfigurationProperties(prefix = “spring.datasource“)
qq_33524771的博客
07-29 1620
一、使用样例 1、我们想手动添加一个配置到容器中，且添加一个数据库配置到数据库中配置文件如下，这里使用application.yml配置 2、创建实体BeanConfig对象（自定义内容）和DataSourceConfig对象（读取配置文件配置内容） public class BeanConfig { private String url; private String username; private String password; // set和get方法 } public cla
@Configuration、@ConfigurationProperties用法
热门推荐
qq_45545968的博客
11-29 1万+
@Configuration、@ConfigurationProperties用法 代码示例： application.properties中配置的属性值 配置方式一：使用@Configuration + @Value方式 调用方式： 运行结果： 配置方式二：使用@ConfigurationProperties获取配置信息，通过@Configuration或@Component注解使spring @ComponentScan能够扫到该类；经操作@Component替换为@Configuration也
@Configuration @ConfigurationProperties
百般回首曾经的相遇，留下的只是一缕残忆
07-29 573
@Configuration @Configuration标注在类上，相当于把该类作为spring的xml配置文件中的，作用为：配置spring容器(应用上下文) @ConfigurationProperties 通过 @ConfigurationProperties 注解，我们可以获取大量在 application.properties 或 application.yml 文件中的参数配置。 通常可以使用 @Value 注解或着使用 Spring Environment bean 访问这些属性，但是这种注
@/ConfigurationProperties详解
最新发布
Gemini1995的博客
10-08 1110
提供了灵活、易用的方式来将配置文件中的内容映射到 Java 类中。它支持复杂的嵌套结构、列表、Map 类型，并且可以结合JSR-303校验注解进行数据验证。适用于处理复杂配置场景，并提高配置管理的安全性和可维护性。
关于@Configuration， @ConfigurationProperties， @EnableConfigurationProperties 注解的使用与关系
Everybody up
01-10 669
关于@Configuration， @ConfigurationProperties， @EnableConfigurationProperties 注解的使用与关系
@ConfigurationProperties与@Configuration
qinwenjng120的博客
03-16 351
一、@ConfigurationProperties package org.springframework.boot.context.propertiess /** * Annotation for externalized configuration. Add this to a class definition or a * {@code @Bean} method in a {@...
使用@Configuration扫描配置文件（@Configuration、@ConfigurationProperties和@PropertySource组合使用）
qq_48033003的博客
08-07 2690
使用@Configuration扫描配置文件（@Configuration、@ConfigurationProperties和@PropertySource组合使用） @Configuration：相当于传统的xml配置文件，如果有些第三方库需要用到xml文件，建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。 比如我要写一个配置类，扫描我的数据库配置信息，那么我可以这样写 一、@Configuration+@Configura
@Configuration和@ConfigurationProperties的区别
08-09
`@Configuration` 和 `@ConfigurationProperties` 都是Spring框架中的注解，用于配置类和属性，但它们的作用有所不同。 1. **@Configuration**: 这个注解通常用于标记一个类作为Spring的配置类，它告诉Spring这个类...
@ConfigurationProperties和@Configuration
09-09
@ConfigurationProperties和@Configuration是Spring框架中的两个注解，它们在配置类中的使用方式有一些不同。 @ConfigurationProperties是一个注解，用于将外部配置文件中的属性值映射到配置类中的属性上。这个注解...
@Configuration、@EnableConfigurationProperties、@ConfigurationProperties配置注解三剑客
qq_40814565的博客
09-22 2408
Spring Boot自动配置注解
(2)springboot- @Configuration和@ConfigurationProperties
allensandy的博客
07-07 1812
@Configuration @Configuation等价于<Beans></Beans> @Bean等价于<Bean></Bean> @ComponentScan等价于<context:component-scan base-package=”com.dxz.demo”/> 两种方法，1.使用包扫描 ，创建bean 2. 使用函数创建bean： 方法一 import org.springframewo...
spring boot配置文件、@ConfigurationProperties、@Value、@ConfigurationProperties、@Configuration和 Profile
猎人在吃肉
12-16 4497
文章目录1、配置文件2、YAML语法：2.1、什么是YAML2.2、基本语法2.2、YAML的写法2.2.1 字面量2.2.2 对象、Map（属性和值）（键值对）：2.2.3 数组（List、Set）：2.3 YAML中 单引号 和 双引号的区别3、配置文件值注入3.1 `@ConfigurationProperties` 与 application.yml 的配置3.2、`@Configurat...
SpringBoot：配置文件和@ConfigurationProperties，@Configuration和@Bean
安晴晚风的博客
07-29 441
SpringBoot中常用的配置文件有两种.properties和.yml。
ConfigurationProperties和EnableConfigurationProperties
熊诗言的博客
05-16 1800
ConfigurationProperties、EnableConfigurationProperties
@ConfigurationProperties 使用
fyinthesky的专栏
05-23 2326
@ConfigurationProperties 使用 背景，可以把属性文件读到bean里方便使用。 【1】 pom.xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-...
@Configuration & @ConfigurationProperties
weixin_33675507的博客
06-04 98
2019独角兽企业重金招聘Python工程师标准>>> ...
Configuration, ConfigurationProperties和EnableConfigurationProperties用法
Town
02-18 1625
因为之前一直对这些长得很像的注解一知半解常常因为觉得肯定是不管什么错肯定是作者的坑（自己的锅）。于是最近花了点时间去研究下具体使用方法，避免日后出错。之前用的时候也经常去看csdn上的文章，基本都是千篇一律互相抄，至于是不是对的也没人去指正。于是自己就写下自己的感受。 @Configuration这个注解的主要作用是把使用该注解的类当做Bean来使用，用于配置Spring容器。@Configu...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

你这个代码我看不懂

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

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

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

打赏作者

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

抵扣说明：

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

余额充值