Merge branch '2021.0' of https://github.com/cheese8/spring-cloud-tencent into 2021.0
cheese8
3 years ago
commit
618cb20e42
2
spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisCircuitBreakerBootstrapConfiguration.java → spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/config/PolarisCircuitBreakerBootstrapConfiguration.java
2
spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisCircuitBreakerBootstrapConfiguration.java → spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/config/PolarisCircuitBreakerBootstrapConfiguration.java
5
spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisFeignClientAutoConfiguration.java → spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/config/PolarisFeignClientAutoConfiguration.java
5
spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisFeignClientAutoConfiguration.java → spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/config/PolarisFeignClientAutoConfiguration.java
@ -0,0 +1,56 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.circuitbreaker.config;
|
||||
|
||||
import com.tencent.cloud.polaris.circuitbreaker.resttemplate.PolarisResponseErrorHandler;
|
||||
import com.tencent.cloud.polaris.circuitbreaker.resttemplate.PolarisRestTemplateModifier;
|
||||
import com.tencent.cloud.polaris.circuitbreaker.resttemplate.PolarisRestTemplateResponseErrorHandler;
|
||||
import com.tencent.cloud.polaris.context.PolarisContextAutoConfiguration;
|
||||
import com.tencent.polaris.api.core.ConsumerAPI;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
/**
|
||||
* @author : wh
|
||||
* @date : 2022/6/21 21:34
|
||||
* @description: Auto configuration PolarisRestTemplateAutoConfiguration
|
||||
*/
|
||||
@ConditionalOnProperty(value = "spring.cloud.polaris.circuitbreaker.enabled",
|
||||
havingValue = "true", matchIfMissing = true)
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
@AutoConfigureAfter(PolarisContextAutoConfiguration.class)
|
||||
public class PolarisRestTemplateAutoConfiguration {
|
||||
|
||||
@Bean
|
||||
@ConditionalOnBean(RestTemplate.class)
|
||||
public PolarisRestTemplateResponseErrorHandler polarisRestTemplateResponseErrorHandler(ConsumerAPI consumerAPI, @Autowired(required = false) PolarisResponseErrorHandler polarisResponseErrorHandler) {
|
||||
return new PolarisRestTemplateResponseErrorHandler(consumerAPI, polarisResponseErrorHandler);
|
||||
}
|
||||
|
||||
@Bean
|
||||
@ConditionalOnBean(RestTemplate.class)
|
||||
public PolarisRestTemplateModifier polarisRestTemplateBeanPostProcessor(PolarisRestTemplateResponseErrorHandler restTemplateResponseErrorHandler) {
|
||||
return new PolarisRestTemplateModifier(restTemplateResponseErrorHandler);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,29 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.circuitbreaker.resttemplate;
|
||||
|
||||
import org.springframework.web.client.ResponseErrorHandler;
|
||||
|
||||
/**
|
||||
* @author : wh
|
||||
* @date : 2022/6/21 19:12
|
||||
* @description: errorHandler {@link ResponseErrorHandler}
|
||||
*/
|
||||
public interface PolarisResponseErrorHandler extends ResponseErrorHandler {
|
||||
|
||||
}
|
||||
@ -0,0 +1,65 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.circuitbreaker.resttemplate;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import org.springframework.beans.BeansException;
|
||||
import org.springframework.beans.factory.SmartInitializingSingleton;
|
||||
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
import org.springframework.context.ApplicationContextAware;
|
||||
import org.springframework.util.ObjectUtils;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
/**
|
||||
* @author : wh
|
||||
* @date : 2022/6/21 21:20
|
||||
* @description: auto configuration RestTemplate Find the RestTemplate bean annotated with {@link LoadBalanced} and replace {@link org.springframework.web.client.ResponseErrorHandler}
|
||||
* with {@link PolarisRestTemplateResponseErrorHandler}
|
||||
*/
|
||||
public class PolarisRestTemplateModifier implements ApplicationContextAware, SmartInitializingSingleton {
|
||||
|
||||
private ApplicationContext applicationContext;
|
||||
|
||||
private final PolarisRestTemplateResponseErrorHandler polarisRestTemplateResponseErrorHandler;
|
||||
|
||||
public PolarisRestTemplateModifier(PolarisRestTemplateResponseErrorHandler polarisRestTemplateResponseErrorHandler) {
|
||||
this.polarisRestTemplateResponseErrorHandler = polarisRestTemplateResponseErrorHandler;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void afterSingletonsInstantiated() {
|
||||
Map<String, Object> beans = this.applicationContext.getBeansWithAnnotation(LoadBalanced.class);
|
||||
if (!ObjectUtils.isEmpty(beans)) {
|
||||
beans.forEach(this::initRestTemplate);
|
||||
}
|
||||
}
|
||||
|
||||
private void initRestTemplate(String beanName, Object bean) {
|
||||
if (bean instanceof RestTemplate) {
|
||||
RestTemplate restTemplate = (RestTemplate) bean;
|
||||
restTemplate.setErrorHandler(polarisRestTemplateResponseErrorHandler);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
|
||||
this.applicationContext = applicationContext;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,111 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.circuitbreaker.resttemplate;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.net.HttpURLConnection;
|
||||
import java.net.URI;
|
||||
import java.net.URL;
|
||||
import java.util.Objects;
|
||||
|
||||
import com.tencent.cloud.common.metadata.MetadataContext;
|
||||
import com.tencent.cloud.common.util.ReflectionUtils;
|
||||
import com.tencent.polaris.api.core.ConsumerAPI;
|
||||
import com.tencent.polaris.api.pojo.RetStatus;
|
||||
import com.tencent.polaris.api.pojo.ServiceKey;
|
||||
import com.tencent.polaris.api.rpc.ServiceCallResult;
|
||||
import com.tencent.polaris.api.utils.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import org.springframework.http.HttpMethod;
|
||||
import org.springframework.http.client.ClientHttpResponse;
|
||||
import org.springframework.web.client.ResponseErrorHandler;
|
||||
|
||||
/**
|
||||
* @author : wh
|
||||
* @date : 2022/6/21 17:25
|
||||
* @description: Extend ResponseErrorHandler to get request information
|
||||
*/
|
||||
public class PolarisRestTemplateResponseErrorHandler implements ResponseErrorHandler {
|
||||
|
||||
private static final Logger LOG = LoggerFactory.getLogger(PolarisRestTemplateResponseErrorHandler.class);
|
||||
|
||||
private static final String FileName = "connection";
|
||||
|
||||
private final ConsumerAPI consumerAPI;
|
||||
|
||||
private final PolarisResponseErrorHandler polarisResponseErrorHandler;
|
||||
|
||||
|
||||
public PolarisRestTemplateResponseErrorHandler(ConsumerAPI consumerAPI, PolarisResponseErrorHandler polarisResponseErrorHandler) {
|
||||
this.consumerAPI = consumerAPI;
|
||||
this.polarisResponseErrorHandler = polarisResponseErrorHandler;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean hasError(ClientHttpResponse response) {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void handleError(ClientHttpResponse response) throws IOException {
|
||||
if (Objects.nonNull(polarisResponseErrorHandler)) {
|
||||
if (polarisResponseErrorHandler.hasError(response)) {
|
||||
polarisResponseErrorHandler.handleError(response);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public void handleError(URI url, HttpMethod method, ClientHttpResponse response) throws IOException {
|
||||
ServiceCallResult resultRequest = null;
|
||||
try {
|
||||
resultRequest = builderServiceCallResult(url, response);
|
||||
}
|
||||
catch (IOException e) {
|
||||
LOG.error("Will report response of {} url {}", response, url, e);
|
||||
throw e;
|
||||
}
|
||||
finally {
|
||||
consumerAPI.updateServiceCallResult(resultRequest);
|
||||
}
|
||||
}
|
||||
|
||||
private ServiceCallResult builderServiceCallResult(URI uri, ClientHttpResponse response) throws IOException {
|
||||
ServiceCallResult resultRequest = new ServiceCallResult();
|
||||
String serviceName = uri.getHost();
|
||||
resultRequest.setService(serviceName);
|
||||
resultRequest.setNamespace(MetadataContext.LOCAL_NAMESPACE);
|
||||
resultRequest.setMethod(uri.getPath());
|
||||
resultRequest.setRetStatus(RetStatus.RetSuccess);
|
||||
String sourceNamespace = MetadataContext.LOCAL_NAMESPACE;
|
||||
String sourceService = MetadataContext.LOCAL_SERVICE;
|
||||
if (StringUtils.isNotBlank(sourceNamespace) && StringUtils.isNotBlank(sourceService)) {
|
||||
resultRequest.setCallerService(new ServiceKey(sourceNamespace, sourceService));
|
||||
}
|
||||
HttpURLConnection connection = (HttpURLConnection) ReflectionUtils.getFieldValue(response, FileName);
|
||||
URL url = connection.getURL();
|
||||
resultRequest.setHost(url.getHost());
|
||||
resultRequest.setPort(url.getPort());
|
||||
if (response.getStatusCode().value() > 500) {
|
||||
resultRequest.setRetStatus(RetStatus.RetFail);
|
||||
}
|
||||
return resultRequest;
|
||||
}
|
||||
|
||||
}
|
||||
@ -1,4 +1,6 @@
|
||||
org.springframework.cloud.bootstrap.BootstrapConfiguration=\
|
||||
com.tencent.cloud.polaris.circuitbreaker.PolarisCircuitBreakerBootstrapConfiguration
|
||||
com.tencent.cloud.polaris.circuitbreaker.config.PolarisCircuitBreakerBootstrapConfiguration
|
||||
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
|
||||
com.tencent.cloud.polaris.circuitbreaker.PolarisFeignClientAutoConfiguration
|
||||
com.tencent.cloud.polaris.circuitbreaker.config.PolarisFeignClientAutoConfiguration,\
|
||||
com.tencent.cloud.polaris.circuitbreaker.config.PolarisRestTemplateAutoConfiguration
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.circuitbreaker;
|
||||
|
||||
|
||||
import java.net.HttpURLConnection;
|
||||
import java.net.URI;
|
||||
import java.net.URL;
|
||||
|
||||
import com.tencent.cloud.polaris.circuitbreaker.resttemplate.PolarisRestTemplateResponseErrorHandler;
|
||||
import com.tencent.polaris.api.core.ConsumerAPI;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.http.HttpMethod;
|
||||
import org.springframework.test.context.junit4.SpringRunner;
|
||||
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
/**
|
||||
* @author : wh
|
||||
* @date : 2022/6/22 09:00
|
||||
* @description: Test for {@link PolarisRestTemplateResponseErrorHandler}.
|
||||
*/
|
||||
@RunWith(SpringRunner.class)
|
||||
@SpringBootTest(classes = PolarisRestTemplateResponseErrorHandlerTest.TestApplication.class,
|
||||
properties = {"spring.cloud.polaris.namespace=Test", "spring.cloud.polaris.service=TestApp"})
|
||||
public class PolarisRestTemplateResponseErrorHandlerTest {
|
||||
|
||||
@Test
|
||||
public void handleError() throws Exception {
|
||||
ConsumerAPI consumerAPI = mock(ConsumerAPI.class);
|
||||
PolarisRestTemplateResponseErrorHandler polarisRestTemplateResponseErrorHandler = new PolarisRestTemplateResponseErrorHandler(consumerAPI, null);
|
||||
URI uri = mock(URI.class);
|
||||
when(uri.getPath()).thenReturn("/test");
|
||||
when(uri.getHost()).thenReturn("host");
|
||||
HttpURLConnection httpURLConnection = mock(HttpURLConnection.class);
|
||||
URL url = mock(URL.class);
|
||||
when(httpURLConnection.getURL()).thenReturn(url);
|
||||
when(url.getHost()).thenReturn("127.0.0.1");
|
||||
when(url.getPort()).thenReturn(8080);
|
||||
when(httpURLConnection.getResponseCode()).thenReturn(200);
|
||||
SimpleClientHttpResponseTest clientHttpResponse = new SimpleClientHttpResponseTest(httpURLConnection);
|
||||
polarisRestTemplateResponseErrorHandler.handleError(uri, HttpMethod.GET, clientHttpResponse);
|
||||
when(consumerAPI.unWatchService(null)).thenReturn(true);
|
||||
}
|
||||
|
||||
@SpringBootApplication
|
||||
protected static class TestApplication {
|
||||
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,106 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.circuitbreaker;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.net.HttpURLConnection;
|
||||
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.client.AbstractClientHttpResponse;
|
||||
import org.springframework.lang.Nullable;
|
||||
import org.springframework.util.StreamUtils;
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
|
||||
/**
|
||||
* @author : wh
|
||||
* @date : 2022/6/22 09:00
|
||||
* @description: mock {@link org.springframework.http.client.SimpleClientHttpResponse}
|
||||
*/
|
||||
public class SimpleClientHttpResponseTest extends AbstractClientHttpResponse {
|
||||
|
||||
private final HttpURLConnection connection;
|
||||
|
||||
@Nullable
|
||||
private HttpHeaders headers;
|
||||
|
||||
@Nullable
|
||||
private InputStream responseStream;
|
||||
|
||||
|
||||
SimpleClientHttpResponseTest(HttpURLConnection connection) {
|
||||
this.connection = connection;
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
public int getRawStatusCode() throws IOException {
|
||||
return this.connection.getResponseCode();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getStatusText() throws IOException {
|
||||
String result = this.connection.getResponseMessage();
|
||||
return (result != null) ? result : "";
|
||||
}
|
||||
|
||||
@Override
|
||||
public HttpHeaders getHeaders() {
|
||||
if (this.headers == null) {
|
||||
this.headers = new HttpHeaders();
|
||||
// Header field 0 is the status line for most HttpURLConnections, but not on GAE
|
||||
String name = this.connection.getHeaderFieldKey(0);
|
||||
if (StringUtils.hasLength(name)) {
|
||||
this.headers.add(name, this.connection.getHeaderField(0));
|
||||
}
|
||||
int i = 1;
|
||||
while (true) {
|
||||
name = this.connection.getHeaderFieldKey(i);
|
||||
if (!StringUtils.hasLength(name)) {
|
||||
break;
|
||||
}
|
||||
this.headers.add(name, this.connection.getHeaderField(i));
|
||||
i++;
|
||||
}
|
||||
}
|
||||
return this.headers;
|
||||
}
|
||||
|
||||
@Override
|
||||
public InputStream getBody() throws IOException {
|
||||
InputStream errorStream = this.connection.getErrorStream();
|
||||
this.responseStream = (errorStream != null ? errorStream : this.connection.getInputStream());
|
||||
return this.responseStream;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void close() {
|
||||
try {
|
||||
if (this.responseStream == null) {
|
||||
getBody();
|
||||
}
|
||||
StreamUtils.drain(this.responseStream);
|
||||
this.responseStream.close();
|
||||
}
|
||||
catch (Exception ex) {
|
||||
// ignore
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,37 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.config;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
|
||||
/**
|
||||
* Whether to connect to a remote server, suitable for local development mode.
|
||||
*
|
||||
* @author lepdou 2022-06-11
|
||||
*/
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@Target({ ElementType.TYPE, ElementType.METHOD })
|
||||
@ConditionalOnProperty(value = "spring.cloud.polaris.config.connect-remote-server", matchIfMissing = true)
|
||||
public @interface ConditionalOnConnectRemoteServerEnabled {
|
||||
|
||||
}
|
||||
@ -0,0 +1,88 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.config.listener;
|
||||
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
import com.tencent.polaris.configuration.api.core.ConfigPropertyChangeInfo;
|
||||
|
||||
/**
|
||||
* A change event when config is changed .
|
||||
*
|
||||
* @author <a href="mailto:iskp.me@gmail.com">Palmer Xu</a> 2022-06-07
|
||||
*/
|
||||
public final class ConfigChangeEvent {
|
||||
|
||||
/**
|
||||
* all changes keys map.
|
||||
*/
|
||||
private final Map<String, ConfigPropertyChangeInfo> changes;
|
||||
|
||||
/**
|
||||
* all interested changed keys.
|
||||
*/
|
||||
private final Set<String> interestedChangedKeys;
|
||||
|
||||
/**
|
||||
* Config Change Event Constructor.
|
||||
* @param changes all changes keys map
|
||||
* @param interestedChangedKeys all interested changed keys
|
||||
*/
|
||||
public ConfigChangeEvent(Map<String, ConfigPropertyChangeInfo> changes, Set<String> interestedChangedKeys) {
|
||||
this.changes = changes;
|
||||
this.interestedChangedKeys = interestedChangedKeys;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the keys changed.
|
||||
* @return the list of the keys
|
||||
*/
|
||||
public Set<String> changedKeys() {
|
||||
return changes.keySet();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a specific change instance for the key specified.
|
||||
* @param key the changed key
|
||||
* @return the change instance
|
||||
*/
|
||||
public ConfigPropertyChangeInfo getChange(String key) {
|
||||
return changes.get(key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether the specified key is changed .
|
||||
* @param key the key
|
||||
* @return true if the key is changed, false otherwise.
|
||||
*/
|
||||
public boolean isChanged(String key) {
|
||||
return changes.containsKey(key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Maybe subclass override this method.
|
||||
*
|
||||
* @return interested and changed keys
|
||||
*/
|
||||
public Set<String> interestedChangedKeys() {
|
||||
return interestedChangedKeys;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,35 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.config.listener;
|
||||
|
||||
/**
|
||||
* Configuring the change listener interface.
|
||||
*
|
||||
* @author Palmer Xu 2022-05-31
|
||||
*/
|
||||
public interface ConfigChangeListener {
|
||||
|
||||
/**
|
||||
* Invoked when there is any config change for the namespace.
|
||||
*
|
||||
* @param changeEvent the event for this change
|
||||
*/
|
||||
void onChange(ConfigChangeEvent changeEvent);
|
||||
|
||||
}
|
||||
@ -0,0 +1,111 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.config.listener;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.Map;
|
||||
import java.util.concurrent.atomic.AtomicBoolean;
|
||||
|
||||
import com.google.common.collect.Maps;
|
||||
import com.tencent.polaris.configuration.api.core.ConfigPropertyChangeInfo;
|
||||
|
||||
import org.springframework.boot.context.event.ApplicationStartedEvent;
|
||||
import org.springframework.cloud.context.environment.EnvironmentChangeEvent;
|
||||
import org.springframework.context.ApplicationEvent;
|
||||
import org.springframework.context.ApplicationListener;
|
||||
import org.springframework.context.ConfigurableApplicationContext;
|
||||
import org.springframework.core.env.ConfigurableEnvironment;
|
||||
import org.springframework.core.env.Environment;
|
||||
import org.springframework.core.env.MutablePropertySources;
|
||||
import org.springframework.lang.NonNull;
|
||||
|
||||
import static com.tencent.cloud.polaris.config.listener.PolarisConfigListenerContext.fireConfigChange;
|
||||
import static com.tencent.cloud.polaris.config.listener.PolarisConfigListenerContext.initialize;
|
||||
import static com.tencent.cloud.polaris.config.listener.PolarisConfigListenerContext.merge;
|
||||
|
||||
/**
|
||||
* Polaris Config Change Event Listener .
|
||||
*
|
||||
* @author <a href="mailto:iskp.me@gmail.com">Elve.Xu</a> 2022-06-08
|
||||
*/
|
||||
public final class PolarisConfigChangeEventListener implements ApplicationListener<ApplicationEvent> {
|
||||
|
||||
private static final AtomicBoolean started = new AtomicBoolean();
|
||||
|
||||
/**
|
||||
* Handle an application event.
|
||||
*
|
||||
* @param event the event to respond to
|
||||
*/
|
||||
@Override
|
||||
public void onApplicationEvent(@NonNull ApplicationEvent event) {
|
||||
|
||||
// Initialize application all environment properties .
|
||||
if (event instanceof ApplicationStartedEvent && started.compareAndSet(false, true)) {
|
||||
ApplicationStartedEvent applicationStartedEvent = (ApplicationStartedEvent) event;
|
||||
ConfigurableEnvironment environment = applicationStartedEvent.getApplicationContext().getEnvironment();
|
||||
Map<String, Object> ret = loadEnvironmentProperties(environment);
|
||||
if (!ret.isEmpty()) {
|
||||
initialize(ret);
|
||||
}
|
||||
}
|
||||
|
||||
// Process Environment Change Event .
|
||||
if (event instanceof EnvironmentChangeEvent) {
|
||||
EnvironmentChangeEvent environmentChangeEvent = (EnvironmentChangeEvent) event;
|
||||
ConfigurableApplicationContext context = (ConfigurableApplicationContext) environmentChangeEvent.getSource();
|
||||
ConfigurableEnvironment environment = context.getEnvironment();
|
||||
Map<String, Object> ret = loadEnvironmentProperties(environment);
|
||||
Map<String, ConfigPropertyChangeInfo> changes = merge(ret);
|
||||
fireConfigChange(changes.keySet(), Maps.newHashMap(changes));
|
||||
changes.clear();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Try load all application environment config properties .
|
||||
* @param environment application environment instance of {@link Environment}
|
||||
* @return properties
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
private Map<String, Object> loadEnvironmentProperties(ConfigurableEnvironment environment) {
|
||||
Map<String, Object> ret = Maps.newHashMap();
|
||||
MutablePropertySources sources = environment.getPropertySources();
|
||||
sources.iterator().forEachRemaining(propertySource -> {
|
||||
Object o = propertySource.getSource();
|
||||
if (o instanceof Map) {
|
||||
for (Map.Entry<String, Object> entry : ((Map<String, Object>) o).entrySet()) {
|
||||
String key = entry.getKey();
|
||||
String value = environment.getProperty(key);
|
||||
ret.put(key, value);
|
||||
}
|
||||
}
|
||||
else if (o instanceof Collection) {
|
||||
int count = 0;
|
||||
Collection<Object> collection = (Collection<Object>) o;
|
||||
for (Object object : collection) {
|
||||
String key = "[" + (count++) + "]";
|
||||
ret.put(key, object);
|
||||
}
|
||||
}
|
||||
});
|
||||
return ret;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,170 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.config.adapter;
|
||||
|
||||
import java.lang.reflect.Type;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
import com.tencent.polaris.configuration.api.core.ConfigFileChangeListener;
|
||||
import com.tencent.polaris.configuration.api.core.ConfigKVFile;
|
||||
import com.tencent.polaris.configuration.api.core.ConfigKVFileChangeEvent;
|
||||
import com.tencent.polaris.configuration.api.core.ConfigKVFileChangeListener;
|
||||
|
||||
/**
|
||||
* Mock config kv file for test.
|
||||
*@author lepdou 2022-06-11
|
||||
*/
|
||||
public class MockedConfigKVFile implements ConfigKVFile {
|
||||
|
||||
private final Map<String, Object> properties;
|
||||
private final List<ConfigKVFileChangeListener> listeners = new ArrayList<>();
|
||||
|
||||
public MockedConfigKVFile(Map<String, Object> properties) {
|
||||
this.properties = properties;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getProperty(String s, String s1) {
|
||||
return String.valueOf(properties.get(s));
|
||||
}
|
||||
|
||||
@Override
|
||||
public Integer getIntProperty(String s, Integer integer) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Long getLongProperty(String s, Long aLong) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Short getShortProperty(String s, Short aShort) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Float getFloatProperty(String s, Float aFloat) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Double getDoubleProperty(String s, Double aDouble) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Byte getByteProperty(String s, Byte aByte) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Boolean getBooleanProperty(String s, Boolean aBoolean) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String[] getArrayProperty(String s, String s1, String[] strings) {
|
||||
return new String[0];
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T extends Enum<T>> T getEnumProperty(String s, Class<T> aClass, T t) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> T getJsonProperty(String s, Class<T> aClass, T t) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> T getJsonProperty(String s, Type type, T t) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Set<String> getPropertyNames() {
|
||||
return properties.keySet();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void addChangeListener(ConfigKVFileChangeListener configKVFileChangeListener) {
|
||||
listeners.add(configKVFileChangeListener);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void removeChangeListener(ConfigKVFileChangeListener configKVFileChangeListener) {
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getContent() {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> T asJson(Class<T> aClass, T t) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> T asJson(Type type, T t) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean hasContent() {
|
||||
return false;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void addChangeListener(ConfigFileChangeListener configFileChangeListener) {
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public void removeChangeListener(ConfigFileChangeListener configFileChangeListener) {
|
||||
|
||||
}
|
||||
|
||||
public void fireChangeListener(ConfigKVFileChangeEvent event) {
|
||||
for (ConfigKVFileChangeListener listener : listeners) {
|
||||
listener.onChange(event);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getNamespace() {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getFileGroup() {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getFileName() {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,188 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.config.adapter;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.LinkedList;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import com.google.common.collect.Lists;
|
||||
import com.tencent.cloud.polaris.config.config.ConfigFileGroup;
|
||||
import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
|
||||
import com.tencent.cloud.polaris.context.PolarisContextProperties;
|
||||
import com.tencent.polaris.configuration.api.core.ConfigFileService;
|
||||
import com.tencent.polaris.configuration.api.core.ConfigKVFile;
|
||||
import org.junit.Assert;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.junit.MockitoJUnitRunner;
|
||||
|
||||
import org.springframework.core.env.Environment;
|
||||
import org.springframework.core.env.PropertySource;
|
||||
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
/**
|
||||
* test for {@link PolarisConfigFileLocator}
|
||||
*@author lepdou 2022-06-11
|
||||
*/
|
||||
@RunWith(MockitoJUnitRunner.class)
|
||||
public class PolarisConfigFileLocatorTest {
|
||||
|
||||
@Mock
|
||||
private PolarisConfigProperties polarisConfigProperties;
|
||||
@Mock
|
||||
private PolarisContextProperties polarisContextProperties;
|
||||
@Mock
|
||||
private ConfigFileService configFileService;
|
||||
@Mock
|
||||
private PolarisPropertySourceManager polarisPropertySourceManager;
|
||||
@Mock
|
||||
private Environment environment;
|
||||
|
||||
private final String testNamespace = "testNamespace";
|
||||
private final String testServiceName = "testServiceName";
|
||||
|
||||
@Test
|
||||
public void testLoadApplicationPropertiesFile() {
|
||||
PolarisConfigFileLocator locator = new PolarisConfigFileLocator(polarisConfigProperties, polarisContextProperties,
|
||||
configFileService, polarisPropertySourceManager, environment);
|
||||
|
||||
when(polarisContextProperties.getNamespace()).thenReturn(testNamespace);
|
||||
when(polarisContextProperties.getService()).thenReturn(testServiceName);
|
||||
|
||||
// application.properties
|
||||
Map<String, Object> applicationProperties = new HashMap<>();
|
||||
applicationProperties.put("k1", "v1");
|
||||
applicationProperties.put("k2", "v2");
|
||||
applicationProperties.put("k3", "v3");
|
||||
ConfigKVFile propertiesFile = new MockedConfigKVFile(applicationProperties);
|
||||
when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "application.properties"))
|
||||
.thenReturn(propertiesFile);
|
||||
|
||||
Map<String, Object> emptyMap = new HashMap<>();
|
||||
ConfigKVFile emptyConfigFile = new MockedConfigKVFile(emptyMap);
|
||||
when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "application.yml")).thenReturn(emptyConfigFile);
|
||||
when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "bootstrap.properties")).thenReturn(emptyConfigFile);
|
||||
when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "bootstrap.yml")).thenReturn(emptyConfigFile);
|
||||
|
||||
when(polarisConfigProperties.getGroups()).thenReturn(null);
|
||||
when(environment.getActiveProfiles()).thenReturn(new String[] {});
|
||||
|
||||
PropertySource<?> propertySource = locator.locate(environment);
|
||||
|
||||
Assert.assertEquals("v1", propertySource.getProperty("k1"));
|
||||
Assert.assertEquals("v2", propertySource.getProperty("k2"));
|
||||
Assert.assertEquals("v3", propertySource.getProperty("k3"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testActiveProfileFilesPriorityBiggerThanDefault() {
|
||||
PolarisConfigFileLocator locator = new PolarisConfigFileLocator(polarisConfigProperties, polarisContextProperties,
|
||||
configFileService, polarisPropertySourceManager, environment);
|
||||
|
||||
when(polarisContextProperties.getNamespace()).thenReturn(testNamespace);
|
||||
when(polarisContextProperties.getService()).thenReturn(testServiceName);
|
||||
|
||||
// application.properties
|
||||
Map<String, Object> applicationProperties = new HashMap<>();
|
||||
applicationProperties.put("k1", "v1");
|
||||
applicationProperties.put("k2", "v2");
|
||||
applicationProperties.put("k3", "v3");
|
||||
ConfigKVFile propertiesFile = new MockedConfigKVFile(applicationProperties);
|
||||
when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "application.properties"))
|
||||
.thenReturn(propertiesFile);
|
||||
|
||||
// application-dev.properties
|
||||
Map<String, Object> devProperties = new HashMap<>();
|
||||
devProperties.put("k1", "v11");
|
||||
ConfigKVFile devFile = new MockedConfigKVFile(devProperties);
|
||||
when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "application-dev.properties"))
|
||||
.thenReturn(devFile);
|
||||
|
||||
Map<String, Object> emptyMap = new HashMap<>();
|
||||
ConfigKVFile emptyConfigFile = new MockedConfigKVFile(emptyMap);
|
||||
when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "application.yml")).thenReturn(emptyConfigFile);
|
||||
when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "application-dev.yml")).thenReturn(emptyConfigFile);
|
||||
when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "bootstrap.properties")).thenReturn(emptyConfigFile);
|
||||
when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "bootstrap-dev.properties")).thenReturn(emptyConfigFile);
|
||||
when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "bootstrap.yml")).thenReturn(emptyConfigFile);
|
||||
when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "bootstrap-dev.yml")).thenReturn(emptyConfigFile);
|
||||
|
||||
when(polarisConfigProperties.getGroups()).thenReturn(null);
|
||||
when(environment.getActiveProfiles()).thenReturn(new String[] {"dev"});
|
||||
|
||||
PropertySource<?> propertySource = locator.locate(environment);
|
||||
|
||||
Assert.assertEquals("v11", propertySource.getProperty("k1"));
|
||||
Assert.assertEquals("v2", propertySource.getProperty("k2"));
|
||||
Assert.assertEquals("v3", propertySource.getProperty("k3"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetCustomFiles() {
|
||||
PolarisConfigFileLocator locator = new PolarisConfigFileLocator(polarisConfigProperties, polarisContextProperties,
|
||||
configFileService, polarisPropertySourceManager, environment);
|
||||
|
||||
when(polarisContextProperties.getNamespace()).thenReturn(testNamespace);
|
||||
when(polarisContextProperties.getService()).thenReturn(testServiceName);
|
||||
|
||||
Map<String, Object> emptyMap = new HashMap<>();
|
||||
ConfigKVFile emptyConfigFile = new MockedConfigKVFile(emptyMap);
|
||||
|
||||
when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "application.properties")).thenReturn(emptyConfigFile);
|
||||
when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "application.yml")).thenReturn(emptyConfigFile);
|
||||
when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "bootstrap.properties")).thenReturn(emptyConfigFile);
|
||||
when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "bootstrap.yml")).thenReturn(emptyConfigFile);
|
||||
|
||||
List<ConfigFileGroup> customFiles = new LinkedList<>();
|
||||
ConfigFileGroup configFileGroup = new ConfigFileGroup();
|
||||
String customGroup = "group1";
|
||||
configFileGroup.setName(customGroup);
|
||||
String customFile1 = "file1.properties";
|
||||
String customFile2 = "file2.properties";
|
||||
configFileGroup.setFiles(Lists.newArrayList(customFile1, customFile2));
|
||||
customFiles.add(configFileGroup);
|
||||
|
||||
when(polarisConfigProperties.getGroups()).thenReturn(customFiles);
|
||||
when(environment.getActiveProfiles()).thenReturn(new String[] {});
|
||||
|
||||
// file1.properties
|
||||
Map<String, Object> file1Map = new HashMap<>();
|
||||
file1Map.put("k1", "v1");
|
||||
file1Map.put("k2", "v2");
|
||||
ConfigKVFile file1 = new MockedConfigKVFile(file1Map);
|
||||
when(configFileService.getConfigPropertiesFile(testNamespace, customGroup, customFile1)).thenReturn(file1);
|
||||
|
||||
// file2.properties
|
||||
Map<String, Object> file2Map = new HashMap<>();
|
||||
file2Map.put("k1", "v11");
|
||||
file2Map.put("k3", "v3");
|
||||
ConfigKVFile file2 = new MockedConfigKVFile(file2Map);
|
||||
when(configFileService.getConfigPropertiesFile(testNamespace, customGroup, customFile2)).thenReturn(file2);
|
||||
|
||||
PropertySource<?> propertySource = locator.locate(environment);
|
||||
|
||||
Assert.assertEquals("v1", propertySource.getProperty("k1"));
|
||||
Assert.assertEquals("v2", propertySource.getProperty("k2"));
|
||||
Assert.assertEquals("v3", propertySource.getProperty("k3"));
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,122 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.config.adapter;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
|
||||
import com.google.common.collect.Lists;
|
||||
import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
|
||||
import com.tencent.polaris.configuration.api.core.ChangeType;
|
||||
import com.tencent.polaris.configuration.api.core.ConfigKVFileChangeEvent;
|
||||
import com.tencent.polaris.configuration.api.core.ConfigPropertyChangeInfo;
|
||||
import org.junit.Assert;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.junit.MockitoJUnitRunner;
|
||||
|
||||
import org.springframework.cloud.context.refresh.ContextRefresher;
|
||||
|
||||
import static org.mockito.Mockito.verify;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
/**
|
||||
* test for {@link PolarisPropertySourceAutoRefresher}
|
||||
*@author lepdou 2022-06-11
|
||||
*/
|
||||
@RunWith(MockitoJUnitRunner.class)
|
||||
public class PolarisPropertiesSourceAutoRefresherTest {
|
||||
|
||||
@Mock
|
||||
private PolarisConfigProperties polarisConfigProperties;
|
||||
@Mock
|
||||
private PolarisPropertySourceManager polarisPropertySourceManager;
|
||||
@Mock
|
||||
private ContextRefresher contextRefresher;
|
||||
|
||||
private final String testNamespace = "testNamespace";
|
||||
private final String testServiceName = "testServiceName";
|
||||
private final String testFileName = "application.properties";
|
||||
|
||||
@Test
|
||||
public void testConfigFileChanged() {
|
||||
PolarisPropertySourceAutoRefresher refresher = new PolarisPropertySourceAutoRefresher(polarisConfigProperties,
|
||||
polarisPropertySourceManager, contextRefresher);
|
||||
|
||||
when(polarisConfigProperties.isAutoRefresh()).thenReturn(true);
|
||||
|
||||
Map<String, Object> content = new HashMap<>();
|
||||
content.put("k1", "v1");
|
||||
content.put("k2", "v2");
|
||||
content.put("k3", "v3");
|
||||
MockedConfigKVFile file = new MockedConfigKVFile(content);
|
||||
PolarisPropertySource polarisPropertySource = new PolarisPropertySource(testNamespace, testServiceName, testFileName,
|
||||
file, content);
|
||||
|
||||
when(polarisPropertySourceManager.getAllPropertySources()).thenReturn(Lists.newArrayList(polarisPropertySource));
|
||||
|
||||
ConfigPropertyChangeInfo changeInfo = new ConfigPropertyChangeInfo("k1", "v1", "v11", ChangeType.MODIFIED);
|
||||
ConfigPropertyChangeInfo changeInfo2 = new ConfigPropertyChangeInfo("k4", null, "v4", ChangeType.ADDED);
|
||||
ConfigPropertyChangeInfo changeInfo3 = new ConfigPropertyChangeInfo("k2", "v2", null, ChangeType.DELETED);
|
||||
Map<String, ConfigPropertyChangeInfo> changeInfos = new HashMap<>();
|
||||
changeInfos.put("k1", changeInfo);
|
||||
changeInfos.put("k2", changeInfo3);
|
||||
changeInfos.put("k4", changeInfo2);
|
||||
|
||||
ConfigKVFileChangeEvent event = new ConfigKVFileChangeEvent(changeInfos);
|
||||
refresher.onApplicationEvent(null);
|
||||
|
||||
file.fireChangeListener(event);
|
||||
|
||||
Assert.assertEquals("v11", polarisPropertySource.getProperty("k1"));
|
||||
Assert.assertEquals("v3", polarisPropertySource.getProperty("k3"));
|
||||
Assert.assertNull(polarisPropertySource.getProperty("k2"));
|
||||
Assert.assertEquals("v4", polarisPropertySource.getProperty("k4"));
|
||||
verify(contextRefresher).refresh();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testNewConfigFile() {
|
||||
PolarisPropertySourceAutoRefresher refresher = new PolarisPropertySourceAutoRefresher(polarisConfigProperties,
|
||||
polarisPropertySourceManager, contextRefresher);
|
||||
|
||||
when(polarisConfigProperties.isAutoRefresh()).thenReturn(true);
|
||||
|
||||
Map<String, Object> emptyContent = new HashMap<>();
|
||||
MockedConfigKVFile file = new MockedConfigKVFile(emptyContent);
|
||||
PolarisPropertySource polarisPropertySource = new PolarisPropertySource(testNamespace, testServiceName, testFileName,
|
||||
file, emptyContent);
|
||||
|
||||
when(polarisPropertySourceManager.getAllPropertySources()).thenReturn(Lists.newArrayList(polarisPropertySource));
|
||||
|
||||
ConfigPropertyChangeInfo changeInfo = new ConfigPropertyChangeInfo("k1", null, "v1", ChangeType.ADDED);
|
||||
Map<String, ConfigPropertyChangeInfo> changeInfos = new HashMap<>();
|
||||
changeInfos.put("k1", changeInfo);
|
||||
|
||||
ConfigKVFileChangeEvent event = new ConfigKVFileChangeEvent(changeInfos);
|
||||
refresher.onApplicationEvent(null);
|
||||
|
||||
file.fireChangeListener(event);
|
||||
|
||||
Assert.assertEquals("v1", polarisPropertySource.getProperty("k1"));
|
||||
verify(contextRefresher).refresh();
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,124 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.config.listener;
|
||||
|
||||
import com.google.common.collect.Sets;
|
||||
import com.tencent.cloud.polaris.config.annotation.PolarisConfigKVFileChangeListener;
|
||||
import com.tencent.polaris.configuration.api.core.ConfigPropertyChangeInfo;
|
||||
import org.junit.Assert;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.cloud.context.environment.EnvironmentChangeEvent;
|
||||
import org.springframework.context.ApplicationEventPublisher;
|
||||
import org.springframework.context.ConfigurableApplicationContext;
|
||||
import org.springframework.stereotype.Component;
|
||||
import org.springframework.test.context.junit4.SpringRunner;
|
||||
|
||||
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.DEFINED_PORT;
|
||||
|
||||
/**
|
||||
* Integration testing for change listener.
|
||||
*@author lepdou 2022-06-11
|
||||
*/
|
||||
@RunWith(SpringRunner.class)
|
||||
@SpringBootTest(webEnvironment = DEFINED_PORT,
|
||||
classes = ConfigChangeListenerTest.TestApplication.class,
|
||||
properties = {"server.port=8081",
|
||||
"spring.config.location = classpath:application-test.yml"})
|
||||
public class ConfigChangeListenerTest {
|
||||
|
||||
@Autowired
|
||||
private ApplicationEventPublisher applicationEventPublisher;
|
||||
@Autowired
|
||||
private ConfigurableApplicationContext applicationContext;
|
||||
@Autowired
|
||||
private TestApplication.TestConfig testConfig;
|
||||
|
||||
@Test
|
||||
public void test() throws InterruptedException {
|
||||
//before change
|
||||
Assert.assertEquals(1000, testConfig.getTimeout());
|
||||
|
||||
//submit change event
|
||||
System.setProperty("timeout", "2000");
|
||||
EnvironmentChangeEvent event = new EnvironmentChangeEvent(applicationContext,
|
||||
Sets.newHashSet("timeout"));
|
||||
|
||||
applicationEventPublisher.publishEvent(event);
|
||||
Thread.sleep(200);
|
||||
//after change
|
||||
Assert.assertEquals(2, testConfig.getChangeCnt());
|
||||
Assert.assertEquals(2000, testConfig.getTimeout());
|
||||
}
|
||||
|
||||
|
||||
@SpringBootApplication
|
||||
protected static class TestApplication {
|
||||
|
||||
@Component
|
||||
protected static class TestConfig {
|
||||
|
||||
@Value("${timeout:1000}")
|
||||
private int timeout;
|
||||
|
||||
private int changeCnt;
|
||||
|
||||
public int getTimeout() {
|
||||
return timeout;
|
||||
}
|
||||
|
||||
public void setTimeout(int timeout) {
|
||||
this.timeout = timeout;
|
||||
}
|
||||
|
||||
public int getChangeCnt() {
|
||||
return changeCnt;
|
||||
}
|
||||
|
||||
@PolarisConfigKVFileChangeListener(interestedKeys = {"timeout"})
|
||||
public void configChangedListener(ConfigChangeEvent event) {
|
||||
ConfigPropertyChangeInfo changeInfo = event.getChange("timeout");
|
||||
timeout = Integer.parseInt(changeInfo.getNewValue());
|
||||
changeCnt++;
|
||||
}
|
||||
|
||||
@PolarisConfigKVFileChangeListener(interestedKeyPrefixes = {"timeout"})
|
||||
public void configChangedListener2(ConfigChangeEvent event) {
|
||||
ConfigPropertyChangeInfo changeInfo = event.getChange("timeout");
|
||||
timeout = Integer.parseInt(changeInfo.getNewValue());
|
||||
changeCnt++;
|
||||
}
|
||||
}
|
||||
|
||||
@Component
|
||||
protected static class EventPublisher implements ApplicationEventPublisher {
|
||||
|
||||
@Override
|
||||
public void publishEvent(Object o) {
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,9 @@
|
||||
spring:
|
||||
application:
|
||||
name: test
|
||||
cloud:
|
||||
polaris:
|
||||
address: grpc://127.0.0.1:8091
|
||||
namespace: default
|
||||
config:
|
||||
connect-remote-server: false
|
||||
@ -1 +1 @@
|
||||
just for test
|
||||
just for test
|
||||
@ -0,0 +1,49 @@
|
||||
/*
|
||||
* Tencent is pleased to support the open source community by making Spring Cloud Tencent 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.cloud.polaris.config.example;
|
||||
|
||||
import java.util.Set;
|
||||
|
||||
import com.tencent.cloud.polaris.config.annotation.PolarisConfigKVFileChangeListener;
|
||||
import com.tencent.cloud.polaris.config.listener.ConfigChangeEvent;
|
||||
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
/**
|
||||
* Custom Config Listener Example .
|
||||
*
|
||||
* @author Palmer Xu 2022-06-06
|
||||
*/
|
||||
@Component
|
||||
public final class PersonConfigChangeListener {
|
||||
|
||||
/**
|
||||
* PolarisConfigKVFileChangeListener Example .
|
||||
* @param event instance of {@link ConfigChangeEvent}
|
||||
*/
|
||||
@PolarisConfigKVFileChangeListener(interestedKeyPrefixes = "teacher")
|
||||
public void onChange(ConfigChangeEvent event) {
|
||||
Set<String> changedKeys = event.changedKeys();
|
||||
|
||||
for (String changedKey : changedKeys) {
|
||||
System.out.printf("%s = %s \n", changedKey, event.getChange(changedKey));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in new issue