springboot 读取外部自定义配置文件

Mr-Wanter

已于 2023-06-28 10:42:52 修改

阅读量675

点赞数 1

CC 4.0 BY-SA版权

分类专栏：【Java技术】文章标签： spring boot 读取外部文件 java

于 2023-05-12 17:12:50 首次发布

本文链接：https://blog.csdn.net/mr_wanter/article/details/130646233

【Java技术】专栏收录该内容

99 篇文章

订阅专栏

文章介绍了如何在Springboot应用中使用JSONHelperUtil工具类来动态读取并处理外部JSON配置文件，无须重启应用。当配置文件不在同级目录时，工具类会尝试从config子目录或类路径下查找。文章还提到了工程和部署目录结构，以及在瘦包部署情况下，如何通过启动脚本确保能找到配置文件。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

springboot 修改外部自定义配置文件，无需重启。

一、JSONHelperUtil

import lombok.extern.slf4j.Slf4j;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.Resource;
import org.springframework.util.ResourceUtils;

import java.io.*;

@Slf4j
public class JSONHelperUtil {
    
    /**
     * 通过文件名获取获取json格式字符串，
     *
     * @param filename 文件存放路径与配置文件路径规范一致
     * @return ResolveJsonFileToString
     * @throws
     */
    public static String ResolveJsonFileToString(String filename) {
        
        BufferedReader br;
        String result;
        try {
            br = new BufferedReader(new InputStreamReader(getResFileStream(filename), "UTF-8"));
            StringBuffer message = new StringBuffer();
            String line;
            while ((line = br.readLine()) != null) {
                message.append(line);
            }
            if (br != null) {
                br.close();
            }
            String defaultString = message.toString();
//            result = defaultString.replace("\r\n", "").replaceAll(" +", "");
            //暂时不去空格(时间字符串中应该有空格)
            result = defaultString.replace("\r\n", "");
        } catch (IOException e) {
            try {
                ClassLoader classloader = Thread.currentThread().getContextClassLoader();
                InputStream in = classloader.getResourceAsStream(filename);
                br = new BufferedReader(new InputStreamReader(in, "UTF-8"));
                StringBuffer message = new StringBuffer();
                String line;
                while ((line = br.readLine()) != null) {
                    message.append(line);
                }
                if (br != null) {
                    br.close();
                }
                if (in != null) {
                    in.close();
                }
                String defaultString = message.toString();
                result = defaultString.replace("\r\n", "").replaceAll(" +", "");
            } catch (Exception e1) {
                throw new RuntimeException("没有找到文件");
            }
            
        }
        
        return result;
    }
    
    
    private static File getResFile(String filename) throws FileNotFoundException {
        File file = new File(filename);
        // 如果同级目录没有，则去config下面找
        // 此处可以自定义目录结构或多层级扩展
        if (!file.exists()) {
            log.debug("不在同级目录，进入config目录查找");
            file = new File("config/" + filename);
        }
        //config目录下还是找不到，那就直接用classpath下的
        Resource resource = new FileSystemResource(file);
        if (!resource.exists()) {
            log.debug("不在config目录，进入classpath目录查找");
            file = ResourceUtils.getFile("classpath:" + filename);
        }
        return file;
    }
    
    /**
     * 通过文件名获取classpath路径下的文件流
     *
     * @param
     * @return
     * @throws
     */
    private static FileInputStream getResFileStream(String filename) throws FileNotFoundException {
        FileInputStream fin;
        File file = getResFile(filename);
        log.info("getResFile path={}", file);
        fin = new FileInputStream(file);
        return fin;
    }
    
}

二、工程目录结构

在这里插入图片描述

三、部署目录结构

将config和部署包放在同一目录即可。此时修改config内的文件即时生效，无需重启项目。
|-config
|-部署包.jar

四、脚本启动找不到文件

当我们的部署包是瘦包部署形式时
|-启动脚本文件夹
|-公共lib
|-部署包.jar（瘦包）、config
此时我们的启动脚本通常要指定可执行jar的相对路径类似-jar ${JAR_PATH}/${JAR_NAME} ${MAIN_CLASS} ，那么此时我们需要在启动脚本添加cd到config所在文件夹，这样才可以读取到config中的文件

source /etc/profile  && cd /service/application  &&  nohup java ${JVM} ${APPLICATION_CONFIG} -Dlog4j2.formatMsgNoLookups=true -Dloader.path=../lib  -Dspring.profiles.active=${profiles}  -jar ${JAR_PATH}/${JAR_NAME} ${MAIN_CLASS} 1>/dev/null 2>&1 &