SpringCloud微服务架构

微服务框架

单体架构

单体架构:将业务的所有功能集中在一个项目中开发,打成一个包部署。
优点:
  架构简单
  部署成本低
缺点:
  耦合度高(维护困难、升级困难)

分布式架构

分布式架构:根据业务功能对系统进行拆分,每个业务模块作为独立项目开发,称为一个服务。
优点:
  降低服务耦合
  有利于服务升级和拓展
缺点:
  服务调用关系错综复杂

微服务

微服务是一种经过良好架构设计的分布式架构方案。
微服务架构特征:
  单一职责:微服务拆分粒度更小,每一个服务都对应唯一的业务能力,做到单一职责,避免重复业务开发
  面向服务:微服务对外暴露业务接口
  自治:团队独立、技术独立、数据独立、部署独立
  隔离性强:服务调用做好隔离、容错、降级,避免出现级联问题

单体架构特点:
  简单方便,高度耦合,扩展性差,适合小型项目。例如:学生管理系统
分布式架构特点:
  松耦合,扩展性好,但架构复杂,难度大。适合大型互联网项目,例如:京东、淘宝
微服务:一种良好的分布式架构方案
  优点:拆分粒度更小、服务更独立、耦合度更低
  缺点:架构非常复杂,运维、监控、部署难度提高

微服务技术对比

微服务这种方案需要技术框架来落地,全球的互联网公司都在积极尝试自己的微服务落地技术。在国内最知名的就是SpringCloud和阿里巴巴的Dubbo。

企业需求

SpringCloud

SpringCloud是目前国内使用最广泛的微服务框架。官网地址:https://spring.io/projects/spring-cloud。
SpringCloud集成了各种微服务功能组件,并基于SpringBoot实现了这些组件的自动装配,从而提供了良好的开箱即用体验。
其中常见的组件包括:

另外,SpringCloud底层是依赖于SpringBoot的,并且有版本的兼容关系,如下:

服务拆分和远程调用

服务拆分原则

不同微服务,不要重复开发相同业务。
微服务数据独立,不要访问其它微服务的数据库。
微服务可以将自己的业务暴露为接口,供其它微服务调用。

服务拆分示例

cloud-demo:父工程,管理依赖
  order-service:订单微服务,负责订单相关业务
  user-service:用户微服务,负责用户相关业务
要求:
  订单微服务和用户微服务都必须有各自的数据库,相互独立。
  订单服务和用户服务都对外暴露Restful的接口。
  订单服务如果需要查询用户信息,只能调用用户服务的Restful接口,不能查询用户数据库。
需求:
  修改order-service中的根据id查询订单业务,要求在查询订单的同时,根据订单中包含的userId查询出用户信息,一起返回。

注册RestTemplate

我们在order-service服务中的OrderApplication启动类中,注册RestTemplate实例:

 1 @MapperScan("cn.itcast.order.mapper")
 2 @SpringBootApplication
 3 public class OrderApplication {
 4     public static void main(String[] args) {
 5         SpringApplication.run(OrderApplication.class, args);
 6     }
 7 
 8     @Bean
 9     public RestTemplate restTemplate() {
10         return new RestTemplate();
11     }
12 }

服务远程调用RestTemplate

修改order-service中的OrderService的queryOrderById方法:

 1 @Service
 2 public class OrderService {
 3     @Autowired
 4     private OrderMapper orderMapper;   
 5     @Autowired
 6     private RestTemplate restTemplate;
 7 
 8     public Order queryOrderById(Long orderId) {
 9         // 1.查询订单
10         Order order = orderMapper.findById(orderId);
11         // 2.远程查询用户 
12         String url = "http://localhost:8081/user/" +  order.getUserId();
13         User user = restTemplate.getForObject(url, User.class);
14         // 3.封装user信息
15         order.setUser(user);
16         // 4.返回
17         return order;
18     }
19 }

提供者与消费者

在服务调用关系中,会有两个不同的角色:
  服务提供者:一次业务中,被其它微服务调用的服务。(提供接口给其它微服务)
  服务消费者:一次业务中,调用其它微服务的服务。(调用其它微服务提供的接口)

服务提供者与服务消费者的角色并不是绝对的,而是相对于业务而言。
如果服务A调用了服务B,而服务B又调用了服务C,服务B的角色是什么?
  对于A调用B的业务而言:A是服务消费者,B是服务提供者
  对于B调用C的业务而言:B是服务消费者,C是服务提供者
因此,服务B既可以是服务提供者,也可以是服务消费者。

Eureka注册中心

Eureka的结构和作用

1、order-service如何得知user-service实例地址?
  获取地址信息的流程如下:
    user-service服务实例启动后,将自己的信息注册到eureka-server(Eureka服务端)。这个叫服务注册
    eureka-server保存服务名称到服务实例地址列表的映射关系。
    order-service根据服务名称,拉取实例地址列表。这个叫服务发现服务拉取
2、order-service如何从多个user-service实例中选择具体的实例?
  order-service从实例列表中利用负载均衡算法选中一个实例地址。向该实例地址发起远程调用。
3、order-service如何得知某个user-service实例是否依然健康,是不是已经宕机?
  user-service会每隔一段时间(默认30秒)向eureka-server发起请求,报告自己状态,称为心跳。
  当超过一定时间没有发送心跳时,eureka-server会认为微服务实例故障,将该实例从服务列表中剔除。
  order-service拉取服务时,就能将故障实例排除了。
注:一个微服务,既可以是服务提供者,又可以是服务消费者,因此eureka将服务注册、服务发现等功能统一封装到了eureka-client端。

在Eureka架构中,微服务角色有两类:
  EurekaServer:服务端,注册中心
    记录服务信息。
    心跳监控。
  EurekaClient:客户端
    Provider:服务提供者,例如案例中的 user-service。
      注册自己的信息到EurekaServer。
      每隔30秒向EurekaServer发送心跳。
    consumer:服务消费者,例如案例中的 order-service。
      根据服务名称从EurekaServer拉取服务列表。
      基于服务列表做负载均衡,选中一个微服务后发起远程调用。

动手实践

搭建eureka-server

注册中心服务端:eureka-server,这必须是一个独立的微服务。

创建eureka-server服务

在cloud-demo父工程下,创建一个子模块:

 填写模块信息、服务信息:

引入eureka依赖

引入SpringCloud为eureka提供的starter依赖:

1 <dependency>
2     <groupId>org.springframework.cloud</groupId>
3     <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
4 </dependency>

编写启动类

给eureka-server服务编写一个启动类,一定要添加一个@EnableEurekaServer注解,开启eureka的注册中心功能:

1 @SpringBootApplication
2 @EnableEurekaServer
3 public class EurekaApplication {
4     public static void main(String[] args) {
5         SpringApplication.run(EurekaApplication.class, args);
6     }
7 }

编写配置文件

编写一个application.yml文件,内容如下:

server:
  port: 10086
spring:
  application:
    name: eureka-server
eureka:
  client:
    service-url: 
      defaultZone: http://127.0.0.1:10086/eureka

启动服务

启动微服务,然后在浏览器访问:http://127.0.0.1:10086。看到下面结果应该是成功了:

服务注册

我们将user-service注册到eureka-server中去。

引入依赖

在user-service的pom文件中,引入下面的eureka-client依赖:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

配置文件

在user-service中,修改application.yml文件,添加服务名称、eureka地址:

spring:
  application:
    name: userservice
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka

启动多个user-service实例

为了演示一个服务有多个实例的场景,我们添加一个SpringBoot的启动配置,再启动一个user-service。
首先,复制原来的user-service启动配置:

然后,在弹出的窗口中,填写信息,为了避免端口冲突,需要修改端口设置:

现在,SpringBoot窗口会出现两个user-service启动配置。不过,第一个是8081端口,第二个是8082端口:

启动两个user-service实例:

查看eureka-server管理页面:

服务发现

我们将order-service的逻辑修改:向eureka-server拉取user-service的信息,实现服务发现。

引入依赖

之前说过,服务发现、服务注册统一都封装在eureka-client依赖,因此这一步与服务注册时一致。
在order-service的pom文件中,引入下面的eureka-client依赖:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

配置文件

服务发现也需要知道eureka地址,因此第二步与服务注册一致,都是配置eureka信息。
在order-service中,修改application.yml文件,添加服务名称、eureka地址:

spring:
  application:
    name: orderservice
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka

服务拉取和负载均衡

服务拉取是基于服务名称获取服务列表,然后在对服务列表做负载均衡
修改order-service服务中的cn.itcast.order.service包下的OrderService类中的queryOrderById方法。修改访问的url路径,用服务名代替ip、端口:

String url = "http://userservice/user/" + order.getUserId();

在order-service项目的启动类OrderApplication中的RestTemplate添加负载均衡注解:

1 @Bean
2 @LoadBalanced
3 public RestTemplate restTemplate() {
4     return new RestTemplate();
5 }

spring会自动帮助我们从eureka-server端,根据userservice这个服务名称,获取实例列表,而后完成负载均衡。

Ribbon负载均衡

负载均衡原理

SpringCloud底层其实是利用了一个名为Ribbon的组件,来实现负载均衡功能的。

源码跟踪

为什么只输入了service名称就可以访问,不需要获取ip和端口:
有人帮我们根据service名称,获取到了服务实例的ip和端口。它就是`LoadBalancerInterceptor`,这个类会在对RestTemplate的请求进行拦截,然后从Eureka根据服务id获取服务列表,随后利用负载均衡算法得到真实的服务地址信息,替换服务id。

LoadBalancerIntercepor

intercept方法,拦截了用户的HttpRequest请求,然后做了几件事:
  request.getURI():获取请求uri,本例中就是 http://user-service/user/8
  originalUri.getHost():获取uri路径的主机名,其实就是服务id,user-service
  this.loadBalancer.execute():处理服务id,和用户请求。
这里的this.loadBalancer是LoadBalancerClient类型,我们继续跟入。

LoadBalancerClient

继续跟入execute方法:

getLoadBalancer(serviceId):根据服务id获取ILoadBalancer,而ILoadBalancer会拿着服务id去eureka中获取服务列表并保存起来。
getServer(loadBalancer):利用内置的负载均衡算法,从服务列表中选择一个。本例中,可以看到获取了8082端口的服务
放行后,再次访问并跟踪,发现获取的是8081(实现了负载均衡):

负载均衡策略IRule

我们继续跟入:

继续跟踪源码chooseServer方法,发现这么一段代码:

这里的rule默认值是一个RoundRobinRule,看类的介绍(轮询的意思):

总结

SpringCloudRibbon的底层采用了一个拦截器,拦截了RestTemplate发出的请求,对地址做了修改:

基本流程如下:
  拦截我们的RestTemplate请求http://userservice/user/1;
  RibbonLoadBalancerClient会从请求url中获取服务名称,也就是user-service;
  DynamicServerListLoadBalancer根据user-service到eureka拉取服务列表;
  eureka返回列表,localhost:8081、localhost:8082;
  IRule利用内置负载均衡规则,从列表中选择一个,例如localhost:8081;
  RibbonLoadBalancerClient修改请求地址,用localhost:8081替代userservice,得到http://localhost:8081/user/1,发起真实请求。

负载均衡策略

负载均衡策略

Ribbon的负载均衡规则是一个叫做IRule的接口来定义的,每一个子接口都是一种规则:

内置负载均衡规则类     规则描述
RoundRobinRule   简单轮询服务列表来选择服务器。
AvailabilityFilteringRule   对以下两种服务器进行忽略:
  (1)在默认情况下,这台服务器如果3次连接失败,这台服务器就会被设置为“短路”状态。短路状态将持续30秒,如果再次连接失败,短路的持续时间就会几何级地增加。
  (2)并发数过高的服务器。如果一个服务器的并发连接数过高,配置了AvailabilityFilteringRule规则的客户端也会将其忽略。并发连接数的上限,可以由客户端的<clientName>.<clientConfigNameSpace>.ActiveConnectionsLimit属性进行配置。
WeightedResponseTimeRule   为每一个服务器赋予一个权重值。服务器响应时间越长,这个服务器的权重就越小。这个规则会随机选择服务器,这个权重值会影响服务器的选择。
ZoneAvoidanceRule(默认实现)   以区域可用的服务器为基础进行服务器的选择。使用Zone对服务器进行分类,这个Zone可以理解为一个机房、一个机架等。而后再对Zone内的多个服务做轮询。
BestAvailableRule   忽略那些短路的服务器,并选择并发数较低的服务器。
RandomRule   随机选择一个可用的服务器。
RetryRule   重试机制的选择逻辑

自定义负载均衡策略

通过定义IRule实现可以修改负载均衡规则,有两种方式:
方式一:代码方式:在order-service中的OrderApplication类中,定义一个新的IRule:

1 @Bean
2 public IRule randomRule(){
3     return new RandomRule();
4 }

方式二:配置文件方式:在order-service的application.yml文件中,添加新的配置也可以修改规则:

userservice: # 给某个微服务配置负载均衡规则,这里是userservice服务
  ribbon:
    NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RandomRule # 负载均衡规则 

注:一般用默认的负载均衡规则,不做修改。

饥饿加载

Ribbon默认是采用懒加载,即第一次访问时才会去创建LoadBalanceClient,请求时间会很长。
而饥饿加载则会在项目启动时创建,降低第一次访问的耗时,通过下面配置开启饥饿加载:

ribbon:
  eager-load:
    enabled: true
    clients: userservice

Nacos注册中心

认识和安装Nacos

[Nacos](https://nacos.io/)是阿里巴巴的产品,现在是[SpringCloud](https://spring.io/projects/spring-cloud)中的一个组件。相比[Eureka](https://github.com/Netflix/eureka)功能更加丰富,在国内受欢迎程度较高。

1、下载安装包
  GitHub主页:https://github.com/alibaba/nacos

2、解压

  bin:启动脚本
  conf:配置文件

3、端口配置
Nacos的默认端口是8848,如果你电脑上的其它进程占用了8848端口,请先尝试关闭该进程。
如果无法关闭占用8848端口的进程,也可以进入nacos的conf目录,修改配置文件中的端口:

修改其中的内容:

4、启动:在bin目录下运行指令:

startup.cmd -m standalone

5、访问
  在浏览器输入地址:http://127.0.0.1:8848/nacos即可,默认的账号和密码都是nacos,进入后:

服务注册到nacos

Nacos是SpringCloudAlibaba的组件,而SpringCloudAlibaba也遵循SpringCloud中定义的服务注册、服务发现规范。因此使用Nacos和使用Eureka对于微服务来说,并没有太大区别。
主要差异在于:
  依赖不同
  服务地址不同

引入依赖

1、在cloud-demo父工程的pom文件中添加spring-cloud-alilbaba的管理依赖:

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
    <version>2.2.6.RELEASE</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

2、注释掉order-service和user-service中原有的eureka依赖。
3、然后在user-service和order-service中的pom文件中引入nacos-discovery依赖:

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

配置nacos地址

修改user-service&order-service中的application.yml文件,注释eureka地址,添加nacos地址:

spring:
  cloud:
    nacos:
      server-addr: localhost:8848

重启

重启微服务后,登录nacos管理页面,可以看到微服务信息:

服务分级存储模型

一个服务可以有多个实例,假如这些实例分布于全国各地的不同机房,Nacos就将同一机房内的实例划分为一个集群。user-service是服务,一个服务可以包含多个集群,如杭州、上海,每个集群下可以有多个实例,形成分级模型,如图:

微服务互相访问时,应该尽可能访问同集群实例,因为本地访问速度更快。当本集群内不可用时,才访问其它集群。例如:

给user-service配置集群

修改user-service的application.yml文件,添加集群配置:

spring:
  cloud:
    nacos:
      server-addr: localhost:8848  # nacos 服务端地址
      discovery:
        cluster-name: HZ # 配置集群名称,也就是机房位置,例如:HZ,杭州

重启两个user-service实例后,我们可以在nacos控制台看到下面结果:

同集群优先的负载均衡

默认的ZoneAvoidanceRule并不能实现根据同集群优先来实现负载均衡。
因此Nacos中提供了一个NacosRule的实现,可以优先从同集群中挑选实例。
1)给order-service配置集群信息
修改order-service的application.yml文件,添加集群配置:

spring:
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos 服务端地址
      discovery:
        cluster-name: HZ # 配置集群名称,也就是机房位置

2)修改负载均衡规则
修改order-service的application.yml文件中设置负载均衡的IRule为NacosRule,这个规则优先会寻找与自己同集群的服务:

userservice:
  ribbon:
    NFLoadBalancerRuleClassName: com.alibaba.cloud.nacos.ribbon.NacosRule # 负载均衡规则 

NacosRule负载均衡策略
  1、优先选择同集群服务实例列表。
  2、本地集群找不到提供者,才去其它集群寻找,并且会报警告。
  3、确定了可用实例列表后,再采用随机负载均衡挑选实例。

权重配置

实际部署中会出现这样的场景:
  服务器设备性能有差异,部分实例所在机器性能较好,另一些较差,我们希望性能好的机器承担更多的用户请求。
但默认情况下NacosRule是同集群内随机挑选,不会考虑机器的性能问题。
因此,Nacos提供了权重配置来控制访问频率,权重越大则访问频率越高。
在nacos控制台,找到user-service的实例列表,点击编辑,即可修改权重(0~1之间,权重越高被访问的频率越高):

将权重设置为0.1,测试可以发现8081被访问到的频率大大降低。

注:如果权重修改为0,则该实例永远不会被访问。

环境隔离

Nacos中服务存储和数据存储的最外层都是一个名为namespace的东西,用来做最外层隔离:
  nacos中可以有多个namespace
  namespace下可以有group、service等
  不同namespace之间相互隔离,例如不同namespace的服务互相不可见

默认情况下,所有service、data、group都在同一个namespace,名为public。我们可以点击页面新增按钮,添加一个namespace:

然后填写一个新的命名空间信息:

给微服务配置namespace

给微服务配置namespace只能通过修改配置来实现。修改order-service的application.yml文件:

spring:
  cloud:
    nacos:
      server-addr: localhost:8848
      discovery:
        cluster-name: HZ
        namespace: 492a7d5d-237b-46a1-a99a-fa8e98e4b0f9 # 命名空间,填ID

重启order-service后,访问控制台,可以看到下面的结果:

此时访问order-service,因为namespace不同,会导致找不到userservice,控制台会报错:

Nacos与Eureka的区别

Nacos的服务实例分为两种类型:
  临时实例:如果实例宕机超过一定时间,会从服务列表剔除,默认的类型。
  非临时实例:如果实例宕机,不会从服务列表剔除,也可以叫永久实例。
配置一个服务实例为永久实例:

spring:
  cloud:
    nacos:
      discovery:
        ephemeral: false # 设置为非临时实例

Nacos和Eureka整体结构类似,服务注册、服务拉取、心跳等待,但是也存在一些差异:

Nacos与eureka的共同点:
  都支持服务注册和服务拉取
  都支持服务提供者心跳方式做健康检测
Nacos与Eureka的区别:
  Nacos支持服务端主动检测提供者状态:临时实例采用心跳模式,非临时实例采用主动检测模式。
  临时实例心跳不正常会被剔除,非临时实例则不会被剔除。
  Nacos支持服务列表变更的消息推送模式,服务列表更新更及时。
  Nacos集群默认采用AP方式,当集群中存在非临时实例时,采用CP模式;Eureka采用AP方式。

Nacos配置管理

Nacos除了可以做注册中心,同样可以做配置管理来使用。

统一配置管理

Nacos一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。

在nacos中添加配置文件

在弹出表单中填写配置信息:

注:项目的核心配置,需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

从微服务拉取配置

微服务要拉取nacos中管理的配置,并且与本地的application.yml配置合并,才能完成项目启动。
由于尚未读取application.yml,因此spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取,流程如下:

1)在user-service服务中,引入nacos-config的客户端依赖:

<!--nacos配置管理依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

2)在user-service中的resource目录添加一个bootstrap.yml文件,这个文件是引导文件,优先级高于application.yml:

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev #开发环境,这里是dev 
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr获取nacos地址,再根据${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id,来读取配置。
本例中,就是去读取 userservice-dev.yaml :

 3)在user-service中的UserController中添加业务逻辑,读取pattern.dateformat配置:

 1 @RestController
 2 @RequestMapping("/user")
 3 public class UserController {
 4     @Autowired
 5     private UserService userService;
 6     
 7     // 注入nacos中的配置属性
 8     @Value("${pattern.dateformat}")
 9     private String dateformat;
10     
11     // 编写controller,通过日期格式化器来格式化现在时间并返回
12     @GetMapping("now")
13     public String now(){
14         return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
15     }
16     // ...略
17 }

在页面访问,可以看到效果:

配置热更新

修改nacos中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新
要实现配置热更新,可以使用两种方式:

方式一

在@Value注入的变量所在类上添加注解@RefreshScope:

方式二

使用@ConfigurationProperties注解代替@Value注解。
在user-service服务中,添加一个类,读取patterrn.dateformat属性:

1 @Component
2 @Data
3 @ConfigurationProperties(prefix = "pattern")
4 public class PatternProperties {
5     private String dateformat;
6 }

在UserController中使用PatternProperties这个类代替@Value:

 1 @RestController
 2 @RequestMapping("/user")
 3 public class UserController {
 4     @Autowired
 5     private UserService userService;
 6 
 7     @Autowired
 8     private PatternProperties patternProperties;
 9     
10     // 注入nacos中的配置属性
11     //@Value("${pattern.dateformat}")
12     //private String dateformat;
13 
14     @GetMapping("now")
15     public String now(){
16         //return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
17         return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat()));
18     }
19     //
20 }

配置共享

微服务启动时会从nacos读取多个配置文件:
  [spring.application.name]-[spring.profiles.active].yaml,例如:userservice-dev.yaml
  [spring.application.name].yaml,例如:userservice.yaml
无论profile如何变化,[spring.application.name].yaml这个文件一定会加载,因此多环境共享配置可以写入这个文件

当nacos、服务本地同时出现相同属性时,优先级有高低之分:

Feign远程调用

利用RestTemplate发起远程调用的代码:

代码可读性差,编程体验不统一。
参数复杂URL难以维护。

Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。

Feign替代RestTemplate

1、引入依赖

在order-service服务的pom文件中引入feign的依赖:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2、添加注解

在order-service的启动类添加注解开启Feign的功能:

1 @EnableFeignClients
2 @MapperScan("cn.itcast.order.mapper")
3 @SpringBootApplication
4 public class OrderApplication {
5     public static void main(String[] args) {
6         SpringApplication.run(OrderApplication.class, args);
7     }
8 }

3、编写Feign的客户端

在order-service中新建一个接口,内容如下:

1 @FeignClient("userservice")
2 public interface UserClient {
3     @GetMapping("/user/{id}")
4     User findById(@PathVariable("id") Long id);
5 }

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
  服务名称:userservice
  请求方式:GET
  请求路径:/user/{id}
  请求参数:Long id
  返回值类型:User
这样,Feign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。

4、测试

修改order-service中的OrderService类中的queryOrderById方法,使用Feign客户端代替RestTemplate:

 1 @Autowired
 2 private UserClient userClient;
 3 public Order queryOrderById(Long orderId) {
 4     // 1.查询订单
 5     Order order = orderMapper.findById(orderId);
 6     // 2.利用Feign发起http 请求,查询用户
 7     User user = userClient.findById(order.getUserId());
 8     // 3.封装user到Order
 9     order.setUser(user);
10     // 4.返回
11     return order;
12 }

自定义配置

Feign运行自定义配置来覆盖默认配置,可以修改的配置如下:

一般我们需要配置的就是日志级别。
配置Feign日志有两种方式:

方式一:配置文件方式

局部生效:

feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL #  日志级别 

全局生效:

feign:  
  client:
    config: 
      default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
        loggerLevel: FULL #  日志级别 

日志的级别分为四种:
  NONE:不记录任何日志信息,这是默认值。
  BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
  HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
  FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。

方式二:Java代码方式

先声明一个类,然后声明一个Logger.Level的对象:

1 public class DefaultFeignConfiguration  {
2     @Bean
3     public Logger.Level feignLogLevel(){
4         return Logger.Level.BASIC; // 日志级别为BASIC
5     }
6 }

如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中:

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class) 

如果是局部生效,则把它放到对应的@FeignClient这个注解中:

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration.class) 

Feign使用优化

Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:
  URLConnection:默认实现,不支持连接池
  Apache HttpClient :支持连接池
  OKHttp:支持连接池
因此优化Feign的性能主要包括:
  使用连接池代替默认的URLConnection
  日志级别,最好用basic或none
Feign添加HttpClient的支持:
  在order-service的pom文件中引入Apache的HttpClient依赖:

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

  在order-service的application.yml中添加配置:

feign:
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

最佳实践

Feign的客户端与服务提供者的controller代码非常相似:

order-service下的feign客户端:

user-service下的UserController:

需要简化重复的代码编写。

方式一:继承方式

1)定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。
2)给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。

优点:
  简单
  实现了代码共享
缺点:
  服务提供方、服务消费方紧耦合
  参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法、参数列表、注解

方式二:抽取方式

将Feign的Client抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用。
例如,将UserClient、User、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。

实现基于抽取的最佳实践

1、抽取
首先创建一个module,命名为feign-api:

在feign-api中然后引入feign的starter依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

2、在order-service中使用feign-api
首先,删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。
在order-service的pom文件中中引入feign-api的依赖:

<dependency>
    <groupId>cn.itcast.demo</groupId>
    <artifactId>feign-api</artifactId>
    <version>1.0</version>
</dependency>

修改order-service中的所有与上述三个组件有关的导包部分,改成导入feign-api中的包
3、重启测试
重启后,发现服务报错了:

这是因为UserClient现在在cn.itcast.feign.clients包下,而order-service的@EnableFeignClients注解是在cn.itcast.order包下,不在同一个包,无法扫描到UserClient。
4、解决扫描包问题
方式一:指定Feign应该扫描的包:

@EnableFeignClients(basePackages = "cn.itcast.feign.clients")

方式二:指定需要加载的Client接口:

@EnableFeignClients(clients = {UserClient.class})

Gateway服务网关

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

Gateway网关是我们服务的守门神,所有微服务的统一入口。
网关功能:
身份认证和权限校验:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
服务路由、负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
请求限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。

在SpringCloud中网关的实现包括两种:
gateway
zuul
Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。

gateway快速入门

创建gateway服务,引入依赖

引入SpringCloudGateway的依赖和nacos的服务发现依赖:

 1 <!--网关-->
 2 <dependency>
 3     <groupId>org.springframework.cloud</groupId>
 4     <artifactId>spring-cloud-starter-gateway</artifactId>
 5 </dependency>
 6 <!--nacos服务发现依赖-->
 7 <dependency>
 8     <groupId>com.alibaba.cloud</groupId>
 9     <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
10 </dependency>

编写启动类

1 @SpringBootApplication
2 public class GatewayApplication {
3     public static void main(String[] args) {
4         SpringApplication.run(GatewayApplication.class, args);
5     }
6 }

编写基础配置和路由规则

创建application.yml文件,内容如下:

 1 server:
 2   port: 10010 # 网关端口
 3 spring:
 4   application:
 5     name: gateway # 服务名称
 6   cloud:
 7     nacos:
 8       server-addr: localhost:8848 # nacos地址
 9     gateway:
10       routes: # 网关路由配置
11         - id: user-service # 路由id,自定义,只要唯一即可
12           # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
13           uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称
14           predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
15             - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求

网关路由的流程图

断言工厂

我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件。
例如Path=/user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的。
像这样的断言工厂在SpringCloudGateway还有十几个:

过滤器工厂

GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:

路由过滤器的种类

Spring提供了31种不同的路由过滤器工厂。例如:

请求头过滤器

需求:给所有进入userservice的请求添加一个请求头:Truth=itcast is freaking awesome!
在gateway中修改application.yml文件,给userservice的路由添加过滤器。只对当前路由的请求生效

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

默认过滤器

如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:

spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 网关路由配置
        - id: user-service 
          uri: lb://userservice  
          predicates: 
            - Path=/user/** 
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
      default-filters: # 默认过滤器,会对所有的路由请求都生效
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

全局过滤器

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。
定义方式是实现GlobalFilter接口。

 1 public interface GlobalFilter {
 2     /**
 3      *  处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
 4      *
 5      * @param exchange 请求上下文,里面可以获取Request、Response等信息
 6      * @param chain 用来把请求委托给下一个过滤器 
 7      * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
 8      */
 9     Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
10 }

自定义全局过滤器

需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
  1.参数中是否有authorization;
  2.authorization参数值是否为admin。
如果同时满足则放行,否则拦截。
步骤:
  1.实现GlobalFilter接口
  2.编写处理逻辑
  3.添加@Order注解或实现Ordered接口
实现:
  在gateway中定义一个过滤器:

 1 @Order(-1)
 2 @Component
 3 public class AuthorizeFilter implements GlobalFilter {
 4     @Override
 5     public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
 6         // 1.获取请求参数
 7         MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
 8         // 2.获取authorization参数
 9         String auth = params.getFirst("authorization");
10         // 3.校验
11         if ("admin".equals(auth)) {
12             // 放行
13             return chain.filter(exchange);
14         }
15         // 4.拦截
16         // 4.1.禁止访问,设置状态码
17         exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
18         // 4.2.结束处理
19         return exchange.getResponse().setComplete();
20     }
21 }

除添加@Order注解外还可以实现Ordered接口:

public class AuthorizeFilter implements GlobalFilter, Ordered {

过滤器执行顺序

请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:

1、每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
2、GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定。
3、路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
4、当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
可以参考下面几个类的源码来查看:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链。

跨域问题

跨域:域名不一致就是跨域,主要包括:
  域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com。
  域名相同,端口不同:localhost:8080和localhost8081。
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题。
解决方案:CORS,Cross-origin resource sharing 跨域资源共享

解决跨域问题

网关处理跨域采用的同样是CORS方案,在gateway服务的application.yml文件中,添加下面的配置:

spring:
  cloud:
    gateway:
      # 。。。
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求 
              - "http://localhost:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期
posted @ 2023-08-04 22:26  溯鸣  阅读(296)  评论(0编辑  收藏  举报