mars-config - spring mvc 、springboot 动态配置系统


Apache
跨平台
Java

软件简介

mars-config是spring mvc 、springboot 动态配置系统。支持http 轮训方式、更新、动态配置。

软件架构

软件架构说明

后端使用技术 :springboot mybatis jwt

前端使用:thymeleaf 模板引擎

数据库 :mysql

jdk :1.8

安装教程

  1. 先创建数据库mars_db ,导入 sql目录下的 init.sql 文件
  2. mars-console 后端管理页面,直接使用外置tomcat 启动即可 端口默认:8080
  3. mars-spring-config 发布jar 后依赖当前jar 即可使用
  4. 访问地址:ip + port 账户:mars 密码:mars 权限:超级管理员

使用说明

  1. 在启动类上使用 @EnableMarsConfig 开启功能使用

1、mars.config.app-id 服务名 和 后端appName 一致

2、mars.config.env-code 环境Code 和 后端envCode 一致

3、mars.config.http.server-address 服务Ip,多个服务地址已逗号分隔

  1. 在后端管理操作

1、应用环境管理 菜单 创建 应用、环境

2、配置管理 菜单 创建配置 点击发布,依赖 mars-spring-config 就会收到服务端修改内容

  1. springboot 具体使用步骤

1、在启动类上添加 @EnableMarsConfig 开启mars 动态配置

import com.gitee.mars.spring.config.annotation.EnableMarsConfig;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
@EnableMarsConfig
public class Main  extends SpringBootServletInitializer {

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

2、通过 @MarsValue 获取动态配置的值 如同spring @Value 功能 autoRefreshed 表示是否自动更新当前值

    @MarsValue(value = "${abc}",autoRefreshed = true)
    private String abc;

3、通过@MarsConfigurationProperties 注解把对应配置映射到 TestConfig 类中,如springboot

@ConfigurationProperties 功能相似

@MarsProperty 读取配置key @MarsIgnoreField忽略abc字段配置

import com.gitee.mars.spring.properties.annotation.MarsConfigurationProperties;
import com.gitee.mars.spring.properties.annotation.MarsIgnoreField;
import com.gitee.mars.spring.properties.annotation.MarsProperty;
import lombok.Data;


@Data
@MarsConfigurationProperties(fileName = "aaa",autoRefreshed = true)
public class TestConfig {

    @MarsProperty("abc")
    public String name ;

    @MarsIgnoreField
    private String abc;
}

4、通过 @MarsConfigListener 监听文件变化,可根据需要使用

    @MarsConfigListener(fileName = "aaa",type = ConfigTypeEnum.TEXT)
    public void marsConfigListenerTest(String context){
        System.out.print(context);
    }

    @MarsConfigListener(fileName = "aaa",type = ConfigTypeEnum.PROPERTIES)
    public void marsConfigListenerProperties(Properties properties){
        System.out.print(properties.toString());
    }

5、在配置文件中添加以下配置

mars.config.app-id=app
mars.config.env-code=betaXX
mars.config.http.server-address=192.168.0.108:8080

6、可通过 mars-test项目中的 springboot-test

参考使用demo

GitHub地址:https://github.com/fashionbrot/mars-config