SpringCloud之Eureka:服务发布与调用例子
eureka是netflix开发的服务发现框架,本身是一个基于rest的服务,主要用于定位运行在aws域中的中间层服务,以达到负载均衡和中间层服务故障转移的目的。
springcloud将它集成在其子项目spring-cloud-netflix中,以实现springcloud的服务发现功能。
eureka概述
eureka包含两个组件:eureka server(服务器,或服务注册中心)和eureka client(客户端)。
eureka server提供服务注册服务,各个节点启动后,会在eureka server中进行注册,这样eurekaserver中的服务注册表中将会存储所有可用服务节点的信息,服务节点的信息可以在界面中直观的看到。
eureka client是一个java客户端,用于简化与eureka server的交互,客户端同时也就是一个内置的、使用轮询(round-robin)负载算法的负载均衡器。
在应用启动后,将会向eureka server发送心跳,默认周期为30秒,如果eureka server在多个心跳周期内没有接收到某个节点的心跳,eureka server将会从服务注册表中把这个服务节点移除(默认90秒)。
eureka server之间通过复制的方式完成数据的同步,eureka还提供了客户端缓存机制,即使所有的eureka server都挂掉,客户端依然可以利用缓存中的信息消费其他服务的api。
综上,eureka通过心跳检查、客户端缓存等机制,确保了系统的高可用性、灵活性和可伸缩性。
eureka的服务发布与调用简单例子
一、构建服务器(服务注册中心)
1、创建项目
开发工具:intellij idea 2019.2.2
idea中创建一个新的springboot项目,名称为“first-ek-server”,springboot版本选择2.1.9,在选择dependencies(依赖)的界面勾选spring cloud discovert -> eureka server。
创建完成后的pom.xml配置文件自动添加springcloud最新稳定版本依赖,当前为greenwich.sr3。
加入的spring-cloud-starter-eureka-server会自动引入spring-boot-starter-web,因此只需加入该依赖,项目就具有web容器的功能。
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 https://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>2.1.9.release</version> <relativepath/> <!-- lookup parent from repository --> </parent> <groupid>com.example</groupid> <artifactid>first-ek-server</artifactid> <version>0.0.1-snapshot</version> <name>first-ek-server</name> <description>demo project for spring boot</description> <properties> <java.version>1.8</java.version> <spring-cloud.version>greenwich.sr3</spring-cloud.version> </properties> <dependencies> <dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-starter-netflix-eureka-server</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>${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.yml
设置服务端口、服务器注册开关。
默认情况下,服务器启动时会把自己当做一个客户端,去注册eureka服务器,并且会到eureka服务器抓取注册信息。
但这里只是作为一个服务器,而不是服务的提供者(客户端),因此设置属性值为flase,否则启动时会在控制台看到异常信息。
caused by: java.net.connectexception: connection refused: connect
com.netflix.discovery.shared.transport.transportexception: cannot execute request on any known server
server: port: 8761 eureka: client: register-with-eureka: false fetch-registry: false
3、修改启动类代码firstekserverapplication.java
增加注解@enableeurekaserver,声明这是一个eureka服务器。
package com.example.firstekserver; import org.springframework.boot.springapplication; import org.springframework.boot.autoconfigure.springbootapplication; import org.springframework.cloud.netflix.eureka.server.enableeurekaserver; @springbootapplication @enableeurekaserver public class firstekserverapplication { public static void main(string[] args) { springapplication.run(firstekserverapplication.class, args); } }
启动服务,浏览器访问http://localhost:8761,页面显示eureka服务器控制台,里面有服务实例列表,当前是空的。
二、编写服务提供者(生产者)
1、创建项目
idea中创建一个新的springboot项目,除了名称为“first-ek-service-provider”,其它步骤和上面一样,pom.xml的依赖项也一样。
2、修改配置application.yml
配置应用名称为 first-service-provider,该服务将会被注册到服务器 http://localhost:8761/eureka/
server: port: 8762 spring: application: name: first-service-provider eureka: instance: hostname: localhost client: serviceurl: defaultzone: http://localhost:8761/eureka/
3、添加类 user.java
package com.example.firstekserviceprovider; public class user { private integer id; private string name; public user(integer id, string name){ this.id = id; this.name = name; } public integer getid() { return id; } public void setid(integer id) { this.id = id; } public string getname() { return name; } public void setname(string name) { this.name = name; } }
4、添加控制器 usercontroller.java
提供一个简单的rest服务。
package com.example.firstekserviceprovider; import org.springframework.http.mediatype; import org.springframework.web.bind.annotation.pathvariable; import org.springframework.web.bind.annotation.requestmapping; import org.springframework.web.bind.annotation.requestmethod; import org.springframework.web.bind.annotation.restcontroller; @restcontroller public class usercontroller { @requestmapping(value = "/user/{userid}", method = requestmethod.get, produces = mediatype.application_json_value) public user finduser(@pathvariable("userid") integer userid){ user user = new user(userid, "gdjlc"); return user; } }
5、修改启动类代码firstekserverapplication.java
添加注解@enableeurekaclient,声明这是一个eureka客户端。
package com.example.firstekserviceprovider; import org.springframework.boot.springapplication; import org.springframework.boot.autoconfigure.springbootapplication; import org.springframework.cloud.netflix.eureka.enableeurekaclient; @springbootapplication @enableeurekaclient public class firstekserviceproviderapplication { public static void main(string[] args) { springapplication.run(firstekserviceproviderapplication.class, args); } }
启动服务,浏览器访问http://localhost:8761,服务实例列表已经增加了first-service-provider。
三、编写服务调用者(消费者)
调用者是指同样注册到 eureka的客户端,来调用其它客户端发布的服务。
1、创建项目
idea中创建一个新的springboot项目,除了名称为“first-ek-service-invoker”,其它步骤和依赖项和上面都一样。
2、修改配置application.yml
配置应用名称为 first-service-invoker,该服务将会被注册到服务器 http://localhost:8761/eureka/
server: port: 8763 spring: application: name: first-service-invoker eureka: instance: hostname: localhost client: serviceurl: defaultzone: http://localhost:8761/eureka/
3、添加控制器 invokercontroller.java
在控制器中,配置了resttemplate的bean,resttemplate是spring-web模块下面的类,主要用来调用rest服务。
本身不具有调用分布式服务的能力,但被@loadbalanced注解修饰后,这个resttemplate实例就具有访问调用分布式服务的能力。
另外,下面调用服务,通过服务名称进行调用。
package com.example.firstekserviceinvoker; import org.springframework.cloud.client.loadbalancer.loadbalanced; import org.springframework.context.annotation.bean; import org.springframework.context.annotation.configuration; import org.springframework.http.mediatype; import org.springframework.web.bind.annotation.requestmapping; import org.springframework.web.bind.annotation.requestmethod; import org.springframework.web.bind.annotation.restcontroller; import org.springframework.web.client.resttemplate; @restcontroller @configuration public class invokercontroller { @bean @loadbalanced public resttemplate getresttemplate(){ return new resttemplate(); } @requestmapping(value = "/router", method = requestmethod.get, produces = mediatype.application_json_value) public string router(){ resttemplate resttpl = getresttemplate(); //根据应用名称调用服务 string json = resttpl.getforobject("http://first-service-provider/user/1", string.class); return json; } }
4、修改启动类代码firstekserviceinvokerapplication.java
添加注解@enablediscoveryclient,使得服务调用者可以去eureka中发现服务。
说明:@enablediscoveryclient注解已经包含了@enableeurekaclient的功能。
package com.example.firstekserviceinvoker; import org.springframework.boot.springapplication; import org.springframework.boot.autoconfigure.springbootapplication; import org.springframework.cloud.client.discovery.enablediscoveryclient; @springbootapplication @enablediscoveryclient public class firstekserviceinvokerapplication { public static void main(string[] args) { springapplication.run(firstekserviceinvokerapplication.class, args); } }
启动服务,浏览器访问http://localhost:8761,服务实例列表又增加了first-service-invoker。
备注:上面的红色粗体警告信息表示eureka已经进入自我保护模式,暂时不用理会。
浏览器访问http://localhost:8763/router,页面输出:
{"id":1,"name":"gdjlc"}
可知,成功调用了服务提供者的服务。
总结,本例子的结构图: