使用Idea构建SpringCloud项目（图文详解+简单易懂）

超、凢脫俗 2022-12-01 15:49 734阅读 0赞

### 文章目录 ###

*   *  一。SpringCloud项目简介
     *  二。构建步骤
     *  三。服务调用
     *  四。服务启动
     *  五。访问消费端接口

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

## 一。SpringCloud项目简介 ##

1.SpringCloud项目可划为三个角色，一个是`服务的注册与发现中心（Eureka ）`，一个是`服务的提供方（Provider）`，最后一个是`服务的消费方（Consumer）`，首先我们要保证Eureka能够正常的运行，让Provider在Eureka上注册服务，然后Consumer就能够在Eureka上发现Provider服务，并可以通过RPC远程调用的方式对Provider服务进行调用，这就是一个简单的微服务结构模型。结构图如下所示：

网购现如今已经变成了我们日常生活中不可或缺的部分，我们可以在某些购物平台上根据自己的需要来进行购买。在这个例子中，我们可以把`某购物平台`类比成一个Eureka，把`商家`类比成一个Provider，把`买家`类比成一个Consumer。只有当购物平台正常运作，且商家在该平台进行注册的情况下，买家才能够在该购物平台中搜索到相关商家的产品信息，并进行购买消费。结构图如下所示：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 1]

**示例项目结构如下：**

1.  springcloud\_demo：项目名称
2.  eureka-server：服务注册与发现子模块
3.  provider：服务提供子模块
4.  consumer：服务消费子模块

## 二。构建步骤 ##

**1.构建一个maven项目：**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 2]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 4]

删除新建项目下的src文件夹，因为我们只需要新建项目的架子，让其存放其他的子服务：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 10]

导入依赖：

![在这里插入图片描述][20200828100013184.png_pic_center]

创建成功效果图：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 12]

**4.创建服务消费子模块：`consumer`，除了Spring Cloud Discovery中勾选Eureka Discovery Client外，创建方式与创建eureka-server子模块方式一致**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 13]

**5.构建完成后项目结构如下：**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 14]

## 三。服务调用 ##

**1.eureka-server子模块：**

在该启动类中加上`@EnableEurekaServer`注解，声明为注册中心：

package com.example.eurekaserver;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
    
    
    //启动类标识
    @SpringBootApplication
    //声明为注册中心
    @EnableEurekaServer
    public class EurekaServerApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(EurekaServerApplication.class, args);
        }
    
    }

把resources下的application.properties文件名改为`application.yml`（快捷键：shift+f6），并添加以下内容：

server:
      #运行端口
      port: 8888
    eureka:
      instance:
        #注册ip
        hostname: localhost
      client:
        #禁止自己当做服务注册
        register-with-eureka: false
        #屏蔽注册信息
        fetch-registry: false
        #注册url
        serviceUrl:
          defaultZone: http://${ eureka.instance.hostname}:${ server.port}/eureka/

**2.provider子模块：**

在该启动类中加上`@EnableEurekaClient`注解，声明为注册服务：

package com.example.provider;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
    
    //启动类标识
    @SpringBootApplication
    //声明为注册服务
    @EnableEurekaClient
    public class ProviderApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(ProviderApplication.class, args);
        }
    
    }

把resources下的application.properties文件名改为`application.yml`（快捷键：shift+f6），并添加以下内容：

eureka:
      client:
        serviceUrl:
          #服务注册地址
          defaultZone: http://localhost:8888/eureka/
    server:
      #运行端口
      port: 8763
    spring:
      application:
        #服务注册名称
        name: service-provider

新建controller包，并新建控制器类`TestController`示例：

package com.example.provider.controller;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * @Description：服务端控制器 * @Author :zks * @Date :16:07 2020/8/27 */
    @RequestMapping("test")
    @RestController
    public class TestController { 
    
        @RequestMapping("getName")
        public String getName(){ 
            return "SpringCloud!";
        }
    }

完成后子模块结构如下：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 15]

**3.consumer子模块：**

在该启动类中加上`@EnableEurekaClient`注解，声明为注册服务：

把resources下的application.properties文件名改为`application.yml`（快捷键：shift+f6），并添加以下内容：

eureka:
      client:
        serviceUrl:
          #服务注册地址
          defaultZone: http://localhost:8888/eureka/
    server:
      #运行端口
      port: 8764
    spring:
      application:
        #服务注册名称
        name: service-consumer

**调用方式一：`使用RestTemplate调用注册子模块接口方法`**

新建service包，并新建一个`ConsumerService`类:

package com.example.consumer.service;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    import org.springframework.web.client.RestTemplate;
    
    /** * @Description：使用RestTemplate调用注册子模块接口方法 * @Author :zks * @Date :16:14 2020/8/27 */
    @Service
    public class ConsumerService { 
    
        @Autowired
        private RestTemplate restTemplate;
    
        public String getName() { 
            //调用子模块接口地址
            String name = restTemplate.getForObject("http://service-provider/test/getName", String.class);
            return name;
        }
    }

在启动类中加入以下代码，把RestTemplate注入到Spring容器中：

//把RestTemplate注入到Spring容器中（不然会找不到该RestTemplate类）
        @Bean
        @LoadBalanced
        RestTemplate restTemplate() { 
            return new RestTemplate();
        }

**调用方式二：`使用@FeignClient注解调用注册子模块接口方法`**

在service包下新建一个`ConsumerService1`类:

package com.example.consumer.service;
    
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.web.bind.annotation.GetMapping;
    
    /** * @Description：使用@FeignClient注解调用注册子模块接口方法 * @Author :zks * @Date :16:31 2020/8/27 */
    //注册子模块名称
    @FeignClient(value = "service-provider")
    public interface ConsumerService1 { 
    
        //接口访问地址
        @GetMapping("test/getName")
        public String getName1();
    
    }

在启动类中加入`@EnableFeignClients`注解，把调用注册子模块接口引入到Spring容器中：

//把调用注册子模块接口引入到Spring容器中（不加此注解会出现找不到@FeignClient修饰的接口）
    @EnableFeignClients

**含有两种调用方式的启动类：**

package com.example.consumer;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.cloud.openfeign.EnableFeignClients;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.client.RestTemplate;
    
    //启动类标识
    @SpringBootApplication
    //声明为注册服务
    @EnableEurekaClient
    //把调用注册子模块接口引入到Spring容器中（不加此注解会出现找不到@FeignClient修饰的接口）
    @EnableFeignClients
    public class ConsumerApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(ConsumerApplication.class, args);
        }
    
        //把RestTemplate注入到Spring容器中（不然会找不到该RestTemplate类）
        @Bean
        @LoadBalanced
        RestTemplate restTemplate() { 
            return new RestTemplate();
        }
    
    }

新建controller包，并新建控制器类`ConsumerController`：

package com.example.consumer.controller;
    
    import com.example.consumer.service.ConsumerService;
    import com.example.consumer.service.ConsumerService1;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * @Description：消费端控制器 * @Author :zks * @Date :16:18 2020/8/27 */
    @RequestMapping("consumer")
    @RestController
    public class ConsumerController { 
    
        @Autowired
        private ConsumerService consumerService;
    
        @Autowired
        private ConsumerService1 consumerService1;
    
        /**方式一：RestTemplate调用 * @return */
        @RequestMapping("getName")
        public String getName(){ 
            return consumerService.getName();
        }
    
        /** * 方式二：@FeignClient调用 * @return */
        @RequestMapping("getName1")
        public String getName1(){ 
            return consumerService1.getName1();
        }
    
    
    }

完成后子模块结构如下：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 17]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 18]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 19]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 20]

## 四。服务启动 ##

**1.首先启动`eureka-server`**

找到该子模块的启动类，启动该模块：

![在这里插入图片描述][20200828111933882.png_pic_center]  
启动成功：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 22]

**2.然后启动`provider-server`**

找到该子模块的启动类，启动该模块：

![在这里插入图片描述][20200828112558164.png_pic_center]  
启动成功：

找到该子模块的启动类，启动该模块：

![在这里插入图片描述][2020082811301970.png_pic_center]  
启动成功：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 26]

至此相关服务以及全部启动完成。

## 五。访问消费端接口 ##

**1.在浏览器中输入：`http://localhost:8764/consumer/getName`，成功得到返回结果：**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 27]

**2.在浏览器中输入：`http://localhost:8764/consumer/getName1`，成功得到返回结果：**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/67d81364c621480f8f02f01db16e65ab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/f90e41fb964440bfa8f1a27df4086806.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/6dbb2969025f432db28fa65d7730e0a5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221123/76b2bc3a4b1a4d8484ad47b44c796c35.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221123/5f488446ab6242ce8aa52c4f5d06c162.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221123/0cd7d3c72a8f4db283afd53da99a1bf8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221123/892ca85477a449759720b3bc36e89be4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221123/3561477441f24298b74c7ffb5e333a97.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 8]: /images/20221123/12528cccf1ce4313a0c5f161b0982c7d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 9]: /images/20221123/fa65210fe08b426599c9c0f1852ec38b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 10]: /images/20221123/7fea55447dcb45c5bc7782182ea8b2ec.png
[20200828100013184.png_pic_center]: /images/20221123/592de566b3884b4681304193f0f82704.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 11]: /images/20221123/61c1bac23870415b984d9d32e429b924.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 12]: /images/20221123/a59eefbf030d4b5e896ff2cb3739b7a3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 13]: /images/20221123/7b2d6a79df2a44a79af1e2da834094e5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 14]: /images/20221123/bb2ba9ad292d4dba9fa6a8fa842ba3b7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 15]: /images/20221123/5def9109bc454f41b5777dd30285b049.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 16]: /images/20221123/97d6cb34a6da42af8bc8a274d62784e9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 17]: /images/20221123/50fc1dc977c54435b05c77e06dd80258.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 18]: /images/20221123/964d5c34f02d422283396d42e1c29fa3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 19]: /images/20221123/7e50d7d0cd7349099ae3d56275ac8651.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 20]: /images/20221123/d613ed190c594d11a9187a0997047951.png
[20200828111933882.png_pic_center]: /images/20221123/65de0c817aad403aaba64ba94e05fbf3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 21]: /images/20221123/a43debb256e44cdcb8364819dfef7577.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 22]: /images/20221123/4715ae9334d64682a6c9d3abe3644a86.png
[20200828112558164.png_pic_center]: /images/20221123/6e593e7ec01f4c51b94adcb4d681a97c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 23]: /images/20221123/7bc8890359804b5a8f62f01295dcfbc9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 24]: /images/20221123/875b0ef1a7484dd2982e16ad3be66c32.png
[2020082811301970.png_pic_center]: /images/20221123/cc00db3043af4f258dd6e86d60c13b80.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 25]: /images/20221123/9bb467e1f79b480e9526c0c72adad265.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 26]: /images/20221123/8df043b9a7d54ac588ca3ddcd42947d6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 27]: /images/20221123/5acc42ac1bcc4c42b2aa469878db3d63.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 28]: /images/20221123/49f06a9f03864073ad7fd4107f602f51.png
[springcloud_demo]: https://download.csdn.net/download/weixin_44009447/12836671