Kendi yönettiğiniz bir Apollo yapılandırma merkezinden Alibaba Cloud Microservices Engine (MSE) Nacos'a geçtiğinizde iki öğeyi taşımanız gerekir: yapılandırma verilerinin kendisi ve bu verileri okuyan uygulama kodu. Bu kılavuz, Apollo yapılandırmalarını dışa aktarmaktan geçişi yapılan uygulamayı doğrulamaya kadar her iki süreci de adım adım açıklar.
Geçiş işlemi altı adımdan oluşur:
Yapılandırmaları Apollo'dan dışa aktarın
Dışa aktarılan dosyayı Nacos biçimine dönüştürün
Yapılandırmaları MSE Nacos'a aktarın
Maven bağımlılığını güncelleyin
Uygulama kodunu güncelleyin
Yapılandırma uç noktasını değiştirin
Apollo kavramlarının Nacos ile eşleşmesi
Apollo ve Nacos yapılandırmaları farklı şekilde düzenler. Başlamadan önce bu iki modelin birbirleriyle nasıl ilişkili olduğunu anlamanız gerekir.
| Apollo parametresi | Nacos parametresi | Notlar |
|---|---|---|
| env | instance | Her Apollo ortamı, bir Nacos örneğine veya bir örnek içindeki ayrı bir ad alanına eşlenir. |
| appId | appName | Uygulamayı tanımlar. |
| cluster | group | Doğrudan eşleme. |
| {appId}.{namespace}.{format} | dataId | Üç Apollo alanı birleştirilerek Nacos dataId değeri oluşturulur. |
Farklı Apollo ortamlarındaki yapılandırmalar, farklı Nacos örneklerine veya tek bir örnek içindeki farklı ad alanlarına eşlenebilir. Dağıtım modelinize en uygun yaklaşımı seçin.
Ön koşullar
Başlamadan önce aşağıdakilere sahip olduğunuzdan emin olun:
Bir MSE Nacos Professional Edition örneği. Talimatlar için bkz. Nacos motoru oluşturma
Kendi yönettiğiniz Apollo konsoluna erişim
1. Adım: Yapılandırmaları Apollo'dan dışa aktarma
Aşağıdaki yöntemlerden birini kullanarak Apollo yapılandırmalarınızı dışa aktarın.
Yöntem 1: Apollo konsolundan dışa aktarma (önerilen)
Kendi yönettiğiniz Apollo konsolunda oturum açın. Bu örnekte Apollo konsoluna
http://81.68.181.139adresinden erişebilirsiniz.My Applications sayfasında hedef uygulamanın adına tıklayın.
Uygulama ayrıntıları sayfasının sağ üst köşesinde Administrator Tools > Configure Export and Import seçeneklerini belirleyin.
Configure Export and Import sayfasında dışa aktarma ortamını seçin ve Export seçeneğine tıklayın.
Her ortamı ayrı ayrı dışa aktarın. Her dışa aktarma işlemi ilgili ortam için bir .zip dosyası üretir.
Yöntem 2: SQL sorgusu çalıştırarak dışa aktarma
Apollo sürümünüz dosya dışa aktarmayı desteklemiyorsa veritabanını doğrudan sorgulayın. Aşağıdaki SQL ifadesini çalıştırın ve sonuçları bir .json veya .xlsx dosyası olarak kaydedin:
SELECT DISTINCT
a.NamespaceId,
b.NamespaceName,
c.`Comment` AS 'NamespaceDesc',
b.AppId,
b.ClusterName,
a.Key,
a.Type,
a.Value,
a.Comment,
a.LineNum
FROM ITEM a
LEFT JOIN Namespace b ON a.NamespaceId = b.id
LEFT JOIN AppNamespace c ON c.Name = b.NamespaceName
WHERE a.IsDeleted = 0
ORDER BY a.NamespaceId, a.LineNum;
2. Adım: Dışa aktarılan dosyayı dönüştürme
1. Adımdaki dışa aktarılan dosyayı (.zip, .json veya .xlsx), MSE Nacos'un içe aktarabileceği bir biçime dönüştürün.
-
Biçim dönüştürme aracını indirin:
curl -O https://msesync.oss-cn-hangzhou.aliyuncs.com/ApolloConfigTransfer.jar -
Dönüştürme aracını çalıştırın.
<exported-file-path>yerine dışa aktarılan Apollo dosyasının tam yolunu girin:java -DsourceFilePath=<exported-file-path> -jar ApolloConfigTransfer.jar Araç tamamlandığında geçerli dizinde
nacos_config_import_{original-filename}_{timestamp}.zipadlı bir dosya görünür. Bu dosya içe aktarmaya hazırdır.
3. Adım: Yapılandırmaları MSE Nacos'a aktarma
MSE konsolunda oturum açın ve üst gezinme çubuğundan bir bölge seçin.
Sol gezinme bölmesinde Microservices Registry > Instances seçeneklerini belirleyin. Nacos örneğinizin adına tıklayın.
Sol gezinme bölmesinde Configuration Management > Configurations seçeneklerini belirleyin.
Namespace açılır listesinden hedef ad alanını seçin.
Import Configuration seçeneğine tıklayın ve 2. Adımdaki
.zipdosyasını yükleyin.
İçe aktarma işlemi tamamlandığında Apollo yapılandırmalarınız MSE Nacos'ta kullanılabilir hale gelir.
4. Adım: Maven bağımlılığını güncelleme
pom.xml dosyanızda Apollo istemci bağımlılığını Spring Cloud Alibaba Nacos Config starter ile değiştirin.
Önce (Apollo):
<dependency>
<groupId>com.ctrip.framework.apollo</groupId>
<artifactId>apollo-client</artifactId>
<version>{apollo.version}</version>
</dependency>
Sonra (Spring Cloud Alibaba Nacos):
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>2.2.10</version>
</dependency>
Sürüm uyumluluğu
Spring Cloud Alibaba sürümünüzle eşleşen spring-cloud-starter-alibaba-nacos-config sürümünü seçin:
| Spring Cloud Alibaba sürümü | Önerilen Nacos Config starter sürümü |
|---|---|
| 2023.x | 2023.0.3.2 |
| 2022.x | 2022.0.0.2 |
| 2021.x | 2021.0.6.2 |
| 2.2.x | 2.2.11 |
5. Adım: Uygulama kodunu güncelleme
Apollo birkaç dinamik yapılandırma desenini destekler. Aşağıda açıklandığı gibi her deseni Nacos eşdeğeriyle değiştirin.
@Value ek açıklaması (değişiklik gerekmez)
@Value ek açıklaması kod değişikliği gerektirmeden Spring Cloud Alibaba ile çalışır. Dinamik yenilemeyi etkinleştirmek için bileşene @RefreshScope ekleyin:
@RestController
@RefreshScope
public class DemoController {
@Value("testKey")
String testKey = "value";
@RequestMapping("/valuekey")
public String getNacosTestKey() {
return testKey;
}
}
@ApolloConfig yerine @ConfigurationProperties kullanma
@ApolloConfig ek açıklaması özellik değerlerini otomatik olarak bir Spring bileşenine enjekte eder. Bunun yerine standart Spring @ConfigurationProperties ek açıklamasını kullanın:
@Configuration
@ConfigurationProperties
public class CNStackInfoConfig {
private String name;
private int customerCount;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getCustomerCount() {
return customerCount;
}
public void setCustomerCount(int customerCount) {
this.customerCount = customerCount;
}
}
Apollo Config API yerine @NacosConfig kullanma
Kodunuz özellik değerlerini almak için Apollo Config API'sini çağırıyorsa:
// Apollo Config API
ConfigService.getAppConfig().getProperty("testkey", "defaulyv1");
ConfigService.getAppConfig("namespace").getProperty("testkey", "defaulyv1");
Bunun yerine @NacosConfig ve Properties.getProperty() kullanın:
@NacosConfig(dataId = "appId1.application.properties", group = "group")
Properties nacosConfigProperties;
private void method() {
String value = nacosConfigProperties.getProperty("key", "defaultValue");
}
ApolloConfigChangeListener yerine @NacosConfigKeysListener kullanma
Kodunuz yapılandırma değişikliklerine tepki vermek için @ApolloConfigChangeListener kullanıyorsa:
// Apollo listener
@ApolloConfigChangeListener(interestedKeyPrefixes = {"data."})
public void apolloNotify(ConfigChangeEvent configChangeEvent) {
System.out.println(configChangeEvent.changedKeys());
}
Bunun yerine @NacosConfigKeysListener kullanın:
// Nacos listener
@NacosConfigKeysListener(
dataId = "appId1.application.properties",
group = "group",
interestedKeyPrefixes = {"data."}
)
public void apolloNotify(ConfigChangeEvent configChangeEvent) {
System.out.println(configChangeEvent.changedKeys());
}
Ek açıklama kullanımına ilişkin ayrıntılar için bkz. Spring Cloud uygulamaları için Nacos yapılandırma merkezlerinin ek açıklamaları.
6. Adım: Yapılandırma uç noktasını değiştirme
Apollo önyükleme yapılandırmasını Nacos yapılandırma uç noktasıyla değiştirin.
Önce (Apollo):
## Apollo configurations
# Environment: -Dappllo.env={env}
apollo.meta=http://127.0.0.1:8070
apollo.bootstrap.enabled=true
# Namespaces to load
apollo.bootstrap.namespaces=application,namespace1
# Cluster
apollo.bootstrap.cluster=default
# Application ID
app.id=app1
Sonra (Nacos):
# Import specific configurations by dataId and group
spring.config.import[0]=nacos:app1.application.properties?group=default&refreshEnabled=true
spring.config.import[1]=nacos:app1.namespace1.properties?group=default&refreshEnabled=true
# MSE Nacos endpoint
spring.cloud.nacos.config.server-addr=mse-xxx-p.nacos-ans.mse.aliyuncs.com
# MSE Nacos namespace (use the namespace ID from the MSE console)
spring.cloud.nacos.config.namespace=<namespace-id>
Aşağıdaki yer tutucuları gerçek değerlerinizle değiştirin:
| Yer tutucu | Açıklama | Örnek |
|---|---|---|
mse-xxx-p.nacos-ans.mse.aliyuncs.com |
MSE Nacos örnek uç noktası | mse-abc123-p.nacos-ans.mse.aliyuncs.com |
<namespace-id> |
MSE konsolundaki ad alanı kimliği | 5babe1ee-1352-xxxx-bd7b-7e7ce892e2ab |
Yapılandırmayı güncelledikten sonra uygulamayı yeniden başlatın.
Geçişi doğrulama
Uygulama yeniden başlatıldıktan sonra geçişin başarılı olduğunu doğrulayın:
Yapılandırma yüklemesini kontrol edin: Uygulama başlatma günlüklerini inceleyin. Yapılandırmaların Nacos uç noktasından hatasız yüklendiğini onaylayın.
Dinamik yenilemeyi doğrulayın: MSE Nacos konsolunda bir yapılandırma değerini değiştirin. Uygulamanın yeniden başlatmaya gerek kalmadan yeni değeri aldığını doğrulayın.
Uygulama davranışını test edin: İşlevsel test paketinizi çalıştırın. Uygulamanın geçirilen yapılandırmalarla beklendiği gibi davrandığını onaylayın.
Geçişten sonra uygulamayı bir süre izleyin. Her şeyin doğru çalıştığını onayladıktan sonra kendi yönettiğiniz Apollo yapılandırma merkezini devre dışı bırakın.