day02 Nacos集群配置、Feign远程调用和统一网关Gateway

1、Nacos配置管理

Nacos除了可以做注册中心,同样可以做配置管理来使用。

统一配置管理

当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第1张图片

Nacos一方面可以将配置进行集中管理,另一方面可以在配置变更时,及时通知微服务,实现配置的热更新。

在Nacos中创建配置

  • 在 Nacos 控制面板中添加配置文件:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第2张图片

  • 然后在弹出的表单中,填写配置信息:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第3张图片

注意:项目的核心配置,需要热更新的配置才有放到nacos管理的必要。其他基本不会发生变更的一些配置还是保存在微服务本地比较好。

微服务拉取Nacos配置

首先我们需要了解 Nacos 读取配置文件的环节是在哪一步,在没加入 Nacos 配置之前,获取配置是这样:

Untitled

加入 Nacos 配置,它的读取是在 application.yml 之前的:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第4张图片

这时候如果把 nacos 地址放在 application.yml 中显然是不合适的,因为这样 Nacos 就无法根据地址去获取配置了。

因此 Spring 引入了一种新的配置文件:bootstrap.yaml 文件,它的优先级会比 application.yml 高很多,所以会在 application.yml 之前被读取,流程如下:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第5张图片

1、引入Nacos的配置管理客户端依赖:


<dependency>
    <groupId>com.alibaba.cloudgroupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-configartifactId>
dependency>

2、在 userservice 中的 resource 目录下添加一个 bootstrap.yaml 文件,这个文件是引导文件,它的优先级高于 application.yml:

注意:application.yml 中相同的配置记得注释掉!

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev #开发环境,这里是dev 
  cloud:
    nacos:
      server-addr: 1.12.65.61:8848 # Nacos服务地址
      config:
        file-extension: yaml # 文件后缀名

这里会根据 spring.cloud.nacos.server-addr 获取nacos地址,再根据

${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id,来读取配置。

本例中,就是去读取userservice-dev.yaml

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第6张图片

3、读取 Nacos 配置

在 user-service 中的UserController中添加业务逻辑,读取pattern.dateformat配置:

@Value("${pattern.dateformat}")
private String dateformat;

@GetMapping("/now")
public String now() {
    //格式化时间
    return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
}

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第7张图片

4、在页面访问,可以看到效果:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第8张图片

配置热更新

我们最终的目的是修改 nacos 中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新

要实现配置热更新,可以使用两种方式来实现:

@RefreshScope

方式一:在@Value注入的变量所在类上添加注解@RefreshScope

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第9张图片

@ConfigurationProperties(推荐)

方式二:使用 @ConfigurationProperties 注解读取配置文件,就不需要加 @RefreshScope 注解。

在 user-service 服务中,添加一个 PatternProperties 类,读取 patterrn.dateformat 属性

@Component
@Data
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {

    private String dateformat;

}
@Autowired
private PatternProperties properties;

@GetMapping("/now")
public String now() {
    //格式化时间
    return LocalDateTime.now().format(DateTimeFormatter.ofPattern(properties.getDateformat()));
}

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第10张图片

多环境配置共享

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

  • [spring.application.name]-[spring.profiles.active].yaml,例如:userservice-dev.yaml
  • spring.application.name].yaml,例如:userservice.yaml

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

添加一个环境共享配置

我们在 nacos 中添加一个 userservice.yaml 文件:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第11张图片

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第12张图片

在user-service中读取共享配置

在 user-service 服务中,修改 PatternProperties 类,读取新添加的属性:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第13张图片

在 user-service 服务中,修改 UserController,添加一个方法:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第14张图片

运行两个UserApplication,使用不同的 profile(环境)

修改 UserApplication2 这个启动项,改变其 profile 值:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第15张图片

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第16张图片

这样,UserApplication(8081)使用的 profile(环境) 是 dev,UserApplication2(8082)使用的 profile(huang’j) 是 test

启动 UserApplication 和 UserApplication2

访问地址:http://localhost:8081/user/prop,结果:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第17张图片

访问地址:http://localhost:8082/user/prop,结果:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第18张图片

多种配置的优先级

当 nacos、服务本地同时出现相同属性时,优先级有高低之分:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第19张图片

更细致的配置:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第20张图片

总结

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第21张图片

搭建Nacos集群

Nacos生产环境下一定要部署为集群状态。

架构介绍

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第22张图片

其中包含3个 Nacos 节点,然后一个负载均衡器代理3个 Nacos。这里负载均衡器可以使用 Nginx。

我们计划的集群结构如下图,MySQL 的主从复制后续再添加。

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第23张图片

三个 Nacos 节点的地址:

Untitled

搭建集群的基本步骤:

  • 搭建数据库,初始化数据库表结构
  • 下载nacos安装包
  • 配置nacos
  • 启动nacos集群
  • nginx反向代理

初始化数据库

Nacos 默认数据存储在内嵌数据库 Derby 中,不属于生产可用的数据库。官方推荐的最佳实践是使用带有主从的高可用数据库集群。这里我们先以单点的数据库为例。

首先新建一个数据库,命名为 nacos,而后导入下面的 SQL

CREATE TABLE `config_info` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
  `data_id` varchar(255) NOT NULL COMMENT 'data_id',
  `group_id` varchar(255) DEFAULT NULL,
  `content` longtext NOT NULL COMMENT 'content',
  `md5` varchar(32) DEFAULT NULL COMMENT 'md5',
  `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
  `src_user` text COMMENT 'source user',
  `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',
  `app_name` varchar(128) DEFAULT NULL,
  `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',
  `c_desc` varchar(256) DEFAULT NULL,
  `c_use` varchar(64) DEFAULT NULL,
  `effect` varchar(64) DEFAULT NULL,
  `type` varchar(64) DEFAULT NULL,
  `c_schema` text,
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_configinfo_datagrouptenant` (`data_id`,`group_id`,`tenant_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info';

/******************************************/
/*   数据库全名 = nacos_config   */
/*   表名称 = config_info_aggr   */
/******************************************/
CREATE TABLE `config_info_aggr` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
  `data_id` varchar(255) NOT NULL COMMENT 'data_id',
  `group_id` varchar(255) NOT NULL COMMENT 'group_id',
  `datum_id` varchar(255) NOT NULL COMMENT 'datum_id',
  `content` longtext NOT NULL COMMENT '内容',
  `gmt_modified` datetime NOT NULL COMMENT '修改时间',
  `app_name` varchar(128) DEFAULT NULL,
  `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_configinfoaggr_datagrouptenantdatum` (`data_id`,`group_id`,`tenant_id`,`datum_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='增加租户字段';

/******************************************/
/*   数据库全名 = nacos_config   */
/*   表名称 = config_info_beta   */
/******************************************/
CREATE TABLE `config_info_beta` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
  `data_id` varchar(255) NOT NULL COMMENT 'data_id',
  `group_id` varchar(128) NOT NULL COMMENT 'group_id',
  `app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',
  `content` longtext NOT NULL COMMENT 'content',
  `beta_ips` varchar(1024) DEFAULT NULL COMMENT 'betaIps',
  `md5` varchar(32) DEFAULT NULL COMMENT 'md5',
  `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
  `src_user` text COMMENT 'source user',
  `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',
  `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_configinfobeta_datagrouptenant` (`data_id`,`group_id`,`tenant_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info_beta';

/******************************************/
/*   数据库全名 = nacos_config   */
/*   表名称 = config_info_tag   */
/******************************************/
CREATE TABLE `config_info_tag` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
  `data_id` varchar(255) NOT NULL COMMENT 'data_id',
  `group_id` varchar(128) NOT NULL COMMENT 'group_id',
  `tenant_id` varchar(128) DEFAULT '' COMMENT 'tenant_id',
  `tag_id` varchar(128) NOT NULL COMMENT 'tag_id',
  `app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',
  `content` longtext NOT NULL COMMENT 'content',
  `md5` varchar(32) DEFAULT NULL COMMENT 'md5',
  `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
  `src_user` text COMMENT 'source user',
  `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_configinfotag_datagrouptenanttag` (`data_id`,`group_id`,`tenant_id`,`tag_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info_tag';

/******************************************/
/*   数据库全名 = nacos_config   */
/*   表名称 = config_tags_relation   */
/******************************************/
CREATE TABLE `config_tags_relation` (
  `id` bigint(20) NOT NULL COMMENT 'id',
  `tag_name` varchar(128) NOT NULL COMMENT 'tag_name',
  `tag_type` varchar(64) DEFAULT NULL COMMENT 'tag_type',
  `data_id` varchar(255) NOT NULL COMMENT 'data_id',
  `group_id` varchar(128) NOT NULL COMMENT 'group_id',
  `tenant_id` varchar(128) DEFAULT '' COMMENT 'tenant_id',
  `nid` bigint(20) NOT NULL AUTO_INCREMENT,
  PRIMARY KEY (`nid`),
  UNIQUE KEY `uk_configtagrelation_configidtag` (`id`,`tag_name`,`tag_type`),
  KEY `idx_tenant_id` (`tenant_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_tag_relation';

/******************************************/
/*   数据库全名 = nacos_config   */
/*   表名称 = group_capacity   */
/******************************************/
CREATE TABLE `group_capacity` (
  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `group_id` varchar(128) NOT NULL DEFAULT '' COMMENT 'Group ID,空字符表示整个集群',
  `quota` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '配额,0表示使用默认值',
  `usage` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '使用量',
  `max_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个配置大小上限,单位为字节,0表示使用默认值',
  `max_aggr_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '聚合子配置最大个数,,0表示使用默认值',
  `max_aggr_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个聚合数据的子配置大小上限,单位为字节,0表示使用默认值',
  `max_history_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '最大变更历史数量',
  `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_group_id` (`group_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='集群、各Group容量信息表';

/******************************************/
/*   数据库全名 = nacos_config   */
/*   表名称 = his_config_info   */
/******************************************/
CREATE TABLE `his_config_info` (
  `id` bigint(64) unsigned NOT NULL,
  `nid` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
  `data_id` varchar(255) NOT NULL,
  `group_id` varchar(128) NOT NULL,
  `app_name` varchar(128) DEFAULT NULL COMMENT 'app_name',
  `content` longtext NOT NULL,
  `md5` varchar(32) DEFAULT NULL,
  `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `src_user` text,
  `src_ip` varchar(50) DEFAULT NULL,
  `op_type` char(10) DEFAULT NULL,
  `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段',
  PRIMARY KEY (`nid`),
  KEY `idx_gmt_create` (`gmt_create`),
  KEY `idx_gmt_modified` (`gmt_modified`),
  KEY `idx_did` (`data_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='多租户改造';

/******************************************/
/*   数据库全名 = nacos_config   */
/*   表名称 = tenant_capacity   */
/******************************************/
CREATE TABLE `tenant_capacity` (
  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `tenant_id` varchar(128) NOT NULL DEFAULT '' COMMENT 'Tenant ID',
  `quota` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '配额,0表示使用默认值',
  `usage` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '使用量',
  `max_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个配置大小上限,单位为字节,0表示使用默认值',
  `max_aggr_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '聚合子配置最大个数',
  `max_aggr_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '单个聚合数据的子配置大小上限,单位为字节,0表示使用默认值',
  `max_history_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '最大变更历史数量',
  `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_tenant_id` (`tenant_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='租户容量信息表';

CREATE TABLE `tenant_info` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
  `kp` varchar(128) NOT NULL COMMENT 'kp',
  `tenant_id` varchar(128) default '' COMMENT 'tenant_id',
  `tenant_name` varchar(128) default '' COMMENT 'tenant_name',
  `tenant_desc` varchar(256) DEFAULT NULL COMMENT 'tenant_desc',
  `create_source` varchar(32) DEFAULT NULL COMMENT 'create_source',
  `gmt_create` bigint(20) NOT NULL COMMENT '创建时间',
  `gmt_modified` bigint(20) NOT NULL COMMENT '修改时间',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_tenant_info_kptenantid` (`kp`,`tenant_id`),
  KEY `idx_tenant_id` (`tenant_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='tenant_info';

CREATE TABLE `users` (
	`username` varchar(50) NOT NULL PRIMARY KEY,
	`password` varchar(500) NOT NULL,
	`enabled` boolean NOT NULL
);

CREATE TABLE `roles` (
	`username` varchar(50) NOT NULL,
	`role` varchar(50) NOT NULL,
	UNIQUE INDEX `idx_user_role` (`username` ASC, `role` ASC) USING BTREE
);

CREATE TABLE `permissions` (
    `role` varchar(50) NOT NULL,
    `resource` varchar(255) NOT NULL,
    `action` varchar(8) NOT NULL,
    UNIQUE INDEX `uk_role_permission` (`role`,`resource`,`action`) USING BTREE
);

INSERT INTO users (username, password, enabled) VALUES ('nacos', '$2a$10$EuWPZHzz32dJN7jexM34MOeYirDdFAZm2kuWj7VEOJhhZkDrxfvUu', TRUE);

INSERT INTO roles (username, role) VALUES ('nacos', 'ROLE_ADMIN');

配置 Nacos

1、进入 nacos 的 conf 目录,修改配置文件 cluster.conf.example,重命名为 cluster.conf

Untitled

2、进入 cluster.conf 文件,添加内容:

nacos服务器地址:8840
nacos服务器地址:8845
nacos服务器地址:8850

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第24张图片

3、然后修改 application.properties 文件,添加数据库配置

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第25张图片

spring.datasource.platform=mysql
db.num=1
db.url.0=jdbc:mysql://mysql服务器地址:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
db.user.0=root
db.password.0=283619

4、将 nacos 文件夹复制到每台服务器上

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第26张图片

5、修改nacos集群模式的启动内存大小,避免因服务器内存不足而启动失败:

Untitled

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第27张图片

6、启动每台服务器上的 nacos 节点

sh startup.sh

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第28张图片

Nginx反向代理

1、Linux 安装Nginx:https://blog.csdn.net/qq_45752401/article/details/122660965?spm=1001.2014.3001.5506

2、修改 conf/nginx.conf 文件,配置如下:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第29张图片

upstream nacos-cluster {
    server nacos服务器地址:8840;
    server nacos服务器地址:8845;
		server nacos服务器地址:8850;
}

server {
    listen       80;
    server_name  nginx服务器地址;

    location /nacos {
        proxy_pass http://nacos-cluster;
    }
}

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第30张图片

3、启动Nginx,在浏览器访问 nginx服务器地址/nacos

Untitled

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第31张图片

4、每个微服务的 application.yml 文件配置改为如下:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第32张图片

实际部署时,需要给反向代理的 Nginx 服务器设置一个域名,这样后续如果有服务器迁移到 Nacos 的客户端也无需更改配置。Nacos 的各个节点应该部署到多个不同服务器,做好容灾和隔离工作。

2、Feign远程调用

RestTemplate方式调用存在的问题

我们以前利用 RestTemplate 发起远程调用的代码:

Untitled

存在下面的问题:

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

Feign介绍

Feign 是一个声明式的 http 客户端,官方地址:https://github.com/OpenFeign/feign

其作用就是帮助我们优雅的实现 http 请求的发送,解决上面提到的问题。

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第33张图片

定义和使用Feign客户端

导入依赖

我们在 order-service 中引入 feign 依赖:


<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-openfeignartifactId>
dependency>

添加注解

在 order-service 的启动类中添加注解开启Feign的功能:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第34张图片

编写Feign的客户端

在 order-service 中创建一个接口,内容如下:

@FeignClient("userservice") // 要发送http请求的服务名称
public interface UserClient {

    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);

}

这个客户端主要是基于 SpringMVC 的 @GetMapping 注解来声明远程调用的信息,比如:

  • 服务名称:userservice
  • 请求方式:GET
  • 请求路径:/user/{id}
  • 请求参数:Long id
  • 返回值类型:User

这样,Feign就可以帮助我们发送 http 请求,无需自己使用 RestTemplate 来发送了。

测试

1、注意:新版本 nacos 中取消了对 ribbon 的支持,所以这里需要把 order-service 中的 application.yml 文件配置改成如下:

server:
  port: 8080
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/cloud_order?useSSL=false&serverTimezone=UTC
    username: root
    password: 283619
    driver-class-name: com.mysql.jdbc.Driver
  application:
    name: orderservice # order服务的服务名称
  cloud:
    nacos:
      server-addr: 1.117.74.26:8848 # nacos服务地址
      discovery:
        cluster-name: HZ # 集群名称,这里的HZ代指杭州
#        namespace: 907d7fcb-5b58-4759-83cd-76a391c118be # dev环境
        ephemeral: false # 设置为非临时实例(永久实例)

mybatis:
  type-aliases-package: cn.itcast.order.pojo
  configuration:
    map-underscore-to-camel-case: true

logging:
  level:
    cn.itcast: debug
  pattern:
    dateformat: MM-dd HH:mm:ss:SSS

2、修改 order-service 中的 OrderService 类中的 queryOrderById 方法,使用Feign客户端代替RestTemplate:

@Service
public class OrderService {

    @Autowired
    private OrderMapper orderMapper;

    @Autowired
    private UserClient userClient;

    public Order queryOrderById(Long orderId) {
        // 1.查询订单
        Order order = orderMapper.findById(orderId);
        // 2.使用feign进行远程调用
        User user = userClient.findById(order.getUserId());
        // 3.将用户信息封装进订单
        order.setUser(user);
        // 4.返回
        return order;
    }

}

自定义Feign的配置

Feign 可以支持很多的自定义配置,如下表所示:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第35张图片

一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的 @Bean 覆盖默认 Bean 即可。下面以日志为例来演示如何自定义配置。

配置文件方式

基于配置文件修改 feign 的日志级别可以针对单个微服务:

feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL # 日志级别

也可以针对所有的微服务:

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

而日志级别分为四种:

  1. NONE:不记录任何日志信息,这是默认值。
  2. BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
  3. HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
  4. FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据

Java代码方式

也可以基于 Java代码 的方式来修改日志级别,先声明一个类,然后声明一个 Logger.Level 的对象

public class DefaultFeignConfiguration {

    @Bean
    public Logger.Level logLevel() {
        // 日志级别为BASIC
        return Logger.Level.BASIC;
    }

}

如果要局部生效,将其放到对应的 @FeignClient 注解中:

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration.class) // 要发送http请求的服务名称
public interface UserClient {

    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);

}

如果要全局生效,将其放到启动类的 @EnableFeignClients 注解中:

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

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

}

建议:

一般情况下使用 BASIC 的日志级别即可,因为记录日志会消耗一定的性能!

Feign的性能优化

Feign 底层发起 http 请求会依赖于其它的客户端。其底层的客户端实现有:

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

因此提高 Feign 性能的主要手段就是使用连接池代替默认的 URLConnection

另外,日志级别应该尽量用 basic或none,可以有效提高性能。

这里我们用 Apache 的HttpClient来演示:

1、导入依赖

在 order-service 的 pom 文件中引入 HttpClient 依赖


<dependency>
    <groupId>io.github.openfeigngroupId>
    <artifactId>feign-httpclientartifactId>
dependency>

2、配置连接池:

在 order-service 的 application.yml 中添加配置

feign:
  client:
    config:
      default: # 这里用default表示全局配置
        loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大连接数
    max-connections-per-route: 50 # 每个请求的最大连接数

Feign的最佳实践

方式一:继承

一样的代码可以通过继承来共享:

  1. 定义一个 API 接口,利用定义方法,并基于 SpringMVC 注解做声明
  2. Feign 客户端、Controller 都集成该接口

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第36张图片

优点

  • 简单
  • 实现了代码共享

缺点

  • 服务提供方、服务消费方紧耦合
  • 参数列表中的注解映射并不会继承,因此 Controller 中必须再次声明方法、参数列表、注解

方式二:抽取

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

例如:将 UserClient、User、Feign 的默认配置都抽取到一个 feign-api 包中,所有微服务引用该依赖包,即可直接使用。

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第37张图片

实现基于抽取的最佳实践

1、首先创建一个 module,命名为 feign-api,然后导入 feign 的starter依赖

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第38张图片


<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-openfeignartifactId>
dependency>

2、将 order-service 中 的 UserClient、User、DefaultFeignConfiguration 都复制到 feign-api 项目中

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第39张图片

3、在 order-service 中导入 feign-api 的依赖


<dependency>
    <groupId>cn.itcast.demogroupId>
    <artifactId>feign-apiartifactId>
    <version>1.0version>
dependency>

4、修改 order-service 中所有与上述三个组件有关的导包部分,改成导入 feign-api 中的包

5、重启测试

发现服务报错:

Description:

Field userClient in cn.itcast.order.service.OrderService required a bean of type 'cn.itcast.feign.clients.UserClient' that could not be found.

这是因为 UserClient 是在 cn.itcast.feign.clients 包下,

而 order-service 的 @EnableFeignClients 注解是在 cn.itcast.order 包下,两者不在同一个包,所以无法扫描到 UserClient。

解决扫描包问题

方式一:指定 FeignClient 所在的包

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

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

}

方式二:指定 FeignClient 的字节码(推荐)

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

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

}

3、统一网关Gateway

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一 API 路由管理方式。

为什么需要网关?

Gateway 网关是我们服务的守门神,所有微服务的统一入口。

网关的核心功能特性:

1、身份认证和权限校验:网关作为微服务的入口,需要校验用户是否有请求资格,如果没有则进行拦截。

2、服务路由、负载均衡:一切请求都必须先经过 Gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当路由的目标服务有多个时,还需要做负载均衡。

3、请求限流:当请求流量过高时,在网关中按照下游的微服务能够接受的速度来放行请求,避免服务压力过大。

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第40张图片

在 SpringCloud 中网关的实现包括两种:

  • Gateway
  • zuul

Zuul 是基于 Servlet 实现的,属于阻塞式编程。

而 Spring Cloud Gateway 则是基于 Spring5 中提供的 WebFlux,属于响应式编程的实现,具有更好的性能。

搭建网关服务

1、创建新的 module,引入 Spring Cloud Gateway 依赖和 Nacos 服务发现依赖:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第41张图片


<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-gatewayartifactId>
dependency>

<dependency>
    <groupId>com.alibaba.cloudgroupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
dependency>

2、编写路由配置及 Nacos 地址

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: 1.117.74.26:8848 # nacos服务地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id,自定义,只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址,http就是固定地址
          uri: lb://userservice # 路由的目标地址,lb就是负载均衡,后面跟着服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**

我们将符合 Path 规则的一切请求,都代理到 uri 参数指定的地址。

上面的例子中,我们将 /user/** 开头的请求,代理到 lb://userservice,其中 lb 是负载均衡(LoadBalance),根据服务名称拉取服务列表,实现负载均衡。

3、重启网关,访问 http://localhost:10010/user/1 时,符合 /user/** 规则,请求转发到 uri:http://userservice/user/1

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第42张图片

网关路由流程图

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第43张图片

路由配置包括:

  1. 路由id:路由的唯一标识
  2. 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名称负载均衡
  3. 路由断言(predicates):判断路由的规则
  4. 路由过滤器(filters):对请求或响应进行处理

路由断言工厂 Route Predicate Factory

我们在配置文件中写的断言规则只是简单的字符串,这些字符串会被 Predicate Factory 读取并处理,转变为路由判断的条件。

例如 Path=/user/** 是按照路径匹配,这个规则是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory 类来处理的,像这样的断言工厂在 Spring Cloud Gateway 中还有十几个:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第44张图片

官方文档:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

一般的,我们只需要掌握 Path,加上官方文档的例子,就可以应对各种工作场景了。

- id: order-service
  uri: lb://orderservice
  predicates:
    - Path=/order/**
    - After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]

像这样的规则,现在是 2022年11月12日22:34:00,很明显 After 条件不满足,路由不起作用。

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第45张图片

总结:PredicateFactory的作用是什么?

读取用户定义的断言条件,对请求做出判断

过滤器工厂 GatewayFilterFactory

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

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第46张图片

Spring 提供了31种不同的路由过滤器工厂。例如:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第47张图片

官方文档:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

请求头过滤器

下面我们以 AddRequestHeader 为例:

需求:给所有进入 userservice 的请求添加一个请求头:Truth=itcast is freaking awesome!

cloud:
    nacos:
      server-addr: 1.117.74.26:8848 # nacos服务地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id,自定义,只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址,http就是固定地址
          uri: lb://userservice # 路由的目标地址,lb就是负载均衡,后面跟着服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
          filters:
            - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

如何验证,我们修改 userservice 中的一个接口

		@GetMapping("/{id}")
    public User queryById(@PathVariable("id") Long id, @RequestHeader(value = "Truth", required = false) String truth) {
        System.out.println("truth = " + truth);
        return userService.queryById(id);
    }

重启服务,访问:http://localhost:10010/user/1

可以看到控制台打印出了这个请求头:

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第48张图片

默认过滤器

当然,Gateway 也是有全局过滤器的,如果要对所有的路由都生效,则可以将过滤器工厂写到 default-filters 下:

spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: 1.117.74.26:8848 # nacos服务地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id,自定义,只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址,http就是固定地址
          uri: lb://userservice # 路由的目标地址,lb就是负载均衡,后面跟着服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
            - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
      default-filters: # 默认过滤器,会对所有的路由请求都生效
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

重启服务,访问:http://localhost:10010/user/1

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第49张图片

全局过滤器 GlobalFilter

上面介绍的过滤器工厂,网关提供了 31 种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与 GatewayFilter 的作用一样。区别在于 GlobalFilter 需要自己写代码来实现,而 GatewayFilter 通过配置定义,处理逻辑是固定的。

定义方式是实现 GlobalFilter 接口

public interface GlobalFilter {
    /**
     *  处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
     *
     * @param exchange 请求上下文,里面可以获取Request、Response等信息
     * @param chain 放行,用来把请求委托给下一个过滤器处理
     * @return {@code Mono} 返回标识当前过滤器业务结束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

自定义全局过滤器

案例:定义全局过滤器,拦截并判断用户身份

需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件

  • 参数中是否有 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();
        // key表示参数名称,值表示参数值
        MultiValueMap<String, String> params = request.getQueryParams();
        // 2.获取请求参数中的 authorization 参数
        String auth = params.getFirst("authorization");
        // 3.判断 authorization 的参数值是否等于 admin
        if ("admin".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.拦截
        // 4.1.禁止访问,设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        // 4.2.结束处理
        return exchange.getResponse().setComplete();
    }

}

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第50张图片

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第51张图片

过滤器执行顺序

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

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

day02 Nacos集群配置、Feign远程调用和统一网关Gateway_第52张图片

排序的规则是什么呢?

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

跨域问题

什么是跨域问题?

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

  • 域名不同: www.taobao.comwww.taobao.orgwww.jd.commiaosha.jd.com
  • 域名相同,端口不同:localhost:8080localhost:8081

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

解决方案:CORS,可以看看 https://www.ruanyifeng.com/blog/2016/04/cors.html

模拟跨域问题

DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Documenttitle>
head>
<body>
<pre>
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 # 这次跨域检测的有效期
pre>
body>
<script src="https://unpkg.com/axios/dist/axios.min.js">script>
<script>
  axios.get("http://localhost:10010/user/1?authorization=admin")
  .then(resp => console.log(resp.data))
  .catch(err => console.log(err))
script>
html>

放入tomcat或nginx这样的web服务器中,启动并访问。

可以在浏览器控制台看到下面的错误:

Untitled

localhost:8090 访问 localhost:10010,端口不同,显然是跨域的请求。

解决跨域问题

网关处理跨域问题同样采用的是 CORS 方案,并且只需要简单配置即可实现:

spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: 1.117.74.26:8848 # nacos服务地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id,自定义,只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址,http就是固定地址
          uri: lb://userservice # 路由的目标地址,lb就是负载均衡,后面跟着服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
        #          filters:
        #            - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
            - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
      default-filters: # 默认过滤器,会对所有的路由请求都生效
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求 allowedOrigins: "*" 表示允许所有网站
              - "*"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

你可能感兴趣的:(SpringCloud,学习笔记,gateway,nacos,spring,cloud,网关,feign)