Consul 的基础知识
Consul 是什么
Consul 是 HashiCorp 公司推出的开源工具，用于实现分布式系统的服务发现与配置。与其他分布式服务注册与发现的方案，Consul的方案更“一站式” ，内置了服务注册与发现框 架, 不再需要依赖其他工具（比如ZooKeeper等）。
以下是consul的特性:
- 分布一致性协议实现、
- 健康检查、
- Key/Value存储、
- 多数据中心方案
使用起来很简单。Consul使用Go语言编写，因此具有天然可移植性(支持Linux、windows和Mac OS X)；安装包仅包含一个可执行文件，方便部署，与Docker等轻量级容器可无缝配合 。 基于 Mozilla Public License 2.0 的协议进行开源. Consul 支持健康检查,并允许 HTTP 和 DNS 协议调用 API 存储键值对. 一致性协议采用 Raft 算法,用来保证服务的高可用. 使用 GOSSIP 协议管理成员和广播消息, 并且支持 ACL 访问控制. 简单来说, 就是易用又强大.
下载地址: https://www.consul.io/downloads
开发模式启动
如果用开发模式启动, 数据和状态并不会持久化到磁盘.
./consul agent -dev
服务器模式启动
如果用服务模式启动, 那么状态会保存到磁盘.
consul agent -server -bootstrap-expect=1 -data-dir=/tmp/consul -node=server-001 -client 0.0.0.0 -ui
这行命令的参数解释如下:
- -bootstrap-expect : 启动节点. 官方建议3-5个. 这是个demo程序, 所以设定为1个.
- -data-dir : 指定数据保存到哪个目录.
- -node: 指定节点的名称
- -ui: 使用这个参数之后, 就可以通过web方式来访问Consul
- -client: 指定客户端的ip地址
现在, 用 localhost:8500 访问Consul, 就可以看到如下界面:
image.png
新建工程并注册服务
这一节我们新建两个服务, 并且注册到 Consul里. 来实际体验下Consul 的用法.
git 源码在: https://gitee.com/xiaofeipapa/spring-cloud-demo
目录为 SpringCloudDemo/consul-demo . 你可以用idea 打开直接运行查看例子.
项目的结构如下图:
image.png
parent工程的pom配置
主要是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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<packaging>pom</packaging>
<modules>
<module>userApi</module>
<module>orderApi</module>
</modules>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.9.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>org.xiaofeipapa.feimall</groupId>
<artifactId>mall-parent</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>mall-parent</name>
<description>A mall distributed application</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Hoxton.SR10</spring-cloud.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-consul-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-consul-discovery</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>
orderApi的配置
项目结构如下图:
image.png
SpringBoot 启动类
package org.xiaofeipapa.scdemo.orderApi;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
@SpringBootApplication
@EnableDiscoveryClient
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class OrderApiApplication {
public static void main( String[] args )
{
SpringApplication.run(OrderApiApplication.class, args);
}
}
启动类比常规SpringBoot特殊的地方, 在于需要加入 @EnableDiscoveryClient , 表示主动将自己加入到 Consul
主配置类
spring:
application:
name: order-api
cloud:
consul:
host: localhost
port: 8500
discovery:
enabled: true
##配置开启服务注册到Consul上
register: true
##配置注册到Consul的服务实例名称(Consul里Feign是通过此名称调用，而非spring.application.name)
service-name: ${spring.application.name}
##配置服务健康检查地址，供Consul调用
healthCheckPath: /health
##Consul 健康检查频率
healthCheckInterval: 15s
instanceId: ${spring.application.name}:${server.port}
配置很简单明了, 不再赘述.
健康检查类
package org.xiaofeipapa.scdemo.orderApi.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
*/
@RestController
public class OrderApiHealthController {
//RequestMapping中的url地址需和配置文件中保持一致
@RequestMapping("/health")
public String healthCheck() {
return "ok";
}
}
当你的组件注册到Consul 之后, 它怎么判断你还"活着"呢? 就是通过不断的轮询来判断. 所以要增加这么一个controller.
接口类
这里简单写了接口, 能够返回信息即可.
package org.xiaofeipapa.scdemo.orderApi.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
/**
*/
@RestController
public class OrderApiController {
@Value("${server.port}")
private String serverPort;
@RequestMapping(value="/hello", method = RequestMethod.GET)
private String hello(){
return "我是 order service, 端口为： " + serverPort;
}
}
用idea 启动第一个实例
现在用idea 运行 OrderApiApplication , 再打开 localhost:8500, 可以看到:
image.png
在Nodes 板块可以看到:
image.png
点击 server-001, 可以看到:
image.png
就这样, 第一个微服务类已经注册成功
用命令行启动第二个实例
现在来到 orderApi的根目录, 打开命令行. 运行如下命令:
# 请记得将maven/bin配置到环境路径
mvn package
java -jar -Dspring.profiles.active=inst2 target/orderApi-0.0.1-SNAPSHOT.jar
再次查看 server-001 下的组件, 你会发现多了个新的服务:
image.png
userApi的代码类似
不再赘述
测试
现在, 分别在浏览器输入:
http://localhost:11000/hello
http://localhost:11003/hello
你都能看到类似的返回:
image.png
那么, 如何通过一个地址来调用服务, 而不用管它实际的ip/端口 ? 这就要用到 Spring Cloud Gateway 了. 下一章再说.
