Spring Cloud 服务注册之 consul

约定不等于承诺〃 2022-03-02 12:38 253阅读 0赞

### 一、consul安装部署 ###

下载地址：[https://www.consul.io/downloads.html][https_www.consul.io_downloads.html]

1、解压，我这里放在 E:\\dev\\consul-1.4.3目录下

![20190320152252974.png][]

2、配置环境变量

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xEWTEwMTY_size_16_color_FFFFFF_t_70][]

3、执行命令 consul agent -dev 启动consul

![20190320152758285.png][]

4、打开网址：[http://localhost:8500][http_localhost_8500] 查看consul管理界面

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xEWTEwMTY_size_16_color_FFFFFF_t_70 1][]

### 二、spring cloud 服务注册到consul ###

1、新建一个spring cloud项目consul-demo-a，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>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.2.RELEASE</version>
    		<relativePath /> 
    	</parent>
    	<groupId>com.example</groupId>
    	<artifactId>consul-demo-a</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>consul-demo-a</name>
    	<description>Demo project for Spring Boot</description>
    
    	<properties>
    		<java.version>1.8</java.version>
    		<spring-cloud.version>Edgware.SR3</spring-cloud.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-consul-discovery</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-actuator</artifactId>
    			<scope>compile</scope>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</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>
    			</plugin>
    		</plugins>
    	</build>
    
    </project>

2、配置application.properties内容如下

server.port=8082
    spring.application.name=consul-demo-a
    
    spring.cloud.consul.host=localhost
    spring.cloud.consul.port=8500
    spring.cloud.consul.discovery.healthCheckPath=/health
    #健康检查频率，也就是心跳频率
    spring.cloud.consul.discovery.healthCheckInterval=15s
    #注册服务 ID
    spring.cloud.consul.discovery.instance-id=consul-demo-a
    #可通过动态ID将多个相同的服务注册到同一个consul
    #spring.cloud.consul.discovery.instance-id=${spring.application.name}:${spring.cloud.client.ip-address}:${server.port}
    
    #false 暴露端点
    management.security.enabled=false

3、编写入口类

4、编写测试接口

package com.example.consul.controller;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class HelloController {
    	
    	@RequestMapping("/hi")
    	public String hi(@RequestParam String name) {
    		return "hi ," + name;
    	}
    
    }

5、启动项目，到consul管理界面看到服务注册成功

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xEWTEwMTY_size_16_color_FFFFFF_t_70 2][]

注意，使用Dalston版本的时候会出现consul注册失败的情况，我这里使用的是Edgware.SR3

### 三、服务调用 ribbon+restTemplate ###

1、新建一个spring cloud项目consul-demo-b，用来测试调用consul-demo-a，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>
    	<groupId>com.example</groupId>
    	<artifactId>consul-demo-b</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>consul-demo</name>
    	<description>Demo project for Spring Boot</description>
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.2.RELEASE</version>
    		<relativePath /> 
    	</parent>
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    	</properties>
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-consul-discovery</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-actuator</artifactId>
    			<scope>compile</scope>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    	</dependencies>
    	<dependencyManagement>
    		<dependencies>
    			<dependency>
    				<groupId>org.springframework.cloud</groupId>
    				<artifactId>spring-cloud-dependencies</artifactId>
    				<version>Edgware.SR3</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>

2、配置application.properties内容如下

server.port=8083
    spring.application.name=consul-demo-b
    
    spring.cloud.consul.host=localhost
    spring.cloud.consul.port=8500
    spring.cloud.consul.discovery.healthCheckPath=/health
    #健康检查频率，也就是心跳频率
    spring.cloud.consul.discovery.healthCheckInterval=15s
    #注册服务 ID
    spring.cloud.consul.discovery.instance-id=consul-demo-b
    
    #false 暴露端点
    management.security.enabled=false

3、编写入口类

package com.example.consul;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.cloud.client.loadbalancer.LoadBalanced;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.client.RestTemplate;
    
    @SpringBootApplication
    @EnableDiscoveryClient
    public class ConsulDemoApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(ConsulDemoApplication.class, args);
    	}
    	
    	@Bean
    	@LoadBalanced
    	RestTemplate restTemplate() {
    		return new RestTemplate();
    	}
    	
    }

4、编写服务调用测试接口

package com.example.consul.controller;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.client.RestTemplate;
    
    @RestController
    public class HelloController {
    	
    	@Autowired
    	private RestTemplate restTemplate;
    	
    	@RequestMapping("/hi")
    	public String hi(@RequestParam String name) {
    		return restTemplate.getForObject("http://consul-demo-a/hi?name="+name, String.class);
    	}
    
    }

5、启动项目，到consul管理界面看到服务注册成功

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xEWTEwMTY_size_16_color_FFFFFF_t_70 3][]

6、输入[http://127.0.0.1:8083/hi?name=ldy][http_127.0.0.1_8083_hi_name_ldy] 查看服务调用结果

![2019032015561939.png][]

**踩坑：动态指定注册的id，可解决同一服务部署多个时的注册问题**

#注册服务 ID
    spring.cloud.consul.discovery.instance-id=${spring.application.name}:${spring.cloud.client.ip-address}:${server.port}

[https_www.consul.io_downloads.html]: https://www.consul.io/downloads.html
[20190320152252974.png]: /images/20220302/30a5029f20eb43f49336498512c45230.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xEWTEwMTY_size_16_color_FFFFFF_t_70]: /images/20220302/a888ff6be5d44d71949aff56b7ca1d31.png
[20190320152758285.png]: /images/20220302/e7517402c04848928919655307db96c7.png
[http_localhost_8500]: http://localhost:8500
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xEWTEwMTY_size_16_color_FFFFFF_t_70 1]: /images/20220302/b40ac8de739b43cb8716221d8bbdc98b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xEWTEwMTY_size_16_color_FFFFFF_t_70 2]: /images/20220302/c168578c061e41368362cbdbea341205.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xEWTEwMTY_size_16_color_FFFFFF_t_70 3]: /images/20220302/a666afa9f1494a3aa8c6811a0bc56640.png
[http_127.0.0.1_8083_hi_name_ldy]: http://127.0.0.1:8083/hi?name=ldy
[2019032015561939.png]: /images/20220302/1395d51fae5d43948abbd0fdc8c6e4f8.png