Spring Cloud 基于Consul 实现服务注册与发现

Spring Cloud自己体系中的注册中心为Eureka,同时也支持其它服务来进行服务注册与发现。本文介绍使用Consul来实现服务注册与发现,并整合进Spring Cloud项目中进行使用。

本文项目依赖环境版本为:

  • Consul → 1.5.0
  • Spring Cloud → Edgware.SR5
  • Spring Boot → 1.5.21
  • 操作系统 → Win10 (PowerShell)

启动Consul服务

首先启动Consul服务,使用以下命令:

1
.\consul.exe agent -server -ui -bootstrap -client 0.0.0.0 -data-dir="d:\consul\data" -bind 127.0.0.1

也可以使用开发模式(更加简单,自动开启UI服务,但是不能保存数据状态)

1
.\consul.exe agent -dev

服务启动成功后访问地址:http://localhost:8500 ,看到如下界面说明服务启动成功

创建Consumer项目

新建Spring Boot项目,指定名称为:leon-consumer,在依赖中选择Web、Consul Discovery,版本选择为1.5.21

修改配置文件application.yml,指定服务端口、名称、Consul服务地址

1
2
3
4
5
6
7
8
9
server:
port: 8081
spring:
application:
name: leon-consumer
cloud:
consul:
host: localhost
port: 8500

启动程序,查看Consul web界面:

此时可以看到服务已经注册到Consul上,但是发现后红色X提醒,点击进入可查看详细提示信息:

可以看到错误提示是健康检查方面的提示,这是因为Consul进行健康检查需要依赖 Actuator 模块,在pom.xml中添加依赖

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

然后重启程序,刷新浏览器再次观察,此时发现就已经全是正常状态



点击后可以看到当前服务的具体的名称、IP、端口等信息。

创建Provider程序

新建Spring Boot项目,指定名称为:leon-provider-1,在依赖中选择Web、Consul Discovery,版本选择为1.5.21
修改配置文件application.yml,指定服务端口、名称、Consul服务地址

1
2
3
4
5
6
7
8
9
server:
port: 8082
spring:
application:
name: leon-provider
cloud:
consul:
host: localhost
port: 8500

添加监控依赖:

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

创建LoginService类,提供login方法供Consumer端调用

1
2
3
4
5
6
7
8
9
10
11
@RestController
public class LoginService {
@RequestMapping("/login")
public String login(@RequestParam("userName") String userName, @RequestParam("passWord") String passWord) {
if (userName.equals("leon") && passWord.equals("888")) {
return "login success";
}
return "login fail";
}
}

改造Consumer服务

为leon-consumer添加Feign相关依赖,然后调用Provider提供的接口
在leon-consumer项目的pom.xml中添加依赖:

1
2
3
4
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-feign</artifactId>
</dependency>

创建一个接口:UserFeignClient,在里面定义好需要调用的接口方法(和Provider提供的方法一致),同时添加@FeignClient注解,并通过name指定需要调用的服务名称:

1
2
3
4
5
@FeignClient(name = "leon-provider")
public interface UserFeignClient {
@RequestMapping(value = "/login", method = RequestMethod.GET)
public String login(@RequestParam("userName") String userName, @RequestParam("passWord") String passWord);
}

创建Controller类调用Provider服务方法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@RestController
public class UserController {
@Autowired
private UserFeignClient userFeignClient;
/**
* 用户账号名和密码登录
*
* @param userName
* @param passWord
* @return
*/
@RequestMapping("/login")
public String login(@RequestParam("userName") String userName, @RequestParam("passWord") String passWord) {
return userFeignClient.login(userName, passWord);
}
}

在启动类上添加注解:@EnableFeignClients

1
2
3
4
5
6
7
@SpringBootApplication
@EnableFeignClients
public class LeonConsumerApplication {
public static void main(String[] args) {
SpringApplication.run(LeonConsumerApplication.class, args);
}
}

运行测试

分别运行leon-provider、leon-consumer,然后访问leon-consumer提供的login方法,分别传入正确、错误参数查看效果:

说明服务已经能够通过注册中心找到对应的服务调用。

服务集群

复制leon-provider-1项目为leon-provider-2,然后打开项目,更改项目端口为8083

1
2
3
4
5
6
7
8
9
server:
port: 8083
spring:
application:
name: leon-provider
cloud:
consul:
host: localhost
port: 8500

修改leon-provider-1、leon-provider-2的方法,添加识别信息:

1
2
3
4
5
6
7
@RequestMapping("/login")
public String login(@RequestParam("userName") String userName, @RequestParam("passWord") String passWord) {
if (userName.equals("leon") && passWord.equals("888")) {
return "leon-provider-1: login success";
}
return "leon-provider-1: login fail";
}
1
2
3
4
5
6
7
@RequestMapping("/login")
public String login(@RequestParam("userName") String userName, @RequestParam("passWord") String passWord) {
if (userName.equals("leon") && passWord.equals("888")) {
return "leon-provider-2: login success";
}
return "leon-provider-2: login fail";
}

分别重启服务,可以看到新增了同名的服务

然后刷新调用登录方法,可以看到会按照Spring Cloud体系中Ribbon的默认负载均衡策略轮询调用不同的服务。

其它配置

服务检测间隔

1
2
3
4
5
6
cloud:
consul:
host: localhost
port: 8500
discovery:
health-check-interval: 3s //3秒后如果服务停掉,检测界面会立即更新为非正常状态
打赏一个煎饼果子!