SpringCloud技术指南系列（四）服务注册发现之Consul服务注册

蔚落 2021-11-11 16:50 459阅读 0赞

## SpringCloud技术指南系列（四）服务注册发现之Consul服务注册 ##

SpringCloud所谓的服务注册与发现，流程大致是：

*  将Springboot微服务客户端项目的地址等信息，通过网络发送到注册中心，由注册中心保存下来。
 *  另一个客户端B访问已经注册到注册中心的服务A，通过注册中心提供的域名解析方式，解析出服务A的地址等信息。
 *  如果提供服务A的客户端有多个，就按照某个策略（比如轮询、负载均衡等）选取一个地址返回。
 *  客户端B访问注册中心返回的地址，获取结果，这里注意，是B直接访问A，而不是注册中心转发，因此要保证B和A是互通的。

目前服务发现的解决方案有Eureka，Consul，Zookeeper等，这三个是SpringCloud官方支持的。

前几篇已经讲了如何搭建Eureka的服务注册发现，本篇讲下Consul的服务注册如何实现，下一篇介绍下consul的服务如何调用。

代码可以在SpringBoot组件化构建[https://www.pomit.cn/java/spring/springcloud.html][https_www.pomit.cn_java_spring_springcloud.html]中的ConsulServer组件中查看，并下载。

首发地址：

[品茗IT-同步发布][IT-]

品茗IT提供在线支持：

[一键快速构建Spring项目工具][Spring]

[一键快速构建SpringBoot项目工具][SpringBoot]

[一键快速构建SpringCloud项目工具][https_www.pomit.cn_java_spring_springcloud.html]

[一站式Springboot项目生成][Springboot]

[Mysql一键生成Mybatis注解Mapper][Mysql_Mybatis_Mapper]

[Mysql一键生成SpringDataRest项目][Mysql_SpringDataRest]

**如果大家正在寻找一个java的学习环境，或者在开发中遇到困难，可以[加入我们的java学习圈，点击即可加入][java]，共同学习，节约学习时间，减少很多在学习中遇到的难题。**

#### 一、Consul注册中心 ####

首先，到[Consul官网][Consul]下载Consul注册中心：[https://www.consul.io/downloads.html][https_www.consul.io_downloads.html];

Consul官网给出了一个consul的界面示例：[https://demo.consul.io/ui/][https_demo.consul.io_ui]

下载完成后，无需安装，直接启动即可：

dev模式启动（普通开发使用，不带记忆功能）：`./consul agent -dev`

线上环境启动（因App而异）：`./consul agent -server -bootstrap-expect 1 -data-dir=/usr/local/consul/data -bind=10.247.62.76 -client=0.0.0.0 -ui`

*  server agent模式是server,agent可以运行为server或client模式。client是一个非常轻量级的进程.用于注册服务,运行健康检查和转发对server的查询.
 *  bootstrap-expect 表示单节点启动
 *  data-dir 数据存放位置
 *  bind 绑定的地址
 *  client 允许的客户端ip
 *  ui 带界面

启动之后，就可以用来做服务发现注册了。consul只是用来存储服务的实时信息与地址的。

### 二、引入依赖 ###

需要引入spring-boot-starter-web和spring-cloud-starter-consul-discovery。

依赖如下：

<?xml version="1.0"?>
    <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    	<modelVersion>4.0.0</modelVersion>
    	<parent>
    		<groupId>cn.pomit</groupId>
    		<artifactId>springcloudwork</artifactId>
    		<version>0.0.1-SNAPSHOT</version>
    	</parent>
    	<artifactId>ConsulServer</artifactId>
    	<name>ConsulServer</name>
    	<url>http://maven.apache.org</url>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    		<maven-jar-plugin.version>2.6</maven-jar-plugin.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>
    	</dependencies>
    </project>

父模块pom文件可以在[https://www.pomit.cn/spring/SpringCloudWork/pom.xml][https_www.pomit.cn_spring_SpringCloudWork_pom.xml]获取。

### 三、配置Consul服务注册 ###

这里使用yaml文件写配置，application.yml：

server:
       port: 8811
    spring:
       application:
          name: consulServer
       cloud:
          consul:
             host: 127.0.0.1
             port: 8500
             discovery:
                prefer-ip-address: true
                healthCheckPath: /consul/health

这里面，包含了端口、应用名、consul注册中心信息、注册方式、健康检查路径。

spring.application.name是标识了应用名，注册到consul之后，显示的就是它。

spring.cloud.consul.discovery.prefer-ip-address是使用ip地址，如果不写它，默认是域名，那样测试起来很麻烦。

spring.cloud.consul.discovery.healthCheckPath这个，consul做健康检查的路径。

spring.cloud.consul.port consul的端口。8500 端口基于 HTTP 协议，用于 API 接口或 WEB UI 访问。

### 四、启动服务注册 ###

#### 3.1 启动类 ####

使用@EnableDiscoveryClient注解启动类, @EnableDiscoveryClient是将项目作为客户端注册到注册中心的注解，开启服务发现功能。

ConsulServerApplication：

package cn.pomit.springbootwork.consulserver;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    
    @EnableDiscoveryClient
    @SpringBootApplication
    public class ConsulServerApplication { 
    	public static void main(String[] args) { 
    		SpringApplication.run(ConsulServerApplication.class, args);
    	}
    }

#### 3.2 开放服务 ####

下面提供了个web接口做服务，访问http://127.0.0.1:8858/consulApi/ip ，可以获取当前请求ip和服务器ip地址。由于我们已经使用了consul，其他应用已经可以通过服务名找到本应用，并通过服务发现访问http://consulServer/consulApi/ip 来访问改接口（注意，普通http请求这样写是访问不到的，只有通过服务注册发现调用，走consul的域名服务才能这样访问）。

ConsulServerRest ：

package cn.pomit.springbootwork.consulserver.web;
    
    import javax.servlet.http.HttpServletRequest;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    import cn.pomit.springbootwork.consulserver.model.IpModel;
    import cn.pomit.springbootwork.consulserver.model.ResultModel;
    import cn.pomit.springbootwork.consulserver.util.IPUtil;
    
    @RestController
    @RequestMapping("/consulApi")
    public class ConsulServerRest { 
    
    	@RequestMapping(value = "/ip", method = {  RequestMethod.GET })
    	public ResultModel welCome(HttpServletRequest request) { 
    		IpModel ipModel = new IpModel();
    		ipModel.setClientIpAddress(IPUtil.getIpAddr(request));
    		ipModel.setServerIpAddress(IPUtil.localIp());
    		return ResultModel.ok(ipModel);
    	}
    }

#### 3.3 健康检查 ####

前面写了我们健康检查地址是/consul/health，这里要开放个接口，让consul来检查身体。

package cn.pomit.springbootwork.consulserver.web;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/consul")
    public class HealthWeb { 
    
    	@RequestMapping(value = "health", method = {  RequestMethod.GET })
    	public String health() { 
    		return "check health";
    	}
    	
    }

### 五、过程中用到的工具类和实体 ###

过程中用到了ResultModel实体和ResultCode枚举类，如果作为测试来用，其实没必要，这里是为后续章节做铺垫，将实体统一化，所以才多出了ResultModel实体和ResultCode枚举类。

IPUtil:

package cn.pomit.springbootwork.consulserver.util;
    
    import java.net.InetAddress;
    import java.net.UnknownHostException;
    
    import javax.servlet.http.HttpServletRequest;
    
    public class IPUtil { 
    	/** * @Description: 获取客户端IP地址 */
    	public static String getIpAddr(HttpServletRequest request) { 
    		String ip = request.getHeader("x-forwarded-for");
    		if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { 
    			ip = request.getHeader("Proxy-Client-IP");
    		}
    		if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { 
    			ip = request.getHeader("WL-Proxy-Client-IP");
    		}
    		if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { 
    			ip = request.getRemoteAddr();
    			if (ip.equals("127.0.0.1")) { 
    				// 根据网卡取本机配置的IP
    				InetAddress inet = null;
    				try { 
    					inet = InetAddress.getLocalHost();
    				} catch (Exception e) { 
    					e.printStackTrace();
    				}
    				ip = inet.getHostAddress();
    			}
    		}
    		// 多个代理的情况，第一个IP为客户端真实IP,多个IP按照','分割
    		if (ip != null && ip.length() > 15) { 
    			if (ip.indexOf(",") > 0) { 
    				ip = ip.substring(0, ip.indexOf(","));
    			}
    		}
    		return ip;
    	}
    
    	/** * 获取的是本地的IP地址 * * @return */
    	public static String localIp() { 
    		String result = "";
    		try { 
    			InetAddress address = InetAddress.getLocalHost();
    			result = address.getHostAddress();
    		} catch (UnknownHostException e) { 
    			e.printStackTrace();
    		}
    		return result;
    	}
    }

IpModel :

package cn.pomit.springbootwork.consulserver.model;
    
    public class IpModel { 
    	private String clientIpAddress;
    	private String serverIpAddress;
    
    	public String getClientIpAddress() { 
    		return clientIpAddress;
    	}
    
    	public void setClientIpAddress(String clientIpAddress) { 
    		this.clientIpAddress = clientIpAddress;
    	}
    
    	public String getServerIpAddress() { 
    		return serverIpAddress;
    	}
    
    	public void setServerIpAddress(String serverIpAddress) { 
    		this.serverIpAddress = serverIpAddress;
    	}
    
    }

ResultModel:

package cn.pomit.springbootwork.consulserver.model;
    
    /** * @author cff */
    public class ResultModel { 
    
    	private String errorCode;
    	private String message;
    	private Object data;
    
    	public ResultModel() { 
    
    	}
    
    	public ResultModel(String errorCode, String message) { 
    		this.errorCode = errorCode;
    		this.message = message;
    	}
    
    	public ResultModel(String errorCode, String message, Object data) { 
    		this.errorCode = errorCode;
    		this.message = message;
    		this.data = data;
    	}
    
    	public ResultModel(ResultCode resultCodeEnum, Object data) { 
    		this.errorCode = resultCodeEnum.getCode();
    		this.message = resultCodeEnum.getDesc();
    		this.data = data;
    	}
    
    	public ResultModel(ResultCode resultCodeEnum) { 
    		this.errorCode = resultCodeEnum.getCode();
    		this.message = resultCodeEnum.getDesc();
    	}
    
    	public String geterrorCode() { 
    		return errorCode;
    	}
    
    	public void seterrorCode(String errorCode) { 
    		this.errorCode = errorCode;
    	}
    
    	public String getMessage() { 
    		return message;
    	}
    
    	public void setMessage(String message) { 
    		this.message = message;
    	}
    
    	public Object getData() { 
    		return data;
    	}
    
    	public void setData(Object data) { 
    		this.data = data;
    	}
    
    	public static ResultModel ok() { 
    		return new ResultModel(ResultCode.CODE_00000);
    	}
    
    	public static ResultModel ok(Object data) { 
    		return new ResultModel(ResultCode.CODE_00000, data);
    	}
    
    	public static ResultModel error() { 
    		return new ResultModel(ResultCode.CODE_00001);
    	}
    
    	public static ResultModel error(String msg) { 
    		return new ResultModel(ResultCode.CODE_00001.getCode(), msg);
    	}
    
    	public static ResultModel error(String msg, Object data) { 
    		return new ResultModel(ResultCode.CODE_00001.getCode(), msg, data);
    	}
    
    	public static ResultModel unAuth() { 
    		return new ResultModel(ResultCode.CODE_40004);
    	}
    }

ResultCode:

package cn.pomit.springbootwork.consulserver.model;
    
    /** * 响应码及其描述 Created by txl on 15/7/9. */
    public enum ResultCode { 
    
    	/** * 通用 */
    	CODE_00000("00000", "操作成功"), CODE_00001("00001", "请求失败"), CODE_00002("00002", "错误的请求方法"), CODE_00003("00003", "非法的参数字段"), CODE_00004("00004", "异常抛出"), CODE_00005("00005", "权限不足"), CODE_00006("00006", "分页limit参数错误"), CODE_00007("00007", "分页offset参数错误"), CODE_00009("00009", "请求过于频繁"), CODE_00010("00010", "数据已存在"), CODE_00011("00011", "数据不存在"), CODE_00012("00012", "参数缺失"), CODE_00013("00013", "系统维护中"), CODE_00014("00014", "token缺失"), CODE_00015("00015", "token失效"), CODE_00016("00016", "签名错误"),
    
    	CODE_10000("10000", "操作部分成功"),
    	/** * 系统 */
    	CODE_30000("30000", "系统ID错误"),
    
    	/** * 授权 */
    	CODE_40001("40001", "用户未找到"), CODE_40002("40002", "该用户状态异常"), CODE_40003("40003", "该用户已被删除"), CODE_40004("40004", "授权异常"),
    
    	CODE_99999("99999", "签名无效");
    
    	private String code;
    	private String desc;
    
    	ResultCode(String code, String desc) { 
    		this.code = code;
    		this.desc = desc;
    	}
    
    	public String getCode() { 
    		return code;
    	}
    
    	public String getDesc() { 
    		return desc;
    	}
    
    	/** * 根据code匹配枚举 * * @param code * @return */
    	public static ResultCode getResultCodeByCode(String code) { 
    		for (ResultCode resultCode : ResultCode.values()) { 
    			if (code.equals(resultCode.getCode())) { 
    				return resultCode;
    			}
    		}
    		return null;
    	}
    
    	public static ResultCode getResultCodeByDesc(String desc) { 
    		for (ResultCode resultCode : ResultCode.values()) { 
    			if (desc.equals(resultCode.getDesc())) { 
    				return resultCode;
    			}
    		}
    		return null;
    	}
    }

### 快速构建项目 ###

[Spring组件化构建][Spring]

[SpringBoot组件化构建][SpringBoot]

[SpringCloud服务化构建][https_www.pomit.cn_java_spring_springcloud.html]

喜欢这篇文章么，喜欢就加入我们一起讨论SpringBoot使用吧！  
![品茗IT交流群][IT]

[https_www.pomit.cn_java_spring_springcloud.html]: https://www.pomit.cn/java/spring/springcloud.html
[IT-]: https://www.pomit.cn/p/2058409372387841
[Spring]: https://www.pomit.cn/java/spring/spring.html
[SpringBoot]: https://www.pomit.cn/java/spring/springboot.html
[Springboot]: https://www.pomit.cn/java/project/sqlToSpringboot.html
[Mysql_Mybatis_Mapper]: https://www.pomit.cn/java/project/sqlToMybatis.html
[Mysql_SpringDataRest]: https://www.pomit.cn/java/project/sqlToSpringDataRest.html
[java]: https://jq.qq.com/?_wv=1027&k=52sgH1J
[Consul]: https://www.consul.io/
[https_www.consul.io_downloads.html]: https://www.consul.io/downloads.html
[https_demo.consul.io_ui]: https://demo.consul.io/ui/
[https_www.pomit.cn_spring_SpringCloudWork_pom.xml]: https://www.pomit.cn/spring/SpringCloudWork/pom.xml
[IT]: /images/20211109/0478f6d7be3945c3a4ef4f3d79ac7239.png