SpringCloud02
文章目录
- 0.学习目标
- 1.Nacos配置管理
- 1.1.统一配置管理
- 1.1.1.在nacos中添加配置文件
- 1.1.2.从微服务拉取配置
- 1.2.配置热更新
- 1.2.1.方式一 (直接@Value注入)
- 1.2.2.方式二 (注入到pojo)
- 1.3.配置共享
- 1)添加一个环境共享配置
- 2)在user-service中读取共享配置
- 3)运行两个UserApplication,使用不同的profile
- 4)配置共享的优先级
- 1.4.搭建Nacos集群
- 2.Feign远程调用
- 2.1.Feign替代RestTemplate
- 1)引入依赖
- 2)添加注解
- 3)编写Feign的客户端
- 4)测试
- 5)总结
- 2.2.自定义配置
- 2.2.1.配置文件方式
- 2.2.2.Java代码方式
- 2.3.Feign使用优化
- 2.4.最佳实践
- 2.4.1.继承方式
- 2.4.2.抽取方式
- 2.4.3.实现基于抽取的最佳实践
- 1)抽取
- 2)在order-service中使用feign-api
- 3)重启测试
- 4)解决扫描包问题
- 3.Gateway服务网关
- 3.1.为什么需要网关
- 3.2.gateway快速入门
- 1)创建gateway服务,引入依赖
- 2)编写启动类
- 3)编写基础配置和路由规则
- 4)重启测试
- 5)网关路由的流程图
- 3.3.断言工厂
- 3.4.过滤器工厂
- 3.4.1.路由过滤器的种类
- 3.4.2.请求头过滤器
- 3.4.3.默认过滤器
- 3.4.4.总结
- 3.5.全局过滤器
- 3.5.1.全局过滤器作用
- 3.5.2.自定义全局过滤器
- 3.5.3.过滤器执行顺序
- 3.6.跨域问题
- 3.6.1.什么是跨域问题
- 3.6.2.模拟跨域问题
- 3.6.3.解决跨域问题
0.学习目标
1.Nacos配置管理
Nacos除了可以做注册中心,同样可以做配置管理来使用。
1.1.统一配置管理
当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。
Nacos一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。
1.1.1.在nacos中添加配置文件
如何在nacos中管理配置呢?
先新建一个配置,完事后交给nacos去管理
然后在弹出的表单中,填写配置信息:
ID其实就是配置文件的名称,需要做到唯一 ,严格按照格式来命名,后缀名写全称
profile其实就是环境:dev、test、prod
注意:项目的核心配置,需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。
点击发布就看到了新建的配置文件,因为之前新建时就在dev集群下新建的,所以配置就在dev集群下
点击详情可以查看详细信息:
为了和课程一致,还是删除然后重新在public集群下新建一个吧:
1.1.2.从微服务拉取配置
微服务要拉取nacos中管理的配置,并且与本地的application.yml配置合并(才是完整的配置文件),才能完成项目启动。
读取顺序修改成了先读取nacos中的配置,再读取application.yml的配置,但是nacos地址目前还是放在application.yml里面,这怎么办呢?也就是:
但如果尚未读取application.yml,又如何得知nacos地址呢?
因此spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取,流程如下:
1)引入nacos-config依赖
首先,在user-service服务中,引入nacos-config的客户端依赖:
问:为什么是user-service?
答:仅仅只是用user-service微服务为例而已,前面新建的nacos配置看命名(userservice-dev.yaml)就知道是user-service微服务的热更新配置
<!--nacos配置管理依赖-->
<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
2)添加bootstrap.yaml
然后,在user-service中添加一个bootstrap.yaml文件,内容如下:
文件名必须bootstrap.yaml 这是一种特殊的文件,看他的图标上有云朵就知道很特殊了
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
:
- 注意,nacos里面有一些重复的配置,可以删除(或注释)了
3)读取nacos配置
在user-service中的UserController中添加业务逻辑,读取pattern.dateformat配置:
controller、java代码里,读取yml配置很简单 直接注入 (application配置是会创建成bean被放在IOC容器中管理的)
完整代码:
package cn.whu.user.web;import cn.whu.user.pojo.User;
import cn.whu.user.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {@Autowiredprivate UserService userService;//controller里读取配置很简单 直接注入 (application配置是会创建成bean被放在IOC容器中管理的)@Value("${pattern.dateformat}") // 注意这个配置是写在nacos配置中心的,并不在本地 (本地只是在bootstrap里配置了该如何读取他 只有正常读到了,这里才能获取到他)private String dateformat;// 写一个controller方便查看有没有读取到@GetMapping("now") //不写/默认会给你加上/public String now(){String value = "格式: " + dateformat;DateTimeFormatter pattern = DateTimeFormatter.ofPattern(dateformat);String res = "时间: "+LocalDateTime.now().format(pattern);return value + "\n" + res;}
}
在页面访问,可以看到效果:
http://localhost:8081/user/now
- 小结
1.2.配置热更新
我们最终的目的,是修改nacos中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新。
浏览器端,nacos控制台,修改配置:
然后点击发布-》确认发布
刷新浏览器,并没有热更新,说明要实现热更新,代码方面还要稍作修改,得做一些配置
要实现配置热更新,可以使用两种方式:
yml配置的读取有两种方式(springBoot课程内容-2.3 yaml数据读取),对应的热更新配置也有两种配置
1.2.1.方式一 (直接@Value注入)
在@Value注入的变量所在类上添加注解@RefreshScope
:
加上注解后重启服务,修该nacos里的yml配置,不用重启,直接刷新,发现真的就能实现热更新了
1.2.2.方式二 (注入到pojo)
使用@ConfigurationProperties注解代替@Value注解。
在user-service服务中,添加一个类,读取patterrn.dateformat属性:
cn.whu.user.config.PatternProperties
package cn.whu.user.config;import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;@Data //提供Get/Set方法 spring就能自动帮我们注入属性值了 (否则私有的,框架也访问不到(业务框架也不可能对你的类进行暴力反射))
@Component //做成spring Bean, IOC容器里有, 那么任何地方就都可以注入他后使用他了
@ConfigurationProperties(prefix = "pattern") // 约定优于配置: 前缀名和属性名拼在一起和配置文件里的配置名一致,就能完成属性的自动注入
public class PatternProperties {private String dateformat;//和nacos的yml配置文件里的名称保持一致
}
在UserController中使用这个类代替@Value:(或者说Bean里有这个类了,直接注入这个类就行了)
注意:不需要结合@RefreshScope注解就可以实现配置的热更新
完整代码:
package cn.whu.user.web;import cn.whu.user.config.PatternProperties;
import cn.whu.user.pojo.User;
import cn.whu.user.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;@Slf4j
@RestController
@RequestMapping("/user")
//@RefreshScope
public class UserController {@Autowiredprivate UserService userService;@Autowiredprivate PatternProperties patternProperties;// 写一个controller方便查看有没有读取到@GetMapping("now") //不写/默认会给你加上/public String now(){String value = "格式: " + patternProperties.getDateformat();DateTimeFormatter pattern = DateTimeFormatter.ofPattern(patternProperties.getDateformat());String res = "时间: "+LocalDateTime.now().format(pattern);return value + "\n" + res;}
}
课程推荐使用方式二:@ConfigurationProperties 直接将配置注入到POJO,然后@Component做成bean,然后直接注入该POJO,即可,该POJO自动热更新,不需要加其他注解了
.
我感觉两种方式都还不错
1.3.配置共享
其实微服务启动时,会去nacos读取多个配置文件,例如:
-
[spring.application.name]-[spring.profiles.active].yaml
,例如:userservice-dev.yaml -
[spring.application.name].yaml
,例如:userservice.yaml
而[spring.application.name].yaml
不包含环境,因此可以被多个环境共享。
(简单理解:这个配置文件命名中没有环境信息,因此,无论哪个环境,微服务启动时,一定都会加载这个配置文件)
下面我们通过案例来测试配置共享
1)添加一个环境共享配置
我们在nacos中添加一个userservice.yaml文件:
点击发布-》确认发布
2)在user-service中读取共享配置
在user-service服务中,修改PatternProperties类(加一个属性就行了),读取新添加的属性:
在user-service服务中,修改UserController,添加一个方法:
@GetMapping("prop")
public PatternProperties prop(){return patternProperties;
}
3)运行两个UserApplication,使用不同的profile
修改UserApplication2这个启动项,改变其profile值:
可以看到第二个微服务主动去读了 userservice-test.yaml
虽然没有
第一个自然就是读 userservice-dev.yaml
了
这样,UserApplication(8081)使用的profile是dev,UserApplication2(8082)使用的profile是test。
启动UserApplication和UserApplication2
访问http://localhost:8081/user/prop,结果:
访问http://localhost:8082/user/prop,结果:
可以看出来,不管是dev,还是test环境,都读取到了envSharedValue这个属性的值。
4)配置共享的优先级
当nacos、服务本地同时出现相同属性时,优先级有高低之分:
在IDEA的user-service的application.yml里也配置一个相同的属性,继续测试:
pattern:name: 本地环境localenvSharedValue: 本地环境共享值
POJO里多加个属性即可获取到
测试结果如下:
在nacos配置
name只有本地有,所以显示本地的值,但是envSharedValue本地和nacos都有,自然就显示优先级更高的nacos配置喽,也证明了上述配置优先级的正确性
还可以进一步详细测试:在nacos控制台userservice.yaml里写name,会覆盖本地的name
再在userservice-dev.yaml里写name, 又会覆盖userservice.yaml的name
- 小结
1.4.搭建Nacos集群
Nacos生产环境下一定要部署为集群状态,部署方式参考课前资料中的文档:
链接:
提取码:v8s5
或者直接参考这篇博客:
2.Feign远程调用
先来看我们以前利用RestTemplate发起远程调用的代码:
存在下面的问题:
•代码可读性差,编程体验不统一
•参数复杂URL难以维护
Feign是一个声明式的http客户端,官方地址:
其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。
2.1.Feign替代RestTemplate
Fegin的使用步骤如下:
1)引入依赖
我们在order-service服务的pom文件中引入feign的依赖:
<!-- feign客户端依赖 -->
<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
-starter- 就是boot起步依赖,自动装配
2)添加注解
在order-service的启动类(OrderApplication)添加注解开启Feign的功能: @EnableFeignClients
3)编写Feign的客户端
在order-service中新建一个接口,内容如下:
cn.whu.order.clients.UserClient
package cn.whu.order.clients;import cn.whu.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;@FeignClient("userservice")
public interface UserClient {@GetMapping("/user/{id}")User findById(@PathVariable("id") Long id);
}
@FeignClient 注解还会使得该类被创建成bean给springIOC容器管理,使得任何java代码处都可以注入后访问它了
对比一下原来的Url方式的信息,都有了,且现在只用调用接口方法就行了,太方便了吧
这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
- 服务名称:userservice
- 请求方式:GET
- 请求路径:/user/{id}
- 请求参数:Long id
- 返回值类型:User
这样,Feign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。
4)测试
修改order-service中的OrderService类中的queryOrderById方法,使用Feign客户端代替RestTemplate:
@Service
public class OrderService {@Autowiredprivate OrderMapper orderMapper;@Autowiredprivate UserClient userClient;public Order queryOrderById(Long orderId) {// 1.查询订单Order order = orderMapper.findById(orderId);// 2.利用Feign发起http请求,查询用户User user = userClient.findById(order.getUserId());// 3.封装user到orderorder.setUser(user);// 4.返回return order;}
}
是不是看起来优雅多了。
1、注意之前如果配置了nacos集群,user-service的注册中心可能改成了80端口那个,需要改回8848(否则都不在一个注册中心里维护,怎么相互调用呢) user-service的bootstrap.yml里的
server-addr: localhost:8848 # Nacos地址
2、namespace会隔离微服务,也得注释掉 : order-service的application.yml
访问正常
更进一步,注释掉所有的负载均衡配置:
order-service的application.yml
order-service的OrderApplication
Feign自动实现了负载均衡就体现在这里,不需要再加@LoadBalanced注解开启负载均衡
然后代码里就没有任何负载均衡的配置的,再次执行
发现负载均衡仍然存在,而且是平均分配,feign自动就实现了负载均衡(不需要加额外注解)
但是好像还是感知不到集群的存在,所有集群都配置也都注释掉了,应该除了UserApplication3其他都是默认集群里,但是并没有优先访问本集群(默认集群)的微服务 【Feign不需要加额外注解开启负载均衡,但是涉及nacos集群,还是得加一行nacos的负载均衡策略配置】
eg: 打开nacos负载均衡策略得配置,就能感知到集群,优先访问本集群(DEFAULT)里的微服务了
再浏览器访问http://localhost:8080/order/101 果然ShangHai集群的UserApplication3就不会被调用了,一行日志也不打印
feign里肯定集成了Ribbon,一查果然有
5)总结
使用Feign的步骤:
① 引入依赖
② 添加@EnableFeignClients注解
③ 编写FeignClient接口
④ 使用FeignClient中定义的方法代替RestTemplate
2.2.自定义配置
基本上使用Boot自动装配的默认配置就够了,只是boot允许我们覆盖默认配置而已
Feign可以支持很多的自定义配置,如下表所示:(只是举了5个例子,并不是只有这5个)
类型 | 作用 | 说明 |
---|---|---|
feign.Logger.Level | 修改日志级别 | 包含四种不同的级别:NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 响应结果的解析器 | http远程调用的结果做解析,例如解析json字符串为java对象 |
feign.codec.Encoder | 请求参数编码 | 将请求参数编码,便于通过http请求发送 |
feign. Contract | 支持的注解格式 | 默认是SpringMVC的注解 |
feign. Retryer | 失败重试机制 | 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试 |
feign底层就是ribbon, 也就相当于有了失败重试机制
一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。
下面以日志为例来演示如何自定义配置。
2.2.1.配置文件方式
基于配置文件修改feign的日志级别可以针对单个服务:
feign: client:config: userservice: # 针对某个微服务的配置loggerLevel: FULL # 日志级别
也可以针对所有服务:
feign: client:config: default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置loggerLevel: FULL # 日志级别
在消费者order-service的application.yml最下面新增配置
重启后,再访问,再查看日志
可以看到远程调用的feign日志了
05-18 16:01:25:642 INFO 113788 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring DispatcherServlet 'dispatcherServlet'
05-18 16:01:25:642 INFO 113788 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet : Initializing Servlet 'dispatcherServlet'
05-18 16:01:25:644 INFO 113788 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet : Completed initialization in 2 ms
05-18 16:01:25:666 INFO 113788 --- [nio-8080-exec-1] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Starting...
05-18 16:01:25:748 INFO 113788 --- [nio-8080-exec-1] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Start completed.
05-18 16:01:25:752 DEBUG 113788 --- [nio-8080-exec-1] c.whu.order.mapper.OrderMapper.findById : ==> Preparing: select * from tb_order where id = ?
05-18 16:01:25:760 DEBUG 113788 --- [nio-8080-exec-1] c.whu.order.mapper.OrderMapper.findById : ==> Parameters: 101(Long)
05-18 16:01:25:768 DEBUG 113788 --- [nio-8080-exec-1] c.whu.order.mapper.OrderMapper.findById : <== Total: 1
05-18 16:01:25:771 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById] ---> GET http://userservice/user/1 HTTP/1.1
05-18 16:01:25:771 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById] ---> END HTTP (0-byte body)
05-18 16:01:25:800 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById] <--- HTTP/1.1 200 (27ms)
05-18 16:01:25:801 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById] connection: keep-alive
05-18 16:01:25:801 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById] content-type: application/json
05-18 16:01:25:801 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById] date: Thu, 18 May 2023 08:01:25 GMT
05-18 16:01:25:801 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById] keep-alive: timeout=60
05-18 16:01:25:801 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById] transfer-encoding: chunked
05-18 16:01:25:801 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById]
05-18 16:01:25:801 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById] {"id":1,"username":"柳岩","address":"湖南省衡阳市"}
05-18 16:01:25:801 DEBUG 113788 --- [nio-8080-exec-1] cn.whu.order.clients.UserClient : [UserClient#findById] <--- END HTTP (59-byte body)
而日志的级别分为四种:
- NONE:不记录任何日志信息,这是默认值。 (只是Feign的日志)
- BASIC:仅记录请求的方法,URL以及响应状态码和执行时间 (http请求什么时候发的,什么时候结束的,耗时多久)
- HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
- FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
2.2.2.Java代码方式
也可以基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:
cn.whu.order.config.DefaultFeignConfiguration.java
public class DefaultFeignConfiguration {@Beanpublic Logger.Level feignLogLevel(){return Logger.Level.BASIC; // 日志级别为BASIC}
}
该类上没有加任何注解,默认肯定不生效,如何让他生效呢?
有以下两种方式
如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中: defaultConfiguration=
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)
把原来yml里的配置注释了,再测试,发现只有BASIC级别的Feign日志了
如果是局部生效,则把它放到对应的(xxxClient接口的)@FeignClient这个注解中: configuration=
@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)
注释掉OrderApplication里的配置
重启服务测试,发现BASIC级别日志还在
- 小结
日志级别:调试时用FULL, 平常就用NONE、BASIC
2.3.Feign使用优化
Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:
•URLConnection:默认实现,不支持连接池 (JDK自带,性能很低,每次创建新的TCP连接,3次握手,释放时4次分手)
•Apache HttpClient :支持连接池
•OKHttp:支持连接池
因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。
这里我们用Apache的HttpClient来演示。(Spring底层默认也是这个)
1)引入依赖
在order-service的pom文件中引入Apache的HttpClient依赖:
<!--httpClient的依赖 -->
<dependency><groupId>io.github.openfeign</groupId><artifactId>feign-httpclient</artifactId>
</dependency>
2)配置连接池
在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 # 每个路径的最大连接数
接下来,在FeignClientFactoryBean中的loadBalance方法中打断点: (双击Shfit搜索FeignClientFactoryBean)
Debug方式启动order-service服务,可以看到这里的client,底层就是Apache HttpClient:
-
总结,Feign的优化:
1.日志级别尽量用basic
2.使用HttpClient或OKHttp代替URLConnection
① 引入feign-httpClient依赖
② 配置文件开启httpClient功能,设置连接池参数
2.4.最佳实践
所谓最佳实践,就是使用过程中总结的经验,最好的一种使用方式。
自习观察可以发现,Feign的客户端与服务提供者的controller代码非常相似:
feign客户端:
UserController:
有没有一种办法简化这种重复的代码编写呢?
2.4.1.继承方式
一样的代码可以通过继承来共享:
1)定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。
2)Feign客户端和Controller都继承该接口
优点:
- 简单
- 实现了代码共享
缺点:
-
服务提供方、服务消费方紧耦合
-
参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法、参数列表、注解
2.4.2.抽取方式
将Feign的Client抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用。
例如,将UserClient、User、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。
- 小结
2.4.3.实现基于抽取的最佳实践
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项目中(直接连包一起复制就行了)
注意UserClient里的user包重新导入一下,毕竟包结构名称变了
原来order-service里的相关包和pojo可以直接删除了
下面红框框出来的直接delete,不要心疼
删完后order-service的OrderService类报错,别着急继续往下做
2)在order-service中使用feign-api
首先,删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。
在order-service的pom文件中中引入feign-api的依赖:
<dependency><groupId>cn.whu.demo</groupId><artifactId>feign-api</artifactId><version>1.0</version>
</dependency>
修改order-service中的所有与上述三个组件有关的导包部分,改成导入feign-api中的包
1、Order.java 里的User
2、OrderService.java里的User和UserClient
3)重启测试
重启后,发现服务报错了:
编译不报错,说明类存在,执行报错,说找不到该类对应的bean,说明spring根本没有扫描到UserClient类,从而无法为其创建对象,也就无法注入对应的bean了
这是因为UserClient现在在cn.whu.feign.clients包下,
而order-service的@EnableFeignClients注解是在cn.whu.order包下,不在同一个包,无法扫描到UserClient。
默认情况下只能扫描到cn.whu.order包及其下面子包的类并创建对象
springBoot也会去扫描导入jar包里面的类,只要其包结构和本项目工程结构一致,都会被扫描
包结构不一样,那么没法自动扫描了,只能手动配置,让其去扫描了
4)解决扫描包问题
方式一:
指定Feign应该扫描的包:
@EnableFeignClients(basePackages = "cn.whu.feign.clients")
方式二:
指定需要加载的Client接口:
@EnableFeignClients(clients = {UserClient.class})
建议用第二种方式
3.Gateway服务网关
Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。
3.1.为什么需要网关
Gateway网关是我们服务的守门神,所有微服务的统一入口。
网关的核心功能特性:
- 请求路由
- 权限控制
- 限流
架构图:
权限控制:网关作为微服务入口,需要校验用户是否有请求资格,如果没有则进行拦截。
路由和负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。
在SpringCloud中网关的实现包括两种:
- gateway
- zuul
Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。
- 小结
3.2.gateway快速入门
下面,我们就演示下网关的基本路由功能。基本步骤如下:
- 创建SpringBoot工程gateway,引入网关依赖
- 编写启动类
- 编写基础配置和路由规则
- 启动网关服务进行测试
1)创建gateway服务,引入依赖
创建服务:
引入依赖:
<!--网关-->
<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服务发现依赖-->
<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
2)编写启动类
package cn.whu.gateway;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
public class GatewayApplication {public static void main(String[] args) {SpringApplication.run(GatewayApplication.class,args);}
}
3)编写基础配置和路由规则
创建application.yml文件,内容如下:
server:port: 10010 # 网关端口
spring:application:name: gateway # 服务名称 (这也是一个微服务而已)cloud:nacos:server-addr: localhost:8848 # nacos地址gateway:routes: # 网关路由配置- id: user-service # 路由id,自定义,只要唯一即可# uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称 (lb:loadBalance)predicates: # 路由断言,也就是判断请求是否符合路由规则的条件- Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求- id: order-serviceuri: lb://orderservicepredicates:- Path=/order/**
我们将符合Path
规则的一切请求,都代理到 uri
参数指定的地址。(代理也可以自己在yml里配了)
本例中,我们将 /user/**
开头的请求,代理到lb://userservice
,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
4)重启测试
启动 GatewayApplication.Main
重启网关,访问 http://localhost:10010/user/1 时,符合/user/**
规则,请求转发到uri:http://userservice/user/1,得到了结果:
同理可以访问:http://localhost:10010/order/101
5)网关路由的流程图
整个访问的流程如下:
总结:
网关搭建步骤:
-
创建项目,引入nacos服务发现和gateway依赖
-
配置application.yml,包括服务基本信息、nacos地址、路由
路由配置包括:
-
路由id:路由的唯一标示
-
路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
-
路由断言(predicates):判断路由的规则,
-
路由过滤器(filters):对请求或响应做处理
接下来,就重点来学习路由断言和路由过滤器的详细知识
3.3.断言工厂
我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
例如Path=/user/**是按照路径匹配,这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory
类来
处理的,像这样的断言工厂在SpringCloudGateway还有十几个:
下面列出了Spring提供的11种基本的Predicate工厂:
名称 | 说明 | 示例 |
---|---|---|
After | 是某个时间点后的请求 | - After=2037-01-20T17:42:47.789-07:00[America/Denver] |
Before | 是某个时间点之前的请求 | - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] |
Between | 是某两个时间点之前的请求 | - Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver] |
Cookie | 请求必须包含某些cookie | - Cookie=chocolate, ch.p |
Header | 请求必须包含某些header | - Header=X-Request-Id, \d+ |
Host | 请求必须是访问某个host(域名) | - Host=.somehost,.anotherhost |
Method | 请求方式必须是指定方式 | - Method=GET,POST |
Path | 请求路径必须符合指定规则 | - Path=/red/{segment},/blue/** |
Query | 请求参数必须包含指定参数 | - Query=name, Jack或者- Query=name |
RemoteAddr | 请求者的ip必须是指定范围 | - RemoteAddr=192.168.1.1/24 |
Weight | 权重处理 |
了解一下:eg:RemoteAddr 可以屏蔽国外网段的IP,不允许国外访问、After 可以只路由规定时间点之后的路由
官方文档
可以根据官方滴玩一玩
重启之后,再想从网关去访问order-service微服务,就访问不到了,报404: http://localhost:10010/order/101
改成before,又能访问了
.但是从网关访问user-service微服务还是可以的:http://localhost:10010/user/1
我们用的是倒数第四个,也就是Path
我们只需要掌握Path这种路由工程就可以了。
- 小结
3.4.过滤器工厂
请求经过网关后才能到达微服务
那么在网关内发生了什么呢?经过前面的学习,我们知道了,肯定至少得经过断言工厂的路由。
其实经过路由后还得经过过滤器
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
3.4.1.路由过滤器的种类
Spring提供了31种不同的路由过滤器工厂。例如:
名称 | 说明 |
---|---|
AddRequestHeader | 给当前请求添加一个请求头 |
RemoveRequestHeader | 移除请求中的一个请求头 |
AddResponseHeader | 给响应结果中添加一个响应头 |
RemoveResponseHeader | 从响应结果中移除有一个响应头 |
RequestRateLimiter | 限制请求的流量 |
目前官网已经更新到37种路由过滤器工厂了
3.4.2.请求头过滤器
下面我们以AddRequestHeader 为例来讲解。
需求:给所有进入userservice的请求添加一个请求头:Truth=itcast is freaking awesome!
只需要修改gateway服务的application.yml文件,添加路由过滤即可:
格式如下:
- AddRequestHeader=key, value # key是请求头名称 value是具体的值
spring:cloud:gateway:routes:- id: user-service uri: lb://userservice predicates: - Path=/user/** filters: # 过滤器- AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头
当前过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效。
- 测试
修改UserController的方法,获取请求头参数并打印一下:
再通过网关访问: http://localhost:10010/user/1
果然控制台有输出,说明请求头添加成功了
3.4.3.默认过滤器
如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:
spring:cloud:gateway:routes: # 网关路由配置- id: order-serviceuri: lb://orderservicepredicates:- Path=/order/**default-filters: # 默认(全局)过滤项 所有微服务的路由请求都会执行这个过滤器的操作- AddRequestHeader=Truth, whu is freaking awesome!! # 添加请求头
重启GatewayApplication,重新访问:http://localhost:10010/user/1,控制台还能打印:
3.4.4.总结
过滤器的作用是什么?
① 对路由的请求或响应做加工处理,比如添加请求头
② 配置在路由下的过滤器只对当前路由的请求生效
defaultFilters的作用是什么?
① 对所有路由都生效的过滤器
3.5.全局过滤器
上一节学习的过滤器,网关提供了31种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。
3.5.1.全局过滤器作用
GatewayFilter的作用和前面的defaultFilters作用是一样的,但是defaultFilters是以配置的方式做过滤操作
而GatewayFilter则可以以java代码方式,灵活地写我们自己想要滴逻辑
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。
定义方式是实现GlobalFilter接口。
public interface GlobalFilter {/*** 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理** @param exchange 请求上下文,里面可以获取Request、Response等信息* @param chain 用来把请求委托给下一个过滤器 * @return {@code Mono<Void>} 返回标示当前过滤器业务结束*/Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
在filter中编写自定义逻辑,可以实现下列功能:
- 登录状态判断
- 权限校验
- 请求限流等
3.5.2.自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
-
参数中是否有authorization,
-
authorization参数值是否为admin
如果同时满足则放行,否则拦截
实现:
在gateway中定义一个过滤器:
package cn.whu.gateway;import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;@Order(-1) //过滤器优先级 值越小,优先级越高
@Component //做成bean才能生效
public class AuthorizeFilter implements GlobalFilter {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {// 1. 获取请求参数ServerHttpRequest request = exchange.getRequest();MultiValueMap<String, String> params = request.getQueryParams();// 2. 获取参数中的 authorization 参数String auth = params.getFirst("authorization"); //get方法获取所有 getFirst获取第一个匹配的// 3. 判断参数值是否等于 adminif("admin".equals(auth)){// 4. 是:放行return chain.filter(exchange);}// 5. 否:拦截// 5.1 拦截之前给出提示 提高用户体验 具体实现就是:// 设置状态码exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);//401未登陆 已经帮你定义好了各种枚举// 5.2 拦截请求return exchange.getResponse().setComplete();}
}
重启网关微服务-GatewayApplication
访问:http://localhost:10010/user/2 被拦截,报401
访问:http://localhost:10010/user/2?authorization=admin 可以正常访问
- 小结
3.5.3.过滤器执行顺序
请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:
排序的规则是什么呢?
- 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
- GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
- 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
- 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
声明顺序指的是yml配置文件里配置的先后顺序,路由过滤器和defaultFilter各自都从1开始计数
.
默认过滤器和路由过滤器底层就是 GateWayFilter
全局过滤器是 GlobalFilter, 看起来完全不一样,但是FilteringWebHandler.java里有个GatewayFilterAdapter,通过适配器模式将GlobalFilter适配成了GateWayFilter
所以上图所有3种过滤器本质上都可以看成是GateWayFilter,类型相同,也就可以放在一个集合中进行排序了
详细内容,可以查看源码:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()
方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()
方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链
- 小结
3.6.跨域问题
3.6.1.什么是跨域问题
跨域:域名不一致就是跨域,主要包括:
-
域名不同: www.taobao 和 www.taobao 和 www.jd 和 miaosha.jd
-
域名相同,端口不同:localhost:8080和localhost8081
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题
解决方案:CORS,这个以前应该学习过,这里不再赘述了。不知道的小伙伴可以查看.html
3.6.2.模拟跨域问题
链接:
提取码:v8s5
找到课前资料的页面文件:
放入tomcat或者nginx这样的web服务器中,启动并访问。(注意得是另一个服务器,主要为了保证url(ip:端口)
不能一样)
可以在浏览器控制台看到下面的错误:
从localhost:8090访问localhost:10010,端口不同,显然是跨域的请求。
3.6.3.解决跨域问题
在gateway服务的application.yml文件中,添加下面的配置:
spring:cloud:gateway:# 。。。globalcors: # 全局的跨域处理add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题 (浏览器会先去询问服务器让不让这个请求跨域,这个询问请求默认会被拦截,但是肯定不能被拦截,此行配置true就是不拦截这个询问请求)corsConfigurations:'[/**]':allowedOrigins: # 允许哪些网站的跨域请求 - "http://localhost:8090"allowedMethods: # 允许的跨域ajax的请求方式- "GET"- "POST"- "DELETE"- "PUT"- "OPTIONS"allowedHeaders: "*" # 允许在请求中携带的头信息 (*表示一切请求头)allowCredentials: true # 是否允许携带cookiemaxAge: 360000 # 这次跨域检测的有效期
如何测试?
不会前端,而且tomcat的8080端口已经被占用了,可以新建一个boot工程,配置不同端口即可
application.yml
server:port: 8089
其中index.hmtl很简单,就是用ajax发送一个跨域请求
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Document</title>
</head>
<body>
<pre>
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 # 是否允许携带cookiemaxAge: 360000 # 这次跨域检测的有效期
</pre>
</body>
<script src=".min.js"></script>
<script>axios.get("http://localhost:10010/user/1?authorization=admin").then(resp => console.log(resp.data)).catch(err => console.log(err))
</script>
</html>
启动web服务,访问: http://localhost:8090/
按F12,发现报错
然后再在gateway里面加上配置,重启gateway,再访问: http://localhost:8090/
浏览器跨域ajax请求成功啦
更多推荐
SpringCloud02
发布评论