您现在的位置是:首页 >技术交流 >Gateway网站首页技术交流

Gateway

xc6 2024-06-14 17:19:07
简介Gateway

Gateway

Nacos配置管理

同一配置管理

在配置管理界面点击+

img

然后填写配置信息

img

配置获取步骤:

img

  1. 引入Nacos的配置管理客户端
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
  1. 在userservice中的resource目录中添加一个bootstrap.yml文件,这个文件是引导文件,优先级高于application.yml:
spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev # 生产环境
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
      config:
        file-extension: yml # 文件后缀

配置自动刷新

第一种方法:

  • 需要在对应controller加上@RefreshScope注解

第二种方法(推荐):

  • 写一个配置类
package cn.itcast.user.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * @author xc
 * @date 2023/5/6 16:22
 */
@Data
@Component
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
    // 使能通过配置文件自动注入
    private String dateformat;
}
  • 然后在controller中通过@Autowire注入后获得

多环境配置共享

微服务启动时会从nacos读取多个配置文件:

无论profile如何变化,[spring.application.name].yml这个文件一定会加载,因此多环境共享配置可以写入这个文件

多环境配置优先级

  • [服务名]-[环境].yml > [服务名].yml > 本地配置

Nacos集群搭建(P30)

Feign远程调用

RestTemplate方式调用存在的问题

  • 代码可读性差,编程体验不统一
  • 参数复杂URL难以维护

Feign的介绍

帮助我们优雅的实现http请求调用

官网:https://github.com/OpenFeign/feign

定义和使用Feign客户端

  1. 导入依赖
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
  1. 开启自动装配功能
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;


@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {

    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }

}
  1. 编写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;

@FeignClient("userservice")
public interface UserClient {
    @GetMapping("user/{id}")
    User findById(@PathVariable("id") Long id);
}
  1. 调用
package cn.itcast.order.service;

import cn.itcast.order.clients.UserClient;
import cn.itcast.order.mapper.OrderMapper;
import cn.itcast.order.pojo.Order;
import cn.itcast.order.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class OrderService {

    @Autowired
    private OrderMapper orderMapper;

    @Autowired
    private UserClient userClient;

	public Order queryOrderById(Long orderId) {
    	// 1.查询订单
    	Order order = orderMapper.findById(orderId);
    	Long userId = order.getUserId();
        // 通过feign调用
    	User user = userClient.findById(userId);
    	order.setUser(user);
    	// 4.返回
    	return order;
	}
}

自定义Feign的配置

img

两种方式:

第一种方式:

  • 全局配置
feign:
	client:
  	config:
    	default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
      	loggerLevel: FULL # 日志级别
  • 局部配置
feign:
	client:
  	config:
    	userservice: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
      	loggerLevel: FULL # 日志级别

第二种方式:

Java代码方式:

先声明Bean

public class FeignClientConfiguration() {
	@Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC;
    }
}
  • 如果是全局配置,则把它放到@EnableFeignClients这个注解中:
@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
  • 如果是局部配置,则把它放到@FeignClient这个注解中:
@FeignClient(value = "userservice",configuration = FeignClientConfiguration.class)

Feign的性能优化

Feign底层的客户端实现:

  • URLConnection:默认实现,不支持连接池
  • Apache HttpClient:支持连接池
  • OKHttp:支持连接池

因此优化Feign的性能主要包括:

  • 使用连接池代替默认的URLConnection
  • 日志级别,最好用basic或none

Feign的性能优化-连接池配置

引入依赖:

      <dependency>
          <groupId>io.github.openfeign</groupId>
          <artifactId>feign-httpclient</artifactId>
      </dependency>

配置连接池:

feign:
  httpclient:
    enabled: true # 支持httpclient的开关
    max-connections: 200 # 最大连接数
    max-connections-per-route: 50 # 单个请求的最大连接数

Feign的最佳实践

方式一(继承):给消费者的FeignClient和提供者的controller定义统一的父接口作为标准

  • 服务紧耦合
  • 父接口参数列表中的映射不会被继承

方式二(抽取):将FeignClient抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用

img

抽取FeignClient

  1. 首先创建一个module,命名为feign-api,然后引入feign的starter依赖
  2. 将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api中
  3. 在order-service中引入feign-api的依赖
  4. 修改order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包
  5. 重启测试

img

Gateway服务网关

为什么需要网关

网关功能

  • 身份认证和权限校验
  • 服务路由、负载均衡
  • 请求限流

img

网关的技术实现

  • gateway
  • zuul

Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。

搭建网关服务

搭建网关服务的步骤:

  1. 创建新的module,引入SpringCloudGateway的依赖和nacos的服务发现依赖:
<!--        nacos服务发现依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
  1. 创建启动类
  2. 编写路由配置及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/开头就符合要求

流程图

img

路由断言工厂Route Predicate Factory

路由配置包括:

  • 路由id:路由的唯一标示
  • uri:路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
  • predicates:判断路由的规则
  • filters:对请求或响应做处理

img

官网:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/

路由过滤器GatewayFilter

GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:

img

Spring提供了31种不同的路由过滤器工厂:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

img

全局过滤器GlobalFilter

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。

区别在于GatewayFilter通过配置定义,处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现

定义方式实现GlobalFilter接口

package cn.itcast.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.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * @author xc
 * @date 2023/5/6 21:26
 */
// 优先级,越小优先级越高
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    /**
     * 处理当前请求,有必要的话通过{@link GatewayApplication}将请求交给下一个过滤器处理
     * @param exchange 请求上下文,里面可以获取Request,Response等信息
     * @param chain 用来把请求委托交给下一个过滤器
     * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> params = request.getQueryParams();
        // 2.获取参数中的authorization参数
        String attribute = params.getFirst("authorization");
        // 3.判断参数值是否等于admin
        if ("xc".equals(attribute)) {
            // 4.是,放行
            return chain.filter(exchange);
        }
        // 5.否,拦截
        // 5.1 设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        // 5.2 拦截请求
        return exchange.getResponse().setComplete();
    }
}

过滤器执行顺序

请求进入网关会碰到三类过滤器:当前路由过滤器、DefaultFilter、GlobalFilter

请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链中,排序后依次执行每个过滤器

img

  • 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前
  • GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
  • 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增
  • 当过滤器的order值一样时,会按照defaultFilter > 路由过滤器 > GlobalFilter顺序执行

img

跨域问题处理

跨域:域名不一致就是跨域,主要包括:

  • 域名不同:www.taobao.com和www.taobao.org
  • 域名相同:端口不同 localhost:8080和localhost:8081

跨域问题:浏览器禁止请求的发起者于服务端发生跨域ajax请求,请求被浏览器拦截问题

解决方案: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 # 这次跨域检测的有效期
gurations:
        	'[/**]':
            	allowedOrigins: # 允许哪些网站跨域请求
              	- "http://localhost:8090"
              	- "http://www.leyou.com"
            	allowedMethods: # 允许的跨域ajax的请求方式
                - "GET"
                - "POST"
                - "DELETE"
                - "PUT"
                - "OPTIONS"
            	allowedHeaders: "*" # 允许在请求中携带的头信息
            	allowCredentials: true # 是否允许携带cookie
            	maxAge: 360000 # 这次跨域检测的有效期
风语者!平时喜欢研究各种技术,目前在从事后端开发工作,热爱生活、热爱工作。