微服务技术二
五、Feign远程调用
之前远程调用使用RestTemplate,代码如下:
String url = "http://xxxservice/xxx接口/" + xxx参数;
User user= restTemplate.getForObject(url, User.class);
使用RestTemplate的缺陷:
- 代码可读性差,编程体验不统一(莫名的url路径)
- 参数复杂时的URL难以维护
Feign是一个声明式的http客户端,官方网址:https://github.com/OpenFeign/feign
Feign替代RestTemplate
使用Feign的步骤:
- 1、引入依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 2、在消费者服务的启动类添加注解开启Feign的功能:
@EnableFeignClients
- 3、编写Feign客户端UserClient 类:
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
- 4、 远程调用示例:
主要是基于SpringMVC的注解来声明远程调用信息,比如:
- 服务名称:userservice
- 请求方式:GET
- 请求路径:/user/{id}
- 请求参数:Long id
- 返回值类型:User
【feign还集成了ribbon,实现了负载均衡】
自定义Feign配置
Feign运行自定义配置来覆盖默认配置,可以修改的配置如下:
类型 | 作用 | 说明 |
---|---|---|
feign.Logger.Level | 修改日志级别 | 包含四种不同的级别:NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 响应结果的解析器 | http远程调用的结果做解析,例如解析json字符串为java对象 |
feign.codec.Encoder | 请求参数编码 | 将请求参数编码,便于通过http请求发送 |
feign.Contract | 支持的注解格式 | 默认是SpringMVC注解 |
feign.Retryer | 失败重试机制 | 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试 |
【一般需要配置的就是日志级别】
配置Feign日志两种方式:【消费者】
方式一:配置文件方式:
- 全局生效:
feign:
client:
config:
default: # 这里用default就是全局配置,如果是写服务名,则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
- 局部生效:
feign:
client:
config:
xxxservice: # 这里写服务名,则是针对某个(xxxservice)微服务的配置
loggerLevel: FULL # 日志级别
方式二:java代码方式
- 1、需要先声明一个Bean:
public class FeignClientConfiguration {
@Bean
public Logger.Level feignLogLevel() {
return Logger.Level.BASIC;
}
}
- 而后如果是全局配置,则把它放到@EnableFeignClients(启动类)这个注解中:
@EnableFeignClients(defaultConfiguration = FeignClientCongiguration.class)
- 如果是局部配置,则把它放到@FeignClient(客户端)这个注解中:
@FeignClient(value = "xxxservice", congiguration = FeignClientConfiguration.class)
Feign性能优化
Feign底层的客户端实现:
- URLConnection:默认实现,不支持连接池
- Apache HttpClient:支持连接池
- OKHttp:支持连接池
优化性能Feign从两个点:
- 使用连接池代替默认的URLConnection
- 日志级别,最好使用basic或none
Feign的性能优化-连接池配置:(消费者)
- 引入依赖,Feign添加HttpClient的支持:
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
- 配置连接池:
feign:
client:
config:
default: # default全局的配置
loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
httpclient:
enable: true # 开启feign对HttpClient的支持
max-connections: 200 # 最大的连接数
max-connections-per-route: 50 # 每个路径的最大连接数
Feign的最佳实践*
- 方式一(继承):给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。
缺陷:紧耦合,不推荐使用 - 方式二(抽取):将FeignClient抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给消费者使用
抽取方式的步骤:
1、首先创建一个module,命名为feign-api,然后引入feign的starter依赖
2、将消费者中编写的客户端、实体类、配置类都复制到fein-api模块中
3、在消费者中引入feign-api的依赖
4、修改消费者服务中的所有与上述三个组件有关的import部分,改成导入feign-api中的包。
5、重启测试。
当定义的FeignClient不在SpringBootApplication的扫描包范围时,这些FeignClient无法使用,两种方式解决:
- 指定FeignClient所在包
@EnableFeignClients(basePackages = "com.jules.feign.clients")
- 方式二:
@EnableFeignClients(clients = {UserClient.class})
六、Gateway网关
网关功能:
- 身份验证和权限校验(一切请求先到 网关,再到微服务)
- 服务路由(根据请求判断去哪个服务)、负载均衡
- 对用户请求做限流
SpringCloud中网关的实现包括两种:
- gateway
- zuul
Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式的编程,性能更好。
搭建网关服务
1、创建新的module,引入SpringCloudGateway的依赖和nacos的服务发现依赖:
<!-- 网关依赖-->
<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、配置application.yml,包括服务基本信息、nacos地址、路由
路由的配置包括;
- 路由id:路由的唯一标示
- 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
- 路由断言 (predicates):判断路由的规则
- 路由过滤器 (filters):对请求或响应做处理
server:
port: 10010 # 网关端口
spring:
application:
name: gateway # 服务名称
cloud:
nacos:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 网关路由配置(可多个)
- id: xxx-service # 路由id,自定义,必须唯一
# uri: http:/127.0.0.1:8081 # 路由的目标地址 http就是固定地址,写死的
uri: lb://xxxservice # 路由的目标地址lb(loadBalance)就是负载均衡,后面跟服务名称
predicates: # 路由断言,就是判断请求是否符合路由规则的条件
- Path=/xxx/** # 这个是按照路径匹配,只要以/xxx/开头就符合
- id: yyy-service
uri: lb://yyyservice
predicates:
- Path=/yyy/**
路由断言工厂Route Predicate Factory
上述配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
路由过滤器 GatewayFilter
GatewayFiler 是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理,提供了31种不同的路由过滤器工厂。
一些路由过滤器工厂:
- AddRequestHeader:给当前请求添加一个请求头
- RemoveRequestHeader:移除请求中一个请求头
- AddResponseHeader:给响应结果中添加一个响应头
- RemoveResponseHeader:从响应结果中移除一个响应头
- RequestRateLimiter:限制请求的流量
- ……
示例:给某一个服务加过滤器
改造测试:
默认过滤器 DefaultFilter
给所有的服务都加上过滤器:
server:
port: 10010 # 网关端口
spring:
application:
name: gateway # 服务名称
cloud:
nacos:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 网关路由配置(可多个)
- id: xxx-service # 路由id,自定义,必须唯一
# uri: http:/127.0.0.1:8081 # 路由的目标地址 http就是固定地址,写死的
uri: lb://xxxservice # 路由的目标地址lb(loadBalance)就是负载均衡,后面跟服务名称
predicates: # 路由断言,就是判断请求是否符合路由规则的条件
- Path=/xxx/** # 这个是按照路径匹配,只要以/xxx/开头就符合
- id: yyy-service
uri: lb://yyyservice
predicates:
- Path=/yyy/**
default-filter: # 默认过滤器,会对所有的路由请求都生效
- AddRequestHeader=Truth, lalalala
全局过滤器 GlobalFilter
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样区别在于GatewayFilter通过配置定义,处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。定义方式是实现ClobalFilter接口。
过滤器示例:
//@Order(-1)
@Component
public class AuthFilter 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)) {
//4.是,放行
return chain.filter(exchange);
}
//5.否,拦截
//5.1.设置状态码
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED); //未认证=401
//5.2.拦截请求
return exchange.getResponse().setComplete();
}
@Override
public int getOrder()
{
return -1;
}
}
过滤器执行顺序
请求路由后,会将当前路由过滤器和DefaultFilter、 GlobalFilter,合并到一个过滤器链 (集合)中,排序后依次执行每个过滤器。
跨域问题解决
网关处理跨域采用的同样是CORS方案,并且只需要简单配置即可实现:
spring:
cloud:
gateway:
globalcors: # 全局的跨域问题
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
corsConfigurations:
'[/**]':
allowedOrigins: # 允许哪些网站的跨域请求
- "http://localhost:端口"
- "http://www.xxx.com"
allowedMethods: # 允许的跨域ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" # 允许在请求中携带的头信息
allowCredentials: true # 是否允许携带cookie
maxAge: 360000 # 这次跨域检测的有效期