This repository has been archived by the owner on Feb 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #307 from qixiaobo/support-apollo
feat(ark-serverless): support apollo
- Loading branch information
Showing
6 changed files
with
657 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
312 changes: 312 additions & 0 deletions
312
...ss-runtime/sofa-serverless-adapter-ext/sofa-serverless-adapter-apollo/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,312 @@ | ||
| # apollo support | ||
|
|
||
| ## apollo支持 | ||
| # 参考 | ||
| [Appollo初始化时，使用的引用项目的app.id · Issue #2659 · apolloconfig/apollo](https://github.com/apolloconfig/apollo/issues/2659) | ||
| [一个tomcat下部署多个war，导致app.id相同 · Issue #2921 · apolloconfig/apollo](https://github.com/apolloconfig/apollo/issues/2921) | ||
| 当前版本apollo-java 1.6.0 | ||
| # 问题现象 | ||
|  | ||
| 出现了不同biz的配置无法获取的情况 | ||
| # 问题探究 | ||
| 其代码实现ApolloApplicationContextInitializer� | ||
| ``` | ||
| private static final String[] APOLLO_SYSTEM_PROPERTIES = {"app.id", ConfigConsts.APOLLO_CLUSTER_KEY, | ||
| "apollo.cacheDir", "apollo.accesskey.secret", ConfigConsts.APOLLO_META_KEY, PropertiesFactory.APOLLO_PROPERTY_ORDER_ENABLE}; | ||
| /** | ||
| * To fill system properties from environment config | ||
| */ | ||
| void initializeSystemProperty(ConfigurableEnvironment environment) { | ||
| for (String propertyName : APOLLO_SYSTEM_PROPERTIES) { | ||
| fillSystemPropertyFromEnvironment(environment, propertyName); | ||
| } | ||
| } | ||
| private void fillSystemPropertyFromEnvironment(ConfigurableEnvironment environment, String propertyName) { | ||
| if (System.getProperty(propertyName) != null) { | ||
| return; | ||
| } | ||
| String propertyValue = environment.getProperty(propertyName); | ||
| if (Strings.isNullOrEmpty(propertyValue)) { | ||
| return; | ||
| } | ||
| System.setProperty(propertyName, propertyValue); | ||
| } | ||
| ``` | ||
| 导致一旦加载过一次apollo 其本质上会发生app.id会被强行覆盖 这样的话实际上会出现哪怕第二个biz出现也只能加载到第一个配置 | ||
|  | ||
| 但是起始apollo加载还有问题 | ||
| DefaultApplicationProvider 我们可以看到 | ||
| ``` | ||
| package com.ctrip.framework.foundation.internals.provider; | ||
| import java.io.InputStream; | ||
| import java.io.InputStreamReader; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.Properties; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import com.ctrip.framework.foundation.internals.Utils; | ||
| import com.ctrip.framework.foundation.internals.io.BOMInputStream; | ||
| import com.ctrip.framework.foundation.spi.provider.ApplicationProvider; | ||
| import com.ctrip.framework.foundation.spi.provider.Provider; | ||
| public class DefaultApplicationProvider implements ApplicationProvider { | ||
| private static final Logger logger = LoggerFactory.getLogger(DefaultApplicationProvider.class); | ||
| public static final String APP_PROPERTIES_CLASSPATH = "/META-INF/app.properties"; | ||
| private Properties m_appProperties = new Properties(); | ||
| private String m_appId; | ||
| private String accessKeySecret; | ||
| @Override | ||
| public void initialize() { | ||
| try { | ||
| InputStream in = Thread.currentThread().getContextClassLoader() | ||
| .getResourceAsStream(APP_PROPERTIES_CLASSPATH.substring(1)); | ||
| if (in == null) { | ||
| in = DefaultApplicationProvider.class.getResourceAsStream(APP_PROPERTIES_CLASSPATH); | ||
| } | ||
| initialize(in); | ||
| } catch (Throwable ex) { | ||
| logger.error("Initialize DefaultApplicationProvider failed.", ex); | ||
| } | ||
| } | ||
| @Override | ||
| public void initialize(InputStream in) { | ||
| try { | ||
| if (in != null) { | ||
| try { | ||
| m_appProperties | ||
| .load(new InputStreamReader(new BOMInputStream(in), StandardCharsets.UTF_8)); | ||
| } finally { | ||
| in.close(); | ||
| } | ||
| } | ||
| initAppId(); | ||
| initAccessKey(); | ||
| } catch (Throwable ex) { | ||
| logger.error("Initialize DefaultApplicationProvider failed.", ex); | ||
| } | ||
| } | ||
| @Override | ||
| public String getAppId() { | ||
| return m_appId; | ||
| } | ||
| @Override | ||
| public String getAccessKeySecret() { | ||
| return accessKeySecret; | ||
| } | ||
| @Override | ||
| public boolean isAppIdSet() { | ||
| return !Utils.isBlank(m_appId); | ||
| } | ||
| @Override | ||
| public String getProperty(String name, String defaultValue) { | ||
| if ("app.id".equals(name)) { | ||
| String val = getAppId(); | ||
| return val == null ? defaultValue : val; | ||
| } | ||
| if ("apollo.accesskey.secret".equals(name)) { | ||
| String val = getAccessKeySecret(); | ||
| return val == null ? defaultValue : val; | ||
| } | ||
| String val = m_appProperties.getProperty(name, defaultValue); | ||
| return val == null ? defaultValue : val; | ||
| } | ||
| @Override | ||
| public Class<? extends Provider> getType() { | ||
| return ApplicationProvider.class; | ||
| } | ||
| private void initAppId() { | ||
| // 1. Get app.id from System Property | ||
| m_appId = System.getProperty("app.id"); | ||
| if (!Utils.isBlank(m_appId)) { | ||
| m_appId = m_appId.trim(); | ||
| logger.info("App ID is set to {} by app.id property from System Property", m_appId); | ||
| return; | ||
| } | ||
| //2. Try to get app id from OS environment variable | ||
| m_appId = System.getenv("APP_ID"); | ||
| if (!Utils.isBlank(m_appId)) { | ||
| m_appId = m_appId.trim(); | ||
| logger.info("App ID is set to {} by APP_ID property from OS environment variable", m_appId); | ||
| return; | ||
| } | ||
| // 3. Try to get app id from app.properties. | ||
| m_appId = m_appProperties.getProperty("app.id"); | ||
| if (!Utils.isBlank(m_appId)) { | ||
| m_appId = m_appId.trim(); | ||
| logger.info("App ID is set to {} by app.id property from {}", m_appId, | ||
| APP_PROPERTIES_CLASSPATH); | ||
| return; | ||
| } | ||
| m_appId = null; | ||
| logger.warn("app.id is not available from System Property and {}. It is set to null", | ||
| APP_PROPERTIES_CLASSPATH); | ||
| } | ||
| private void initAccessKey() { | ||
| // 1. Get accesskey secret from System Property | ||
| accessKeySecret = System.getProperty("apollo.accesskey.secret"); | ||
| if (!Utils.isBlank(accessKeySecret)) { | ||
| accessKeySecret = accessKeySecret.trim(); | ||
| logger | ||
| .info("ACCESSKEY SECRET is set by apollo.accesskey.secret property from System Property"); | ||
| return; | ||
| } | ||
| //2. Try to get accesskey secret from OS environment variable | ||
| accessKeySecret = System.getenv("APOLLO_ACCESSKEY_SECRET"); | ||
| if (!Utils.isBlank(accessKeySecret)) { | ||
| accessKeySecret = accessKeySecret.trim(); | ||
| logger.info( | ||
| "ACCESSKEY SECRET is set by APOLLO_ACCESSKEY_SECRET property from OS environment variable"); | ||
| return; | ||
| } | ||
| // 3. Try to get accesskey secret from app.properties. | ||
| accessKeySecret = m_appProperties.getProperty("apollo.accesskey.secret"); | ||
| if (!Utils.isBlank(accessKeySecret)) { | ||
| accessKeySecret = accessKeySecret.trim(); | ||
| logger.info("ACCESSKEY SECRET is set by apollo.accesskey.secret property from {}", | ||
| APP_PROPERTIES_CLASSPATH); | ||
| return; | ||
| } | ||
| accessKeySecret = null; | ||
| } | ||
| @Override | ||
| public String toString() { | ||
| return "appId [" + getAppId() + "] properties: " + m_appProperties | ||
| + " (DefaultApplicationProvider)"; | ||
| } | ||
| } | ||
| ``` | ||
| 其默认还是依靠System.getProperty("app.id")� | ||
| 我们知道既然是多biz加载 相当于System这些的共享配置不能进行修改共享的 会造成污染 而且上文中我们已经注释 | ||
| 因此需要按照他的逻辑去加载META-INF/app.properties� | ||
| 所以需要在每个biz项目创建如下配置 | ||
|  | ||
| 除此之外我们还发现 这个都是guice一次性单实例注入 所以无法按照不同biz初始化不同的实例 | ||
| ``` | ||
| package com.ctrip.framework.foundation; | ||
| import com.ctrip.framework.foundation.internals.NullProviderManager; | ||
| import com.ctrip.framework.foundation.internals.ServiceBootstrap; | ||
| import com.ctrip.framework.foundation.spi.ProviderManager; | ||
| import com.ctrip.framework.foundation.spi.provider.ApplicationProvider; | ||
| import com.ctrip.framework.foundation.spi.provider.NetworkProvider; | ||
| import com.ctrip.framework.foundation.spi.provider.ServerProvider; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| public abstract class Foundation { | ||
| private static final Logger logger = LoggerFactory.getLogger(Foundation.class); | ||
| private static Object lock = new Object(); | ||
| private static volatile ProviderManager s_manager; | ||
| // Encourage early initialization and fail early if it happens. | ||
| static { | ||
| getManager(); | ||
| } | ||
| private static ProviderManager getManager() { | ||
| try { | ||
| if (s_manager == null) { | ||
| // Double locking to make sure only one thread initializes ProviderManager. | ||
| synchronized (lock) { | ||
| if (s_manager == null) { | ||
| s_manager = ServiceBootstrap.loadFirst(ProviderManager.class); | ||
| } | ||
| } | ||
| } | ||
| return s_manager; | ||
| } catch (Throwable ex) { | ||
| s_manager = new NullProviderManager(); | ||
| logger.error("Initialize ProviderManager failed.", ex); | ||
| return s_manager; | ||
| } | ||
| } | ||
| public static String getProperty(String name, String defaultValue) { | ||
| try { | ||
| return getManager().getProperty(name, defaultValue); | ||
| } catch (Throwable ex) { | ||
| logger.error("getProperty for {} failed.", name, ex); | ||
| return defaultValue; | ||
| } | ||
| } | ||
| public static NetworkProvider net() { | ||
| try { | ||
| return getManager().provider(NetworkProvider.class); | ||
| } catch (Exception ex) { | ||
| logger.error("Initialize NetworkProvider failed.", ex); | ||
| return NullProviderManager.provider; | ||
| } | ||
| } | ||
| public static ServerProvider server() { | ||
| try { | ||
| return getManager().provider(ServerProvider.class); | ||
| } catch (Exception ex) { | ||
| logger.error("Initialize ServerProvider failed.", ex); | ||
| return NullProviderManager.provider; | ||
| } | ||
| } | ||
| public static ApplicationProvider app() { | ||
| try { | ||
| return getManager().provider(ApplicationProvider.class); | ||
| } catch (Exception ex) { | ||
| logger.error("Initialize ApplicationProvider failed.", ex); | ||
| return NullProviderManager.provider; | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| 大量的静态化处理使得无法正常启动多个实例 | ||
| 关于此 我们还发现其apollo拉取配置的时候longpoll也是单个ExecutorService | ||
|  | ||
| 发现polling出现问题 即只有一个线程 无法处理拉取多个config 同时由于该线程绑定的classLoader 导致无法获取其他config更新 | ||
| 综上看来 整个apollo基本上是构建在单一应用上的 因此很难服用到多模块中 | ||
| 为此 我们考虑了是否还是要讲apollo放入到biz 利用classLoader的隔离确保整个static这些都是隔离的 | ||
| 但是由此产生了新的问题 我们需要hack原先apollo的实现 这个代码要如何维护呢？？？ | ||
| 我们肯定不希望是要给每个biz都要去改 都要去维护啊 | ||
| 因此产生了一个需求 | ||
| 我们期望在base维护或者说依赖sdk 同时加载的class要通过biz的classsLoader | ||
| 其实这就是一个典型的针对中间件进行patch的流程 | ||
| 此处暂时不展开 我们先讲apollo的改动同步 | ||
|  | ||
| 修改为provided 同时注意idea的配置 | ||
|  | ||
|
|
||
| springboot默认勾选了包含provided依赖 要关闭掉该选项 确保classpath不包含apollo【提供provided是因为需要编译】 |
Oops, something went wrong.