Spring Cloud（三）Feign请求方式、GateWay网关
文章目录
- Feign请求方式
-
- 基本使用
- 自定义配置
- 性能优化
- 最佳实践
- Gateway网关
-
- 搭建网关服务
- 路由断言工厂（Route Predicate Factory）
- 路由过滤器GatewayFilter
- 全局过滤器 GlobalFilter
- 过滤器执行顺序
- 跨域问题处理
Feign请求方式
之前在order-service中，我们使用RestTemplate发起远程调用。
String url = "http://userservice/user/" + order.getUserId();
User user = restTemplate.getForObject(url, User.class);
这种方式存在下面的问题：
- 代码可读性差，编程体验不统一。
- 参数复杂URL难以维护。
因此我们介绍一个更加优雅的远程调用请求方式——Feign。
Feign是一个声明式的http客户端，其作用是帮助我们优雅的实现http请求的发送，解决RestTemplate中存在的问题。
基本使用
引入依赖
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-openfeignartifactId>
dependency>
在order-service的启动类添加注解并开启Feign的功能
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {
编写Feign客户端
package cn.itcast.order.clients;
import cn.itcast.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
/**
* @version 1.0
* @Description
* @Author 月上叁竿
* @Date 2022-05-07 15:11
**/
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
主要基于Spring MVC的注解来声明远程调用的信息，比如：
- 服务名称：userservice
- 请求方式：Get
- 请求路径：/user/{id}
- 请求参数：Long id
- 返回值类型： User
用Feign客户端代替RestTemplate
@Autowired
private UserClient userClient;
public Order queryOrderById(Long orderId) {
// 1.查询订单
Order order = orderMapper.findById(orderId);
// 2.用feign进行远程调用，得到user信息
User user = userClient.findById(order.getUserId());
// 3.将user信息进行封装
order.setUser(user);
// 4.返回
return order;
}
自定义配置
Feign运行自定义配置来覆盖默认配置，可以修改的配置如下：
一般需要配置的是日志级别。
配置Feign有两种方式：
方式一：配置文件方式
全局生效：
feign:
client:
config:
default: # 用default就是全局配置，如果写服务名称，则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
局部生效：
feign:
client:
config:
userservice: # 用default就是全局配置，如果写服务名称，则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
方式二：Java代码方式，需要先声明一个Bean
package cn.itcast.order.config;
import feign.Logger;
import org.springframework.context.annotation.Bean;
/**
* @version 1.0
* @Description
* @Author 月上叁竿
* @Date 2022-05-07 17:47
**/
public class DefaultFeignConfiguration {
@Bean
public Logger.Level level(){
return Logger.Level.BASIC;
}
}
如果是全局配置，需要将这个Bean放到@EnableFeignClients这个注解中：
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class)
如果是局部配置，则将其放在@FeignClient这个注解中：
@FeignClient(value = "userservice",configuration = DefaultFeignConfiguration.class)
public class DefaultFeignConfiguration {
性能优化
Feign底层的客户端实现：
- URLConnection：默认实现，不支持连接池。
- Apache HttpClient：支持连接池
- OKHttp：支持连接池
Feign的性能优化主要包括：
- 使用连接池代替默认的URLConnection
- 日志级别，最好使用basic或none
Feign添加HttpClient的支持：引入依赖
<dependency>
<groupId>io.github.openfeigngroupId>
<artifactId>feign-httpclientartifactId>
dependency>
配置连接池
feign:
client:
config:
default: # 用default就是全局配置，如果写服务名称，则是针对某个微服务的配置
loggerLevel: Basic # 日志级别，最基本的请求和响应信息
httpclient:
enabled: true # 支持HTTPClient的开关
max-connections: 200 # 最大连接数
max-connections-per-route: 50 # 单个请求路径的最大连接数
最佳实践
方式一：继承，给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。
特点：
- 服务紧耦合
- 父接口参数列表中的映射不会被继承
注：通常不建议在服务器和客户端之间共享接口。引入了紧密耦合，并且实际上也不能以当前的形式与spring MVC一起工作（方法参数映射不是继承的）。
方式二（抽取）：将FeignClient抽取为独立模块，并且把接口有关的POJO，默认的Feign配置都放在这个模块中，提供给所有的消费者使用。
实现步骤如下：
- 首先创建一个module，命名为feign-api，然后引入feign的starter依赖。
- 将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中。
- 在order-service中引入feign-api的依赖
- 修改order-service中所有与上述三个组件有关的import部分，改成feign-api的包
- 重启测试
重启测试后，发现orderService无法启动，是因为不能注入UserClient。我们必须配置扫描范围才能扫描到UserClient进行注入，有两种解决方式：
方式一： 指定FeignClient所在的包
@EnableFeignClients(basePackage = "cn.cast.feign.clients")
方式二：指定FeignClient字节码
@EnableFeignClients(clients={UserClient.class})
Gateway网关
在Spring Cloud中网关的实现包括两种：
- gateway
- zuul
其中Zuul是基于Servlet的实现，属于阻塞式编程，而SpringCloudGateway是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。
搭建网关服务
第一步，创建新的module，引入SpringCloudGateway的依赖和nacos的服务发现依赖
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-gatewayartifactId>
dependency>
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
dependency>
第二步，编写application.yml配置文件，编写路由配置及其nacos地址
server:
port: 10010 # 服务端口
spring:
application:
name: gateway # 服务名称
cloud:
nacos:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 网关路由配置
- id: user-service # 路由id 自定义 唯一即可
uri: lb://userservice # 路由的目标地址 lb就是负载均衡 后面跟服务名称
predicates: #路由断言，判断请求是否符合路由规则的条件
- Path=/user/** # 按路径匹配，只要以/user开头就符合要求
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
路由断言工厂（Route Predicate Factory）
网关路由可以配置的内容包括如下：
- 路由id：路由的唯一标示
- uri：路由目的地，支持lb和http两种
- predicates：路由断言，判断请求是否符合要求，符合则转发到路由目的地
- filters：路由过滤器，处理请求或响应
路由断言工厂
我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件。
例如Path=/user/**是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的。
像这样的断言工厂在SpringCloudGateway还有十一个，都是Spring帮我们提供的：
spring:
application:
name: gateway # 服务名称
cloud:
nacos:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 网关路由配置
- id: user-service # 路由id 自定义 唯一即可
uri: lb://userservice # 路由的目标地址 lb就是负载均衡 后面跟服务名称
predicates: #路由断言，判断请求是否符合路由规则的条件
- Path=/user/** # 按路径匹配，只要以/user开头就符合要求
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
- After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
路由过滤器GatewayFilter
GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理。
案例：给所有进入userservice的请求加入请求头Life=is a fucking movie!
修改application.yml
spring:
application:
name: gateway # 服务名称
cloud:
nacos:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 网关路由配置
- id: user-service # 路由id 自定义 唯一即可
uri: lb://userservice # 路由的目标地址 lb就是负载均衡 后面跟服务名称
predicates: #路由断言，判断请求是否符合路由规则的条件
- Path=/user/** # 按路径匹配，只要以/user开头就符合要求
filters:
- AddRequestHeader=Life, is a fucking movie!
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
测试
public class UserController {
@Autowired
private UserService userService;
/**
* 路径： /user/110
*
* @param id 用户id
* @return 用户
*/
@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id, @RequestHeader(value = "Life", required = false) String life) {
System.out.println("Life " + life);
return userService.queryById(id);
}
如果要对所有的路由都生效，则可以将过滤器工厂写到default下：
spring:
application:
name: gateway # 服务名称
cloud:
nacos:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 网关路由配置
- id: user-service # 路由id 自定义 唯一即可
uri: lb://userservice # 路由的目标地址 lb就是负载均衡 后面跟服务名称
predicates: #路由断言，判断请求是否符合路由规则的条件
- Path=/user/** # 按路径匹配，只要以/user开头就符合要求
# filters:
# - AddRequestHeader=Life,Itsdfsdfsdfsdfsdfsdfsdf is a fucking movie!
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
default-filters: # 默认过滤器，对所有请求都生效
- AddRequestHeader=Life, is a fucking movie!
全局过滤器 GlobalFilter
全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。
区别在于GatewayFliter通过配置定义，处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码去实现。
定义方式是实现GlobalFilter接口。
案例：定义全局过滤器，拦截并判断用户身份
需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下列条件
- 参数中是否有authorization
- authorization参数值是否为admin
如果同时满足则放行，否则拦截。
package cn.itcast.gateway.filter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
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;
/**
* @version 1.0
* @Description
* @Author 月上叁竿
* @Date 2022-05-08 16:22
**/
@Component
//@Order(-1)
public class AuthorizeFilter implements GlobalFilter, Ordered {
@Override
public 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");
// 3.判断参数值是否等于admin
if ("admin".equals(auth)){
// 等于则放行
return chain.filter(exchange);
}
// 不等则拦截
// 设置状态码
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
return exchange.getResponse().setComplete();
}
@Override
public int getOrder() {
return -1;
}
}
全局过滤器的作用：对所有路由都生效的过滤器，并且可以自定义处理逻辑。
实现全局过滤器的步骤：
- 实现GlobalFilter接口
- 添加@Order注解或实现Ordered接口
- 编写处理逻辑
过滤器执行顺序
请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFliter、GlobalFliter。
请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器。
每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，则执行顺序就越靠前。
GlobalFilter通过实现Order接口，或者添加@Order注解来指定order值，由自己来指定。
路由过滤器和defaultFilter的order由Spring指定，默认按照声明顺序从1递增。
当过滤器的order值一样时，会按照defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
参考下面几个类的源码：
- org.springframework.cloud.gateway.route.RouteDefinitionRouteLocal#getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后进行合并。
- org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器，与之前的过滤器合并后根据order排序，组织过滤器链。
跨域问题处理
跨域：域名不一致就是跨域：
- 域名不同：www.tabobao.com和www.taobao.org
- 域名相同，端口不同：localhost:8080和localhost:8081
跨域问题：浏览器禁止请求的发起者和服务端发生跨域ajax请求，请求被浏览器拦截的问题。
解决方案：CORS，网关处理跨域采用的同样的是CORS方案，只需要简单配置即可
spring:
cloud:
gateway:
globalcors: # 全局的跨域处理
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
corsConfigurations:
'[/**]':
allowedOrigins: # 允许哪些网站的跨域请求
- "http://localhost:8090"
- "http://www.leyou.com"
allowedMethods: # 允许的跨域ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" # 允许在请求中携带的头信息
allowCredentials: true # 是否允许携带cookie
maxAge: 360000 # 这次跨域检测的有效期