SpringBoot 加载自定义配置

╰+哭是因爲堅強的太久メ 2022-02-24 13:24 345阅读 0赞

在resources目录下自定义配置，如果让springboot加载呢？可以使用@PropertySource("classpath:goods.md") 完成，goods.md就是一个自定义配置，可以设置为自己的配置。

如下展示3种使用方式：

方式一：

goods.md

goods.id=1
    goods.name=a

GoodsController.java

package cn.cld.cldapp.controller;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.PropertySource;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    @PropertySource("classpath:goods.md")
    @RestController
    public class GoodsController {
        @Value("${goods.id}")
        private String id;
        @Value("${goods.name}")
        private String name;
    
        @GetMapping("/q")
        String query(){
            return id+"-"+name;
        }
    }

使用@Value注解就可以获取配置的值了。很简单！！！

方式二：

接下来看另外一个问题，如何使用实体类来关联配置的内容呢？

Goods.java

package com.cld.utils;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.PropertySource;
    import org.springframework.stereotype.Component;
    
    @Component
    @PropertySource("classpath:goods.md")
    public class Goods {
        @Value("${goods.id}")
        private String id;
        @Value("${goods.name}")
        private String name;
    
        public String getId() {
            return id;
        }
    
        public void setId(String id) {
            this.id = id;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        @Override
        public String toString() {
            return "Goods{" +
                    "id='" + id + '\'' +
                    ", name='" + name + '\'' +
                    '}';
        }
    }

不要忘记@Component注解，因为在这里有2个作用：（1）@PropertySource需要作为spring组件，才能生效@Componen会注册spring组件。（2）Goods需要在别的地方注入,也需要注册spring组件。当然还需要确保实体类要被扫描到，我的是在com子包下，启动类里添加了@SpringBootApplication(scanBasePackages = \{"cn","com"\})。

GoodsController.java

package cn.cld.cldapp.controller;
    
    import com.cld.utils.Goods;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    @RestController
    public class GoodsController {
        @Autowired
        private Goods goods;
    
        @GetMapping("/q")
        String query(){
            return goods.toString();
        }
    }

也是很简单。

方式三：

最后一个问题，如果不使用@Value？

可以使用@ConfigurationProperties把对象和配置绑定，@EnableConfigurationProperties导入到spring 容器。

Goods.java

package com.cld.utils;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.context.annotation.PropertySource;
    import org.springframework.stereotype.Component;
    @Component
    @PropertySource("classpath:goods.md")
    @ConfigurationProperties(prefix = "goods")
    public class Goods {
        private String id;
        private String name;
    
        public String getId() {
            return id;
        }
    
        public void setId(String id) {
            this.id = id;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        @Override
        public String toString() {
            return "Goods{" +
                    "id='" + id + '\'' +
                    ", name='" + name + '\'' +
                    '}';
        }
    }

GoodsController.java

package cn.cld.cldapp.controller;
    
    import com.cld.utils.Goods;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.context.properties.EnableConfigurationProperties;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    @RestController
    @EnableConfigurationProperties(Goods.class)
    public class GoodsController {
        @Autowired
        private Goods goods;
    
        @GetMapping("/q")
        String query(){
            return goods.toString();
        }
    }

这里@Component的功能是只有让 @PropertySource("classpath:goods.md")生效了，因为@EnableConfigurationProperties(Goods.class)会自动把Goods导入容器作为bean。