springboot自定义自动装配(可把参数配置在properties配置文件中,实现默认配置)

最新推荐文章于 2024-05-10 02:19:09 发布

孟浩浩

最新推荐文章于 2024-05-10 02:19:09 发布

阅读量3.6k

点赞数 3

分类专栏： SpringBoot 文章标签： spring boot java

本文链接：https://blog.csdn.net/JAVA_MHH/article/details/116119384

版权

SpringBoot 专栏收录该内容

13 篇文章 4 订阅

订阅专栏

1.首先创建自定义装配auto configuration自动配置模块

1.1 引入相关pom依赖

        <groupId>JAVA_MHH</groupId>
		<artifactId>customSpringBootConfig</artifactId>
		<version>1.0.0-SNAPSHOT</version>
		
		<!--引入springboot父工程依赖-->
		<!--引入依赖作用：
		可以省去version标签来获得一些合理的默认配置
		-->
		<parent>
		    <artifactId>spring-boot-starter-parent</artifactId>
		    <groupId>org.springframework.boot</groupId>
		    <version>2.3.2.RELEASE</version>
		</parent>
		
		<dependencies>
		    <!--这是Spring Boot的核心启动器，包含了自动配置、日志和YAML。-->
		    <dependency>
		        <groupId>org.springframework.boot</groupId>
		        <artifactId>spring-boot-starter</artifactId>
		    </dependency>
		
		    <!--spring默认使用yml中的配置，感觉好像没啥用给注释掉了-->
		   <!-- <dependency>
		        <groupId>org.springframework.boot</groupId>
		        <artifactId>spring-boot-configuration-processor</artifactId>
		        <optional>true</optional>
		    </dependency>-->
		</dependencies>

1.2 创建java bean对象(就是你要自定义装配的对象)

@Configuration(这个注解一定要写，我还没研究明白他为啥要写在javabean里，但不添加这个注解就无法完成自定义装配)

        import org.springframework.boot.context.properties.ConfigurationProperties;
		import org.springframework.context.annotation.Configuration;
		import org.springframework.context.annotation.PropertySource;
		
		@Configuration
		@PropertySource(value = "classpath:user.properties",encoding="GBK")//加载自定义配置文件[properties编码格式为GBK,这里读取是也采用GBK]
		@ConfigurationProperties(prefix = "myproperties.user")//从配置文件中读取以myproperties.user开头的属性给此对象做相应的赋值
		public class User {
		
		    private String name;
		
		    private Integer age;
		
		
		    @Override
		    public String toString() {
		        return "User{" +
		                "name='" + name + '\'' +
		                ", age=" + 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;
		    }
		}

1.3 创建config配置类，主要作用是把自己想要的对象注入到ioc

@EnableConfigurationProperties(User.class) //这里再详细说下：如果你引入的这个自动装配模块全路径和你的测试模块名全路径不一致或者启动类路径更深，它就无法扫描到User这个对象了也就无法完成自动装配，所以必须写这个注解用来引入User对象

		import com.it.mhh.doman.User;
		import org.springframework.boot.context.properties.EnableConfigurationProperties;
		import org.springframework.context.annotation.Bean;
		import org.springframework.context.annotation.Configuration;
		
		@Configuration//用于定义配置类
		@EnableConfigurationProperties(User.class)//此注解主要解决 如果调用此自定义配置模块路径与此配置不一致或调用方启动类路径比此配置要深入，就会无法注入
		public class UserConfig {
		
		    @Bean//将此返回对象注入Ioc
		    public User getUser(){
		        return new User();
		    }
		}

1.4 在resources/META-INF 下创建 spring.factories[因@ComponentScan注解只能扫描spring-boot项目包内的bean并注册到spring容器中,因此用factories文件来记录项目包外需要注册的bean类名]

在spring.factories文本里添加以下代码就行；
org.springframework.boot.autoconfigure.EnableAutoConfiguration：就是@EnableAutoConfiguration注解;
com.it.mhh.config.UserConfig：就是我的UserConfig全路径名;
总的意思就是把@EnableAutoConfiguration注解配置在UserConfig上，然后springboot就会把我的UserConfig加载到ioc容器中;

org.springframework.boot.autoconfigure.EnableAutoConfiguration =com.it.mhh.config.UserConfig

1.5 在resources/META-INF 下创建spring-autoconfigure-metadata.properties[就是一个过滤条件,符合此文件下的配置要求就运行相应的配置]

就跟SpringBoot中Condition包下的注解一样的作用
想了解的可以看下
链接：SpringBoot中Condition包下常用条件依赖注解详细介绍及案例使用

ConditionalOnNotWebApplication：作用是不处于Web环境时，加载相应的配置
~~ConditionalOnWebApplication：作用是处于Web环境时，加载相应的配置~~

com.it.mhh.config.UserConfig.ConditionalOnNotWebApplication=com.it.mhh.config.UserConfig

1.6 在resources/META-INF 下创建spring-configuration-metadata.json [就是在配置文件中有提示作用]

spring-configuration-metadata.json 与 additional-spring-configuration-metadata.json 功能好像一致
相关配置详细描述：就是在yml配置里有个提示作用

{
  "groups": [
    {
      "name": "myproperties.user",
      "type": "com.it.mhh.doman.User",
      "description": "用户.",
      "sourceType": "com.it.mhh.doman.User",
      "sourceMethod": "getUser()"
    }
  ],
  "properties": [
    {
      "name": "myproperties.user.name",
      "type": "java.lang.String",
      "description": "该用户姓名.",
      "sourceType": "com.it.mhh.doman.User",
      "defaultValue": "小白"
    },
    {
      "name": "myproperties.user.oldage",
      "type": "java.lang.Integer",
      "description": "该用户年龄.",
      "sourceType": "com.it.mhh.doman.User",
      "defaultValue": 12,
      "deprecation":{
        "level": "error",
        "reason": "不好使",
        "replacement": "myproperties.user.age"
      }
    }
  ]
}

相关配置详细描述：官方讲述配置元数据
groups数组中包含的JSON对象可以包含下表中显示的属性：

名称	类型	目的
name	String	组的全名。此属性是必需的。
type	String	组数据类型的类名。例如，如果该组基于带有注释的类@ConfigurationProperties，则该属性将包含该类的完全限定名称。如果基于@Bean方法，则它将是该方法的返回类型。如果类型未知，则可以省略该属性。
description	String	可以显示给用户的组的简短描述。如果没有可用的描述，则可以省略。建议使用简短的描述，第一行提供简要的摘要。说明中的最后一行应以句点（.）结尾。
sourceType	String	贡献此组的源的类名。例如，如果组基于带有@Bean注释的方法@ConfigurationProperties，则此属性将包含@Configuration包含该方法的类的完全限定名称。如果源类型未知，则可以省略该属性。
sourceMethod	String	促成该组的方法的全名（包括括号和参数类型）（例如，带@ConfigurationProperties注释的@Bean方法的名称）。如果源方法未知，则可以省略。

相关配置详细描述： [defaultValue：原本以为此属性可以赋值默认值,但好像并不是,只能给用户提示默认值是什么而已]
properties数组中包含的JSON对象可以包含下表中描述的属性：

名称	类型	目的
name	String	属性的全名。名称以小写的句点分隔（例如myproperties.user.name）,此属性是必需的。
type	String	属性的数据类型的完整签名（例如java.lang.String），还包含完整的通用类型（例如java.util.Map<java.lang.String,acme.MyEnum>）。您可以使用此属性指导用户输入的值的类型。为了保持一致性，通过使用原始包装的对应对象来指定原始类型（例如，boolean变为java.lang.Boolean）。请注意，此类可能是一个复杂的类型，当String绑定值时会从a转换为此类。如果类型未知，则可以省略。
description	String	可以显示给用户的属性的简短描述。如果没有可用的描述，则可以省略。建议使用简短的描述，第一行提供简要的摘要。说明中的最后一行应以句点（.）结尾。
sourceType	String	贡献此属性的源的类名称。例如，如果属性来自带有注释的类@ConfigurationProperties，则此属性将包含该类的完全限定名称。如果源类型未知，则可以省略。
defaultValue	Object	默认值，如果未指定该属性，则使用该默认值。如果属性的类型是数组，则它可以是值的数组。如果默认值未知，则可以省略。
deprecation	Deprecation	指定是否不推荐使用该属性。如果不建议使用该字段，或者该信息未知，则可以将其省略。下表提供了有关该deprecation属性的更多详细信息。

相关配置详细描述：更改了相应的配置，可以给对方友好的提示，及时更换配置

deprecation每个properties元素的属性中包含的JSON对象可以包含以下属性：

名称	类型	目的
level	String	弃用级别，可以是warning（默认值）或error。当某个属性具有warning弃用级别时，它仍应绑定在环境中。但是，当它具有error弃用级别时，该属性将不再受管理且不受约束。
reason	String	对不推荐使用该属性的原因的简短描述。如果没有可用的原因，则可以省略。建议使用简短的描述，第一行提供简要的摘要。说明中的最后一行应以句点（.）结尾。
replacement	String	替换此不推荐使用的属性的属性的全名。如果无法替代此属性，则可以省略。

1.7 在resources下配置自定义的properties配置: user.properties[因为是自定义配置必须以myproperties开头]

这里配置文件名为user.properties:因为在javaBean里引入的@PropertySource()注解的value值就是此配置名，编码格式为GBK,properties配置文件编码格式为GBK,yml为UTF-8
在properties配置文件里配置默认值(表明对方引用我的自动配置，如果对方在配置文件里没有配置相应属性，就按照此配置来，如果配置了相应属性，就按照对方的的来)
！这里一定要用 myproperties开头，否则无法实现自定义自动装配
！这里必须是properties格式文件，现在自定义配置SpringBoot暂时只支持properties格式，yml配置格式无法注入。

myproperties.user.age: 12
myproperties.user.name: 小黑

1.8 properties配置文件编码格式修改为utf-8格式

2.创建auto configuration自动配置测试模块

2.1 引入pom依赖

		   <!--引入springboot父工程依赖-->
			<!--引入依赖作用：
			可以省去version标签来获得一些合理的默认配置
			-->
			<parent>
			    <groupId>org.springframework.boot</groupId>
			    <artifactId>spring-boot-starter-parent</artifactId>
			    <version>2.3.2.RELEASE</version>
			</parent>
			<dependencies>
			    <!--这是Spring Boot的核心启动器，包含了自动配置、日志和YAML。-->
			    <dependency>
			        <groupId>org.springframework.boot</groupId>
			        <artifactId>spring-boot-starter</artifactId>
			    </dependency>
			    <!--引入写好的自定义自动配置-->
			    <dependency>
			        <groupId>JAVA_MHH</groupId>
			        <artifactId>customSpringBootConfig</artifactId>
			        <version>1.0.0-SNAPSHOT</version>
			    </dependency>
			
			    <!--用来查看mybatis怎么写的自定义自动配置的，这里注释了-->
			    <!--<dependency>
			        <groupId>org.mybatis.spring.boot</groupId>
			        <artifactId>mybatis-spring-boot-starter</artifactId>
			        <version>2.1.2</version>
			    </dependency>-->
			</dependencies>

2.2 启动类测试[使用默认配置]

这里不添加配置，就会启用自动装配里的配置

import com.it.mhh.doman.User;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class TestConfigApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(TestConfigApplication.class, args);
        User user = (User) context.getBean("getUser");//这里因为是注入ioc时 @Bean没有指定名字，则就是方法名从ioc中获取此对象
        System.out.println(user);//User{name='小黑', age=12}
    }
}

2.2.1 启动类测试[使用自己的配置]

yml或者properties配置文件都可以，这里我用优先等级最高的properties配置
优先等级：properties > yaml > yml

application.properties:

myproperties.user.name=小白白

2.2.2 启动类配置

可以看到我自己定义的name名字已经装配 name=小白白
age没有自己定义，那么就是用的之前的默认配置 age=12

import com.it.mhh.doman.User;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class TestConfigApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(TestConfigApplication.class, args);
        User user = (User) context.getBean("getUser");//这里因为是注入ioc时 @Bean没有指定名字，则就是方法名从ioc中获取此对象
        System.out.println(user);//User{name='小白白', age=12}
    }
}

链接：springboot自定义自动装配源代码下载地址

孟浩浩

关注

3
点赞
踩
4

收藏

觉得还不错? 一键收藏
打赏
0
评论
springboot自定义自动装配(可把参数配置在properties配置文件中,实现默认配置)

目录1.首先创建自定义装配auto configuration自动配置模块1.1 ==引入相关pom依赖==1.2 ==创建java bean对象(就是你要自定义装配的对象)==1.3 ==创建config配置类，主要作用是把自己想要的对象注入到ioc==1.4 ==在resources/META-INF 下创建 spring.factories[因@ComponentScan注解只能扫描spring-boot项目包内的bean并注册到spring容器中,因此用factories文件来记录项目包外需要注册的
复制链接

扫一扫