环境搭建

创建父工程 RuoYi-Cloud

使用 idea 创建 maven 结构的父工程，其 gav坐标为

  1.         <groupId>com.ruoyi</groupId>
  2.     <artifactId>ruoyi</artifactId>
  3.     <version>1.0.0</version>

删除src目录

父工程一般都不需要写代码，因此 src 目录可以删除。

父工程 pom.xml 文件

主要做了哪些事情？
①、pom 表明这是一个父工程
②、全局定义了 SpringBoot、SpringCloud、以及SpringCloud Alibaba的版本号
③、覆盖了 alibaba-nacos 自带的nacos-client 版本号（1.4.1），将它改为了2.0.3。因为我们 nacos 服务器选择的也是 2.0.3 版本

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>com.ruoyi</groupId>
  8.     <artifactId>ruoyi</artifactId>
  9.     <version>1.0.0</version>
  10.     <packaging>pom</packaging>
  13.     <properties>
  14.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  15.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  16.         <java.version>1.8</java.version>
  17.         <spring-boot.version>2.5.3</spring-boot.version>
  18.         <spring-cloud.version>2020.0.3</spring-cloud.version>
  19.         <spring-cloud-alibaba.version>2021.1</spring-cloud-alibaba.version>
  20.         <alibaba.nacos.version>2.0.3</alibaba.nacos.version>
  21.     </properties>
  23.     <dependencies>
  24.         <!-- bootstrap 启动器 -->
  25.         <dependency>
  26.             <groupId>org.springframework.cloud</groupId>
  27.             <artifactId>spring-cloud-starter-bootstrap</artifactId>
  28.         </dependency>
  29.     </dependencies>
  31.     <dependencyManagement>
  32.         <dependencies>
  33.             <!-- SpringBoot 依赖配置 -->
  34.             <dependency>
  35.                 <groupId>org.springframework.boot</groupId>
  36.                 <artifactId>spring-boot-dependencies</artifactId>
  37.                 <version>${spring-boot.version}</version>
  38.                 <type>pom</type>
  39.                 <scope>import</scope>
  40.             </dependency>
  42.             <!-- SpringCloud 微服务 -->
  43.             <dependency>
  44.                 <groupId>org.springframework.cloud</groupId>
  45.                 <artifactId>spring-cloud-dependencies</artifactId>
  46.                 <version>${spring-cloud.version}</version>
  47.                 <type>pom</type>
  48.                 <scope>import</scope>
  49.             </dependency>
  51.             <!-- SpringCloud Alibaba 微服务 -->
  52.             <dependency>
  53.                 <groupId>com.alibaba.cloud</groupId>
  54.                 <artifactId>spring-cloud-alibaba-dependencies</artifactId>
  55.                 <version>${spring-cloud-alibaba.version}</version>
  56.                 <type>pom</type>
  57.                 <scope>import</scope>
  58.             </dependency>
  60.             <!-- Alibaba Nacos 配置 -->
  61.             <dependency>
  62.                 <groupId>com.alibaba.nacos</groupId>
  63.                 <artifactId>nacos-client</artifactId>
  64.                 <version>${alibaba.nacos.version}</version>
  65.             </dependency>
  67.         </dependencies>
  68.     </dependencyManagement>
  70. </project>

创建网关模块 ruoyi-gateway

在父工程下创建网关模块（ruoyi-gateway），其 gav 坐标为：

  1.     <parent>
  2.         <artifactId>ruoyi</artifactId>
  3.         <groupId>com.ruoyi</groupId>
  4.         <version>1.0.0</version>
  5.     </parent>
  6.     <modelVersion>4.0.0</modelVersion>
  8.     <artifactId>ruoyi-gateway</artifactId>

注意了，ruoyi-gateway 作为 ruoyi 的子模块，因此在 父工程中会多出

  1.     <modules>
  2.         <module>ruoyi-gateway</module>
  3.     </modules>

ruoyi-gateway 模块的 pom.xml 文件

做了哪些事情？
①、作为网关需要引入 spring-cloud-starter-gateway 依赖
②、我们需要把网关程序注册到 nacos， 因此需要引入 spring-cloud-starter-alibaba-nacos-discovery
③、我们需要实现动态配置功能，因此将 nacos作为配置中心，网关程序启动时需要读取 在nacos中的配置，
因此引入 spring-cloud-starter-alibaba-nacos-config 依赖

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <groupId>com.ruoyi</groupId>
  7.         <artifactId>ruoyi</artifactId>
  8.         <version>1.0.0</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>ruoyi-gateway</artifactId>
  14.     <dependencies>
  15.         <!-- SpringCloud Gateway -->
  16.         <dependency>
  17.             <groupId>org.springframework.cloud</groupId>
  18.             <artifactId>spring-cloud-starter-gateway</artifactId>
  19.         </dependency>
  21.         <!-- SpringCloud Alibaba Nacos -->
  22.         <dependency>
  23.             <groupId>com.alibaba.cloud</groupId>
  24.             <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  25.         </dependency>
  27.         <!-- SpringCloud Alibaba Nacos Config -->
  28.         <dependency>
  29.             <groupId>com.alibaba.cloud</groupId>
  30.             <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
  31.         </dependency>
  34.     </dependencies>
  36. </project>

创建 bootstrap.yml 文件

做了哪些事情？
①、凡是微服务都必须定义的2个东西。“端口号” 和 “应用名”
②、服务注册的地址，即告诉网关程序服务往哪里注册
③、配置中心地址，即告诉网关程序去哪里获取配置信息

  1. server:
  2.   port: 8080
  4. spring:
  5.   application:
  6.     name: ruoyi-gateway
  7.   profiles:
  8.     active: dev
  10.   cloud:
  11.     nacos:
  12.       discovery:
  13.         # 服务注册地址
  14.         server-addr: 127.0.0.1:8848
  15.       config:
  16.         # 配置中心地址
  17.         server-addr: 127.0.0.1:8848
  18.         # 配置文件格式
  19.         file-extension: yml
  20.         # 共享配置
  21.         shared-configs:
  22.           - application-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}

配置中心

打开 nacos 服务 -> 登陆到nacos控制台 -> 在配置管理中新建配置 ruoyi-gateway-dev.yml
现在我们还没有用到配置，所以该文件可以空着内容不写。

main方法

注意了，在较新版本 @EnableDiscoveryClient 注解不写也同样能完成微服务注册

  1. package com.ruoyi.gateway;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
  6. import org.springframework.cloud.client.SpringCloudApplication;
  7. import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
  9. @SpringBootApplication(exclude = {DataSourceAutoConfiguration.class })
  10. //@EnableDiscoveryClient 这个注解可以不需要写了
  11. public class RuoYiGatewayApplication {
  13.     public static void main(String[] args) {
  14.         SpringApplication.run(RuoYiGatewayApplication.class, args);
  15.     }
  17. }

网关程序注册到nacos

运行 RuoYiGatewayApplication 的main 方法
image.png

创建认证中心模块 ruoyi-auth

在父工程下创建网关模块（ruoyi-auth），其 gav 坐标为：

  1.     <parent>
  2.         <artifactId>ruoyi</artifactId>
  3.         <groupId>com.ruoyi</groupId>
  4.         <version>1.0.0</version>
  5.     </parent>
  6.     <modelVersion>4.0.0</modelVersion>
  8.     <artifactId>ruoyi-auth</artifactId>

ruoyi-auth 模块的 pom.xml 文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>ruoyi</artifactId>
  7.         <groupId>com.ruoyi</groupId>
  8.         <version>1.0.0</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>ruoyi-auth</artifactId>
  14.     <dependencies>
  15.         <!-- SpringBoot Web -->
  16.         <dependency>
  17.             <groupId>org.springframework.boot</groupId>
  18.             <artifactId>spring-boot-starter-web</artifactId>
  19.         </dependency>
  22.     </dependencies>
  24. </project>

创建 bootstrap.yml 文件

主要做了哪些事情？
①、定义了端口和应用名

  1. server:
  2.   port: 9200
  4. spring:
  5.   application:
  6.     name: ruoyi-auth
  7.   profiles:
  8.     # 环境配置
  9.     active: dev

主启动类

  1. package com.ruoyi.auth;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. @SpringBootApplication
  7. public class RuoYiAuthApplication {
  9.     public static void main(String[] args) {
  10.         SpringApplication.run(RuoYiAuthApplication.class, args);
  11.     }
  13. }

编写测试Controller - HelloController

  1. package com.ruoyi.auth.controller;
  3. import org.springframework.beans.factory.annotation.Value;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  7. @RestController
  8. public class HelloController {
  10.     @Value("${spring.application.name}")
  11.     private String appName;
  13.     @Value("${server.port}")
  14.     private String port;
  16.     @RequestMapping("/auth/hello")
  17.     public String hello() {
  18.         return  appName + " 项目，端口号：" + port;
  19.     }
  21. }

测试

运行 RuoYiAuthApplication 类的 main 方法。
image.png

网关转发

网关作为整个微服务的入口，一般都有如下几个用途！
①、请求转发。 即路由功能
微服务项目一般都是前后端分离的，那么前端发过来的请求不是请求到具体的微服务上，而是统一的经过 网关程序进行转发。这样做可以屏蔽到具体微服务地址
②、过滤
所有的请求都会经过网关，因此我们可以使用过滤功能，对请求进行加工和处理

简单的转发

在 ruoyi-gateway-dev.yml 配置文件中，配置转发规则。
如下表示如果发送 http://localhost:8080/auth/hello 请求，网关中的路径断言规则中 /auth/** 匹配到了，所以会
将请求转发到 http://localhost:9200

  1. spring:
  2.   cloud: 
  3.     gateway: 
  4.       discovery: 
  5.       routes:
  6.         - id: ruoyi-auth
  7.           uri: http://localhost:9200
  8.           predicates:
  9.             - Path=/auth/**

转发路径去掉前缀

比如 http://localhost:8080/auth/hello 会转发时需要去掉 /auth 前缀。怎么弄？
①、修改 @RequestMapping(“/auth/hello”) 为 @RequestMapping(“/hello”)
②、在 ruoyi-gateway-dev.yml 文件中添加过滤器 StripPrefix 。

  1. spring:
  2.   cloud: 
  3.     gateway: 
  4.       discovery: 
  5.       routes:
  6.         - id: ruoyi-auth
  7.           uri: http://localhost:9200
  8.           predicates:
  9.             - Path=/auth/**
  10.           filters:
  11.             - StripPrefix=1    # 去掉前缀

③、重启 网关和认证中心的程序，然后发送 http://localhost:8080/auth/hello 请求，观察效果是否和直接访问
http://localhost:9200/hello 效果一样？

网关的负载均衡转发

之前我们在路由转发的时候，路径都是写死的。例如：uri: http://localhost:9200 ，这样无法转发到多台微服务上

将认证中心模块（ruoyi-auth）注册到 nacos。

①、ruoyi-auth 模块引入依赖

  1.                 <!-- SpringCloud Alibaba Nacos -->
  2.         <dependency>
  3.             <groupId>com.alibaba.cloud</groupId>
  4.             <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  5.         </dependency>

②、编写 bootstrap.yml 配置，使其注册到 nacos

  1. server:
  2.   port: 9200
  4. spring:
  5.   application:
  6.     name: ruoyi-auth
  7.   profiles:
  8.     # 环境配置
  9.     active: dev
  10.   cloud:
  11.     nacos:
  12.       discovery:
  13.         # 服务注册地址
  14.         server-addr: 127.0.0.1:8848

网关模块 ruoyi-gateway

①、引入依赖， 如果跳过这一步，在最后运行网关程序的时候，会报出 type=Service Unavailable, status=503 错误

  1.                 <dependency>
  2.             <groupId>org.springframework.cloud</groupId>
  3.             <artifactId>spring-cloud-starter-loadbalancer</artifactId>
  4.         </dependency>

②、修改 ruoyi-gateway 在nacos中的配置，添加上负载均衡功能

  1. spring:
  2.   cloud: 
  3.     gateway: 
  4.       discovery: 
  5.         locator: 
  6.           lowerCaseServiceId: true
  7.           enabled: true
  8.       routes:
  9.         - id: ruoyi-auth
  10.           #uri: http://localhost:9200
  11.           #uri: lb://ruoyi-auth
  12.           predicates:
  13.             - Path=/auth/**
  14.           filters:
  15.             - StripPrefix=1    # 去掉前缀

测试

重启网关和认证中心程序
image.png
image.png