springboot2.0+spring cloud+eureka（分布式项目）项目搭建详细教程（附加源码）

刺骨的言语ヽ痛彻心扉 2022-02-28 12:20 280阅读 0赞

**重点：本项目资源地址请点击：[https://download.csdn.net/download/hp\_yangpeng/11064773][https_download.csdn.net_download_hp_yangpeng_11064773]**（ps：最好先看文档，跟着做完，然后再下载demo）

**1、相关环境**

1.  开发工具：idea；
2.  springboot版本：2.1.13
3.  springcloud版本：Finchley.SR1（注意，此处使用的是springboot2.0.x以上的版本，而springcloud对应的版本为Finchley，且springboot2.0相比于springboot1.5.x来说，maven依赖变化较大，这个问题在搭建分布式项目时我会做出说明）
4.  中间件：eureka、fegin（其他中间件比如hystrix、ribbon等后续再添加）；

**2、项目创建**  
**说明：此处我们会创建一个父项目，其他子项目（生产者、消费者、注册中心）均以module的形式在展示在项目目录中，首先比较符合当前开发规范，其次也比较方便；**  
**1. 创建父项目：springbootdemo，具体截图如下：**  
![选择spring Initializr][spring Initializr]注意：此处可以选择一个web依赖，一个Eureka Server依赖  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70]  
在Idea里我将无关的文件全部隐藏了，另外将test给删除了，具体文件目录如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 1]  
pom.xml 做个修改，具体pom.xml配置如下：：  
说明：在创建当前项目的时候选择了springcloud的eureka，但是创建结束之后我发现springcloud的版本号为`<spring-cloud.version>Greenwich.SR1</spring-cloud.version>` 这个我没有细查，所以就直接用下面的配置文件吧，保证是没有问题的；

<dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
            
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>Finchley.SR1</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>

**父项目创建完毕；**  
**2.创建子项目——公共entity项目 springbootdemo-entity**  
项目结构如下：entity子项目中主要有两个entity，包名为：`com.example.springbootdemoentity.entity`；  
entity中的字段自己随便写，我的内容如下：

public class Consumer {
    
        private String name;
        private int age;
        private String add;
        private String email;
    
        public Consumer() {
            this.name = "name";
            this.age = 12;
            this.add = "北京市历史互通";
            this.email = "6666.qq.com";
        }
    
        @Override
        public String toString() {
            return "Consumer{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    ", add='" + add + '\'' +
                    ", email='" + email + '\'' +
                    '}';
        }
    }

/**
     * @author YangPeng
     * @Title: Product
     * @ProjectName springboot
     * @Description: TODO
     * @date 2019/3/25-16:23
     */
    public class Product {
    
        private String name;
        private int age;
        private String add;
        private String email;
    
        public Product() {
            this.name = "name";
            this.age = 12;
            this.add = "北京市历史互通";
            this.email = "6666.qq.com";
        }
    
        @Override
        public String toString() {
            return "Product{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    ", add='" + add + '\'' +
                    ", email='" + email + '\'' +
                    '}';
        }
    }

entity子项目创建结束！！！  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 2]

**3.创建子项目——注册中心 springbootdemo-eureka**  
项目目录如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 3]

*  修改pom.xml，添加eureka依赖，此处需要注意的是要添加springcloud的依赖管理，版本号为Finchley.SR1

<dependencies>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
            </dependency>
        </dependencies>
        <dependencyManagement>
            <dependencies>
                
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>Finchley.SR1</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>

*  修改application.properties为application.yml，并添加如下配置：

server:
      port: 5060
      servlet:
        context-path: /eureka
    spring:
      application:
        name: eureka-server
    eureka:
      client:
        #是否启用湖区注册服务信息，因为这是一个单节点的EurekaServer，不需要同步其他的EurekaServer节点的数据，所以设置为false；
        fetch-registry: false
        #表示是否向eureka注册服务，即在自己的eureka中注册自己，默认为true，此处应该设置为false；
        register-with-eureka: true
        service-url:
          defaultZone:  http://localhost:5060/eureka/eureka
      instance:
        hostname: localhost
      server:
        #设为false，关闭自我保护，即Eureka server在云心光器件会去统计心跳失败比例在15分钟之内是否低于85%,如果低于85%，EurekaServer
        #会将这些事例保护起来，让这些事例不会过期，但是在保护器内如果刚哈这个服务提供者非正常下线了，此时服务消费者会拿到一个无效的服务
        #实例，此时调用会失败，对于这个问题需要服务消费者端有一些容错机制，如重试、断路器等；
        enable-self-preservation: false
        #扫描失效服务的间隔时间（单位是毫秒，摩恩是60*1000)，即60s
        eviction-interval-timer-in-ms: 10000

*  修改启动文件，添加@EnableEurekaServer注解，表示这个是一个Eureka注册中心  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 4]启动eureka项目，并访问：[http://localhost:5060/eureka][http_localhost_5060_eureka] ，出现如下页面表示Eureka项目创建成功！  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 5]  
    **4.创建子项目——生产者 springbootdemo-product**  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 6]说明：此处删除无用的test文件夹，并将application.properties改为application.yml;  
    pom.xml文件修改：
 *  修改该工程的父依赖：  
    原来为：

<parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.3.RELEASE</version>
            <relativePath/> 
        </parent>

修改为：

<parent>
            <groupId>com.example</groupId>
            <artifactId>springbootdemo</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <relativePath/> 
        </parent>

具体配置如下：

<?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>
        <parent>
            <groupId>com.example</groupId>
            <artifactId>springbootdemo</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <relativePath/>
        </parent>
        <groupId>com.example</groupId>
        <artifactId>springbootdemo-product</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>springbootdemo-product</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
      
           <dependency>
                <groupId>com.example</groupId>
                <artifactId>springbootdemo-entity</artifactId>
                <version>0.0.1-SNAPSHOT</version>
                <scope>compile</scope>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-openfeign</artifactId>
            </dependency>
        </dependencies>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>

*  修改resources下的application.properties为application.yml并添加如下配置：

spring:
      application:
        name: product-server
    server:
      port: 7002
      servlet:
        context-path: /product
    eureka:
      client:
        service-url:
        #defaultZone 这个是不会提示的，此处需要自己写
        #实际上属性应该是service-url,这个属性是个map（key-value）格式；当key是defaultZone的时候才能被解析；所以这里没有提示，
        #但是自己还需要写一个defaultZone；
          defaultZone: http://localhost:5060/eureka/eureka

*  创建接口Controller  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 7]
 *  启动类添加注解：添加@EnableEurekaClient和EnableFeginClients注解

@SpringBootApplication
    //@EnableEurekaClient 和 @EnableDiscoveryClient 都是让eureka发现该服务并注册到eureka上的注解
    //相同点：都能让注册中心Eureka发现，并将该服务注册到注册中心上；
    //不同点：@EnableEurekaClient只适用于Eureka作为注册中心，而@EnableDiscoveryClient可以是其他注册中心；
    @EnableEurekaClient
    //表示开启Fegin客户端
    @EnableFeignClients
    public class SpringbootProductApplication {
        public static void main(String[] args) {
            SpringApplication.run(SpringbootProductApplication.class, args);
        }
    
    }

*  启动项目，查看是否注册到eureka注册中心上：下图所示：服务已经注册到注册中心中；  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 8]
 *  访问项目路径，查看RestController接口是否能正确返回数据：[http://localhost:7002/product/getProduct，如下图，接口能正确返回数据][http_localhost_7002_product_getProduct]  
    ![在这里插入图片描述][20190327111751498.png]  
    **至此，Product工程创建结束**

**5.创建子项目——消费者 springbootdemo-cousumer**

*  module的创建过程同product工程的创建过程，此处就不细写了，主要写一下相关的配置文件；
 *  pom.xml文件修改：
 *   *  修改parent父依赖为：

<parent>
            <groupId>com.example</groupId>
            <artifactId>springbootdemo</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <relativePath/> 
        </parent>

*   *  添加依赖如下：

<dependency>
                <groupId>com.example</groupId>
                <artifactId>springbootdemo-entity</artifactId>
                <version>0.0.1-SNAPSHOT</version>
                <scope>compile</scope>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-openfeign</artifactId>
            </dependency>
            <build>
            
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>

*  修改application.properties 为application.yml并添加如下配置：

server:
      servlet:
      #  定义项目的访问访问路径
        context-path: /consumer
        #定义端口号
      port: 7001
    spring:
    #  下面是我整合redis使用的配置，你们此处不需要
    #  redis:
    #    cluster:
    #      expire-seconds: 120
    #      command-timeout: 5000
    #      nodes:   
    #  namenode22:6379,datanode23:6379,datanode24:6379,datanode25:6379,datanode26:6379,datanode27:6379
      application:
      #定义应用名称，即服务名称
        name: consumer-server
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:5060/eureka/eureka

*  启动类添加注解：@EnableEurekaClient和@EnableEurekaClient

@SpringBootApplication
    @EnableEurekaClient
    @EnableFeignClients
    public class SpringbootdemoConsumerApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(SpringbootdemoConsumerApplication.class, args);
        }
    
    }

**- 整合fegin步骤：**

*   *  第一步：启动类中添加注解：@EnableFeignClients，表示开启fegin客户端（该操作我们已经在上面搞定）
 *   *  第二步：创建service接口，在接口的类名称上指明服务名称(application name)和服务的应用名称（contest-path），并在接口中添加方法，方法名上添加 @RequestMapping注解，注解的value就是你要访问的方法的路径；并写明返回值和参数（如果有参数的话，需要使用@RequestParam标注参数名称），具体如下：

下图为我服务的接口相关信息：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 9][]fegin调用接口信息如下：

/**
     * @author YangPeng
     * @Title: ProductService
     * @ProjectName springbootdemo
     * @Description: TODO
     * @date 2019/3/27-11:23
     */
    //name 为product项目中application.yml配置文件中的application.name;
    //path 为product项目中application.yml配置文件中的context.path;
    @FeignClient(name = "product-server",path ="/product" )
    //@Componet注解最好加上，不加idea会显示有错误，但是不影响系统运行；
    @Component
    public interface ProductService {
        @RequestMapping(value = "getProduct")
        String getProduct();
    }

*   *  第三步：创建controller，注入service，并进行调用；

@RestController
    public class ConsumerController {
        @Autowired
        private ProductService productService;
    
        @RequestMapping(value = "getConsumer")
        public String getConsumer(){
           String str =  productService.getProduct();
           return str;
        }
    }

*  启动项目，查看consumer项目是否被注册到注册中心，并访问getConsumer接口；  
    服务已经被注册到注册中心；  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 10]访问服务：[http://localhost:7001/consumer/getConsumer；如下图所示，已经能够使用fegin调用服务的接口了；][http_localhost_7001_consumer_getConsumer_fegin]  
    ![在这里插入图片描述][20190327114016740.png]至此，springboot2.1.13（官网最新版本）+springcloud+eureka+fegin进行远程调用的功能已经完成；欢迎各位留言；

**重点中的重点：鉴于好多朋友的CSDN账号没有C币，所以我把项目传到github上了，哈哈哈哈，朋友们可以直接去github clone下来，地址如下：[https://github.com/yanpgeng/springbootdemo][https_github.com_yanpgeng_springbootdemo] 克隆下来之后直接使用idea工具open这个项目，然后将项目add as maven project即可**

**下一篇：[springboot整合redis集群详解][springboot_redis]**

[https_download.csdn.net_download_hp_yangpeng_11064773]: https://download.csdn.net/download/hp_yangpeng/11064773
[spring Initializr]: /images/20220228/93d9bb4c671b4b23aebcdf9dc9334320.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70]: /images/20220228/010db69b3da242a2ad8022bd17121b92.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 1]: /images/20220228/3421a9965f5a4365acdb2a66be0ca63f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 2]: /images/20220228/644bba339c9e469eabb23523e9b3ebff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 3]: /images/20220228/198c8c8ab36a4104bf274a363353b485.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20190327105614460.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n,size_16,color_FFFFFF,t_70
[http_localhost_5060_eureka]: http://localhost:5060/eureka
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 5]: /images/20220228/0c9bdab87ee444439da862a6323f16cf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 6]: /images/20220228/67b4212e1acf4a2ca9a6d2905fa3fd0d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 7]: /images/20220228/fd3817fe8b43479cbb5c566300c77ce9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 8]: /images/20220228/b85abde3ae2f439e8d32dc8cb1f2455d.png
[http_localhost_7002_product_getProduct]: http://localhost:7002/product/getProduct%EF%BC%8C%E5%A6%82%E4%B8%8B%E5%9B%BE%EF%BC%8C%E6%8E%A5%E5%8F%A3%E8%83%BD%E6%AD%A3%E7%A1%AE%E8%BF%94%E5%9B%9E%E6%95%B0%E6%8D%AE
[20190327111751498.png]: /images/20220228/7191c185090a4c7a915aeb6a821469d3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 9]: /images/20220228/7fda780efae14eeda5c48ca7244bb1e7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n_size_16_color_FFFFFF_t_70 10]: https://img-blog.csdnimg.cn/20190327113843803.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hwX3lhbmdwZW5n,size_16,color_FFFFFF,t_70
[http_localhost_7001_consumer_getConsumer_fegin]: http://localhost:7001/consumer/getConsumer%EF%BC%9B%E5%A6%82%E4%B8%8B%E5%9B%BE%E6%89%80%E7%A4%BA%EF%BC%8C%E5%B7%B2%E7%BB%8F%E8%83%BD%E5%A4%9F%E4%BD%BF%E7%94%A8fegin%E8%B0%83%E7%94%A8%E6%9C%8D%E5%8A%A1%E7%9A%84%E6%8E%A5%E5%8F%A3%E4%BA%86%EF%BC%9B
[20190327114016740.png]: /images/20220228/6e6e6f2a7665418b9d90496f89cdb5cb.png
[https_github.com_yanpgeng_springbootdemo]: https://github.com/yanpgeng/springbootdemo
[springboot_redis]: https://blog.csdn.net/hp_yangpeng/article/details/89002788