专栏首页Spring专栏SpringCloud 初始化父子项目并集成 Consul 服务发现
原创

SpringCloud 初始化父子项目并集成 Consul 服务发现

SpringCloud 初始化父子项目并集成 Consul 服务发现

准备工作

开始

简介:consul的功能

  • 服务发现
  • Key/Value存储
  • 健康检查

今天我们主要来学习实践服务发现功能

先到 https://start.spring.io/ 初始化一个父项目

初始化一个父项目

生成之后解压,先用IDE编辑文件修改pom.xml,如下图,在底部 </build> 标签下切换国内阿里源

<repositories>
        <!--阿里云主仓库,代理了maven central和jcenter仓库-->
        <repository>
            <id>aliyun</id>
            <name>aliyun</name>
            <url>https://maven.aliyun.com/repository/public</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
        <!--阿里云代理Spring 官方仓库-->
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://maven.aliyun.com/repository/spring</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

保存,然后使用 IDEA 打开,等Maven加载完毕

新建子项目

右击项目名称,New -> Module

New -> Module

包名自定义,不一定非要相同,这里的包名或许后面也要改掉

设置子模块信息

下一步选择包,先跳过,点击Finish 完成

关联父子项目

在父 Modulepom.xml中的<dependencies>标签上部新增

	<modules>
		<module>pro-service</module>
	</modules>

如图示

修改后的父pom

在子项目 pro-service 中的 <modelVersion>4.0.0</modelVersion> 标签后追加

    <parent>
        <groupId>com.github.springtools</groupId>
        <artifactId>SpringCloudPro</artifactId>
        <version>0.0.1</version>
    </parent>到这里会发现Maven找不到一些Spring Boot的依赖
在父项目增加管理依赖版本号的定义
在父项目增加管理依赖版本号
最终的父项目pom.xml

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.github.springtools</groupId>
<artifactId>SpringCloudPro</artifactId>
<version>0.0.1</version>
<name>SpringCloudPro</name>
<description>父项目</description>
<packaging>pom</packaging>
<properties>
    <java.version>1.8</java.version>
    <spring-cloud.version>Hoxton.SR5</spring-cloud.version>
    <spring-boot.version>2.3.0.RELEASE</spring-boot.version>
</properties>
<modules>
    <module>pro-service</module>
</modules>
<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-consul-config</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-consul-discovery</artifactId>
    </dependency>
    <!--监控-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
        <exclusions>
            <exclusion>
                <groupId>org.junit.vintage</groupId>
                <artifactId>junit-vintage-engine</artifactId>
            </exclusion>
        </exclusions>
    </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>
        <!--支持Spring Boot 2.3.X-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${spring-boot.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>
<repositories>
    <!--阿里云主仓库,代理了maven central和jcenter仓库-->
    <repository>
        <id>aliyun</id>
        <name>aliyun</name>
        <url>https://maven.aliyun.com/repository/public</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
    <!--阿里云代理Spring 官方仓库-->
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://maven.aliyun.com/repository/spring</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

</project>

子项目`pom.xml`
```xml

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
    <groupId>com.github.springtools</groupId>
    <artifactId>SpringCloudPro</artifactId>
    <version>0.0.1</version>
</parent>
<artifactId>pro-service</artifactId>
<version>0.0.1</version>
<name>pro-service</name>
<description>业务模块</description>
<properties>
    <java.version>1.8</java.version>
</properties>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>
<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

</project>

项目结构图
![项目结构图](https://img-blog.csdnimg.cn/20200603000004795.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0ZpbmVfQ3Vp,size_16,color_FFFFFF,t_70)
## 集成服务发现 Consul
父项目添加如下依赖,在上述的最终父项目`pom.xml`中已经加过了,这里简要说明

![依赖简要说明](https://img-blog.csdnimg.cn/20200603000426852.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0ZpbmVfQ3Vp,size_16,color_FFFFFF,t_70)
在`pro-service`中的`resources`目录下,删除自带的`application.properties`,新增`bootstrap.yml`  

因为后续的`config`要用到,`bootstrap`比`application.properties`加载优先级别高
 
 ## 完善子项目并注册到 Consul
 
**bootstrap.yml**
```yaml

spring:

application:

name: pro-service

cloud:

consul:
  discovery:
    health-check-path: /actuator/health  # 检测实例健康
    health-check-interval: 10s   # 每隔10s检查
    hostname: localhost    # 配置实例地址
    register: true  # 自动注册
    service-name: ${spring.application.name} # 实例名称
  host: localhost
  port: 8500
ps:这里的`spring.application.name`与`spring.cloud.consul.discovery.service-name`一定要加,不然会抛出异常

Caused by: java.lang.IllegalArgumentException: Consul service ids must not be empty, must start with a letter, end with a letter or digit, and have as interior characters only letters, digits

-- 参考:https://www.jianshu.com/p/83d3a8105620

定义启动类 `ProServiceApplication.java`
```java

package com.github.springtools.proservice;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RestController;

@RestController

@EnableDiscoveryClient

@SpringBootApplication

public class ProServiceApplication {

@GetMapping("/")
public String hello() {
    return "Hello world";
}
public static void main(String[] args) {
    SpringApplication.run(ProServiceApplication.class, args);
}

}

启动

启动完成

打开Consul Web 控制台 http://localhost:8500

发现已经注册上去

好了,今天就先写到这里了

源代码地址

https://github.com/Gleans/SpringCloudPro

ps:写着写着又凌晨一点了,头发又少了,一天天儿~的过得也太快了,淦

原创声明,本文系作者授权云+社区发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • SpringBoot2.x与MongoDB集成(十)

    介绍MongoDB与Spring Boo集成,并通过MongoRepository以及MongoTemplate来执行CRUD操作。

    拾荒者的笔记
  • 都2020年了,你还不会写简洁的Java代码!

    Java之道,写的代码第一点是要别人能看的明白,不然你离职了留下一堆像shi一样的代码,接盘的人一定会问候你的亲人,何必呢

    拾荒者的笔记
  • 一文整懂 Java 中静态代码块 / 初始块 / 构造方法的执行顺序

    “ 相信,刷过面试题应该都碰到过很多题,关于类继承后 Java 中静态代码块 / 初始块 / 构造方法的执行顺序问题,每每记一下又忘了,那么,今天来用不多的时间...

    拾荒者的笔记
  • spring整合ORM框架

    注:本文篇幅有点长,总字数3万多,所以建议各位下载源码学习。(如需要请收藏!转载请声明来源,谢谢!)

    逍遥壮士
  • SSM项目搭建

    其他结构图,参考https://blog.csdn.net/zhuangxingzan/article/details/90598439

    逆回十六夜
  • spring data jpa 入门

    项目中有用到spring data jpa,简单看了一下,在基础的数据库操作上,要比mybatis好用,简化了持久层的操作,使coder可以专注于业务逻辑的实现...

    用户2146693
  • SpringCloud 2.x学习笔记:12、Spring Cloud Gateway简单例子(Greenwich版本)

    Spring Cloud Gateway是Spring Cloud官方推出的第二代网关框架,取代Zuul网关。 Spring Cloud Gateway构建于...

    程裕强
  • Spring Cloud中服务的发现与消费

    通过前面两篇文章(使用Spring Cloud搭建服务注册中心、使用Spring Cloud搭建高可用服务注册中心)的学习,相信小伙伴们已经可以自己搭建一个单节...

    江南一点雨
  • ELK入门使用-与springboot集成

    ELK官方的中文文档写的已经挺好了,为啥还要记录本文?因为我发现,我如果不写下来,过几天就忘记了,而再次捡起来必然还要经历资料查找筛选测试的过程。虽然这个过程很...

    Ryan-Miao
  • 史上最简单的SpringCloud教程 | 第三篇: 服务消费者(Feign)

    上一篇文章,讲述了如何通过RestTemplate+Ribbon去消费服务,这篇文章主要讲述如何通过Feign去消费服务。 一、Feign简介 Feign是一个...

    方志朋

扫码关注云+社区

领取腾讯云代金券