【SpringCloud】 微服务常用组件的pom依赖及配置
1. Eureka
1.1 Eureka服务端
Eureka服务端需要单独新建一个服务,启动服务后访问:http://127.0.0.1:10086
1.1.1 Eureka的服务端依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
1.1.2 Eureka的服务端配置
server:
port: 10086
spring:
application:
name: eureka-server
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:10086/eureka
1.2 Eureka客户端
Eureka客户端就是各个微服务
1.2.1 Eureka的客户端依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
1.2.2 Eureka的客户端配置
spring:
application:
name: 服务名
eureka:
client:
service-url:
#eureka服务的url地址
defaultZone: http://127.0.0.1:10086/eureka
2. Ribbon
2.1 Ribbon定义负载均衡规则的两种方式
- 编码方式
- yml配置方式
2.1.1编码方式
在配置类里定义一个新的 IRule
:
@Bean
public IRule randomRule(){
return new RandomRule();
}
2.1.2 yml配置方式
# 给某个微服务配置负载均衡规则,这里是userservice服务
userservice:
ribbon:
NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RandomRule # 负载均衡规则
注意:一般用默认的负载均衡规则(轮询),不做修改。
2.2 饥饿加载
Ribbon默认是采用懒加载,即第一次访问时才会去创建 LoadBalanceClient
,请求时间会很长。
而饥饿加载则会在项目启动时创建,降低第一次访问的耗时,通过下面配置开启饥饿加载:
ribbon:
eager-load:
enabled: true
clients: userservice
3. Nacos
Nacos和Eureka功能类似,都拥有 服务注册,服务发现 的功能,但是Nacos还有作为 配置中心 的功能。
3.1 Nacos的相关依赖
因为Nacos是SpringCloud的组件,所以我们需要在父工程中引入 SpringCloudAlibaba
的依赖(版本自选):
<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>
Nacos和Eureka不太一样,Nacos没有什么服务端和客户端,也不需要单开一个服务来运行它。我们只需要在每一个服务中添加如下依赖即可:
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
3.2 Nacos的配置
在每个微服务的配置文件中添加nacos的地址:
spring:
cloud:
nacos:
server-addr: localhost:8848
3.3 微服务集群
假设一个微服务 user-service
打算做集群,一个集群在HZ,一个集群在SH 。
添加集群配置:
假设多个实例以如下配置启动
spring:
cloud:
nacos:
server-addr: localhost:8848
discovery:
# 集群名称
cluster-name: HZ
再次启动多个实例,改变如下属性,port的值每次都需要不同:
-Dserver.port=8083 -Dspring.cloud.nacos.discovery.cluster-name=SH
3.4 同集群优先的负载均衡
默认的ZoneAvoidanceRule
并不能实现根据同集群优先来实现负载均衡。因此Nacos中提供了一个NacosRule
的实现,可以优先从同集群中挑选实例。
我们上面的服务提供者 user-service
已经配置了两个集群,我们再配置一个服务消费者 order-service
集群。
1)添加集群配置:
spring:
cloud:
nacos:
server-addr: localhost:8848
discovery:
cluster-name: HZ # 集群名称
2)修改负载均衡规则
修改order-service的配置文件,修改负载均衡规则:
userservice:
ribbon:
# 负载均衡规则
NFLoadBalancerRuleClassName: com.alibaba.cloud.nacos.ribbon.NacosRule
修改完毕,相同集群的服务消费者会优先调用相同集群的服务提供者,如:HZ集群的order-service会优先调用HZ集群的user-service,当HZ集群的user-service都下线了,HZ集群的order-service才会跨集群去调用SH的user-service。
3.5 权重配置
实际部署中会出现这样的场景:
服务器设备性能有差异,部分实例所在机器性能较好,另一些较差,我们希望性能好的机器承担更多的用户请求。
但默认情况下NacosRule是同集群内随机挑选,不会考虑机器的性能问题。因此,Nacos提供了权重配置来控制访问频率,权重越大则访问频率越高。在nacos控制台,找到user-service的实例列表,点击编辑,即可修改权重,权重值区间为[0,1],若权重为0,则永不调用。
3.6 环境隔离
Nacos提供了namespace来实现环境隔离功能。
namespace>group>service/data
- nacos中可以有多个namespace
- namespace下可以有group、service等
- 不同namespace之间相互隔离,例如不同namespace的服务互相不可见
3.6.1 创建命名空间(namespace)
登录nacos管理页面,在左侧菜单栏中点击 命名空间(默认所有的service,data,group都在同一个namespace,名为public)。再点击 新建命名空间 ,填写表单,假设“命名空间名”填“dev”,“描述”随便填,再点击确定就能在页面中看到一个名为“dev”的namespace,复制 命名空间ID 用于配置。
3.6.2 给微服务配置命名空间(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为dev,而user-service的namespace为public。所以会导致order-service找不到user-service,控制台会报错。
3.7. Nacos和Eureka的区别
Nacos的服务实例分为两种类型:
- 临时实例(默认):如果实例宕机超过一定时间,会从服务列表剔除。
- 非临时实例(永久实例):如果实例宕机,不会从服务列表剔除。
配置一个服务实例为永久实例:
spring:
cloud:
nacos:
discovery:
# 设置为非临时实例
ephemeral: false
Nacos和Eureka整体结构类似,服务注册、服务拉取、心跳等待,但是也存在一些差异:
-
Nacos与eureka的共同点
- 都支持服务注册和服务拉取
- 都支持服务提供者心跳方式做健康检测
-
Nacos与Eureka的区别
- Nacos支持服务端主动检测提供者状态:临时实例采用心跳模式,非临时实例采用主动检测模式
- 临时实例心跳不正常会被剔除,非临时实例则不会被剔除
- Nacos支持服务列表变更的消息推送模式,服务列表更新更及时
- Nacos集群默认采用AP方式,当集群中存在非临时实例时,采用CP模式;Eureka采用AP方式
4. Feign
我们之前使用 RestTemplate
发起远程调用的代码如下:
//2.1.url路径
String url="http://userservice/user/"+ order.getUserId();
//2.2.发起请求,实现远程调用
User user = restTemplate.getForObject(url,User.class);
以上代码存在以下问题:
- 代码可读性差,编程体验不统一
- 参数复杂,URL难以维护
而Feign作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。
4.1 Feign的依赖
1)添加依赖
我们使用 Feign
替代 RestTemplate
,在服务消费者中添加如下依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2)添加注解
我们在服务消费者的启动类上添加注解来开启Feign的功能(多余注解和代码已省略):
@EnableFeignClients
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
}
3)编写Feign的客户端
在order-service中新建一个接口,内容如下:
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
- 服务名称:userservice
- 请求方式:GET
- 请求路径:/user/{id}
- 请求参数:Long id
- 返回值类型:User
这样,Feign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。
4)测试
我们修改之前通过 RestTemplate
请求User的代码,使用Feign客户端替代:
//2.用Feign远程调用
User user = userClient.findById(order.getUserId());
这样就解决了之前代码可读性差,风格不统一的问题。
5)总结
使用Feign的步骤:
① 引入依赖
② 添加@EnableFeignClients注解
③ 编写FeignClient接口
④ 使用FeignClient中定义的方法代替RestTemplate
4.2 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的重试 |
一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。
4.2.1 Feign的日志级别配置
基于配置文件修改feign的日志级别可以针对单个服务:
feign:
client:
config:
# 针对某个微服务的配置
userservice:
# 日志级别
loggerLevel: FULL
也可以针对所有服务:
feign:
client:
config:
# 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
default:
# 日志级别
loggerLevel: FULL
而日志的级别分为四种:
- NONE:不记录任何日志信息,这是默认值。
- BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
- HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
- FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
4.2.2 编码实现日志配置
可以通过java代码来修改日志级别,声明一个类,然后向容器中注入一个Logger.Level的对象:
public class DefaultFeignConfiguration {
@Bean
public Logger.Level feignLogLevel(){
// 日志级别为BASIC
return Logger.Level.BASIC;
}
}
如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中:
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)
如果是局部生效,则把它放到对应的@FeignClient这个注解中:
@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)
4.3 Feign优化
Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:
•URLConnection:默认实现,不支持连接池
•Apache HttpClient :支持连接池
•OKHttp:支持连接池
为提高Feign的性能,我们使用支持 连接池 的Apache HttpClient代替URLConnection。
1)引入Apache HttpClient依赖
<!--httpClient的依赖 -->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
2)配置连接池
在order-service的application.yml中添加如下配置:
feign:
client:
config:
# default全局的配置
default:
# 日志级别,BASIC就是基本的请求和响应信息
loggerLevel: BASIC
httpclient:
# 开启feign对HttpClient的支持
enabled: true
# 最大的连接数
max-connections: 200
# 每个路径的最大连接数
max-connections-per-route: 50
3) 总结
Feign的优化:
1.日志级别尽量用basic
2.使用HttpClient或OKHttp代替URLConnection
① 引入feign-httpClient依赖
② 配置文件开启httpClient功能,设置连接池参数
4.4 代码架构设计
自习观察可以发现,Feign的客户端与服务提供者的controller代码非常相似:
feign客户端:
@FeignClient("userservice")
public interface UserClient{
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
服务提供者的UserController:
@GetMapping("/user/{id}")
User queryById(@PathVariable("id") Long id){
return userService.queryById(id);
}
我们发现相同含义的代码,我们在客户端编写了一遍在服务提供者内又写了一遍,这样的代码就显得有点冗余了。
为精炼代码,有以下两种方式:
- 继承方式
- 抽取方式(推荐)
4.4.1 继承方式
一样的代码与其写两遍,不如编写一个接口,把方法写在接口当中,再让双方都 继承/实现 它。
1)定义一个API接口,利用定义方法,并基于SpringMVC注解做申明。
2)Feign客户端和服务提供者都继承/实现该接口。
优点:
- 简单
- 实现了代码共享
缺点:
- 服务提供者和服务消费者紧耦合
- 参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法、参数列表、注解。
4.4.2 抽取方式
将Feign的Client抽取为独立模块,即一个新的服务,并把接口有关的POJO 、默认的Feign配置都放到这个模块中,提供给服务消费者使用。
例如,将UserClient、User、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。
1)在父工程下创建一个新的moudle,命名为feign-api
2)在feign-api中引入依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
3)然后,order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
4)删除order-service中所有feign有关的类或接口,在order-service的pom文件中中引入feign-api的依赖:
<dependency>
<groupId>cn.itcast.demo</groupId>
<artifactId>feign-api</artifactId>
<version>1.0</version>
</dependency>
5)重启发现报错,那是因为修改之后UserClient现在在 cn.itcast.feign.clients
包下,而order-service的 @EnableFeignClients
注解在 cn.itcast.order
包下,order-service的注解扫不到不在同一个包下的Component。
6)解决扫描包问题
方式一:
指定Feign应该扫描的包:
@EnableFeignClients(basePackages = "cn.itcast.feign.clients")
方式二:
指定需要加载的Client接口:
@EnableFeignClients(clients = {UserClient.class})
5. Gateway服务网关
Gateway网关是我们服务的守门神,所有微服务的统一入口。
5.1 Gateway核心功能
网关的核心功能特性:
- 请求路由
- 权限控制
- 限流
架构图:
5.1.1 请求路由
一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由 。当然路由的目标服务有多个时,还需要做负载均衡。
5.1.2 权限控制
网关作为微服务入口,需要校验用户是否有请求资格,如果没有则进行拦截。
5.1.3 限流
当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行,避免服务压力过大。
5.2 Gateway的依赖和基础配置
Gateway的依赖:
<!--网关-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
基本配置:
server:
# 网关端口
port: 10010
spring:
application:
# 服务名称
name: gateway
cloud:
nacos:
# nacos地址
server-addr: localhost:8848
gateway:
# 网关路由配置
routes:
# 路由id,自定义,只要唯一即可
- id: user-service
# 路由的目标地址 http就是固定地址
# uri: http://127.0.0.1:8081
# 路由的目标地址 lb就是负载均衡,后面跟服务名称
uri: lb://userservice
# 路由断言,也就是判断请求是否符合路由规则的条件
predicates:
# 这个是按照路径匹配,只要以/user/开头就符合要求
- Path=/user/**
我们将符合Path
规则的一切请求,都代理到 uri
参数指定的地址。
本例中,我们将 /user/**
开头的请求,代理到lb://userservice
,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
5.3 网关路由的流程图
整个访问的流程如下:
总结:
网关搭建步骤:
-
创建项目,引入nacos服务发现和gateway依赖
-
配置application.yml,包括服务基本信息、nacos地址、路由
路由配置包括:
- 路由id:路由的唯一标示
- 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
- 路由断言(predicates):判断路由的规则,
- 路由过滤器(filters):对请求或响应做处理
5.4 断言工厂
我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
例如Path=/user/**是按照路径匹配,这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory
类来
处理的,像这样的断言工厂在SpringCloudGateway还有十几个:
名称 | 说明 | 示例 |
---|---|---|
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.org,.anotherhost.org |
Method | 请求方式必须是指定方式 | - Method=GET,POST |
Path | 请求路径必须符合指定规则 | - Path=/red/{segment},/blue/** |
Query | 请求参数必须包含指定参数 | - Query=name, Jack或者- Query=name |
RemoteAddr | 请求者的ip必须是指定范围 | - RemoteAddr=192.168.1.1/24 |
Weight | 权重处理 |
我们只需要掌握Path这种路由工程就可以了。
5.5 过滤器工厂
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
5.5.1 路由过滤器种类
Spring提供了31种不同的路由过滤器工厂。例如:
名称 | 说明 |
---|---|
AddRequestHeader | 给当前请求添加一个请求头 |
RemoveRequestHeader | 移除请求中的一个请求头 |
AddResponseHeader | 给响应结果中添加一个响应头 |
RemoveResponseHeader | 从响应结果中移除有一个响应头 |
RequestRateLimiter | 限制请求的流量 |
5.5.1.1 请求头过滤器
以 AddRequestHeader
为例。
需求:给所有进入user-service的请求添加一个请求头:Truth=itcast is freaking awesome!
在gateway服务的配置文件中添加如下配置:
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
# 过滤器
filters:
# 添加请求头
- AddRequestHeader=Truth, Itcast is freaking awesome!
当前过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效。
5.5.1.2 默认过滤器
如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:
spring:
cloud:
gateway:
default-filters: # 默认过滤项
- AddRequestHeader=Truth, Itcast is freaking awesome!
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
5.5.1.3 总结
过滤器的作用是什么?
① 对路由的请求或响应做加工处理,比如添加请求头
② 配置在路由下的过滤器只对当前路由的请求生效
defaultFilters的作用是什么?
① 对所有路由都生效的过滤器
5.6 全局过滤器
我们已经知道spring-cloud-gateway提供了31种过滤器,但这31种过滤器的作用是固定,我们无法进行相关业务逻辑修改。
5.6.1 全局过滤器作用
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与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中编写自定义逻辑,可以实现下列功能:
- 登录状态判断
- 权限校验
- 请求限流等
5.6.2 自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
-
参数中是否有authorization,
-
authorization参数值是否为admin
如果同时满足则放行,否则拦截
实现:
在gateway项目的包下定义一个过滤器:
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
@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);
//5.2拦截请求
return exchange.getResponse().setComplete();
}
}
5.6.3 过滤器执行顺序
请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
我认为过滤器的粒度越高,或者说功能越细化,过滤器执行的顺序越偏后。
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:
排序的规则是什么呢?
- 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
- GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
- 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
- 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
详细内容,可以查看源码:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()
方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()
方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链
5.7 跨域问题
5.7.1 什么是跨域问题?
跨域:域名不一致就是跨域,主要包括:
-
域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
-
域名相同,端口不同:localhost:8080和localhost8081
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题,但是通过接口测试工具就不会被拦截。
5.7.2 解决跨域问题
在gateway服务的配置文件中添加如下配置:
spring:
cloud:
gateway:
# 全局的跨域处理
globalcors:
# 解决options请求被拦截问题
add-to-simple-url-handler-mapping: true
corsConfigurations:
'[/**]':
# 允许哪些网站的跨域请求
allowedOrigins:
- "http://localhost:8090"
# 允许的跨域ajax的请求方式
allowedMethods:
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
# 允许在请求中携带的头信息
allowedHeaders: "*"
# 是否允许携带cookie
allowCredentials: true
# 这次跨域检测的有效期
maxAge: 360000