com.tencent.polaris.configuration.client.internal.RemoteConfigFileRepo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of polaris-all Show documentation
Show all versions of polaris-all Show documentation
All in one project for polaris-java
/*
* Tencent is pleased to support the open source community by making Polaris available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
*
* Licensed under the BSD 3-Clause License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*
* Unless required by applicable law or agreed to in writing, software distributed
* under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package com.tencent.polaris.configuration.client.internal;
import com.tencent.polaris.api.control.Destroyable;
import com.tencent.polaris.api.exception.ServerCodes;
import com.tencent.polaris.api.plugin.filter.ConfigFileFilterChain;
import com.tencent.polaris.api.plugin.configuration.ConfigFile;
import com.tencent.polaris.api.plugin.configuration.ConfigFileConnector;
import com.tencent.polaris.api.plugin.configuration.ConfigFileResponse;
import com.tencent.polaris.api.utils.ThreadPoolUtils;
import com.tencent.polaris.client.api.SDKContext;
import com.tencent.polaris.client.util.NamedThreadFactory;
import com.tencent.polaris.configuration.api.core.ConfigFileMetadata;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.atomic.AtomicReference;
/**
* @author lepdou 2022-03-01
*/
public class RemoteConfigFileRepo extends AbstractConfigFileRepo {
private static final long INIT_VERSION = 0;
private static final int PULL_CONFIG_RETRY_TIMES = 3;
private static ScheduledExecutorService pullExecutorService;
private final AtomicReference remoteConfigFile;
//服务端通知的版本号，此版本号有可能落后于服务端
private final AtomicLong notifiedVersion;
private final ConfigFileConnector configFileConnector;
private final ConfigFileFilterChain configFileFilterChain;
private final RetryPolicy retryPolicy;
private ConfigFilePersistentHandler configFilePersistHandler;
private final boolean fallbackToLocalCache;
private String token;
static {
createPullExecutorService();
}
public RemoteConfigFileRepo(SDKContext sdkContext,
ConfigFileLongPullService pullService,
ConfigFileFilterChain configFileFilterChain,
ConfigFileConnector connector,
ConfigFileMetadata configFileMetadata,
ConfigFilePersistentHandler handler) {
super(sdkContext, configFileMetadata);
//保证线程池正常初始化
createPullExecutorService();
this.token = sdkContext.getConfig().getConfigFile().getServerConnector().getToken();
this.remoteConfigFile = new AtomicReference<>();
this.notifiedVersion = new AtomicLong(INIT_VERSION);
this.retryPolicy = new ExponentialRetryPolicy(1, 120);
this.configFilePersistHandler = handler;
this.configFileFilterChain = configFileFilterChain;
//获取远程调用插件实现类
this.configFileConnector = connector;
this.fallbackToLocalCache = sdkContext.getConfig().getConfigFile().getServerConnector().getFallbackToLocalCache();
//注册 destroy hook
registerRepoDestroyHook(sdkContext);
//同步从远程仓库拉取一次
pull();
//加入到长轮询的池子里
addToLongPollingPool(pullService, configFileMetadata);
startCheckVersionTask();
}
private static void createPullExecutorService() {
if (pullExecutorService == null || pullExecutorService.isShutdown() || pullExecutorService.isTerminated()) {
pullExecutorService = Executors.newScheduledThreadPool(1, new NamedThreadFactory("Configuration-Pull"));
}
}
private void addToLongPollingPool(ConfigFileLongPullService pullService, ConfigFileMetadata configFileMetadata) {
ConfigFile configFile = remoteConfigFile.get();
//理论上，加到长轮询任务之前会同步一次配置文件，但是可能会同步失败。
if (configFile == null) {
configFile = new ConfigFile(configFileMetadata.getNamespace(), configFileMetadata.getFileGroup(),
configFileMetadata.getFileName());
//初始版本号为0
configFile.setVersion(INIT_VERSION);
}
pullService.addConfigFile(this);
}
@Override
public String getContent() {
return remoteConfigFile.get() != null ? remoteConfigFile.get().getContent() : null;
}
public String getMd5() {
return remoteConfigFile.get() != null ? remoteConfigFile.get().getMd5() : "";
}
public long getConfigFileVersion() {
if (remoteConfigFile.get() == null) {
return INIT_VERSION;
}
return remoteConfigFile.get().getVersion();
}
@Override
protected void doPull() {
long startTime = System.currentTimeMillis();
ConfigFile pullConfigFileReq = new ConfigFile(configFileMetadata.getNamespace(),
configFileMetadata.getFileGroup(),
configFileMetadata.getFileName());
pullConfigFileReq.setVersion(notifiedVersion.get());
LOGGER.info("[Config] start pull config file. config file = {}, version = {}",
configFileMetadata, notifiedVersion.get());
int retryTimes = 0;
while (retryTimes < PULL_CONFIG_RETRY_TIMES) {
try {
ConfigFileResponse response = configFileFilterChain
.execute(pullConfigFileReq, configFile -> configFileConnector.getConfigFile(pullConfigFileReq));
retryPolicy.success();
//打印请求信息
long pulledConfigFileVersion =
response.getConfigFile() != null ? response.getConfigFile().getVersion() : -1;
LOGGER.info("[Config] pull config file finished. config file = {}, code = {}, version = {}, duration = {} ms",
configFileMetadata, response.getCode(), pulledConfigFileVersion,
System.currentTimeMillis() - startTime);
if (response.getCode() == ServerCodes.EXECUTE_SUCCESS) {
ConfigFile pulledConfigFile = response.getConfigFile();
//本地配置文件落后，更新内存缓存
if (remoteConfigFile.get() == null ||
pulledConfigFile.getVersion() >= remoteConfigFile.get().getVersion()) {
ConfigFile copiedConfigFile = deepCloneConfigFile(pulledConfigFile);
remoteConfigFile.set(copiedConfigFile);
//配置有更新，触发回调
fireChangeEvent(copiedConfigFile.getContent());
// update local file cache
this.configFilePersistHandler.asyncSaveConfigFile(pulledConfigFile);
}
return;
}
//远端没有此配置文件
if (response.getCode() == ServerCodes.NOT_FOUND_RESOURCE) {
LOGGER.warn("[Config] config file not found, please check whether config file released. {}",
configFileMetadata);
//delete local file cache
this.configFilePersistHandler
.asyncDeleteConfigFile(new ConfigFile(configFileMetadata.getNamespace(),
configFileMetadata.getFileGroup(), configFileMetadata.getFileName()));
//删除配置文件
if (remoteConfigFile.get() != null) {
remoteConfigFile.set(null);
//删除配置文件也需要触发通知
fireChangeEvent(null);
}
return;
}
//预期之外的状态码，重试
LOGGER.error("[Config] pull response without expected code. retry times = {}, code = {}", retryTimes,
response.getCode());
retryPolicy.fail();
retryTimes++;
retryPolicy.executeDelay();
fallbackIfNecessary(retryTimes, pullConfigFileReq);
} catch (Throwable t) {
LOGGER.error("[Config] failed to pull config file. retry times = " + retryTimes, t);
retryPolicy.fail();
retryTimes++;
retryPolicy.executeDelay();
fallbackIfNecessary(retryTimes, pullConfigFileReq);
}
}
}
private void fallbackIfNecessary(final int retryTimes, ConfigFile configFileReq) {
if (retryTimes >= PULL_CONFIG_RETRY_TIMES && fallbackToLocalCache) {
ConfigFile configFileRes = configFilePersistHandler.loadPersistedConfigFile(configFileReq);
if (configFileRes != null) {
LOGGER.info("[Config] failed to pull config file from remote,fallback to local cache success.{}.", configFileRes);
remoteConfigFile.set(configFileRes);
//配置有更新，触发回调
fireChangeEvent(configFileRes.getContent());
return;
}
LOGGER.info("[Config] failed to pull config file from remote,fallback to local cache fail.{}.", configFileReq);
}
}
public void onLongPollNotified(long newVersion) {
if (remoteConfigFile.get() != null && remoteConfigFile.get().getVersion() >= newVersion) {
return;
}
notifiedVersion.set(newVersion);
//版本落后，从服务端拉取最新的配置文件
pullExecutorService.submit((Runnable) this::pull);
}
// 有可能出现收到通知时，重新拉取配置失败。此时 notifiedVersion 大于 remoteConfigFile.version，需要定时重试
private void startCheckVersionTask() {
pullExecutorService.scheduleAtFixedRate(() -> {
//没有通知的版本号
if (notifiedVersion == null || notifiedVersion.get() == 0) {
return;
}
long pulledVersion =
remoteConfigFile.get() != null ? remoteConfigFile.get().getVersion() : INIT_VERSION;
//版本落后，需要重新拉取
if (notifiedVersion.get() > pulledVersion) {
LOGGER.info("[Config] notified version greater than pulled version, will pull config file."
+ "file = {}, notified version = {}, pulled version = {}", getConfigFileMetadata(),
notifiedVersion, pulledVersion);
pull();
}
}, 1, 1, TimeUnit.MINUTES);
}
private ConfigFile deepCloneConfigFile(ConfigFile sourceConfigFile) {
ConfigFile configFile =
new ConfigFile(sourceConfigFile.getNamespace(), sourceConfigFile.getFileGroup(),
sourceConfigFile.getFileName());
configFile.setContent(sourceConfigFile.getContent());
configFile.setVersion(sourceConfigFile.getVersion());
configFile.setMd5(sourceConfigFile.getMd5());
return configFile;
}
public static void registerRepoDestroyHook(SDKContext context) {
context.registerDestroyHook(new Destroyable() {
@Override
protected void doDestroy() {
destroyPullExecutor();
}
});
}
static void destroyPullExecutor() {
ThreadPoolUtils.waitAndStopThreadPools(new ExecutorService[]{pullExecutorService});
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy