Spring Cloud 微服务应用开发

    准备工作

    • 下载 Maven 并设置环境变量
    • 下载最新版本的 。
    • 按以下步骤启动 Nacos Server。
      1. 解压下载的 Nacos Server 压缩包
      2. 进入 nacos/bin 目录,启动 Nacos Server。

    :::tip Linux/Unix/Mac 系统:sh startup.sh -m standalone

    Windows 系统:双击运行 startup.cmd :::

    创建服务提供者

    在本地创建服务提供者应用工程,添加依赖,开启服务注册与发现功能,并将注册中心指定为 Nacos Server。

    1. 创建命名为 nacos-service-provider 的 Maven 工程。
    2. 在 pom.xml 文件中添加依赖,以 Spring Boot 2.1.4.RELEASE 和 Spring Cloud Greenwich.SR1 为例:

    示例中使用的版本为 Spring Cloud Greenwich ,对应 Spring Cloud Alibaba 版本为 2.1.1.RELEASE。如果使用 Spring Cloud Finchley 版本,对应 Spring Cloud Alibaba 版本为 2.0.1.RELEASE。如果使用 Spring Cloud Edgware 版本,对应 Spring Cloud Alibaba 版本为 1.5.1.RELEASE。

    :::tip 注意:Spring Cloud Edgware 版本的生命周期已结束,不推荐使用这个版本开发应用 :::

    1. 在 src/main/java 下创建 package: io.terminus.erda.trial.demo.hellospringcloud
    1. import org.springframework.boot.SpringApplication;
    2. import org.springframework.boot.autoconfigure.SpringBootApplication;
    3. import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    4. /**
    5. * @author erda
    6. */
    7. @SpringBootApplication
    8. @EnableDiscoveryClient
    9. public class ProviderApplication {
    10. public static void main(String[] args) {
    11. SpringApplication.run(ProviderApplication.class, args);
    12. }
    13. }

    在 package: io.terminus.erda.trial.demo.hellospringcloud 中创建 EchoController,指定 URL mapping 为 {/echo/{String}},指定 HTTP 方法为 GET,方法参数从 URL 路径中获得,回显收到的参数。

    1. package io.terminus.erda.trial.demo.hellospringcloud;
    2. import org.springframework.web.bind.annotation.PathVariable;
    3. import org.springframework.web.bind.annotation.RequestMapping;
    4. import org.springframework.web.bind.annotation.RequestMethod;
    5. import org.springframework.web.bind.annotation.RestController;
    6. /**
    7. * @author erda
    8. */
    9. @RestController
    10. public class EchoController {
    11. @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
    12. public String echo(@PathVariable String string) {
    13. return string;
    14. }
    15. }
    1. 在 src/main/resources 路径下创建文件 application.yml ,在 application.yml 中添加如下配置,指定 Nacos Server 的地址。

    :::tip 其中 127.0.0.1 为 Nacos Server 的地址。如果 Nacos Server 部署在另外一台机器,则需要修改成对应的 IP 地址。 :::

    1. spring:
    2. application.name: service-provider
    3. cloud:
    4. nacos:
    5. discovery:
    6. namespace: ${NACOS_TENANT_ID:}
    1. 验证结果。
      1. 执行 nacos-service-provider 中 ProviderApplication 的 main 函数,启动应用。
      2. 登录本地启动的 Nacos Server 控制台 (本地 Nacos 控制台的默认用户名和密码同为 nacos)。
      3. 在左侧导航栏中选择服务管理 > 服务列表。可以看到服务列表中已经包含了 service-provider ,且在详情中可以查询该服务的详情。

    创建服务消费者

    本内容除介绍服务注册的功能,还将介绍 Nacos 服务发现与 RestTemplate 和 FeignClient 两个客户端如何配合使用。

    1. 创建命名为 nacos-service-consumer 的 Maven 工程。
    2. 在 pom.xml 中添加依赖。
    1. 在 src/main/java 下创建 package: io.terminus.erda.trial.demo.hellospringcloud
    2. 在 package: io.terminus.erda.trial.demo.hellospringcloud 中配置 RestTemplate 和 FeignClient。

    在 package: io.terminus.erda.trial.demo.hellospringcloud 中创建一个接口类 EchoService ,添加 @FeignClient 注解,并配置对应的 HTTP URL 地址及 HTTP 方法。

    1. package io.terminus.erda.trial.demo.hellospringcloud;
    2. import org.springframework.cloud.openfeign.FeignClient;
    3. import org.springframework.web.bind.annotation.RequestMapping;
    4. import org.springframework.web.bind.annotation.RequestMethod;
    5. /**
    6. * @author erda
    7. */
    8. @FeignClient(name = "service-provider")
    9. public interface EchoService {
    10. @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
    11. String echo(@PathVariable("str") String str);
    12. }

    在 package: io.terminus.erda.trial.demo.hellospringcloud 中创建启动类 ConsumerApplication 并添加相关配置。使用 @EnableDiscoveryClient 注解启用服务注册与发现;使用 @EnableFeignClients 注解激活 FeignClient;添加 @LoadBalanced 注解将 RestTemplate 与服务发现集成。

    1. package io.terminus.erda.trial.demo.hellospringcloud;
    2. import org.springframework.boot.SpringApplication;
    3. import org.springframework.boot.autoconfigure.SpringBootApplication;
    4. import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    5. import org.springframework.cloud.client.loadbalancer.LoadBalanced;
    6. import org.springframework.cloud.openfeign.EnableFeignClients;
    7. import org.springframework.context.annotation.Bean;
    8. import org.springframework.web.client.RestTemplate;
    9. /**
    10. * @author erda
    11. */
    12. @SpringBootApplication
    13. @EnableDiscoveryClient
    14. @EnableFeignClients
    15. public class ConsumerApplication {
    16. @LoadBalanced
    17. @Bean
    18. public RestTemplate restTemplate() {
    19. return new RestTemplate();
    20. }
    21. public static void main(String[] args) {
    22. SpringApplication.run(ConsumerApplication.class, args);
    23. }
    24. }
    1. 在 package: io.terminus.erda.trial.demo.hellospringcloud 中创建类 TestController 以演示和验证服务发现功能。
    1. package io.terminus.erda.trial.demo.hellospringcloud;
    2. import org.springframework.beans.factory.annotation.Autowired;
    3. import org.springframework.web.bind.annotation.PathVariable;
    4. import org.springframework.web.bind.annotation.RequestMethod;
    5. import org.springframework.web.bind.annotation.RestController;
    6. import org.springframework.web.client.RestTemplate;
    7. /**
    8. * @author edas
    9. */
    10. @RestController
    11. public class TestController {
    12. @Autowired
    13. private RestTemplate restTemplate;
    14. @Autowired
    15. private EchoService echoService;
    16. @RequestMapping(value = "/echo-rest/{str}", method = RequestMethod.GET)
    17. public String rest(@PathVariable String str) {
    18. return restTemplate.getForObject("http://service-provider/echo/" + str,
    19. String.class);
    20. }
    21. @RequestMapping(value = "/echo-feign/{str}", method = RequestMethod.GET)
    22. public String feign(@PathVariable String str) {
    23. return echoService.echo(str);
    24. }
    25. }
    1. 在 src/main/resources 路径下创建文件 application.yml ,在 application.yml 中添加如下配置,指定 Nacos Server 的地址。
    1. 验证结果。
      1. 执行 nacos-service-consumer 中 ConsumerApplication 的 main 函数,启动应用。
      2. 登录本地启动的 Nacos Server 控制台 Nacos 控制台的默认用户名和密码同为 nacos)。
      3. 在左侧导航栏中选择服务管理 -> 服务列表,可以看到服务列表中已经包含了 service-consumer,且在详情中可以查询该服务的详情。

    本地测试

    在本地测试消费者对提供者的服务调用结果。

    • Linux/Unix/Mac 系统,运行以下命令
    1. curl http://127.0.0.1:18082/echo-rest/rest-rest
    2. curl http://127.0.0.1:18082/echo-feign/feign-rest

    将应用部署到 Erda

    要将应用部署到 Erda,注意如下配置中的环境变量会被自动注入

    1. spring:
    2. application.name: service-provider
    3. cloud:
    4. nacos:
    5. discovery:
    6. server-addr: ${NACOS_ADDRESS:127.0.0.1:8848}
    7. namespace: ${NACOS_TENANT_ID:}
    1. spring:
    2. application.name: service-consumer
    3. cloud:
    4. nacos:
    5. discovery:
    6. server-addr: ${NACOS_ADDRESS:127.0.0.1:8848}
    7. namespace: ${NACOS_TENANT_ID:}

    修改 dice.yml,添加注册中心 v2.0 的依赖:

    服务部署成功后,Erda 会自动注入两个环境变量:

    • NACOS_ADDRESS

    点击注册中心,可以看到注册上来的服务