# conf4j

**Repository Path**: dingnate/conf4j

## Basic Information

- **Project Name**: conf4j
- **Description**: properties文件的配置工具库，配置修改动态生效。支持扫描本地目录/git/svn仓库
- **Primary Language**: Java
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 42
- **Forks**: 8
- **Created**: 2018-03-16
- **Last Updated**: 2024-01-05

## Categories & Tags

**Categories**: utils

**Tags**: None

## README

# conf4j

## 描述

properties文件的配置工具库，配置修改动态生效。支持扫描本地目录/git/svn仓库。

## 使用方法

### 配置类

#### 定义配置类

配置文件：demo.properties

```properties
demo.attrStr=strValue
demo.attrLong=10000
demo.attrInt=100
demo.attrBool=true
```

配置类：DemoConf.java

```java
@Config(file = "demo.properties", prefix = "demo")
public class DemoConf implements Conf {
	private static transient final Logger LOG = LoggerFactory.getLogger(Conf.class);
	public final static DemoConf ME = new DemoConf();
	static {
		try {
			ConfKit.handler(DemoConf.class);
		} catch (Exception e) {
			LOG.error("handler DemoConf failed.", e);
		}
	}
	String attrStr;
	long attrLong;
	int attrInt;
	boolean attrBool;
	//省略getter/setter方法
	@Override
	public String toString() {
		return "DemoConf [attrStr=" + attrStr + ", attrLong=" + attrLong + ", attrInt=" + attrInt + ", attrBool="
				+ attrBool + "]";
	}
}
```

#### 调用配置类对象

```java
public class Main {
	public static void main(String[] args) throws InterruptedException {
		// 通过配置类的me获取实例调用配置属性
		System.out.println(DemoConf.ME);
		// 通过ConfigManager.config(配置类)获取实例调用配置属性
		System.out.println(ConfigManager.config(DemoConf.class));
		// 通过ConfigManager.putProperties()追加自定义全局配置属性
		Properties properties = new Properties();
		String testPropertyKey = "test.add.property.key";
		properties.setProperty(testPropertyKey, "test.add.property.value");
		ConfigManager.putProperties(properties);
		System.out.println(testPropertyKey + "=" + ConfigManager.getValueByKey(testPropertyKey));
	}
}
```

控制台输出

```
DemoConf [attrStr=strValue, attrLong=10000, attrInt=100, attrBool=true]
DemoConf [attrStr=strValue, attrLong=10000, attrInt=100, attrBool=true]
test.add.property.key=test.add.property.value
```

### 配置扫描器

#### 配置扫描器配置

conf4j.properties

```properties
##conf4j config扫描器配置
#扫描器类
conf4j.config.scaner.className=com.conf4j.file.scaner.ConfigFileScaner
conf4j.config.scaner.url=
conf4j.config.scaner.user=
conf4j.config.scaner.password=
#扫描的本地配置目录，可使用绝对路径，也支持相对路径
conf4j.config.scaner.localPath=src/test/resources1
#扫描配置的间隔（秒）
conf4j.config.scaner.intervalSec=2
#扫描的配置文件，多个文件以','分割
conf4j.config.scaner.keys=conf4j.properties,demo.properties
```

#### 启动配置扫描器

```java
public class Main {
	public static void main(String[] args) throws InterruptedException {
      //启动配置扫描
		ConfigManager.startScaner();
		int i = 0;
		while (i++ < 100) {
			Thread.sleep(2000);
			System.out.println(DemoConf.ME);
		}
	}
}
```

控制台输出

```
DemoConf [attrStr=strValue, attrLong=10000, attrInt=100, attrBool=true]
DemoConf [attrStr=strValue, attrLong=10000, attrInt=100, attrBool=true]
...
```

### 工程介绍

- conf4j.api支持扫描本地配置目录
- conf4j.git支持扫描git仓库
- conf4j.svn支持扫描svn仓库

例子参考conf4j.api/conf4j.git/conf4j.svn中的Main类

### -D参数使用

-D参数或conf4j.properties中conf4j.config.scaner.localPath不为空时，配置路径中配置文件覆盖类路径下的配置文件

```
-Dconf4j.config.scaner.localPath=config/local/path
```

### 扩展使用

可以扫描类根据Config注解对配置类自动注入属性，省去static代码块中ConfKit.handle方法的调用。

## 约束

自己读取配置文件请使用com.conf4j.kit.ClassLoaderKit.getResourceAsStream(String)接口

## 更新日志
2018/04/19

- 修改Conf子类的默认单例名为大写（me->ME）
- ConfigManager支持非Conf子类的配置类


2018/04/10

- 合并conf4j.file工程到conf4j.api
- 优化com.conf4j.file.Main类
- 统一包名为com.conf4j.xx
- 开启git扫描器时，从git仓库更新配置修改为强制替换为git仓库的配置

2018/04/8

- 支持扫描svn仓库

2018/04/3

- 支持-Dconf4j.config.scaner.localPath参数指定配置文件路径，
- -D参数或conf4j.properties中conf4j.config.scaner.localPath不为空时，配置路径中配置文件覆盖类路径下的配置文件


2018/03/30

- 增加扫描本地目录中的配置，修改目录中的properties文件文件，对应的配置类属性值会自动更新
- 支持扫描git仓库中的配置
- 增加ConfigManager类，添加(获取)配置对象、获取配置属性、添加全局属性
- 工程结构模块化：conf4j.api,conf4j.file,conf4j.git。

## 交流

请在下方评论或提issue，我会及时回复。

## 打赏

如果感觉本项目对您有用，打赏是对作者最大的鼓励。

![](https://note.youdao.com/yws/api/personal/file/9C97D8BD1E9E497097DEC70A1E739090?method=download&shareKey=90d5b78980e32ff73fde6c3035e34a75)