polish #761 update pkg name & maven coordinate for Greenwich

spring-cloud-alibaba-nacos-config/src/main/java/com/alibaba/cloud/nacos/client/NacosPropertySource.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright (C) 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.alibaba.cloud.nacos.client;
+
+import java.util.Date;
+import java.util.Map;
+
+import org.springframework.core.env.MapPropertySource;
+
+/**
+ * @author xiaojing
+ * @author pbting
+ */
+public class NacosPropertySource extends MapPropertySource {
+
+	/**
+	 * Nacos Group
+	 */
+	private final String group;
+
+	/**
+	 * Nacos dataID
+	 */
+	private final String dataId;
+
+	/**
+	 * timestamp the property get
+	 */
+	private final Date timestamp;
+
+	/**
+	 * Whether to support dynamic refresh for this Property Source
+	 */
+	private final boolean isRefreshable;
+
+	NacosPropertySource(String group, String dataId, Map<String, Object> source,
+			Date timestamp, boolean isRefreshable) {
+		super(dataId, source);
+		this.group = group;
+		this.dataId = dataId;
+		this.timestamp = timestamp;
+		this.isRefreshable = isRefreshable;
+	}
+
+	public String getGroup() {
+		return this.group;
+	}
+
+	public String getDataId() {
+		return dataId;
+	}
+
+	public Date getTimestamp() {
+		return timestamp;
+	}
+
+	public boolean isRefreshable() {
+		return isRefreshable;
+	}
+}

spring-cloud-alibaba-nacos-config/src/main/java/com/alibaba/cloud/nacos/client/NacosPropertySourceBuilder.java

@@ -0,0 +1,131 @@
+/*
+ * Copyright (C) 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.alibaba.cloud.nacos.client;
+
+import java.io.StringReader;
+import java.util.Date;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Properties;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
+import org.springframework.core.io.ByteArrayResource;
+import org.springframework.util.StringUtils;
+
+import com.alibaba.cloud.nacos.NacosPropertySourceRepository;
+import com.alibaba.nacos.api.config.ConfigService;
+import com.alibaba.nacos.api.exception.NacosException;
+
+/**
+ * @author xiaojing
+ * @author pbting
+ */
+public class NacosPropertySourceBuilder {
+	private static final Logger log = LoggerFactory
+			.getLogger(NacosPropertySourceBuilder.class);
+	private static final Properties EMPTY_PROPERTIES = new Properties();
+
+	private ConfigService configService;
+	private long timeout;
+
+	public NacosPropertySourceBuilder(ConfigService configService, long timeout) {
+		this.configService = configService;
+		this.timeout = timeout;
+	}
+
+	public long getTimeout() {
+		return timeout;
+	}
+
+	public void setTimeout(long timeout) {
+		this.timeout = timeout;
+	}
+
+	public ConfigService getConfigService() {
+		return configService;
+	}
+
+	public void setConfigService(ConfigService configService) {
+		this.configService = configService;
+	}
+
+	/**
+	 * @param dataId Nacos dataId
+	 * @param group Nacos group
+	 */
+	NacosPropertySource build(String dataId, String group, String fileExtension,
+			boolean isRefreshable) {
+		Properties p = loadNacosData(dataId, group, fileExtension);
+		NacosPropertySource nacosPropertySource = new NacosPropertySource(group, dataId,
+				propertiesToMap(p), new Date(), isRefreshable);
+		NacosPropertySourceRepository.collectNacosPropertySources(nacosPropertySource);
+		return nacosPropertySource;
+	}
+
+	private Properties loadNacosData(String dataId, String group, String fileExtension) {
+		String data = null;
+		try {
+			data = configService.getConfig(dataId, group, timeout);
+			if (!StringUtils.isEmpty(data)) {
+				log.info(String.format("Loading nacos data, dataId: '%s', group: '%s'",
+						dataId, group));
+
+				if (fileExtension.equalsIgnoreCase("properties")) {
+					Properties properties = new Properties();
+
+					properties.load(new StringReader(data));
+					return properties;
+				}
+				else if (fileExtension.equalsIgnoreCase("yaml")
+						|| fileExtension.equalsIgnoreCase("yml")) {
+					YamlPropertiesFactoryBean yamlFactory = new YamlPropertiesFactoryBean();
+					yamlFactory.setResources(new ByteArrayResource(data.getBytes()));
+					return yamlFactory.getObject();
+				}
+
+			}
+		}
+		catch (NacosException e) {
+			log.error("get data from Nacos error,dataId:{}, ", dataId, e);
+		}
+		catch (Exception e) {
+			log.error("parse data from Nacos error,dataId:{},data:{},", dataId, data, e);
+		}
+		return EMPTY_PROPERTIES;
+	}
+
+	@SuppressWarnings("unchecked")
+	private Map<String, Object> propertiesToMap(Properties properties) {
+		Map<String, Object> result = new HashMap<>(16);
+		Enumeration<String> keys = (Enumeration<String>) properties.propertyNames();
+		while (keys.hasMoreElements()) {
+			String key = keys.nextElement();
+			Object value = properties.getProperty(key);
+			if (value != null) {
+				result.put(key, ((String) value).trim());
+			}
+			else {
+				result.put(key, null);
+			}
+		}
+		return result;
+	}
+
+}

spring-cloud-alibaba-nacos-config/src/main/java/com/alibaba/cloud/nacos/client/NacosPropertySourceLocator.java

@@ -0,0 +1,225 @@
+/*
+ * Copyright (C) 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.alibaba.cloud.nacos.client;
+
+import java.util.Arrays;
+import java.util.List;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.cloud.bootstrap.config.PropertySourceLocator;
+import org.springframework.core.annotation.Order;
+import org.springframework.core.env.CompositePropertySource;
+import org.springframework.core.env.Environment;
+import org.springframework.core.env.PropertySource;
+import org.springframework.util.StringUtils;
+
+import com.alibaba.cloud.nacos.NacosConfigProperties;
+import com.alibaba.cloud.nacos.NacosPropertySourceRepository;
+import com.alibaba.cloud.nacos.refresh.NacosContextRefresher;
+import com.alibaba.nacos.api.config.ConfigService;
+
+/**
+ * @author xiaojing
+ * @author pbting
+ */
+@Order(0)
+public class NacosPropertySourceLocator implements PropertySourceLocator {
+
+	private static final Logger log = LoggerFactory
+			.getLogger(NacosPropertySourceLocator.class);
+	private static final String NACOS_PROPERTY_SOURCE_NAME = "NACOS";
+	private static final String SEP1 = "-";
+	private static final String DOT = ".";
+	private static final String SHARED_CONFIG_SEPARATOR_CHAR = "[,]";
+	private static final List<String> SUPPORT_FILE_EXTENSION = Arrays.asList("properties",
+			"yaml", "yml");
+
+	private NacosPropertySourceBuilder nacosPropertySourceBuilder;
+
+	private NacosConfigProperties nacosConfigProperties;
+
+	public NacosPropertySourceLocator(NacosConfigProperties nacosConfigProperties) {
+		this.nacosConfigProperties = nacosConfigProperties;
+	}
+
+	@Override
+	public PropertySource<?> locate(Environment env) {
+
+		ConfigService configService = nacosConfigProperties.configServiceInstance();
+
+		if (null == configService) {
+			log.warn("no instance of config service found, can't load config from nacos");
+			return null;
+		}
+		long timeout = nacosConfigProperties.getTimeout();
+		nacosPropertySourceBuilder = new NacosPropertySourceBuilder(configService,
+				timeout);
+		String name = nacosConfigProperties.getName();
+
+		String dataIdPrefix = nacosConfigProperties.getPrefix();
+		if (StringUtils.isEmpty(dataIdPrefix)) {
+			dataIdPrefix = name;
+		}
+
+		if (StringUtils.isEmpty(dataIdPrefix)) {
+			dataIdPrefix = env.getProperty("spring.application.name");
+		}
+
+		CompositePropertySource composite = new CompositePropertySource(
+				NACOS_PROPERTY_SOURCE_NAME);
+
+		loadSharedConfiguration(composite);
+		loadExtConfiguration(composite);
+		loadApplicationConfiguration(composite, dataIdPrefix, nacosConfigProperties, env);
+
+		return composite;
+	}
+
+	private void loadSharedConfiguration(
+			CompositePropertySource compositePropertySource) {
+		String sharedDataIds = nacosConfigProperties.getSharedDataids();
+		String refreshDataIds = nacosConfigProperties.getRefreshableDataids();
+
+		if (sharedDataIds == null || sharedDataIds.trim().length() == 0) {
+			return;
+		}
+
+		String[] sharedDataIdArry = sharedDataIds.split(SHARED_CONFIG_SEPARATOR_CHAR);
+		checkDataIdFileExtension(sharedDataIdArry);
+
+		for (int i = 0; i < sharedDataIdArry.length; i++) {
+			String dataId = sharedDataIdArry[i];
+			String fileExtension = dataId.substring(dataId.lastIndexOf(".") + 1);
+			boolean isRefreshable = checkDataIdIsRefreshbable(refreshDataIds,
+					sharedDataIdArry[i]);
+
+			loadNacosDataIfPresent(compositePropertySource, dataId, "DEFAULT_GROUP",
+					fileExtension, isRefreshable);
+		}
+	}
+
+	private void loadExtConfiguration(CompositePropertySource compositePropertySource) {
+		if (nacosConfigProperties.getExtConfig() == null
+				|| nacosConfigProperties.getExtConfig().isEmpty()) {
+			return;
+		}
+
+		List<NacosConfigProperties.Config> extConfigs = nacosConfigProperties
+				.getExtConfig();
+		checkExtConfiguration(extConfigs);
+
+		for (NacosConfigProperties.Config config : extConfigs) {
+			String dataId = config.getDataId();
+			String fileExtension = dataId.substring(dataId.lastIndexOf(".") + 1);
+			loadNacosDataIfPresent(compositePropertySource, dataId, config.getGroup(),
+					fileExtension, config.isRefresh());
+		}
+	}
+
+	private void checkExtConfiguration(List<NacosConfigProperties.Config> extConfigs) {
+		String[] dataIds = new String[extConfigs.size()];
+		for (int i = 0; i < extConfigs.size(); i++) {
+			String dataId = extConfigs.get(i).getDataId();
+			if (dataId == null || dataId.trim().length() == 0) {
+				throw new IllegalStateException(String.format(
+						"the [ spring.cloud.nacos.config.ext-config[%s] ] must give a dataid",
+						i));
+			}
+			dataIds[i] = dataId;
+		}
+		checkDataIdFileExtension(dataIds);
+	}
+
+	private void loadApplicationConfiguration(
+			CompositePropertySource compositePropertySource, String dataIdPrefix,
+			NacosConfigProperties properties, Environment environment) {
+
+		String fileExtension = properties.getFileExtension();
+		String nacosGroup = properties.getGroup();
+
+		loadNacosDataIfPresent(compositePropertySource,
+				dataIdPrefix + DOT + fileExtension, nacosGroup, fileExtension, true);
+		for (String profile : environment.getActiveProfiles()) {
+			String dataId = dataIdPrefix + SEP1 + profile + DOT + fileExtension;
+			loadNacosDataIfPresent(compositePropertySource, dataId, nacosGroup,
+					fileExtension, true);
+		}
+	}
+
+	private void loadNacosDataIfPresent(final CompositePropertySource composite,
+			final String dataId, final String group, String fileExtension,
+			boolean isRefreshable) {
+		if (NacosContextRefresher.getRefreshCount() != 0) {
+			NacosPropertySource ps;
+			if (!isRefreshable) {
+				ps = NacosPropertySourceRepository.getNacosPropertySource(dataId);
+			}
+			else {
+				ps = nacosPropertySourceBuilder.build(dataId, group, fileExtension, true);
+			}
+
+			composite.addFirstPropertySource(ps);
+		}
+		else {
+			NacosPropertySource ps = nacosPropertySourceBuilder.build(dataId, group,
+					fileExtension, isRefreshable);
+			composite.addFirstPropertySource(ps);
+		}
+	}
+
+	private static void checkDataIdFileExtension(String[] dataIdArray) {
+		StringBuilder stringBuilder = new StringBuilder();
+		for (int i = 0; i < dataIdArray.length; i++) {
+			boolean isLegal = false;
+			for (String fileExtension : SUPPORT_FILE_EXTENSION) {
+				if (dataIdArray[i].indexOf(fileExtension) > 0) {
+					isLegal = true;
+					break;
+				}
+			}
+			// add tips
+			if (!isLegal) {
+				stringBuilder.append(dataIdArray[i] + ",");
+			}
+		}
+
+		if (stringBuilder.length() > 0) {
+			String result = stringBuilder.substring(0, stringBuilder.length() - 1);
+			throw new IllegalStateException(String.format(
+					"[%s] must contains file extension with properties|yaml|yml",
+					result));
+		}
+	}
+
+	private boolean checkDataIdIsRefreshbable(String refreshDataIds,
+			String sharedDataId) {
+		if (refreshDataIds == null || "".equals(refreshDataIds)) {
+			return false;
+		}
+
+		String[] refreshDataIdArry = refreshDataIds.split(SHARED_CONFIG_SEPARATOR_CHAR);
+		for (String refreshDataId : refreshDataIdArry) {
+			if (refreshDataId.equals(sharedDataId)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+}