SpringCloudAlibaba - 项目完整搭建（Nacos + OpenFeign + Getway + Sentinel）

今天药忘吃喽~ 2024-02-19 08:08 36阅读 0赞

**目录**

一、SpringCloudAlibaba 项目完整搭建

1.1、初始化项目

1.1.1、创建工程

1.1.2、配置父工程的 pom.xml

1.1.3、创建子模块

1.2、user 微服务

1.2.1、配置 pom.xml

1.2.2、创建 application.yml 配置文件

1.2.3、创建启动类

1.2.4、测试

1.3、product 微服务

1.3.1、配置 pom.xml

1.3.2、创建 application.yml 配置文件

1.3.3、创建启动类

1.3.4、测试

1.4、引入 OpenFeign，进行远程调用

1.4.1、引入依赖

1.4.2、实现远程调用

1.5、user 微服务集成 Sentinel

1.5.1、引入 sentinel 依赖

1.5.2、在 application.yml 中配置 sentinel

1.5.3、测试

1.6、网关微服务

1.6.1、配置 pom.xml

1.6.2、创建 application.yml 并配置网关

1.6.3、创建启动类

1.6.4、测试

1.7、nacos 实现配置中心

1.7.1、建议

1.7.2、引入 nacos 配置中心依赖

1.7.3、在 nacos 上创建配置

--------------------

## 一、SpringCloudAlibaba 项目完整搭建 ##

--------------------

### 1.1、初始化项目 ###

#### 1.1.1、创建工程 ####

a）先创建一个空项目，名字自定义.

![29c37d1c61434e219800a4d4ae08599a.png][]

> Ps：
> 
> 1. 这里也可以不创建空项目，而是直接创建一个 Maven 项目作为父项目，然后删掉 src 目录即可.
> 
> 2. 还有一种更方便的管理办法，就是直接创建一个 Spring Boot 项目做为父项目，这样就可以提前引入好依赖，然后只留下 pom.xml 、.gitinore 、.idea 即可.

b）在刚刚的空项目下创建整个项目的父模块

![99b11e3e26d74755aefb529acc1afa7d.png][]

c）父工程下的 src 可以删了，没用

![493c3acc91dd4de7bcf00376ca6d20d3.png][]

d）最后直接用 IDEA 打开空项目下的父工程（否则 Java 文件不生效）

#### 1.1.2、配置父工程的 pom.xml ####

a）引入依赖如果没有语法提示，可以这样添加索引

![d452bea3c98c46af8bcd500abccf5f8a.png][]

b）配置依赖如下

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>org.example</groupId>
        <artifactId>springcloud_alibaba_parent</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        
        <properties>
            <java.version>8</java.version>
            <spring-cloud.version>Hoxton.SR8</spring-cloud.version>
            <spring-cloud-alibaba.version>2.2.5.RELEASE</spring-cloud-alibaba.version>
        </properties>
    
    
        
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.9.RELEASE</version>
        </parent>
    
        <dependencies>
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </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>
    
                
                <dependency>
                    <groupId>com.alibaba.cloud</groupId>
                    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                    <version>${spring-cloud-alibaba.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
    
            </dependencies>
        </dependencyManagement>
    
    </project>

> Ps：SpringCloud Alibaba 、SpringCloud、SpringBoot 各版本对应说明 如下
> 
> [https://github.com/alibaba/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E][https_github.com_alibaba_spring-cloud-alibaba_wiki_E7_89_88_E6_9C_AC_E8_AF_B4_E6_98_8E]

例如按照上述文档，这里给出一个更新的版本样式（稳定）.

<parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.6.3</version>
            <relativePath/> 
        </parent>
    
    
        <properties>
            <java.version>1.8</java.version>
            <mybatis-spring-boot.version>2.3.1</mybatis-spring-boot.version>
            <mysql.version>5.1.49</mysql.version>
            <spring-cloud.version>2021.0.1</spring-cloud.version>
            <spring-cloud-alibaba.version>2021.0.1.0</spring-cloud-alibaba.version>
        </properties>
    
        
        <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>
    
                
                <dependency>
                    <groupId>com.alibaba.cloud</groupId>
                    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                    <version>${spring-cloud-alibaba.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
    
                
                <dependency>
                    <groupId>org.mybatis.spring.boot</groupId>
                    <artifactId>mybatis-spring-boot-starter</artifactId>
                    <version>${mybatis-spring-boot.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>${mysql.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-test</artifactId>
                    <scope>test</scope>
                </dependency>
    
                
                <dependency>
                    <groupId>org.mybatis.spring.boot</groupId>
                    <artifactId>mybatis-spring-boot-starter-test</artifactId>
                    <version>${mybatis-spring-boot.version}</version>
                    <scope>test</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>

#### 1.1.3、创建子模块 ####

在父工程下创建 4 个 module

*  user：用户微服务（案例）.
 *  product：商品微服务（案例）.
 *  gateway：网关微服务.
 *  model：模组微服务，用来管理实体类，公共依赖（例如 user 微服务和 product 微服务中都需要 spring web 依赖，那么只需要将这个依赖放到 model 中，然后在 user 和 product 中分别引入 model 模块即可）

![1be0e57a02da4c8fafe3276ff71139a3.png][]

### 1.2、user 微服务 ###

#### 1.2.1、配置 pom.xml ####

用户微服务所需依赖如下（按需引入）：

<dependencies>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
            <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-openfeign</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
            </dependency>
    
    
        </dependencies>

> Ps：不要一开始就引入这么多，按需引入！尤其是 nacos config配置 依赖，如果引入不使用就会报错！

#### 1.2.2、创建 application.yml 配置文件 ####

配置端口号，以及 nacos 地址

server:
      port: 8090
    
    spring:
      application:
        name: user
      cloud:
        nacos:
          server-addr: localhost:8890

#### 1.2.3、创建启动类 ####

@SpringBootApplication
    @EnableDiscoveryClient // nacos 服务发现(可以省略)
    public class UserApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(UserApplication.class, args);
        }
    
    }

启动 user 微服务，就可以看到 nacos 中存在该服务了

![8930f37b0b334f8690c331fc02023e79.png][]

#### 1.2.4、测试 ####

创建 UserController，如下

@Slf4j
    @RestController
    @RequestMapping
    public class UserController {
    
        @Value("${server.port}")
        private int port;
    
        @GetMapping("/user")
        public String user() {
            log.info("user ok!  port={}", port);
            return "user ok! port=" + port;
        }
    
    }

postman 测试结果如下：

![57b4581c8d1048df8ca9eb6866e24700.png][]

### 1.3、product 微服务 ###

#### 1.3.1、配置 pom.xml ####

用户微服务所需依赖如下（按需引入）：

> Ps：不要一开始就引入这么多，按需引入！尤其是 nacos config配置 依赖，如果引入不使用就会报错！

#### 1.3.2、创建 application.yml 配置文件 ####

配置端口号，以及 nacos 地址

server:
      port: 8091
    
    spring:
      application:
        name: product
      cloud:
        nacos:
          server-addr: localhost:8890

#### 1.3.3、创建启动类 ####

@SpringBootApplication
    @EnableDiscoveryClient //可省略
    public class ProductApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ProductApplication.class, args);
        }
    
    }

启动 user 微服务，就可以看到 nacos 中存在该服务了

![89d99d9a4ae9473cb6c7c4ba9302f3af.png][]

#### 1.3.4、测试 ####

创建 UserController，如下

postman 测试结果如下：

![c163db9f39554d2eacca62fc8db162a8.png][]

### 1.4、引入 OpenFeign，进行远程调用 ###

#### 1.4.1、引入依赖 ####

在 user 微服务中引入 openfeign 依赖（这里只是举例，实际开发中，按需引入）.

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-openfeign</artifactId>
            </dependency>

**注意：由于SpringCloud Feign高版本（例如 springcloud 2021.0.1）不使用Ribbon而是使用spring-cloud-loadbalancer，所以需要引用spring-cloud-loadbalancer或者降版本**

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-loadbalancer</artifactId>
            </dependency>

#### 1.4.2、实现远程调用 ####

a）在 user 微服务中创建一个 product 微服务 feign 接口

@FeignClient("product")
    public interface ProductClient {
    
        @GetMapping("/product")
        String product();
    
    }

b）在启动类中开启 feign 客户端

@SpringBootApplication
    @EnableDiscoveryClient // nacos 服务发现(可以省略)
    @EnableFeignClients // 开启 openfeign 远程调用
    public class UserApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(UserApplication.class, args);
        }
    
    }

> c）如果是高版本的 SpringCloud，那么就需要使用 SpringCloud LoadBalencer 做负载均衡.

具体的添加@LoadBalancerClient注解：在调用服务的Service类上添加@LoadBalancerClient注解，并指定服务名。这样，负载均衡器将根据配置的属性来选择合适的服务实例进行调用。例如：

如下：

@FeignClient(value = "service-name", configuration = LoadBalancerClientConfig.class)  
    public interface MyService {  
        @LoadBalanced  //启用负载均衡
        @GetMapping("/endpoint")  
        String getEndpointData();  
    }

d）在 UserController 中进行远程调用.

@GetMapping("/user")
        public String user() {
            log.info("user ok!  port={}", port);
            //远程调用 product
            String result = productClient.product();
            log.info("远程调用 result: {}", result);
            return "user ok! port=" + port;
        }

执行结果如下：

![b834673e854d42618f5620830e9d2a41.png][]

### 1.5、user 微服务集成 Sentinel ###

#### 1.5.1、引入 sentinel 依赖 ####

在 user 微服务中引入 sentinel 依赖

<dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
            </dependency>

#### 1.5.2、在 application.yml 中配置 sentinel ####

server:
      port: 8090
    
    spring:
      application:
        name: user
      cloud:
        nacos:
          server-addr: localhost:8890
        sentinel:
          eager: true # 立即触发 sentinel
          transport:
            dashboard: localhost:8891

#### 1.5.3、测试 ####

a）打开 sentinel 控制台

![fe960140f2034db19a501dd86db2abcf.png][]

b）设置流控规则为 1秒 / 3次点击.

![223f80c1446d4d80951fefa24b9c40d8.png][]

c）测试后限流生效

### 1.6、网关微服务 ###

#### 1.6.1、配置 pom.xml ####

<dependencies>
    
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-gateway</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            </dependency>
    
        </dependencies>

如果使用的是 springcloud高版本（例如 2020.1.0），那么 gateway 中的 ribbon 负载均衡已经被剔除了，因此需要引入 springcloud loadbalencer 作为 gateway 的负载均衡.

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-loadbalancer</artifactId>
            </dependency>

引入此依赖后，可能还会报 cache 的警告，引入一下两个依赖即可

<dependency>
                <groupId>com.github.ben-manes.caffeine</groupId>
                <artifactId>caffeine</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context-support</artifactId>
            </dependency>

#### 1.6.2、创建 application.yml 并配置网关 ####

另外，如果配置跨域，如下：

server:
      port: 18080
    
    spring:
      application:
        name: gateway
      cloud:
        nacos:
          server-addr: localhost:8890
        gateway:
          routes:
            - id: users_router
              # uri: http://localhost:9090 无负载均衡
              uri: lb://user  # lb 表示负载均衡
              predicates:
                - Path=/user
    
            - id: products_router
              # uri: http://localhost:9091
              uri: lb://product
              predicates:
                - Path=/product
          globalcors: # 全局跨域处理
            cors-configurations:
              '[/**]':
                allowedMethods: "*"
                allowedHeaders: "*"
                allowedOriginPatterns: "*" # 2.4 以后版本不可以写成 allowedOrigin
                allowCredentials: true

#### 1.6.3、创建启动类 ####

@SpringBootApplication
    @EnableDiscoveryClient //(可省略)
    public class GatewayApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(GatewayApplication.class, args);
        }
    
    }

#### 1.6.4、测试 ####

通过网关访问 user 微服务和 product 微服务

![2110fa0a7d4c409cbef080170efa2d2f.png][]

![aed7328b831543fbb61eda2eb4580cb7.png][]

### 1.7、nacos 实现配置中心 ###

#### 1.7.1、建议 ####

一般来说，项目初期开发只用三个组件：nacos注册中心、gateway网关、openFeign声明式远程调用。

值得注意的是，前期项目开发完成之前，也不要使用 nacos 配置中心，原因如下：

1.  因为一旦需要改什么配置，还需要打开 nacos 修改，容易分心，建议就先用项目中 application.yml 即可
2.  引入依赖，但不配置，会报错.

#### 1.7.2、引入 nacos 配置中心依赖 ####

这里以 user 微服务为例，引入 nacos 配置中心依赖.

<dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
            </dependency>

**注意：SpringCloudAlibaba 高版本（例如 springcloud-alibaba 2021.0.1.0）会忽略 bootstrap.yml 文件，因此需要加上以下配置**

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-bootstrap</artifactId>
            </dependency>

#### 1.7.3、在 nacos 上创建配置 ####

a）在 nacos 上创建一个命名空间

![3b1d04355c3a4e95abb937541262b9a1.png][]

b）在配置管理中选择刚创建的命名空间 demo1

![4c547dc35da84f25ab7162c9e9dd42a4.png][]

c）创建一个新的配置文件，接着就可以把 user 微服务 yml 中配置所有信息都放到 nacos 上进行统一管理，随后点击发布

![b78052945af34794b9ca4e3222a21cec.png][]

> Ps：配置内容不要有注释！ 天坑！

d）创建 bootstrap.yml 配置文件，用来拉去 nacos 上的配置文件.

# 远端配置中心是谁
    spring:
      cloud:
        nacos:
          server-addr: locahost:8890
          config:
            # 使用 nacos 中的哪个 namespace
            namespace: 0e48f075-ad88-4700-a422-d315a81f9ced
            # 使用 nacos 中的哪个组
            group: user
            # 使用 nacos 中的哪个 dataId  1.name+文件后缀 2.文件名+env+后缀
            name: user-prod
            file-extension: yml

> Ps：原先的 application.yml 就可以删除了.

![cd0a9ec0b5f748e89e418147684845af.gif][]

[29c37d1c61434e219800a4d4ae08599a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/3450c25a268440e5a15f1bf8172cc49c.png
[99b11e3e26d74755aefb529acc1afa7d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/daf71af8cba24a72ac8b7fe8d8e74446.png
[493c3acc91dd4de7bcf00376ca6d20d3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/e31a4fc8b3dc48e9b2f86e3acd230d99.png
[d452bea3c98c46af8bcd500abccf5f8a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/1ea46d497a564d1e81524575fa4f8d9c.png
[https_github.com_alibaba_spring-cloud-alibaba_wiki_E7_89_88_E6_9C_AC_E8_AF_B4_E6_98_8E]: https://github.com/alibaba/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E
[1be0e57a02da4c8fafe3276ff71139a3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/40cc50fb5f774e41a5a86853c4aa8985.png
[8930f37b0b334f8690c331fc02023e79.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/b9f4635546ff4a5aab6a3a4d1023f5d6.png
[57b4581c8d1048df8ca9eb6866e24700.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/3813f836f7ad4f1aa916dde31fdfd9a2.png
[89d99d9a4ae9473cb6c7c4ba9302f3af.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/d718c85a77de49b39ee55fc2fd6d69c2.png
[c163db9f39554d2eacca62fc8db162a8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/8f1deb64239e447ba306bb6728da4653.png
[b834673e854d42618f5620830e9d2a41.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/49990b2b0c8942ad9c0431128c0bdf9c.png
[fe960140f2034db19a501dd86db2abcf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/2a2897623ce8485095484c193f6840ea.png
[223f80c1446d4d80951fefa24b9c40d8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/a5d3a6941d5242dab1c09b57a76483a7.png
[2110fa0a7d4c409cbef080170efa2d2f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/6141d8f541fa4f7a9df7fe10d8989cb1.png
[aed7328b831543fbb61eda2eb4580cb7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/c6e1a320541e43d4b0479bb05dc684fd.png
[3b1d04355c3a4e95abb937541262b9a1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/9e7df518003345dba29c245b3649f7bf.png
[4c547dc35da84f25ab7162c9e9dd42a4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/b90a588458ab4e12993c33835fda96e7.png
[b78052945af34794b9ca4e3222a21cec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/b81c80907d1e405fa4259ec5fdd47989.png
[cd0a9ec0b5f748e89e418147684845af.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/d0427de442c548289e6685b302743533.png