SpringCloud技术指南系列（三）服务注册发现之Eureka服务调用

绝地灬酷狼 2021-11-13 21:12 331阅读 0赞

## SpringCloud技术指南系列（三）服务注册发现之Eureka服务调用 ##

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

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

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

前面已经讲了如何搭建Eureka的注册中心和服务注册，本篇讲下Eureka的服务发现，使用两种方式进行服务发现。

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

首发地址：

[品茗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]，共同学习，节约学习时间，减少很多在学习中遇到的难题。**

#### 一、引入依赖 ####

需要引入spring-boot-starter-web和spring-cloud-starter-netflix-eureka-client，因为要进行服务调用，所以要引入spring-cloud-starter-netflix-ribbon，如果要使用openfeign来进行服务调用，则可以引入spring-cloud-starter-openfeign。

依赖如下：

<?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>EurekaClient</artifactId>
    	<name>EurekaClient</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-netflix-eureka-client</artifactId>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
    		</dependency>
    
                    
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-openfeign</artifactId>
    		</dependency>
    	</dependencies>
    </project>

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

### 二、配置eureka服务注册 ###

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

server:
      port: 8810
    spring:
      application:
        name: eurekaClient
    eureka:
      instance:
        hostname: localhost
        prefer-ip-address: true
      client:
        serviceUrl:
          defaultZone: http://${eureka.instance.hostname}:8888/eureka/

这里面，包含了端口、应用名、注册信息、方式。

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

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

eureka.client.serviceUrl这个，是配置将本服务注册为客户端，这里注册到http://localhost:8888/eureka/。

注意这里的url里有/eureka，这个后缀，而访问注册中心的时候用的是http://localhost:8888。

### 三、启动服务注册发现 ###

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

使用@EnableEurekaClient和@EnableDiscoveryClient注解启动类, @EnableEurekaClient是将项目作为客户端注册到注册中心的注解，@EnableDiscoveryClient开启服务发现功能。使用Eureka做服务发现，要加上这两个注解。

**如果是使用Feign，需要加上@EnableFeignClients注解，开启Feign的使用**

EurekaClientApplication：

package cn.pomit.springbootwork.eurekaclient;
    
    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.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.client.RestTemplate;
    
    //@EnableFeignClients
    @EnableEurekaClient
    @EnableDiscoveryClient
    @SpringBootApplication
    public class EurekaClientApplication { 
    	public static void main(String[] args) { 
    		SpringApplication.run(EurekaClientApplication.class, args);
    	}
    
    	@Bean
    	@LoadBalanced
    	RestTemplate restTemplate() { 
    		return new RestTemplate();
    	}
    }

这里的RestTemplate使用@LoadBalanced注解，我们跟踪RestTemplate的时候可以看到，RestTemplate多了个LoadBalancerInterceptor。

#### 3.2 Ribbon做服务调用 ####

如果我们使用Ribbon做服务调用，需要使用RestTemplate，这个RestTemplate是标识为负载均衡的。我们来调用上一篇提供的ip服务：

IpInfoService ：

package cn.pomit.springbootwork.eurekaclient.service;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.ResponseEntity;
    import org.springframework.stereotype.Service;
    import org.springframework.web.client.RestTemplate;
    
    import cn.pomit.springbootwork.eurekaclient.model.ResultModel;
    
    @Service
    public class IpInfoService { 
    	/** * 第一个EUREKASERVER是服务提供方配置文件种的spring.application.name,第二个eurekaServer是服务提供方的controller中配置的路径 */
    	public static String remoteIpServiceUrl = "http://EUREKASERVER/eurekaServer/ip";
    	@Autowired
    	private RestTemplate restTemplate;
    
    	public ResultModel getIpInfo() { 
    		ResponseEntity<ResultModel> ipModel = restTemplate.getForEntity(remoteIpServiceUrl, ResultModel.class);
    		return ipModel.getBody();
    	}
    }

这里，[第一个EUREKASERVER是服务提供方配置文件种的spring.application.name][EUREKASERVER_spring.application.name],第二个eurekaServer是服务提供方的controller中配置的路径。我们使用统一的实体ResultModel进行数据接收转换。

#### 3.3 Feign做服务调用 ####

如果我们使用Feign做服务调用，写法就和controller中写法类似，需要注意的是，如果带参数，需要使用@RequestParam("")标识参数名 ：

IpInfoService ：

package cn.pomit.springbootwork.eurekafeign.service;
    
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    
    import cn.pomit.springbootwork.eurekafeign.model.ResultModel;
    
    @FeignClient("EUREKASERVER")
    public interface IpInfoService { 
    	@RequestMapping(method = RequestMethod.GET, value = "/eurekaServer/ip", consumes = "application/json")
    	public ResultModel getIpInfo();
    }

这里，@FeignClient中的EUREKASERVER是服务提供方配置文件种的spring.application.name,/eurekaServer/ip中的eurekaServer是服务提供方的controller中配置的路径。方法尽量和服务提供方的方法一样。

#### 3.4 测试Web ####

package cn.pomit.springbootwork.eurekaclient.web;
    
    import org.springframework.beans.factory.annotation.Autowired;
    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.eurekaclient.model.ResultModel;
    import cn.pomit.springbootwork.eurekaclient.service.IpInfoService;
    
    @RestController
    @RequestMapping("/eurekaClient")
    public class EurekaClientRest { 
    	@Autowired
    	IpInfoService ipInfoService;
    
    	@RequestMapping(value = "/test", method = {  RequestMethod.GET })
    	public String test() { 
    		return "Hello, Hello";
    	}
    
    	@RequestMapping(value = "/ip", method = {  RequestMethod.GET })
    	public ResultModel ip() { 
    		return ipInfoService.getIpInfo();
    	}
    }

### 四、过程中用到的实体 ###

过程中用到了ResultModel实体和ResultCode枚举类，是和上一篇中的实体对应的，作为统一的实体来用。

ResultModel:

package cn.pomit.springbootwork.eurekaclient.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.eurekaclient.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/2039870943234561
[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
[https_www.pomit.cn_spring_SpringCloudWork_pom.xml]: https://www.pomit.cn/spring/SpringCloudWork/pom.xml
[EUREKASERVER_spring.application.name]: http://xn--EUREKASERVERspring-kz12a9xg4kypevzxqj1hv7ieib64fvzir44k3uuaiwjfl8ati7j.application.name
[IT]: /images/20211113/efd947c26c64495fb41b80d0cbad1234.png