1.Nacos配置管理
Nacos除了可以做注册中心,同样可以做配置管理来使用。
1.1.Nacos安装与配置
1.1.1.下载
官网地址:home (nacos.io)
GitHub->Tags
选择2.2.0版本
1.1.2.安装
将下载的压缩包解压至需要安装的目录,如D:\Program Files。
1.1.3.修改启动文件
将 cluster
修改为standalone
1.1.4.启动Nacos服务
双击运行startup.cmd
1.1.5.访问Nacos服务
浏览器输入http://localhost:8848/nacos并访问,默认的用户名和密码均为"nacos"。此时数据源为Nacos自带的。
1.1.6将数据源改为MySQL数据库
①创建数据库nacos_config
②执行mysql-schema.sql
文件的sql语句
1.1.7修改配置文件
用文本编辑器打开application.properties
编辑内容:35、38、41~43行取消注释,并修改数据库名、用户名和密码。
1.1.8重新启动Nacos服务
发现闪退,查询解决方法
①环境变量的系统变量设置的JAVA_HOME没有用,应该在用户变量也设置JAVA_HOME,不管用
②在配置结尾新增以下内容
pause
endlocal
再次启动,发现问题了!!!
java.lang.IllegalStateException: No DataSource set
数据库连接不上。查看当前用户的权限。
select host,user from user;
发现root用户只能在本地访问。修改root权限为,可以远程登录。
update user set host='%' where user='root';
刷新权限
flush privileges;
权限修改成功
1.1.9访问Nacos服务
浏览器输入http://localhost:8848/nacos并访问,默认的用户名和密码均为"nacos"。
1.2.统一配置管理
当微服务部署的实例越来越多,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。Nacos一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。
1.2.1.在Nacos中添加配置文件
然后在弹出的表单中,填写配置信息:
1.1.2.从微服务拉取配置
微服务要拉取nacos中管理的配置,并且与本地的application.yml配置合并,才能完成项目启动。
但如果尚未读取application.yml,又如何得知nacos地址呢?
因此spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取。
①引入nacos-config依赖
首先,在manage-api服务中,引入nacos-config的客户端依赖:
<!--nacos配置管理依赖-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>2.2.6.RELEASE</version>
</dependency>
②添加bootstrap.yaml
然后,在manage-api中添加一个bootstrap.yaml文件,内容如下:
spring:
profiles:
active: dev
application:
name: manage-api
cloud:
nacos:
server-addr: localhost:8848
config:
file-extension: yaml
这里会根据spring.cloud.nacos.server-addr获取nacos地址,再根据${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id,来读取配置。本例中,就是去读取manage-api-dev.yaml。
③读取nacos配置
在manage-api中的UserApi中添加业务逻辑,读取pattern.dateformat配置:
@RequestMapping(value = "/v1/user")
@RestController
@AllArgsConstructor
@Tag(name = "用户接口", description = "用户接口")
public class UserApi {
@Value("${pattern.dateformat}")
private String dateformat;
@GetMapping("now")
public String now(){
return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
}
}
启动报错:org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'configurationPropertiesBeans' defined in class path resource
原因:spring-boot的版本与nacos版本不一致
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.3.RELEASE</version>
<relativePath/>
</parent>
<dependencies>
<!--nacos配置管理依赖-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>2.2.3.RELEASE</version>
</dependency>
</dependencies>
启动报错:org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'userApi': Injection of autowired dependencies failed; nested exception is java.lang.IllegalArgumentException: Could not resolve placeholder 'pattern.dateformat' in value "${pattern.dateformat}
加入注解
<!-- 自动读取配置文件,赋值给成员变量依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
1.2.2.配置热更新
我们最终的目的,是修改nacos中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新。要实现配置热更新,可以使用两种方式:
①在@Value注入的变量所在类上添加注解@RefreshScope
②使用@ConfigurationProperties注解代替@Value注解
在manage-api服务中,添加一个类,读取patterrn.dateformat属性:
package com.manage.application.api.annotation;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@Data
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
private String dateformat;
}
@RequestMapping(value = "/v1/user")
@RestController
@RequiredArgsConstructor
@Tag(name = "用户接口", description = "用户接口")
public class UserApi {
@Autowired
private PatternProperties dateformat;
@GetMapping("now")
@Operation(summary = "获取当前时间", description = "获取当前时间")
public String now(){
return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat.getDateformat()));
}
}
1.3.配置共享
其实微服务启动时,会去nacos读取多个配置文件,例如:
- [spring.application.name]-[spring.profiles.active].yaml,例如:manage-api-dev.yaml
- [spring.application.name].yaml,例如:manage-api.yaml
由于[spring.application.name].yaml不包含环境,因此可以被多个环境共享。
①添加一个环境共享配置
②在manage-api中读取共享配置
③修改不同的spring.profiles.active,使用不同的profile
dev:
sit:
不管是dev,还是sit,都读取到了envSharedValue这个属性的值。
2.Feign远程调用
Feign是一个声明式的http客户端,作用就是帮助我们优雅的实现http请求的发送。
2.1.Feign替代RestTemplate
Fegin的使用步骤如下:
2.1.1.引入依赖
我们在服务的pom文件中引入feign的依赖:
<!-- Feign远程调用客户端 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2.1.2.开启Feign自动装配
在的启动类上添加注解 @EnableFeignClients
2.1.3.声明远程调用
Feign 采用了 Spring MVC 的注解的方式发起远程调用。只需要把发 HTTP 请求的信息声明在一个接口中,并添加注解 @FeignClient("微服务名称")
,Feign 就会自动为我们发起 HTTP 请求。通常需要声明的信息如下。
@FeignClient("cloud-auth-server")
public interface UserFegin {
@GetMapping("/auth/oauth/findByName")
CommonResult<OAuthUser> findByName(@PathVariable("name") String name);
}
3.Gateway服务网关
3.1.为什么需要网关
Gateway网关是我们服务的守门神,所有微服务的统一入口。
网关的核心功能特性: 请求路由、权限控制、限流
- 权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
- 路由和负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
- 限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。
在SpringCloud中网关的实现包括两种: gateway和zuul。 Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。
3.2.gateway快速入门
下面,我们就演示下网关的基本路由功能。
3.2.1.创建gateway服务,引入依赖
①创建服务
②引入依赖
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.1</version>
<relativePath/>
</parent>
<properties>
<spring-cloud.version>2021.0.8</spring-cloud.version>
</properties>
<dependencies>
<!--网关-->
<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>
<version>2.2.3.RELEASE</version>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
③编写启动类
package com.example.gatewayapi;
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);
}
}
④编写基础配置和路由规则
# 网关端口
server:
port: 10010
spring:
application:
name: gateway
cloud:
nacos:
server-addr: localhost:8848
gateway:
# 网关路由配置
routes:
# 路由id,自定义,只要唯一即可
- id: gateway-api
# 路由的目标地址 lb就是负载均衡,后面跟服务名称
uri: lb://gateway-api
# 路由断言,也就是判断请求是否符合路由规则的条件
predicates:
# 这个是按照路径匹配,只要以/user/开头就符合要求
- Path=/v1/gateway-api/**
-
路由id:路由的唯一标示
-
路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
-
路由断言(predicates):判断路由的规则
-
路由过滤器(filters):对请求或响应做处理
⑤在nacos注册
⑥启动
报错Parameter 0 of method loadBalancerWebClientBuilderBeanPostProcessor in org.springframework.cloud.client.loadbalancer.reactive.LoadBalancerBeanPostProcessorAutoConfiguration required a bean of type 'org.springframework.cloud.client.loadbalancer.reactive.DeferringLoadBalancerExchangeFilterFunction' that could not be found
主要原因是springboot版本高了,引入负载均衡依赖
<!--负载均衡-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>
重启成功
⑦测试
重启网关,访问localhost:10010/v1/gateway-api/hello时,符合/v1/gateway-api/**
规则,请求转发到uri:http://gateway-api/v1/gateway-api/hello,得到了结果:
3.3过滤器工厂
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
3.4.1.路由过滤器的种类
Spring提供了31种不同的路由过滤器工厂。例如:
- AddRequestHeader:给当前请求添加一个请求头
- RemoveRequestHeader:移除请求中的一个请求头
- AddResponseHeader:给响应结果中添加一个响应头
- RemoveResponseHeader:从响应结果中移除有一个响应头
- RequestRateLimiter:限制请求的流量
3.4.2.请求头过滤器
下面我们以AddRequestHeader 为例来讲解
需求:给所有进入userservice的请求添加一个请求头:Truth=itcast is freaking awesome!
只需要修改gateway服务的application.yml文件,添加路由过滤即可:
# 网关端口
server:
port: 10010
spring:
application:
name: gateway
cloud:
nacos:
server-addr: localhost:8848
gateway:
# 网关路由配置
routes:
# 路由id,自定义,只要唯一即可
- id: gateway-api
# 路由的目标地址 lb就是负载均衡,后面跟服务名称
uri: lb://gateway-api
# 路由断言,也就是判断请求是否符合路由规则的条件
predicates:
# 这个是按照路径匹配,只要以/user/开头就符合要求
- Path=/v1/gateway-api/**
filters: # 过滤器
- AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头
当前过滤器写在gateway-api路由下,因此仅仅对访问gateway-api的请求有效。
3.4.3.默认过滤器
如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:
# 网关端口
server:
port: 10010
spring:
application:
name: gateway
cloud:
nacos:
server-addr: localhost:8848
gateway:
# 网关路由配置
routes:
# 路由id,自定义,只要唯一即可
- id: gateway-api
# 路由的目标地址 lb就是负载均衡,后面跟服务名称
uri: lb://gateway-api
# 路由断言,也就是判断请求是否符合路由规则的条件
predicates:
# 这个是按照路径匹配,只要以/user/开头就符合要求
- Path=/v1/gateway-api/**
default-filters: # 默认过滤项
- AddRequestHeader=Truth, Itcast is freaking awesome!
过滤器的作用:对路由的请求或响应做加工处理,比如添加请求头;配置在路由下的过滤器只对当前路由的请求生效
defaultFilters的作用:对所有路由都生效的过滤器
3.5.全局过滤器
3.5.1.全局过滤器作用
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。定义方式是实现GlobalFilter接口。
package com.example.gatewayapi.demos.web.filter;
import jdk.nashorn.internal.runtime.logging.Logger;
import lombok.extern.log4j.Log4j2;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Component
@Log4j2
public class PrintAnyGatewayFilterFactory extends AbstractGatewayFilterFactory<Object> {
@Override
public GatewayFilter apply(Object config) {
return new GatewayFilter() {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 获取请求
ServerHttpRequest request = exchange.getRequest();
// 编写过滤器逻辑
log.info("过滤器执行了");
// 放行
return chain.filter(exchange);
}
};
}
}
在filter中编写自定义逻辑,可以实现登录状态判断、权限校验、请求限流等功能
3.5.2.自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
- 参数中是否有authorization
- authorization参数值是否为admin
如果同时满足则放行,否则拦截。在gateway中定义一个过滤器:
package com.example.gatewayapi.demos.web.filter;
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.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 1.获取请求参数
MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
// 2.获取authorization参数
String auth = params.getFirst("authorization");
// 3.校验
if ("admin".equals(auth)) {
// 放行
return chain.filter(exchange);
}
// 4.拦截
// 4.1.禁止访问,设置状态码
exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
// 4.2.结束处理
return exchange.getResponse().setComplete();
}
}
3.5.3.过滤器执行顺序
请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器。
排序规则:
- 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
- GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
- 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
3.6.登录校验
3.6.1JWT工具
登录校验需要用到JWT,而且JWT的加密需要秘钥和加密工具。
3.7.跨域问题
3.6.1.什么是跨域问题
跨域:域名不一致就是跨域,主要包括:
- 域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
- 域名相同,端口不同:localhost:8080和localhost8081
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题
解决方案:CORS
3.7.2.解决跨域问题
在gateway服务的application.yml文件中,添加下面的配置:
gateway:
# 网关路由配置
globalcors: # 全局的跨域处理
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
corsConfigurations:
'[/**]':
# 允许哪些网站的跨域请求
allowedOrigins:
- "http://localhost:8090"
# 允许的跨域ajax的请求方式
allowedMethods:
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
# 允许在请求中携带的头信息
allowedHeaders: "*"
# 是否允许携带cookie
allowCredentials: true
# 这次跨域检测的有效期
maxAge: 360000
3.7.网关限流
3.7.1 为什么要限流
3.7.2 限流算法
常见的限流算法有以下三种:
- 计数器算法
- 漏桶算法(Leaky Bucket)
- 令牌桶算法 (Token Bucket)
3.8 Gateway限流
Spring Cloud Gateway
官方提供了 RequestRateLimiterGatewayFilterFactory
过滤器工厂,使用 Redis
和Lua
脚本实现了令牌桶的方式
3.8.1 注入依赖
<!--spring data redis reactive 依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis-reactive</artifactId>
</dependency>
<!--commons-pool2 对象池依赖-->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
3.8.2 配置 yml 文件
# 网关端口
server:
port: 10010
spring:
application:
name: gateway
redis:
# Redis数据库索引(默认为0)
database: 0
# Redis服务器地址
host: localhost
# Redis服务器连接端口
port: 6379
# Redis服务器连接密码(默认为空)
password:
jedis:
pool:
# 连接池最大连接数(使用负值表示没有限制) 默认 8
max-active: 8
# 连接池最大阻塞等待时间(使用负值表示没有限制) 默认 -1
max-wait: -1
# 连接池中的最大空闲连接 默认 8
max-idle: 8
# 连接池中的最小空闲连接 默认 0
min-idle: 0
# 连接超时时间(毫秒)
timeout: 1000
cloud:
nacos:
server-addr: localhost:8848
gateway:
# 网关路由配置
globalcors: # 全局的跨域处理
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
corsConfigurations:
'[/**]':
# 允许哪些网站的跨域请求
allowedOrigins:
- "http://localhost:8090"
# 允许的跨域ajax的请求方式
allowedMethods:
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
# 允许在请求中携带的头信息
allowedHeaders: "*"
# 是否允许携带cookie
allowCredentials: true
# 这次跨域检测的有效期
maxAge: 360000
routes:
# 路由id,自定义,只要唯一即可
- id: gateway-api
# 路由的目标地址 lb就是负载均衡,后面跟服务名称
uri: lb://gateway-api
# 路由断言,也就是判断请求是否符合路由规则的条件
predicates:
# 这个是按照路径匹配,只要以/user/开头就符合要求
- Path=/v1/gateway-api/**
predicates:
- Path=/order/**
filters: # 过滤器
- name: RequestRateLimiter
args:
#令牌桶每秒填充数量
redis-rate-limiter.replenishRate: 1
#令牌桶总容量
redis-rate-limiter.burstCapacity: 2
#使用SpEL表达式按名称引用 bean
key-resolver: "#{@ipKeyResolver}"
hm:
jwt:
location: classpath:hmall.jks # 秘钥地址
alias: hmall # 秘钥别名
password: hmall123 # 秘钥文件密码
tokenTTL: 30m # 登录有效期
auth:
excludePaths: # 无需登录校验的路径
- /search/**
- /users/login
- /items/**
3.8.3 限流规则
① URI 限流
/**
* @title URI 限流
* @description 验证Gateway的 URI 限流
* JDK 1.8
*
*/
@Bean
public KeyResolver pathKeyResolver(){
return exchange -> Mono.just(exchange.getRequest().getURI().getPath());
}
② 参数限流
/**
* @title 参数 限流
* @description 验证Gateway的 参数 限流
* JDK 1.8
*
*/
@Bean
public KeyResolver paramemterKeyResolver(){
return exchange -> Mono.just(Objects.requireNonNull(exchange.getRequest().getQueryParams().getFirst("id")));
}
③ IP限流
/**
* @title IP 限流
* @description 验证Gateway的 IP 限流
* JDK 1.8
*
*/
@Bean
public KeyResolver ipKeyResolver(){
return exchange -> Mono.just(Objects.requireNonNull(exchange.getRequest().getRemoteAddress()).getHostName());
}
3.9 Hystrix熔断
3.9.1 maven依赖导入
<!-- Hystrix 依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
<version>2.2.9.RELEASE</version>
</dependency>
3.9.2 设置yml文件
filters:
- name: Hystrix
args:
name: fallbackcmd
fallbackUri: forward:/fallback #返回路径
hystrix.command.fallbackcmd.execution.isolation.thread.timeoutInMilliseconds: 3000
3.9.3 设置/fallback路径
@RestController
public class DefaultHystrixController{
@RequestMapping(value = "/fallback",method = RequestMethod.GET)
public String fallback(){
log.info("fallback****Gateway");
return "welcome to fallback";
}
}