将Spring Cloud应用托管到SAE

为什么托管到SAE

原依赖Eureka、Consul、ZooKeeper等组件实现服务注册与发现的Spring Cloud应用，如果需要部署至SAE，仅需将原服务注册与发现中心和配置中心替换为Alibaba Nacos Discovery，无需修改任何业务代码。

SAE服务注册中心具有Spring Cloud Alibaba Nacos Discovery所有功能，SAE服务注册中心可以完全代替ZooKeeper和Redis等，作为您微服务应用的服务注册中心。

将Spring Cloud应用托管到SAE，您仅需关注Spring Cloud应用自身的逻辑，无需再关注注册中心和配置中心搭建和维护，托管后还可以使用SAE提供的弹性伸缩、一键批量启停、应用监控等功能，大幅度降低开发和运维成本。

如果您仍决定使用自建的Nacos作为服务注册中心，请参见如何搭建Nacos为服务注册中心（不推荐）。

步骤一：获取Demo

eureka-service-provider和eureka-service-consumer是SAE提供的微服务Demo应用程序包，二者均为已经接入Eureka的Spring Cloud应用。eureka-service-consumer（本文简称Consumer）消费eureka-service-provider（本文简称Provider）提供的服务。

• eureka-service-provider下载
• eureka-service-consumer下载

步骤二：修改Provider的服务注册与发现配置

将云原生的Provider应用托管到SAE中，需要在Provider应用程序中修改pom依赖，并指定Nacos Server的IP地址。

1. 添加pom依赖。
   打开Provider应用程序的pom.xml 文件，将spring-cloud-starter-netflix-eureka-client替换成为spring-cloud-starter-alibaba-nacos-discovery，并设置Nacos Server的版本信息。

   替换前：

   <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
   </dependency>                            

   替换后：

   <dependency>
       <groupId>com.alibaba.cloud</groupId>
       <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
       <version>2.1.1.RELEASE</version>
   </dependency>                           

   说明

   • 示例中使用的版本为Spring Cloud Greenwich，对应spring-cloud-starter-alibaba-nacos-discovery版本为2.1.1.RELEASE。
   • 如果您使用的是Spring Cloud Finchley版本，对应spring-cloud-starter-alibaba-nacos-discovery版本为2.0.1.RELEASE。
   • 如果使用的是Spring Cloud Edgware版本，对应spring-cloud-starter-alibaba-nacos-discovery版本为1.5.1.RELEASE。
2. 指定Nacos Server的IP地址。
   打开src\main\resources路径下文件application.properties，指定Nacos Server的IP地址。

   修改前：

   spring.application.name=service-provider
   server.port=18081
   eureka.client.serviceUrl.defaultZone=http://127.0.0.1:8761/eureka/                            

   修改后：

   spring.application.name=service-provider
   server.port=18081
   spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848                            

   其中127.0.0.1为Nacos Server的IP地址。如果Nacos Server部署在其他机器上，则需要修改为对应的IP地址。如果有其它需求，可以参考配置项参考在application.properties文件中增加所需配置。

3. 查询应用服务。
   1. 执行nacos-service-provider中ProviderApplication的main函数，以启动应用。
   2. 登录本地启动的Nacos Server控制台http://127.0.0.1:8848/nacos，在左侧导航栏中选择服务管理 > 服务列表。

      如果服务列表中显示service-provider，且在详情中可以查询该服务的详情，那么表示服务注册成功。

      说明 本地Nacos控制台的默认用户名和密码均为nacos。

步骤三： 修改Consumer的服务注册与发现配置

如需将原来的Consumer应用托管到SAE中，则需要在Consumer应用程序中修改pom依赖，并指定Nacos Server的IP地址。

1. 添加pom依赖。

   在Consumer应用的pom.xml文件中，将 spring-cloud-starter-netflix-eureka-server替换成spring-cloud-starter-alibaba-nacos-discovery，并设置Nacos Server的版本。

   替换前：

   <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
   </dependency>                            

   替换后：

   <dependency>
       <groupId>com.alibaba.cloud</groupId>
       <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
       <version>2.1.1.RELEASE</version>
   </dependency>                            

   说明

   • 示例中使用的版本为Spring Cloud Greenwich，对应spring-cloud-starter-alibaba-nacos-discovery版本为2.1.1.RELEASE。
   • 如果您使用的是Spring Cloud Finchley版本，对应spring-cloud-starter-alibaba-nacos-discovery版本为2.0.1.RELEASE。
   • 如果使用的是Spring Cloud Edgware版本，对应spring-cloud-starter-alibaba-nacos-discovery版本为1.5.1.RELEASE。
2. 指定Nacos Server的IP地址。

   打开src\main\resources路径下的文件application.properties，指定Nacos Server的IP地址。

   修改前 ：

   spring.application.name=service-consumer
   server.port=18082
   eureka.client.serviceUrl.defaultZone=http://127.0.0.1:8761/eureka/                            

   修改后：

   spring.application.name=service-consumer
   server.port=18082
   spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848                            

   其中127.0.0.1为Nacos Server的IP地址。如果您的Nacos Server部署在其他服务器，则需要修改为对应的IP地址。如果有其它需求，可以参考配置项参考在application.properties文件中增加配置。

3. 查询应用服务。
   1. 执行eureka-service-provider中ConsumerApplication.java，启动应用。
   2. 登录本地启动的Nacos Server控制台http://127.0.0.1:8848/nacos，在左侧导航栏中选择服务管理 > 服务列表 。

      如果在服务列表中显示service-consumer，且在详情中可以查询该服务的详情，表示服务注册成功。

      说明 本地Nacos控制台的默认用户名和密码均为nacos。

步骤四：查看Provider与Consumer的调用结果

在本地测试消费者对提供者的服务调用结果。启动服务，执行IP+port/echo-rest/{自定义变量}或IP+port/echo-feign/{自定义变量}查看调用结果。

• Linux/Unix/Mac 系统：执行curl http://127.0.0.1:18082/echo-rest/{自定义变量}或curl http://127.0.0.1:18082/echo-feign/{自定义变量}。
• Windows系统：在浏览器中输入http://127.0.0.1:18082/echo-rest/{自定义变量}或http://127.0.0.1:18082/echo-feign/{自定义变量}。

示例：以Windows系统为例。当显示如下结果，表示Provider与Consumer业务调用成功。

步骤五：将应用部署到SAE

1. 在应用的pom.xml文件中添加应用程序的打包配置，添加完成后执行mvn clean package 命令将本地的程序编译成可执行的JAR包。

   <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>                        

2. 将编译好的Provider和Consumer应用包部署至SAE，具体操作请参见部署微服务应用到SAE。
   注意

   • SAE暂不支持创建空应用，因此第一次部署须在控制台完成。
   • 如果使用JAR包部署，在应用部署配置时应用运行环境须选择标准 Java 应用运行环境 。
   • 如果使用WAR包部署，在应用部署配置时应用运行环境须选择apache-tomcat-XXX 。

   当您将应用部署到SAE时，SAE服务注册中心以高优先级自动设置Nacos Server服务端地址和服务端口，以及namespace、access-key、secret-key、context-path等信息，您无需进行任何额外的配置。对于原有的配置内容您可以保留或删除。

   说明

   • 使用自建Nacos时请确保SAE的网络与自建Nacos的网络互通。
   • 使用自建Nacos为服务注册中心，在部署应用时建议使用镜像方式或者JAR包方式，并配置启动参数-Dnacos.use.endpoint.parsing.rule=false和-Dnacos.use.cloud.namespace.parsing=false。
     • 如采用镜像方式，请将-Dnacos.use.endpoint.parsing.rule=false和-Dnacos.use.cloud.namespace.parsing=false配置在镜像文件中。
     • 如果JAR包方式，请在部署时启动命令中设置。

   如果您不熟悉如何制作Docker镜像，具体操作请参见制作应用容器Docker镜像。

步骤六：结果验证

1. 为Consumer应用绑定公网 SLB，并在浏览器键入所设置的公网访问地址，进入应用首页。
2. 在应用首页发起调用请求，然后登录SAE控制台，进入消费者应用详情页面。
3. 在左侧导航栏选择应用监控 > 应用总览，查看服务调用数据总览。
   如果能够监测到调用数据，则说明服务调用成功。

配置项参考

更多关于Spring Cloud Alibaba Nacos Discovery的信息请参见开源版本的 Spring Cloud Alibaba Nacos Discovery 文档。

更多信息

• 在SAE部署完成后，您可以对应用进行更新、扩缩容、启停、删除应用等生命周期管理操作，具体操作方式请参见管理应用生命周期。
• 在SAE部署完成后，您可以对应用进行自动弹性伸缩、SLB绑定和批量启停等提升应用性能的操作，具体操作方式请参见如下文档。
  • 绑定SLB
  • 配置弹性伸缩
  • 一键启停应用
  • 配置管理
  • 变更实例规格
• 在SAE部署完成后，您还可以对应用进行日志管理、监控管理、应用事件查看和变更记录查看等聚焦应用运行状态的操作，具体操作方式请参见如下文档。
  • 日志管理
  • 监控管理
  • 应用事件查看
  • 变更记录查看
  • 使用 Webshell 诊断应用

问题反馈

如果您在使用 SAE 过程中有任何疑问，欢迎您扫描下面的二维码加入钉钉群进行反馈。