Polaris【北极星】企业级云原生微服务框架

如果本文档由于Github网速原因无法完整阅读，请访问

如果本代码由于Github网速原因无法快速阅读，请访问

如果指南示例的代码和文档由于Github网速原因无法快速阅读，请访问

指南示例包含两个版本，请访问

普遍适用版本，参考指南示例极简版获取，分支为master
基于Spring Boot 2.3.x特性制作的Docker版本，参考指南示例高级版获取，分支为premium

前言

① 云原生（Cloud Native）定义

英文版定义

Cloud native technologies empower organizations to build and run scalable applications in modern, dynamic environments such as public, private, and hybrid clouds. Containers, service meshes, microservices, immutable infrastructure, and declarative APIs exemplify this approach.

These techniques enable loosely coupled systems that are resilient, manageable, and observable. Combined with robust automation, they allow engineers to make high-impact changes frequently and predictably with minimal toil.

The Cloud Native Computing Foundation seeks to drive adoption of this paradigm by fostering and sustaining an ecosystem of open source, vendor-neutral projects. We democratize state-of-the-art patterns to make these innovations accessible for everyone.

中文版定义

云原生技术有利于各组织在公有云、私有云和混合云等新型动态环境中，构建和运行可弹性扩展的应用。云原生的代表技术包括容器、服务网格、微服务、不可变基础设施和声明式API。

这些技术能够构建容错性好、易于管理和便于观察的松耦合系统。结合可靠的自动化手段，云原生技术使工程师能够轻松地对系统作出频繁和可预测的重大变更。

云原生计算基金会（CNCF）致力于培育和维护一个厂商中立的开源生态系统，来推广云原生技术。我们通过将最前沿的模式民主化，让这些创新为大众所用。

-- 摘自Github CNCF官网CNCF Cloud Native Definition v1.0

② 云原生（Cloud Native）要素

Pivotal官网对云原生概括为4个要素，如下

要素	描述
Micro Service	微服务
Container	容器
DevOps	开发运维一体化，包含CI（Continuous Integration）持续集成
CD（Continuous Delivery）	持续交付

③ 云原生（Cloud Native）所需能力与特征

下文着重刻画Micro Service的架构，描述DevOps的边界，展现Container的落地，但不涉及CD（Continuous Delivery）的层面

简介

Polaris【北极星】企业级云原生微服务基础架构脚手架，围绕Discovery【探索】框架打造，基于Spring Cloud Discovery服务注册发现、Ribbon负载均衡、Feign和RestTemplate调用等组件全方位增强的企业级云原生微服务开源解决方案，面向企业级生产需求精雕细琢，赋能和助力企业快速搭建基础架构的底层云原生微服务框架。整个架构体系打造，遵循最严格的Maven对称结构和规范，最严格的命名格式，给予使用者最舒适的使用体验

支持如下中间件的集成和封装

支持阿里巴巴Nacos、Eureka、Consul和Zookeeper四个服务注册发现中心
支持阿里巴巴Nacos、携程Apollo两个远程配置中心
支持阿里巴巴Sentinel和Hystrix两个熔断限流降级权限中间件
支持Uber Jaeger、Apache Skywalking两个符合OpenTracing规范的调用链中间件
支持Prometheus Micrometer和Spring Boot Admin两个指标中间件
支持Java Agent解决异步跨线程ThreadLocal上下文传递
支持Spring Cloud Gateway、Zuul网关、微服务、控制台、自动化测试五个独立的应用模块
支持和兼容Spring Cloud Finchley版、Greenwich版和Hoxton版。默认集成Hoxton版，如果需要，请使用者自行修改成其它两个版本

支持如下应用型的功能

支持灰度蓝绿发布、灰度路由过滤、流量权重、限流、熔断、降级、隔离、监控、追踪等企业生产级功能
支持动态域名、双云双活和SET单元化的配置，支持跨云的服务注册和配置读取（例如，阿里云上的微服务想要注册到华为云上的Nacos注册中心，或者跨云读取Apollo配置中心的配置，通过DevOps修改相关配置驱动即可）。一套SDK体系可以同时适配和运行在不同的云上
支持在核心的pom.xml上实现同类型的组件的快速切换（例如，Eureka注册中心切换到Consul，Apollo配置中心切换到Nacos等），但同类型组件不可并存使用（例如，Eureka和Consul注册中心不可同时并存，Apollo和Nacos配置中心不可同时并存等）
支持框架层面实现每个组件对四个环境（DEV | FAT | UAT | PRO）的内置最佳配置，遵循全局公共配置和局部环境配置相结合的方式，遵循“约定大于配置”的策略，业务层面实现微量配置甚至零配置。框架集成人员可以内置定制化的配置，业务开发人员在业务层可以把内置的配置覆盖掉，达到扩展性强、灵活使用的目的
支持业务开发人员使用该框架的时候，对其尽最大可能屏蔽一切跟Spring Cloud和中间件有关的代码书写、配置参数、环境地址等，零Spring Cloud经验的业务开发人员也可以快速上手研发基于Spring Cloud微服务技术栈的业务服务，最大程度上减轻业务人员的压力

请联系我

微信、公众号和文档

Alt text

架构工程

工程介绍

工程名	描述
polaris-parent	Polaris Parent定义
polaris-platform	Polaris平台目录
polaris-component	Polaris组件目录
polaris-component-common	Polaris通用组件
polaris-component-env	Polaris环境组件，支持动态域名、双云双活和SET单元化支持DEV、FAT、UAT、PRO四个环境配置动态读取
polaris-component-banner	Polaris旗标组件，启动时显示旗标和重要中间件版本号信息
polaris-component-apollo	Polaris Apollo组件目录
polaris-component-apollo-starter-config	Polaris Apollo配置组件的封装
polaris-component-nacos	Polaris Nacos组件目录
polaris-component-nacos-starter-config	Polaris Nacos配置组件的封装
polaris-component-nacos-starter-discovery	Polaris Nacos注册发现组件的封装
polaris-component-consul	Polaris Consul组件目录
polaris-component-consul-starter-discovery	Polaris Consul注册发现组件的封装
polaris-component-eureka	Polaris Eureka组件目录
polaris-component-eureka-starter-discovery	Polaris Eureka注册发现组件的封装
polaris-component-zookeeper	Polaris Zookeeper组件目录
polaris-component-zookeeper-starter-discovery	Polaris Zookeeper注册发现组件的封装
polaris-component-jaeger	Polaris Jaeger组件目录
polaris-component-jaeger-starter	Polaris Jaeger调用链组件的封装
polaris-component-jaeger-starter-sentinel	Polaris Jaeger调用链组件集成Sentinel的封装
polaris-component-skywalking	Polaris Skywalking组件目录
polaris-component-skywalking-starter	Polaris Skywalking调用链组件的封装
polaris-component-skywalking-starter-sentinel	Polaris Skywalking调用链组件集成Sentinel的封装
polaris-component-prometheus	Polaris Prometheus组件目录
polaris-component-prometheus-starter-micrometer	Polaris Prometheus指标组件集成Micrometer的封装
polaris-component-spring-boot-admin	Polaris Spring Boot Admin组件目录
polaris-component-spring-boot-admin-starter	Polaris Polaris Spring Boot Admin指标组件的封装
polaris-component-gray	Polaris Gray版本灰度蓝绿，区域路由，环境隔离等组件目录
polaris-component-gray-common	Polaris Gray通用组件
polaris-component-gray-starter-gateway	Polaris Gray集成Spring Cloud Gateway网关的封装
polaris-component-gray-starter-zuul	Polaris Gray集成Zuul网关的封装
polaris-component-gray-starter-service	Polaris Gray集成微服务的封装
polaris-component-agent	Polaris Java Agent组件目录
polaris-component-agent-starter-cross-thread	Polaris支持跨线程异步调用Agent组件
polaris-component-hystrix	Polaris Hystrix限流熔断组件目录
polaris-component-hystrix-starter	Polaris支持Hystrix跨线程异步调用组件
polaris-component-sentinel	Polaris Sentinel限流熔断组件目录
polaris-component-sentinel-common	Polaris Sentinel通用组件
polaris-component-sentinel-config-starter-apollo	Polaris Sentinel集成Apollo配置组件的封装
polaris-component-sentinel-config-starter-nacos	Polaris Sentinel集成Nacos配置组件的封装
polaris-component-sentinel-starter-gateway	Polaris Sentinel集成Spring Cloud Gateway网关的封装
polaris-component-sentinel-starter-zuul	Polaris Sentinel集成Zuul网关的封装
polaris-component-sentinel-starter-service	Polaris Sentinel集成微服务的封装
polaris-component-console	Polaris控制台组件目录
polaris-component-console-config-starter-apollo	Polaris控制台集成Apollo配置组件的封装
polaris-component-console-config-starter-nacos	Polaris控制台集成Nacos配置组件的封装
polaris-component-console-starter	Polaris控制台组件
polaris-component-core	Polaris核心组件目录，主要是组装和代理基础底层组件
polaris-component-core-starter-banner	Polaris旗标组件的组装
polaris-component-core-starter-discovery	Polaris注册发现组件的组装
polaris-component-core-starter-discovery-gray	Polaris灰度蓝绿对注册发现组件的组装
polaris-component-core-starter-config	Polaris配置组件的组装
polaris-component-core-starter-config-gray	Polaris灰度蓝绿对配置组件的组装
polaris-component-core-starter-config-console	Polaris控制台对配置组件的组装
polaris-component-core-starter-config-sentinel	Polaris Sentinel对配置组件的组装
polaris-component-core-starter-protector-gateway	Polaris防护组件集成Spring Cloud Gateway网关的组装
polaris-component-core-starter-protector-zuul	Polaris防护组件集成Zuul网关的组装
polaris-component-core-starter-protector-service	Polaris防护组件集成微服务的组装
polaris-component-core-starter-tracing	Polaris调用链组件的组装
polaris-component-core-starter-metrics	Polaris指标组件的组装
polaris-component-core-starter-gray-gateway	Polaris灰度蓝绿组件集成Spring Cloud Gateway网关的组装
polaris-component-core-starter-gray-zuul	Polaris灰度蓝绿组件集成Zuul网关的组装
polaris-component-core-starter-gray-service	Polaris灰度蓝绿组件集成微服务的组装
polaris-component-core-starter-console	Polaris控制台组件的组装
polaris-component-core-starter-test	Polaris测试组件的组装
polaris-component-test	Polaris测试组件目录
polaris-component-test-starter-automation	Polaris自动化测试组件
polaris-framework	Polaris框架目录
polaris-framework-starter-console	Polaris框架对控制台的封装
polaris-framework-starter-gateway	Polaris框架对Spring Cloud Gateway网关的封装
polaris-framework-starter-zuul	Polaris框架对Zuul网关的封装
polaris-framework-starter-service	Polaris框架对微服务的封装
polaris-framework-starter-test	Polaris框架对测试的封装

集成步骤

集成入口

集成入口位于polaris-framework模块下，包括如下五个子模块

polaris-framework-starter-gateway
polaris-framework-starter-zuul
polaris-framework-starter-service
polaris-framework-starter-console
polaris-framework-starter-test

以polaris-framework-starter-service为例，展现出高度对称统一的架构美感

<?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">
    <artifactId>polaris-framework-starter-service</artifactId>
    <name>Nepxion Polaris Framework Starter Service</name>
    <packaging>jar</packaging>
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.nepxion</groupId>
        <artifactId>polaris-framework</artifactId>
        <version>1.0.0</version>
    </parent>

    <dependencies>
        <!-- 旗标核心组件 -->
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>polaris-component-core-starter-banner</artifactId>
            <version>${project.version}</version>
        </dependency>

        <!-- 注册发现核心组件 -->
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>polaris-component-core-starter-discovery</artifactId>
            <version>${project.version}</version>
        </dependency>

        <!-- 配置核心组件 -->
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>polaris-component-core-starter-config</artifactId>
            <version>${project.version}</version>
        </dependency>

        <!-- 调用链核心组件 -->
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>polaris-component-core-starter-tracing</artifactId>
            <version>${project.version}</version>
        </dependency>

        <!-- 指标核心组件 -->
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>polaris-component-core-starter-metrics</artifactId>
            <version>${project.version}</version>
        </dependency>

        <!-- 防护核心组件 -->
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>polaris-component-core-starter-protector-service</artifactId>
            <version>${project.version}</version>
        </dependency>

        <!-- 灰度蓝绿核心组件 -->
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>polaris-component-core-starter-gray-service</artifactId>
            <version>${project.version}</version>
        </dependency>
    </dependencies>
</project>