Spring Cloud + consul 配合搭建微服务

关于consul 的介绍这尽量少.网上很多如何安装及使用的教程 可以参考官网教程consul官网

• 首先保证consul服务正常启用 如本地则访问localhost:8500(在不修改任何配置的默认情况下能看到UI界面)如下图 consul UI

图上unified-user-data 为本人整体测试项目统一认证的SSO项目.基本启动只可能看到consul这一个节点

• 接下来创建spring项目
  POM文件:

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

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <project.version>1.0.0</project.version>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
        <fastjson.version>1.2.31</fastjson.version>
        <jwt.sersion>0.6.0</jwt.sersion>
    </properties>

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

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>${fastjson.version}</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <!--jwt-->
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt</artifactId>
            <version>${jwt.sersion}</version>
        </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>
        </dependencies>
    </dependencyManagement>

除了正常引入的spring 内容后主要增加了spring-cloud-starter-openfeign 及spring-cloud-starter-consul-discovery 主要作用为引入consul及使用consul下的feign熔断
接下来配置项目所需配置文件

application.yml

spring:
  cloud:
    consul:
         port: 8500
         host: hostname
     discovery:
      service-name=${spring.application.name}
      enabled=true
      tags: dev
      health-check-path: /health

management:
    endpoint:
      health:
          show-details: always

上诉对应配置为
port: 接入的端口
host: 填写ip(之前做过负载想接入URL 但是没成功还未发现如何不用ip使用url的方式)

service-name: 填写接入注册服务的名称
discovery.enabled启用 consul 配置中心
tags 标签在UI上显示
health-check-path 健康检查地址 我本地写了一个requestMapping 作为返回
management.endpoint.health.show-details 作为节点检查时如出现红叉进行排查使用 他会在server-check中显示问题原因

接下来spring 启动main方法

@SpringBootApplication
@EnableDiscoveryClient
@RestController
public class Application {

    public static void main(String[] args){
        SpringApplication.run(Application.class , args);
    }

    @GetMapping("/health")
    public String health(){
        return "OK";
    }
}

在注解上写入@EnableDiscoveryClient 便可进行使用

以上内容则为正常看完后了解到的..当时就很纳闷那我接下来该如何做如何配置.毕竟第一次接触到.后续就发现正常编写所有controller.service.dao.domain等等业务逻辑.并跟controller编写好后其实已经完成了微服务的注册.后续的引用则可以直接使用feign的方式进行使用.下述富有内容

假设我们已经有一个spring.application.name= Demo的服务
我们新建一个module作为client进行调用POM文件参照上述文件
增加一个新的application.yml

client端application.yml

spring:
  cloud:
    consul:
      port: 8500
      host: hostname
      discovery:
        register: false #不注册到consul中
    config:
      enabled: false
feign:
  hystrix:
    enabled: true

创建调用的service

@FeignClient(name = "Demo" , fallback = ApiFallbackService.class)
public interface IApiService {

    @RequestMapping(value = "/Api" , method = RequestMethod.GET)
    ResultModel getApi(@RequestParam("method")String method , @RequestParam("content")String content , @RequestParam("token")String token);

    @RequestMapping(value = "/Api" , method = RequestMethod.POST)
    ResultModel postApi(@RequestBody JSONObject jsonObject);

    @RequestMapping(value = "/Api" , method = RequestMethod.PATCH)
    ResultModel patchApi(@RequestBody JSONObject jsonObject);

    @RequestMapping(value = "/Api" , method = RequestMethod.DELETE)
    ResultModel deleteApi(@RequestParam("method")String method , @RequestParam("content")String content , @RequestParam("token")String token);
}

feignClient的name值为服务端注册进的service-name ,fallback则为熔断机制,如担心接口异常可以增加. 下述的所有RequstMapping 个人理解就为调用接口一样.直接将服务端的接口描述好.直接调用service使用.value值填写则为服务端ResutMapping对应的值.方法名可以不同名.

调用方法我们就可以创建一个service类并将FeignClient的service引入进行调用使用

@Service
public class OrganizationService {

    @Resource
    private IApiService apiService;

    public ResultModel getOrganization(String content , String token) {
        return apiService.getApi(OrganizationCommon.GET_ORGANIZATION_METHOD , content , token);
    }

    public ResultModel getKmairOrganization(String content , String token) {
        return apiService.getApi(OrganizationCommon.GET_KMAIR_ORGNIZATION_METHOD , content , token);
    }
}

到目前为止其实关于consul我们的声明及调用都已经结束.
后面将介绍关于spring cloud 及 consul 服务端之间调用如果需要token认证等机制问题添加.
为本人最近填坑填写的内容.如描述不好请原谅哈..