相关推荐recommended
SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel)
作者:mmseoamin日期:2023-12-25

目录

一、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)先创建一个空项目,名字自定义.

SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第1张

Ps:

1. 这里也可以不创建空项目,而是直接创建一个 Maven 项目作为父项目,然后删掉 src 目录即可.

2. 还有一种更方便的管理办法,就是直接创建一个 Spring Boot 项目做为父项目,这样就可以提前引入好依赖,然后只留下 pom.xml 、.gitinore 、.idea 即可.

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

SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第2张

c)父工程下的 src 可以删了,没用

SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第3张

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

1.1.2、配置父工程的 pom.xml

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

SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第4张

b)配置依赖如下



    4.0.0
    org.example
    springcloud_alibaba_parent
    1.0-SNAPSHOT
    
    
        8
        Hoxton.SR8
        2.2.5.RELEASE
    
    
    
        org.springframework.boot
        spring-boot-starter-parent
        2.3.9.RELEASE
    
    
        
        
            org.projectlombok
            lombok
        
    
    
    
        
            
            
                org.springframework.cloud
                spring-cloud-dependencies
                ${spring-cloud.version}
                pom
                import
            
            
            
                com.alibaba.cloud
                spring-cloud-alibaba-dependencies
                ${spring-cloud-alibaba.version}
                pom
                import
            
        
    

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

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

    
        org.springframework.boot
        spring-boot-starter-parent
        2.6.3
         
    
    
        1.8
        2.3.1
        5.1.49
        2021.0.1
        2021.0.1.0
    
    
    
        
            
            
                org.springframework.cloud
                spring-cloud-dependencies
                ${spring-cloud.version}
                pom
                import
            
            
            
                com.alibaba.cloud
                spring-cloud-alibaba-dependencies
                ${spring-cloud-alibaba.version}
                pom
                import
            
            
            
                org.mybatis.spring.boot
                mybatis-spring-boot-starter
                ${mybatis-spring-boot.version}
            
            
            
                mysql
                mysql-connector-java
                ${mysql.version}
            
            
            
                org.springframework.boot
                spring-boot-starter-test
                test
            
            
            
                org.mybatis.spring.boot
                mybatis-spring-boot-starter-test
                ${mybatis-spring-boot.version}
                test
            
        
    

1.1.3、创建子模块

在父工程下创建 4 个 module

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

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第5张

    1.2、user 微服务

    1.2.1、配置 pom.xml

    用户微服务所需依赖如下(按需引入):

        
            
            
                org.springframework.boot
                spring-boot-starter-web
            
            
            
                com.alibaba.cloud
                spring-cloud-starter-alibaba-nacos-discovery
            
            
            
                org.springframework.cloud
                spring-cloud-starter-openfeign
            
            
            
                com.alibaba.cloud
                spring-cloud-starter-alibaba-sentinel
            
        
    

    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 中存在该服务了

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第6张

    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 测试结果如下:

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第7张

    1.3、product 微服务

    1.3.1、配置 pom.xml

    用户微服务所需依赖如下(按需引入):

        
            
            
                org.springframework.boot
                spring-boot-starter-web
            
            
            
                com.alibaba.cloud
                spring-cloud-starter-alibaba-nacos-discovery
            
            
            
                org.springframework.cloud
                spring-cloud-starter-openfeign
            
            
            
                com.alibaba.cloud
                spring-cloud-starter-alibaba-sentinel
            
        
    

    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 中存在该服务了

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第8张

    1.3.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 测试结果如下:

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第9张

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

    1.4.1、引入依赖

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

            
            
                org.springframework.cloud
                spring-cloud-starter-openfeign
            

    注意:由于SpringCloud Feign高版本(例如 springcloud 2021.0.1)不使用Ribbon而是使用spring-cloud-loadbalancer,所以需要引用spring-cloud-loadbalancer或者降版本

            
                org.springframework.cloud
                spring-cloud-loadbalancer
            
    

    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;
        }
    

    执行结果如下:

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第10张

    1.5、user 微服务集成 Sentinel

    1.5.1、引入 sentinel 依赖

    在 user 微服务中引入 sentinel 依赖

            
            
                com.alibaba.cloud
                spring-cloud-starter-alibaba-sentinel
            
    

    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 控制台

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第11张

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

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第12张

    c)测试后限流生效

    1.6、网关微服务

    1.6.1、配置 pom.xml

        
            
            
                org.springframework.cloud
                spring-cloud-starter-gateway
            
            
            
                com.alibaba.cloud
                spring-cloud-starter-alibaba-nacos-discovery
            
        
    

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

            
                org.springframework.cloud
                spring-cloud-loadbalancer
            
    

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

            
                com.github.ben-manes.caffeine
                caffeine
            
            
                org.springframework
                spring-context-support
            
    

    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
    

    另外,如果配置跨域,如下:

    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 微服务

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第13张

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第14张

    1.7、nacos 实现配置中心

    1.7.1、建议

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

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

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

    1.7.2、引入 nacos 配置中心依赖

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

            
            
                com.alibaba.cloud
                spring-cloud-starter-alibaba-nacos-config
            
    

    注意:SpringCloudAlibaba 高版本(例如 springcloud-alibaba 2021.0.1.0)会忽略 bootstrap.yml 文件,因此需要加上以下配置 

            
                org.springframework.cloud
                spring-cloud-starter-bootstrap
            
    

    1.7.3、在 nacos 上创建配置

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

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第15张

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

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第16张

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

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第17张

    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 就可以删除了.

    SpringCloudAlibaba - 项目完整搭建(Nacos + OpenFeign + Getway + Sentinel),第18张