SpringBoot整合Disconf

迷南。 2022-11-19 01:07 236阅读 0赞

本文演示SpringBoot整合Disconf，并演示获取配置信息。  
一、环境准备  
服务器端安装Disconf不再细述，可自行前往官网https://disconf.readthedocs.io/zh\_CN/latest/install/index.html 查阅。需要说明的是，Disconf安装依赖Nginx、Tomcat、Zookeeper、Redis、MySQL。  
安装完成后，新建测试配置文件：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xkbGxvdmVneWg_size_16_color_FFFFFF_t_70][]  
二、项目搭建  
新建一个SpringBoot项目，引入依赖：

<properties>
            <java.version>1.8</java.version>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <swagger2.version>2.9.2</swagger2.version>
            <disconf.version>2.6.36</disconf.version>
            <maven.test.skip>true</maven.test.skip>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>${swagger2.version}</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>${swagger2.version}</version>
            </dependency>
            
            <dependency>
                <groupId>com.baidu.disconf</groupId>
                <artifactId>disconf-client</artifactId>
                <version>${disconf.version}</version>
            </dependency>
        </dependencies>

三、配置文件  
①application.yml配置项目端口号：

server:
      port: 8989

②添加xml配置spring-disconf.xml：

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans.xsd">
    
        <bean id="disconfMgrBean" class="com.baidu.disconf.client.DisconfMgrBean" destroy-method="destroy">
            <property name="scanPackage" value="com.ldl.demo.disconf"/>
        </bean>
        <bean id="disconfMgrBeanSecond" class="com.baidu.disconf.client.DisconfMgrBeanSecond" init-method="init" destroy-method="destroy"/>
        <bean id="configproperties_no_reloadable_disconf" class="com.baidu.disconf.client.addons.properties.ReloadablePropertiesFactoryBean">
            <property name="locations">
                <list>
                    <value>test.properties</value>
                </list>
            </property>
        </bean>
    </beans>

③disconf配置类disconf.properties：

enable.remote.conf=true
    conf_server_host=******
    version=1_0_0
    app=disconf-demo
    env=rd
    disconf.enable_local_download_dir_in_class_path=true
    disconf.user_define_download_dir=./config/disconf

④Swagger配置类

@Configuration
    @EnableSwagger2
    public class Swagger2Configure {
        /**
         * API及扫描配置
         * @return
         */
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                    .apis(RequestHandlerSelectors.basePackage("com.ldl.demo.controller"))
                    .paths(PathSelectors.any()).build();
        }
    
        /**
         * 展示信息
         * @return
         */
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder().title("api文档")
                    .version("1.0").build();
        }
    }

四、编码实现  
①编写测试配置类：

@Service
    @DisconfFile(filename = "test.properties")
    public class TestConfig {
    
        private String name;
        public TestConfig() {
        }
        public TestConfig(String name) {
            this.name = name;
        }
    
        @DisconfFileItem(name = "name", associateField = "name")
        public String getName() {
            return name;
        }
    
        @Override
        public String toString() {
            return "======>>>>>>"+name;
        }
    }

②编写Controller类及测试请求方法：

@RestController
    @RequestMapping("/")
    public class TestController {
    
        @Autowired
        private TestConfig testConfig;
    
        @GetMapping("getName")
        @ApiOperation("获取disocnf配置信息")
        public String getName(){
            return testConfig.toString();
        }
    
    }

③启动类

@SpringBootApplication
    @ImportResource(locations = {"classpath:/spring-disconf.xml"})
    public class DisconfDemoApplication {
        public static void main(String[] args) {
            SpringApplication.run(DisconfDemoApplication.class, args);
        }
    
    }

④启动项目并访问http://localhost:8989/swagger-ui.html：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xkbGxvdmVneWg_size_16_color_FFFFFF_t_70 1][]

测试获取配置属性OK!

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xkbGxvdmVneWg_size_16_color_FFFFFF_t_70]: /images/20221022/ba12738bcb75455e9d5c674abf1826a1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xkbGxvdmVneWg_size_16_color_FFFFFF_t_70 1]: /images/20221022/2cffba6718804891a4f8db513ae326c9.png