Java应用程序读取外部配置文件

简介: 当我们在服务器上安装一些软件服务时,如 MySQL、Kafka、ES 等,在启动服务的时候,脚本会读取默认路径下的配置文件,如果配置文件没有放到默认的路径下,我们也可以通过参数的方式指定,通过这个配置文件,可以灵活方便的开始某些功能或调整某些参数,不用重新对源码进行修改、编译和发布了。所以,我们工作当中有时希望可以把配置文件放在程序外,这样就可以做到配置与业务分离,在项目中使用的 properties,这里就说一下如何用 properties 配置文件,默认加载 classpath 下的文件,如果通过参数指定了文件路径就可以使用外部配置了。

背景


  • 当我们在服务器上安装一些软件服务时,如 MySQL、Kafka、ES 等,在启动服务的时候,脚本会读取默认路径下的配置文件,如果配置文件没有放到默认的路径下,我们也可以通过参数的方式指定,通过这个配置文件,可以灵活方便的开始某些功能或调整某些参数,不用重新对源码进行修改、编译和发布了。
  • 所以,我们工作当中有时希望可以把配置文件放在程序外,这样就可以做到配置与业务分离,在项目中使用的 properties,这里就说一下如何用 properties 配置文件,默认加载 classpath 下的文件,如果通过参数指定了文件路径就可以使用外部配置了。
  • 最近在使用 Netty 实现一个 TCP Server,主要用来接收媒体数据,然后对其进行相应的处理;同时,在这个项目中也嵌入了 HTTP 服务,使用 Jetty 实现了 HTTP Servlet,用来实现一些 Web 的交互控制。在这个项目中,服务的端口和一些开关设置使用了配置文件。

举例


在介绍完背景后,来看看是怎么来实现这样一个应用程序,此程序仅使用了 Netty 和 Jetty ,没有使用 Spring 相关的框架。本篇主要介绍如何实现读取外部配置文件

依赖


<dependency>
    <groupId>commons-configuration</groupId>
    <artifactId>commons-configuration</artifactId>
    <version>1.10</version>
</dependency>

实现


lombok, 通过注解引入 log

单例模式

package com.xxx.config;
import lombok.extern.log4j.Log4j2;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.PropertiesConfiguration;
import org.apache.commons.configuration.SystemConfiguration;
import org.apache.commons.configuration.reloading.FileChangedReloadingStrategy;
import org.apache.commons.lang3.StringUtils;
import java.io.File;
@Log4j2
public class ConfigStrategy {
    private boolean autoReload;
    private static final String BASE_PATH;
    private static final String GLOBAL_CONFIG_PATH = "global.config.path";
    private static final String fileName="conf.properties";
    private static volatile PropertiesConfiguration prop =null;
    static{
        log.info("start init configuration strategy");
        SystemConfiguration sysConfig = new SystemConfiguration();
        String globalPath = sysConfig.getString(GLOBAL_CONFIG_PATH);
        log.info("configuration globalPath {} ", globalPath);
        // 默认加载classpath下面的文件
        if(StringUtils.isBlank(globalPath)){
            globalPath = Thread.currentThread().getContextClassLoader().getResource(fileName).getFile();
        }
        BASE_PATH=globalPath;
    }
    public ConfigStrategy(boolean autoReload) throws ConfigurationException {
        this.autoReload = autoReload;
        loadConfig();
    }
    public void loadConfig() throws ConfigurationException {
        if (null == prop){
            prop = new PropertiesConfiguration();
        }
        File file = new File(BASE_PATH);
        prop.setFile(file);
        prop.setAutoSave(false);
        // 重载策略,5秒钟监视文件变化
        if(autoReload){
            prop.setReloadingStrategy(new FileChangedReloadingStrategy());
        }
        prop.load();
    }
    /**
     * 获取字符串类型的配置项
     *
     * @param key
     * @return value
     */
    public  String getProperty(String key) {
        return prop.getString(key);
    }
    /**
     * 获取整数类型的配置项
     *
     * @param key
     * @return value
     */
    public  Integer getInteger(String key) {
        String value = getProperty(key);
        return Integer.valueOf(value);
    }
    /**
     * 获取布尔类型的配置项
     *
     * @param key
     * @return value
     */
    public  Boolean getBoolean(String key) {
        String value = getProperty(key);
        return Boolean.valueOf(value);
    }
    /**
     * 获取Long类型的配置项
     *
     * @param key
     * @return
     */
    public  Long getLong(String key) {
        String value = getProperty(key);
        return Long.valueOf(value);
    }
    private static class SingletonHelp {
        static ConfigStrategy instance;
        static {
            try {
                instance = new ConfigStrategy(true);
            } catch (ConfigurationException e) {
                log.error("configuration strategy init error ", e);
            }
        }
    }
    public static ConfigStrategy build(){
        return SingletonHelp.instance;
    }
}

项目启动命令


-Dglobal.config.path 指定配置文件的位置

注意 -Dglobal.config.path=./conf.properties 的顺序,在放到 xxxx.jar 前,否则读取不到配置文件。

java -jar -Dglobal.config.path=./conf.properties xxxx.jar
相关文章
|
8月前
|
人工智能 算法 Java
Java与AI驱动区块链:构建智能合约与去中心化AI应用
区块链技术和人工智能的融合正在开创去中心化智能应用的新纪元。本文深入探讨如何使用Java构建AI驱动的区块链应用,涵盖智能合约开发、去中心化AI模型训练与推理、数据隐私保护以及通证经济激励等核心主题。我们将完整展示从区块链基础集成、智能合约编写、AI模型上链到去中心化应用(DApp)开发的全流程,为构建下一代可信、透明的智能去中心化系统提供完整技术方案。
529 3
|
8月前
|
消息中间件 缓存 Java
Spring框架优化:提高Java应用的性能与适应性
以上方法均旨在综合考虑Java Spring 应该程序设计原则, 数据库交互, 编码实践和系统架构布局等多角度因素, 旨在达到高效稳定运转目标同时也易于未来扩展.
726 8
|
8月前
|
安全 Java
Java异常处理:程序世界的“交通规则
Java异常处理:程序世界的“交通规则
399 98
|
9月前
|
人工智能 Java API
Java与大模型集成实战:构建智能Java应用的新范式
随着大型语言模型(LLM)的API化,将其强大的自然语言处理能力集成到现有Java应用中已成为提升应用智能水平的关键路径。本文旨在为Java开发者提供一份实用的集成指南。我们将深入探讨如何使用Spring Boot 3框架,通过HTTP客户端与OpenAI GPT(或兼容API)进行高效、安全的交互。内容涵盖项目依赖配置、异步非阻塞的API调用、请求与响应的结构化处理、异常管理以及一些面向生产环境的最佳实践,并附带完整的代码示例,助您快速将AI能力融入Java生态。
1478 12
|
9月前
|
安全 Java API
Java SE 与 Java EE 区别解析及应用场景对比
在Java编程世界中,Java SE(Java Standard Edition)和Java EE(Java Enterprise Edition)是两个重要的平台版本,它们各自有着独特的定位和应用场景。理解它们之间的差异,对于开发者选择合适的技术栈进行项目开发至关重要。
1505 1
存储 jenkins 持续交付
998 2
|
9月前
|
存储 Java 编译器
对比Java学习Go——程序结构与变量
本节对比了Java与Go语言的基础结构,包括“Hello, World!”程序、代码组织方式、入口函数定义、基本数据类型及变量声明方式。Java强调严格的面向对象结构,所有代码需置于类中,入口方法需严格符合`public static void main(String[] args)`格式;而Go语言结构更简洁,使用包和函数组织代码,入口函数为`func main()`。两种语言在变量声明、常量定义、类型系统等方面也存在显著差异,体现了各自的设计哲学。
326 0
|
10月前
|
人工智能 监控 安全
智慧工地解决方案,java智慧工地程序代码
智慧工地系统融合物联网、AI、大数据等技术,实现对施工现场“人、机、料、法、环”的全面智能监控与管理,提升安全、效率与决策水平。
294 2
|
10月前
|
设计模式 XML 安全
Java枚举(Enum)与设计模式应用
Java枚举不仅是类型安全的常量,还具备面向对象能力,可添加属性与方法,实现接口。通过枚举能优雅实现单例、策略、状态等设计模式,具备线程安全、序列化安全等特性,是编写高效、安全代码的利器。