19 Star 42 Fork 8

dingnate / conf4j

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
LGPL-3.0

conf4j

描述

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

使用方法

配置类

定义配置类

配置文件:demo.properties

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

配置类:DemoConf.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 + "]";
	}
}

调用配置类对象

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

##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

启动配置扫描器

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,我会及时回复。

打赏

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

GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. [http://fsf.org/] Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

简介

properties文件的配置工具库,配置修改动态生效。支持扫描本地目录/git/svn仓库 展开 收起
Java
LGPL-3.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/dingnate/conf4j.git
git@gitee.com:dingnate/conf4j.git
dingnate
conf4j
conf4j
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891