Spring cloud 尝试使用 consul 作为服务注册和发现
springCloud是基于SpringBoot的一整套实现微服务的框架。
它提供了微服务开发所需的配置管理、服务发现、断路器、智能路由、微代理、控制总线、全局锁、决策竞选、分布式会话和集群状态管理等组件。
微服务是什么?假如让你设计一个简单的打车软件你会怎么设计呢?整体应用?
我们可以把一个打车软件拆分为几个为服务,分别开发:用户服务;车辆管理服务;Oauth权限认证服务;支付服务;地址服务;邮寄服务.....
这样有必要吗?有什么好处呢?
-
它解决了复杂性的问题
-
这种架构使得每个服务可以由单独的团队独立开发,这些团队可以专注于某个服务
-
微服务架构模式使得每一个微服务能被独立部署
-
微服务架构模式使得每一个服务都可以被独立扩展
-
服务之间只是接口调用,非常利于扩展,天然的低耦合。
到这里应该不用说,有过开发经验的基本都会认同微服务架构。因为在之前的整体应用中,我们被庞大的老旧代码折磨到奔溃,谁也不想面对庞大的无注释的老旧怪兽。
微服务设计原则:
-
单一职责原则
-
服务自治原则
-
轻量级通信原则
-
微服务粒度(项目根据业务规划接口,每个接口最好只实现一种功能,单一,高内聚)
微服务简介:https://blog.csdn.net/u012256142/article/details/82839728
本篇的开源:https://github.com/TorGor/spring-cloud-consul.git
需要使用 Eureka 作为注册中心的,可以看我的另一个开源,github 地址;
地址:https://github.com/TorGor/spring-cloud-microservice-cluster
Spring cloud consul 官方文档:https://springcloud.cc/spring-cloud-consul.html
安装 consul
下载:https://www.consul.io/downloads.html
下载所需要的版本,我的为Win-64:
配置所需要的环境变量:
cmd 命令窗口执行:consul agent -dev
consul 自带 UI 界面,打开网址:http://localhost:8500
cmd 命令窗口执行:
consul.exe agent -server ui -bootstrap -client 0.0.0.0 -data-dir="E:\consul" -bind X.X.X.X
其中X.X.X.X为服务器ip,即可使用http://X.X.X.X:8500 访问ui
启动服务放着别动。。。。。
Spring boot 2.0 创建项目
新建项目:
根据自己项目需要,选择Spring boot 的相应版本,我这里用的是Spring boot 2.0 ,然后其他勾选相应的依赖。
选中后,pom中会有以下依赖,其中actuator 是健康检查依赖;
<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>
</dependency>
接下来是配置 application.properties 或者 application.yml,官网建议是使用 yml,而我建议新手使用properties ,可以依赖 idea 的使用提示,更容易使用;
Spring Cloud consul 微服务注册
1.先来创建一个服务提供者微服务: consul-client-provider1
新建一个Spring boot 2.0 微服务 consul-client-provider1,和上面教程一样;
在 application 启动类上面加上 @EnableDiscoveryClient
@SpringBootApplication
@EnableDiscoveryClient
public class EurekaClientProvider1Application {
public static void main(String[] args) {
SpringApplication.run(EurekaClientProvider1Application.class, args);
}
}
一个简单的controller,返回这个 服务 的 端口号;
@RestController
public class RestTemController {
@GetMapping(value = "provider")
public String provider() {
return "Hello 8081";
}
}
简单的 application 配置:
server.port=8081
spring.application.name=consul-provider
spring.cloud.consul.host=localhost
spring.cloud.consul.port=8500
2.创建另一个服务提供者微服务: consul-client-provider2
新建一个Spring boot 2.0 微服务 consul-client-provider2,和上面教程一样;
3.创建 调用者 微服务: consul-client-invoker
新建一个Spring boot 2.0 微服务 consul-client-invoker;
在这个微服务中,我们通过接口调用 consul 中注册的 provider 服务,因为有两个provider ,我们需要做负载均衡,而spring cloud 支持 ribbon ,直接添加依赖,就然后加上配置就可以完美集成;也支持自定义负债均衡规则。
提到 Ribbon 顺便简单介绍下,它是安装在客户端的负债均衡器。
Ribbon是Netflix发布的开源项目,主要功能是提供客户端的软件负载均衡算法,将Netflix的中间层服务连接在一起。Ribbon客户端组件提供一系列完善的配置项如连接超时,重试等。简单的说,就是在配置文件中列出Load Balancer(简称LB)后面所有的机器,Ribbon会自动的帮助你基于某种规则(如简单轮询,随即连接等)去连接这些机器。我们也很容易使用Ribbon实现自定义的负载均衡算法。
spring cloud 中使用 Ribbon:
第一种方式,直接默认依次选择服务;在 RestTemplate 上面加上 @LoadBalanced 注解即可。
@Configuration
public class RestTemplete {
@Bean(name = "restTemplateCommon")
@LoadBalanced
public RestTemplate restTemplateCommon(RestTemplateBuilder builder) {
return builder
.setConnectTimeout(5000)
.setReadTimeout(15000)
.build();
}
}
第二种方式,自定义规则:
public class DefineRibbonRule implements IRule {
private ILoadBalancer lb;
@Override
public Server choose(Object key) {
System.out.println("====My Rule====");
Random r = new Random();
int randomNum = r.nextInt(10);
List<Server> servers = lb.getAllServers();
if(randomNum > 7) {
Server s = getServerByPort(servers, 8081);
return s;
}
return getServerByPort(servers, 8082);
}
private Server getServerByPort(List<Server> servers, int port) {
for(Server s : servers) {
if(s.getPort() == port) {
return s;
}
}
return null;
}
@Override
public void setLoadBalancer(ILoadBalancer lb) {
this.lb = lb;
}
@Override
public ILoadBalancer getLoadBalancer() {
return lb;
}
}
使用 feign 调用接口:
什么是feign?
Feign简介
Feign是Netflix开发的声明式、模板化的HTTP客户端,其灵感来自Retrofit、JAXRS-2.0以及WebSocket。Feign可帮助我们更加便捷、优雅地调用HTTP API。
在Spring Cloud中,使用Feign非常简单——创建一个接口,并在接口上添加一些注解,代码就完成了。Feign支持多种注解,例如Feign自带的注解或者
JAX-RS注解等。
Spring Cloud对Feign进行了增强,使Feign支持了Spring MVC注解,并整合了Ribbon和Eureka,从而让Feign的使用更加方便。
接下来看看代码中的 Feign 是如何优雅的取代 RestTemplate 的;
先来段RestTempate 调用方式:
@GetMapping(value = "/call")
// @HystrixCommand
public String call(){
String msg = template.getForObject("http://consul-provider/provider",String.class);
return msg;
}
在来看看Feign 是如何调用的:
controller:
@Autowired
private FeignService feignClient;
@GetMapping("/feigncall")
public String feigncall(){
String msg = feignClient.getHello();
log.info("=====<invoker log>=====");
return msg;
}
service:
@FeignClient(value = "consul-provider",fallback = FeignServiceImpl.class)
public interface FeignService {
@GetMapping("/provider")
String getHello();
}
啥玩意?搞定了?是的!!!没错!!!就是这么优雅。
那个 fallback 是个啥玩意?字面理解,错误回调,那么好懂了,就是用来处理异常时的业务逻辑,这里必须要实现 FeignService
上面三个服务都启动成功,如果看到consul 的控制台里面有自己的服务,就说明注册成功了:
consul 控制台:
访问:
RestTemplate: http://localhost:8080/call
Feign:http://localhost:8080/feigncall
至此,如果执行成功,说明已经成功跨出了一小步了。接下来还有配置中心,和网关,还有最最重要的断路保护 Hytrix ;这些我将在下篇继续;
我的完整目录如下;
我的 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.bolocloud</groupId>
<artifactId>consul-client-provider1</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>consul-client-provider1</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>net.logstash.logback</groupId>
<artifactId>logstash-logback-encoder</artifactId>
<version>5.1</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-sleuth-zipkin</artifactId>
</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>
<!--<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-consul-discovery</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</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>