本章将通过在 Spring Clound 中集成 Nacos,并且开启服务发现功能,然后使用 Open Feign 实现服务调用。
使用 IDEA 创建一个 Spring Boot 项目(Maven),项目结构如下图:
版本信息:
JDK 1.8 64bit
Nacos 2.2.3
spring-cloud-alibaba-dependencies 2.1.2.RELEASE
spring-cloud-dependencies Greenwich.RELEASE
spring-boot-dependencies 2.1.3.RELEASE
注意:在开始运行项目前,请先启动 Nacos 服务(如何启动 Nacos 请参考 “Nacos 快速开始” 章节)。
在父项目中通过 <dependencyManagement> 管理依赖和版本信息,避免子模块引用的版本不一致。pom.xml 依赖信息:
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>com.hxstrive.nacos</groupId> <artifactId>springcloud_alibaba_nacos</artifactId> <version>1.0-SNAPSHOT</version> </parent> <artifactId>nacos_spring_cloud5</artifactId> <name>nacos_spring_cloud5</name> <packaging>pom</packaging> <!-- 定义两个子模块 --> <modules> <module>service1</module> <module>service2</module> </modules> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencyManagement> <dependencies> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-alibaba-dependencies</artifactId> <version>2.1.2.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-dependencies --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Greenwich.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-dependencies --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>2.1.3.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
直接继承父项目,引入需要用到的 Spring Boot 和 Spring cloud 相关依赖,如下:
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>com.hxstrive.nacos</groupId> <artifactId>nacos_spring_cloud5</artifactId> <version>1.0-SNAPSHOT</version> </parent> <artifactId>service1</artifactId> <name>service1</name> <dependencies> <!-- Spring Boot Begin --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <!-- Spring Boot End --> <!-- Spring Cloud Begin --> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency> <!-- Spring Cloud End --> </dependencies> </project>
server: port: ${port:8081} spring: application: name: service1 cloud: nacos: discovery: # Nacos 服务地址 server-addr: 127.0.0.1:8848 # Nacos 登录用户名 username: nacos # Nacos 登录密码 password: nacos # 默认服务注册到 public 命名空间 # 指定将服务注册到 dev 命名空间 namespace: 8719efd1-94a6-49f7-9846-2debd66f6c0f # 默认集群名称为 DEFAULT,下面将集群名指定为 mycluster cluster-name: mycluster
在启动类上添加 @EnableDiscoveryClient 注解,开启 Nacos 服务发现功能,并且添加 @RestController 创建一个 /get 接口,用来获取一个字符串信息,如下:
package com.hxstrive.nacos; import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; /** * 入口类 * @author hxstrive.com */ @SpringBootApplication // 启用服务发现 @EnableDiscoveryClient @RestController public class BootstrapApp { public static void main(String[] args) { SpringApplication.run(BootstrapApp.class, args); } @Value("${server.port}") private String port; @GetMapping("/get") public String get() { return "service1.BootstrapApp port=" + port; } }
直接继承父项目,引入需要用到的 Spring Boot 和 Spring cloud 相关依赖,如下:
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>com.hxstrive.nacos</groupId> <artifactId>nacos_spring_cloud5</artifactId> <version>1.0-SNAPSHOT</version> </parent> <artifactId>service2</artifactId> <name>service2</name> <dependencies> <!-- Spring Boot Begin --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <!-- Spring Boot End --> <!-- Spring Cloud Begin --> <!-- 引入 Nacos 服务发现 --> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency> <!-- 引入 Feign --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> <!-- Spring Cloud End --> </dependencies> </project>
server: port: 8082 spring: application: name: service2 cloud: nacos: discovery: # Nacos 服务地址 server-addr: 127.0.0.1:8848 # Nacos 登录用户名 username: nacos # Nacos 登录密码 password: nacos # 默认服务注册到 public 命名空间 # 指定将服务注册到 dev 命名空间 namespace: 8719efd1-94a6-49f7-9846-2debd66f6c0f # 默认集群名称为 DEFAULT,下面将集群名指定为 mycluster cluster-name: mycluster
定义一个接口,接口中仅有一个方法 get,该方法用来调用 service1 提供的 /get 接口。接口通过 @FeignClient 注解声明这是一个 OpenFeign 组件,Open Feign 会生成一个代理实现类,帮助我们对 service1 服务的 /get 发起请求,并且封装请求参数和响应参数。如下:
package com.hxstrive.nacos; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.web.bind.annotation.GetMapping; /** * @author hxstrive.com */ @FeignClient("service1") public interface Service1Agent { @GetMapping("/get") public String get(); }
启动类,通过 @EnableFeignClients 注解开启 OpenFeign 功能,通过 @EnableDiscoveryClient 开启 Nacos 服务发现功能,并且开声明该类是一个 Rest 控制器,提供一个简单的 /get 接口,用来调用 service1 服务的 /get 接口。代码如下:
package com.hxstrive.nacos; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; import org.springframework.cloud.openfeign.EnableFeignClients; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; /** * 入口类 * @author hxstrive.com */ @SpringBootApplication @EnableDiscoveryClient @EnableFeignClients @RestController public class BootstrapApp { public static void main(String[] args) { SpringApplication.run(BootstrapApp.class, args); } // 注入 Service1Agent 接口的 OpenFeign 代理实现 @Autowired private Service1Agent service1Agent; @GetMapping("/get") public String get() { // 调用目标服务 return "service2.invoke = " + service1Agent.get(); } }
分别启动 service1 和 service2,启动完成后进入 Nacos 管理页面查看服务情况,如下图:
两个服务都正常启动了。
现在,在浏览器输入 http://localhost:8082/get 地址调用 service2 的 /get 接口,输出如下:
上面输出信息中,“service1.BootstrapApp port=28081” 则来自 service1 服务的返回信息。
此时,可能有读者会有疑问,代码中:
// 注入 Service1Agent 接口的 OpenFeign 代理实现 @Autowired private Service1Agent service1Agent;
service1Agent 变量究竟是一个什么样的对象,打个断点看看就知道了,如下图:
实际上,service1Agent 是一个代理对象,由 OpenFeign 实现,帮助我们发起请求。