Microservices Engine:Migrate application configurations from Apollo to MSE Nacos

Mapeamento de conceitos do Apollo para o Nacos

O Apollo e o Nacos organizam as configurações de maneiras diferentes. Antes de começar, entenda como os dois modelos se relacionam.

Configurações em ambientes diferentes do Apollo podem ser mapeadas para instâncias distintas do Nacos ou para namespaces diferentes dentro de uma única instância. Escolha a abordagem mais adequada ao seu modelo de implantação.

Pré-requisitos

Antes de iniciar, certifique-se de ter:

• Uma instância do MSE Nacos Professional Edition. Para obter instruções, consulte Crie um mecanismo Nacos

• Acesso ao console do Apollo autogerenciado

Etapa 1: Exportar configurações do Apollo

Exporte suas configurações do Apollo usando um dos métodos a seguir.

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;

Etapa 2: Converter o arquivo exportado

Converta o arquivo exportado na Etapa 1 (.zip, .json ou .xlsx) para um formato compatível com a importação no MSE Nacos.

1. Baixe a ferramenta de conversão de formato:

      curl -O https://msesync.oss-cn-hangzhou.aliyuncs.com/ApolloConfigTransfer.jar

2. Execute a ferramenta de conversão. Substitua <exported-file-path> pelo caminho completo do arquivo exportado do Apollo:

      java -DsourceFilePath=<exported-file-path> -jar ApolloConfigTransfer.jar

3. Após a conclusão da execução, um arquivo chamado nacos_config_import_{original-filename}_{timestamp}.zip aparecerá no diretório atual. Esse arquivo está pronto para importação.

Etapa 3: Importar configurações para o MSE Nacos

1. Faça login no console do MSE e selecione uma região na barra de navegação superior.

2. No painel de navegação à esquerda, selecione Microservices Registry > Instances. Clique em no nome da sua instância do Nacos.

3. No painel de navegação à esquerda, selecione Configuration Management > Configurations.

4. Selecione o namespace de destino na lista suspensa Namespace.

5. Clique em Import Configuration e faça upload do arquivo .zip gerado na Etapa 2.

Após a conclusão da importação, suas configurações do Apollo estarão disponíveis no MSE Nacos.

Etapa 4: Atualize a dependência do Maven

Substitua a dependência do cliente Apollo pelo starter Spring Cloud Alibaba Nacos Config no seu arquivo pom.xml.

Antes (Apollo):

<dependency>
    <groupId>com.ctrip.framework.apollo</groupId>
    <artifactId>apollo-client</artifactId>
    <version>{apollo.version}</version>
</dependency>

Depois (Spring Cloud Alibaba Nacos):

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>2.2.10</version>
</dependency>

Etapa 5: Atualize o código da aplicação

O Apollo oferece suporte a diversos padrões de configuração dinâmica. Substitua cada padrão pelo equivalente no Nacos conforme descrito abaixo.

@RestController
@RefreshScope
public class DemoController {

    @Value("testKey")
    String testKey = "value";

    @RequestMapping("/valuekey")
    public String getNacosTestKey() {
        return testKey;
    }
}

@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
ConfigService.getAppConfig().getProperty("testkey", "defaulyv1");
ConfigService.getAppConfig("namespace").getProperty("testkey", "defaulyv1");

@NacosConfig(dataId = "appId1.application.properties", group = "group")
Properties nacosConfigProperties;

private void method() {
    String value = nacosConfigProperties.getProperty("key", "defaultValue");
}

// Apollo listener
@ApolloConfigChangeListener(interestedKeyPrefixes = {"data."})
public void apolloNotify(ConfigChangeEvent configChangeEvent) {
    System.out.println(configChangeEvent.changedKeys());
}

// Nacos listener
@NacosConfigKeysListener(
    dataId = "appId1.application.properties",
    group = "group",
    interestedKeyPrefixes = {"data."}
)
public void apolloNotify(ConfigChangeEvent configChangeEvent) {
    System.out.println(configChangeEvent.changedKeys());
}

Etapa 6: Alternar o endpoint de configuração

Substitua a configuração de bootstrap do Apollo pelo endpoint de configuração do Nacos.

Antes (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

Depois (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>

Substitua os seguintes espaços reservados pelos seus valores reais:

Após atualize a configuração, reinicie a aplicação.

Verifique a migração

Depois de reiniciar a aplicação, valide o sucesso da migração:

1. Verifique o carregamento das configurações: Revise os logs de inicialização da aplicação. Confirme se as configurações foram carregadas a partir do endpoint do Nacos sem erros.

2. Validar a atualização dinâmica: Altere um valor de configuração no console do MSE Nacos. Verifique se a aplicação adota o novo valor sem necessidade de reinicialização.

3. Testar o comportamento da aplicação: Execute sua suíte de testes funcionais. Confirme se a aplicação se comporta conforme o esperado com as configurações migradas.