Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[2022.x] Fix nacos clusterName and extended properties #3780

Merged
merged 3 commits into from
Jul 1, 2024
Merged

[2022.x] Fix nacos clusterName and extended properties #3780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2513c22
fix nacos clusterName
chickenlj Jun 21, 2024
07674ba
fix nacos config service init too early
chickenlj Jun 24, 2024
bca6270
code reformat
chickenlj Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions ...tarter-alibaba-nacos-config/src/main/java/com/alibaba/cloud/nacos/NacosConfigManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ public class NacosConfigManager {

public NacosConfigManager(NacosConfigProperties nacosConfigProperties) {
this.nacosConfigProperties = nacosConfigProperties;
// Compatible with older code in NacosConfigProperties,It will be deleted in the
// future.
createConfigService(nacosConfigProperties);
}

/**
Expand Down
91 changes: 37 additions & 54 deletions ...ter-alibaba-nacos-config/src/main/java/com/alibaba/cloud/nacos/NacosConfigProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,90 +101,50 @@ public class NacosConfigProperties {
@Autowired
@JsonIgnore
private Environment environment;

@PostConstruct
public void init() {
this.overrideFromEnv();
}

private void overrideFromEnv() {
if (environment == null) {
return;
}
if (StringUtils.isEmpty(this.getServerAddr())) {
String serverAddr = environment
.resolvePlaceholders("${spring.cloud.nacos.config.server-addr:}");
if (StringUtils.isEmpty(serverAddr)) {
serverAddr = environment.resolvePlaceholders(
"${spring.cloud.nacos.server-addr:127.0.0.1:8848}");
}
this.setServerAddr(serverAddr);
}
if (StringUtils.isEmpty(this.getUsername())) {
this.setUsername(
environment.resolvePlaceholders("${spring.cloud.nacos.username:}"));
}
if (StringUtils.isEmpty(this.getPassword())) {
this.setPassword(
environment.resolvePlaceholders("${spring.cloud.nacos.password:}"));
}
}

/**
* nacos config server address.
*/
private String serverAddr;

/**
* the nacos authentication username.
*/
private String username;

/**
* the nacos authentication password.
*/
private String password;

/**
* encode for nacos config content.
*/
private String encode;

/**
* nacos config group, group is config data meta info.
*/
private String group = "DEFAULT_GROUP";

/**
* nacos config dataId prefix.
*/
private String prefix;

/**
* the suffix of nacos config dataId, also the file extension of config content.
*/
private String fileExtension = "properties";

/**
* timeout for get config from nacos.
*/
private int timeout = 3000;

/**
* nacos maximum number of tolerable server reconnection errors.
*/
private String maxRetry;

/**
* nacos get config long poll timeout.
*/
private String configLongPollTimeout;

/**
* nacos get config failure retry time.
*/
private String configRetryTime;

/**
* If you want to pull it yourself when the program starts to get the configuration
* for the first time, and the registered Listener is used for future configuration
Expand All @@ -193,65 +153,82 @@ private void overrideFromEnv() {
* recommend that you use {@link ConfigService#getConfigAndSignListener} directly.
*/
private boolean enableRemoteSyncConfig = false;

/**
* endpoint for Nacos, the domain name of a service, through which the server address
* can be dynamically obtained.
*/
private String endpoint;

/**
* namespace, separation configuration of different environments.
*/
private String namespace;

/**
* access key for namespace.
*/
private String accessKey;

/**
* secret key for namespace.
*/
private String secretKey;

/**
* role name for aliyun ram.
*/
private String ramRoleName;

/**
* context path for nacos config server.
*/
private String contextPath;

/**
* nacos config cluster name.
*/
private String clusterName;

/**
* nacos config dataId name.
*/
private String name;

/**
* a set of shared configurations .e.g:
* spring.cloud.nacos.config.shared-configs[0]=xxx .
*/
private List<Config> sharedConfigs;

/**
* a set of extensional configurations .e.g:
* spring.cloud.nacos.config.extension-configs[0]=xxx .
*/
private List<Config> extensionConfigs;

/**
* the master switch for refresh configuration, it default opened(true).
*/
private boolean refreshEnabled = true;

@PostConstruct
public void init() {
this.overrideFromEnv();
}

private void overrideFromEnv() {
if (environment == null) {
return;
}
if (StringUtils.isEmpty(this.getServerAddr())) {
String serverAddr = environment
.resolvePlaceholders("${spring.cloud.nacos.config.server-addr:}");
if (StringUtils.isEmpty(serverAddr)) {
serverAddr = environment.resolvePlaceholders(
"${spring.cloud.nacos.server-addr:127.0.0.1:8848}");
}
this.setServerAddr(serverAddr);
}
if (StringUtils.isEmpty(this.getUsername())) {
this.setUsername(
environment.resolvePlaceholders("${spring.cloud.nacos.username:}"));
}
if (StringUtils.isEmpty(this.getPassword())) {
this.setPassword(
environment.resolvePlaceholders("${spring.cloud.nacos.password:}"));
}
}

// todo sts support

public String getServerAddr() {
Expand Down Expand Up @@ -456,7 +433,7 @@ public void setRefreshEnabled(boolean refreshEnabled) {
public String getSharedDataids() {
return null == getSharedConfigs() ? null
: getSharedConfigs().stream().map(Config::getDataId)
.collect(Collectors.joining(COMMAS));
.collect(Collectors.joining(COMMAS));
}

/**
Expand Down Expand Up @@ -486,7 +463,7 @@ public void setSharedDataids(String sharedDataids) {
public String getRefreshableDataids() {
return null == getSharedConfigs() ? null
: getSharedConfigs().stream().filter(Config::isRefresh)
.map(Config::getDataId).collect(Collectors.joining(COMMAS));
.map(Config::getDataId).collect(Collectors.joining(COMMAS));
}

/**
Expand Down Expand Up @@ -565,7 +542,7 @@ public Properties getConfigServiceProperties() {
*/
public Properties assembleConfigServiceProperties() {
Properties properties = new Properties();
properties.put(SERVER_ADDR, Objects.toString(this.serverAddr, DEFAULT_ADDRESS));
properties.put(SERVER_ADDR, Objects.toString(this.serverAddr, ""));
properties.put(USERNAME, Objects.toString(this.username, ""));
properties.put(PASSWORD, Objects.toString(this.password, ""));
properties.put(ENCODE, Objects.toString(this.encode, ""));
Expand All @@ -591,6 +568,12 @@ public Properties assembleConfigServiceProperties() {
}

enrichNacosConfigProperties(properties);

// set default value when serverAddr and endpoint is empty
if (StringUtils.isEmpty(this.serverAddr) && StringUtils.isEmpty(this.endpoint)) {
properties.put(SERVER_ADDR, DEFAULT_ADDRESS);
}

return properties;
}

Expand Down
29 changes: 15 additions & 14 deletions ...aba-nacos-config/src/main/java/com/alibaba/cloud/nacos/refresh/NacosContextRefresher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,12 @@ public class NacosContextRefresher
.getLogger(NacosContextRefresher.class);

private static final AtomicLong REFRESH_COUNT = new AtomicLong(0);

private NacosConfigProperties nacosConfigProperties;

private final boolean isRefreshEnabled;

private final NacosRefreshHistory nacosRefreshHistory;
private NacosConfigProperties nacosConfigProperties;
private ConfigService configService;

private final ConfigService configService;
private NacosConfigManager configManager;

private ApplicationContext applicationContext;

Expand All @@ -71,12 +69,20 @@ public class NacosContextRefresher

public NacosContextRefresher(NacosConfigManager nacosConfigManager,
NacosRefreshHistory refreshHistory) {
this.configManager = nacosConfigManager;
this.nacosConfigProperties = nacosConfigManager.getNacosConfigProperties();
this.nacosRefreshHistory = refreshHistory;
this.configService = nacosConfigManager.getConfigService();
this.isRefreshEnabled = this.nacosConfigProperties.isRefreshEnabled();
}

public static long getRefreshCount() {
return REFRESH_COUNT.get();
}

public static void refreshCountIncrement() {
REFRESH_COUNT.incrementAndGet();
}

@Override
public void onApplicationEvent(ApplicationReadyEvent event) {
// many Spring context
Expand Down Expand Up @@ -127,6 +133,9 @@ public void innerReceive(String dataId, String group,
}
});
try {
if (configService == null && configManager != null) {
configService = configManager.getConfigService();
}
configService.addListener(dataKey, groupKey, listener);
log.info("[Nacos Config] Listening config: dataId={}, group={}", dataKey,
groupKey);
Expand Down Expand Up @@ -159,12 +168,4 @@ public boolean isRefreshEnabled() {
return isRefreshEnabled;
}

public static long getRefreshCount() {
return REFRESH_COUNT.get();
}

public static void refreshCountIncrement() {
REFRESH_COUNT.incrementAndGet();
}

}
13 changes: 5 additions & 8 deletions ...ibaba-nacos-discovery/src/main/java/com/alibaba/cloud/nacos/NacosDiscoveryProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
import java.util.regex.Matcher;
import java.util.regex.Pattern;


import com.alibaba.cloud.commons.lang.StringUtils;
import com.alibaba.cloud.nacos.event.NacosDiscoveryInfoChangedEvent;
import com.alibaba.cloud.nacos.util.InetIPv6Utils;
Expand All @@ -49,7 +48,6 @@
import org.springframework.core.env.Environment;

import static com.alibaba.nacos.api.PropertyKeyConst.ACCESS_KEY;
import static com.alibaba.nacos.api.PropertyKeyConst.CLUSTER_NAME;
import static com.alibaba.nacos.api.PropertyKeyConst.ENDPOINT;
import static com.alibaba.nacos.api.PropertyKeyConst.ENDPOINT_PORT;
import static com.alibaba.nacos.api.PropertyKeyConst.NAMESPACE;
Expand All @@ -70,14 +68,12 @@
@ConfigurationProperties("spring.cloud.nacos.discovery")
public class NacosDiscoveryProperties {

private static final Logger log = LoggerFactory
.getLogger(NacosDiscoveryProperties.class);

/**
* Prefix of {@link NacosDiscoveryProperties}.
*/
public static final String PREFIX = "spring.cloud.nacos.discovery";

private static final Logger log = LoggerFactory
.getLogger(NacosDiscoveryProperties.class);
private static final Pattern PATTERN = Pattern.compile("-(\\w)");

private static final String IPV4 = "IPv4";
Expand Down Expand Up @@ -134,7 +130,7 @@ public class NacosDiscoveryProperties {
/**
* cluster name for nacos .
*/
private String clusterName = "DEFAULT";
private String clusterName;

/**
* group name for nacos.
Expand Down Expand Up @@ -692,7 +688,8 @@ public Properties getNacosProperties() {

properties.put(ACCESS_KEY, accessKey);
properties.put(SECRET_KEY, secretKey);
properties.put(CLUSTER_NAME, clusterName);
// only used for instance.setClusterName()
// properties.put(CLUSTER_NAME, clusterName);
properties.put(NAMING_LOAD_CACHE_AT_START, namingLoadCacheAtStart);

enrichNacosDiscoveryProperties(properties);
Expand Down
Loading