Apollo(六)-源码解析-本地缓存文件位置

￡神魔★判官ぃ 2021-11-17 03:00 1983阅读 0赞

### Apollo-源码解析-本地缓存文件位置 ###

*  前提
 *  调试代码
 *   *   *  pom.xml
         *  ApolloLocalFileDemo.java
         *  log4j2.xml
         *  app.properties
 *  分析源码-缓存目录
 *   *   *  Debug相关代码
         *  分析源码
         *  结论

# 前提 #

启动ConfigServiceApplication，否则无法拉取配置；

# 调试代码 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70]

### pom.xml ###

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>helloworld</artifactId>
            <groupId>com.ydfind</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>apollo-configuration-demo</artifactId>
        <dependencies>
            <dependency>
                <groupId>com.ctrip.framework.apollo</groupId>
                <artifactId>apollo-client</artifactId>
                <version>1.4.0</version>
            </dependency>
            
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-api</artifactId>
                <version>2.11.0</version>
            </dependency>
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-slf4j-impl</artifactId>
                <version>2.11.0</version>
            </dependency>
            
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>jcl-over-slf4j</artifactId>
                <version>1.7.25</version>
            </dependency>
        </dependencies>
    </project>

### ApolloLocalFileDemo.java ###

package com.ydfind.apollo;
    
    import com.ctrip.framework.apollo.Config;
    import com.ctrip.framework.apollo.ConfigService;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class ApolloLocalFileDemo {
        private static final Logger logger = LoggerFactory.getLogger(ApolloLocalFileDemo.class);
        private String DEFAULT_VALUE = "undefined";
        private Config config;
    
        public ApolloLocalFileDemo() {
            config = ConfigService.getAppConfig();
        }
    
        private String getConfig(String key) {
            String result = config.getProperty(key, DEFAULT_VALUE);
            logger.info(String.format("Loading key : %s with value: %s", key, result));
            return result;
        }
    
        public static void main(String[] args){
            System.setProperty("env", "dev");
            System.setProperty("dev_meta", "http://localhost:8080");
            ApolloLocalFileDemo apolloConfigDemo = new ApolloLocalFileDemo();
            apolloConfigDemo.getConfig("timeout");
        }
    }

### log4j2.xml ###

<?xml version="1.0" encoding="UTF-8"?>
    <configuration monitorInterval="60">
      <appenders>
        <Console name="Console" target="SYSTEM_OUT">
          <PatternLayout pattern="[%t]%d %-5p [%c] %m%n"/>
        </Console>
        <Async name="Async" includeLocation="true">
          <AppenderRef ref="Console"/>
        </Async>
      </appenders>
      <loggers>
        <logger name="com.ydfind.apollo" additivity="false" level="DEBUG">
          <AppenderRef ref="Async"/>
        </logger>
        <root level="INFO">
          <AppenderRef ref="Async"/>
        </root>
      </loggers>
    </configuration>

### app.properties ###

app.id=100004458

# 分析源码-缓存目录 #

### Debug相关代码 ###

先打断点确定主要的代码：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 2]  
详细的函数调用情况如下所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 3]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 4]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 5]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 6]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 7]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 8]  
配置文件的命名规则  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 9]

### 分析源码 ###

代码调用关系：findLocalCacheDir() -> LocalFileConfigRepository.**findLocalCacheDir** \-> **ConfigUtil.java**

private File findLocalCacheDir() {
        try {
          String defaultCacheDir = m_configUtil.getDefaultLocalCacheDir();
          Path path = Paths.get(defaultCacheDir);
          if (!Files.exists(path)) {
            Files.createDirectories(path);
          }
          if (Files.exists(path) && Files.isWritable(path)) {
         // private static final String CONFIG_DIR = "/config-cache";
          // 默认目录后面会加上/config-cache
            return new File(defaultCacheDir, CONFIG_DIR);
          }
        } catch (Throwable ex) {
          //ignore
        }
    
        return new File(ClassLoaderUtil.getClassPath(), CONFIG_DIR);
      }

// ConfigUtil.java
    // 返回本地缓存目录
    public String getDefaultLocalCacheDir() {
        String cacheRoot = getCustomizedCacheRoot();
    
        if (!Strings.isNullOrEmpty(cacheRoot)) {
          return cacheRoot + File.separator + getAppId();
        }
    
        cacheRoot = isOSWindows() ? "C:\\opt\\data\\%s" : "/opt/data/%s";
        return String.format(cacheRoot, getAppId());
    }
    
    private String getCustomizedCacheRoot() {
        // 1. Get from System Property-----可以通过设置System的apollo.cacheDir制定缓存目录
        String cacheRoot = System.getProperty("apollo.cacheDir");
        if (Strings.isNullOrEmpty(cacheRoot)) {
          // 2. Get from OS environment variable
          cacheRoot = System.getenv("APOLLO_CACHEDIR");
        }
        if (Strings.isNullOrEmpty(cacheRoot)) {
          // 3. Get from server.properties-----配置文件设置apollo.cacheDir制定缓存目录
          cacheRoot = Foundation.server().getProperty("apollo.cacheDir", null);
        }
    
        return cacheRoot;
    }
    
    // 判断是否是windows操作系统
    public boolean isOSWindows() {
        String osName = System.getProperty("os.name");
        if (Strings.isNullOrEmpty(osName)) {
          return false;
        }
        return osName.startsWith("Windows");
    }

### 结论 ###

*  1）可以通过设置System（大多数是与程序有关）的apollo.cacheDir制定缓存目录

System.setProperty("apollo.cacheDir", "C:\\ydfind\\data");

结果  
![C:\\ydfind\\data\\100004458][C_ydfind_data_100004458]

*  2）配置文件C:\\opt\\settings\\server.properties设置apollo.cacheDir制定缓存目录

apollo.cacheDir=C:\\ydfind\\data1

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 10]  
打断点可以看到目录正确设置了  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 11]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 12]  
3）getEnv系统相关变量，同理，这里不再尝试了。  
4）文件拼接规则：设定目录\\appid\\config-cache\\appid+cluster+namespace.properties

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70]: /images/20211116/f2a3bfdd6dac4162a7bd7808e1d94ee1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 1]: /images/20211116/68dc930390814467bfb3d691e5151bf1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 2]: /images/20211116/2d244b07fef943488585141361e7cb22.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 3]: /images/20211116/15e63bc67cc34c35b698aad80a3eb4db.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 4]: /images/20211116/2501804083ca4436b3305f06f684a8e5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 5]: /images/20211116/3a7d62cd2cd24d2ba8922e6d77946d82.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 6]: /images/20211116/fab36d86df014147a314077c436a1172.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 7]: /images/20211116/b7414b17761f473fa8f9a648bc58c361.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 8]: /images/20211116/ebdb62f2a7e040d0abf85a3bbad6ecf8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 9]: /images/20211116/3066a587f842432a9083686b2c5d8d7d.png
[C_ydfind_data_100004458]: /images/20211116/7dcd975d763e489ba6dad0c7f2ad6555.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 10]: /images/20211116/54bd06b8d2ee45eb94c05d8f35338ea0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 11]: /images/20211116/c80b165183ee471d940e7f47bb7bd3fa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NuZGF5WVU_size_16_color_FFFFFF_t_70 12]: /images/20211116/7bf6c3a1add94f46a062643453ae0b69.png