淘东电商项目(11) -Apollo分布式配置中心管理Swagger

简介: 淘东电商项目(11) -Apollo分布式配置中心管理Swagger

引言

在上一节《淘东电商项目(10) -Apollo分布式配置中心管理application.yml》,主要讲解了把微服务项目的application.yml配置托管到Apollo分布式配置中心托管。

代码已提交至Github(版本号:3bc1cd6540ba8bd6b7fb67051d3c9eb048effce0),有兴趣的同学可以下载来看看:https://github.com/ylw-github/taodong-shop

本文继续讲解分布式基础设施环境的搭建,主要讲解如何把网关的Swagger配置托管至Apollo配置中心。

阅读本文之前,建议先阅读如下前面的两篇博客:

《淘东电商项目(05) - Swagger及网关统一管理API》

《淘东电商项目(10) -Apollo分布式配置中心管理application.yml》

本文目录结构:

l____引言

l____ 1. Apollo管理网关项目的application.yml

l____ 2. Apollo管理Swagger

l________ 2.1 Apollo配置Swagger

l________ 2.2 项目代码配置动态获取Swagger信息

l____ 3. 测试

l____总结

1. Apollo管理网关项目的application.yml

step1: 网关项目添加apollo的maven依赖:

<dependency>
  <groupId>com.ctrip.framework.apollo</groupId>
  <artifactId>apollo-client</artifactId>
  <version>1.0.0</version>
</dependency>
<dependency>
  <groupId>com.ctrip.framework.apollo</groupId>
  <artifactId>apollo-core</artifactId>
  <version>1.0.0</version>
</dependency>

step2: 启动类允许Apollo配置@EnableApolloConfig

@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
@EnableSwagger2Doc
@EnableApolloConfig
public class AppGateWay {
  //省略此处代码。。。
}

step3: Apollo新建项目

step4: 配置文件转换后,粘贴至Apollo网关项目,并发布:

step5: 新增application.properties,内容如下:

app.id=app-basics-zuul
apollo.meta=http://192.168.162.135:8080

step6: 启动项目,可以看到网关服务正常启动:

2. Apollo管理Swagger

我们看一下网关服务的启动类代码,可以看到swagger的配置代码都是写死的,那么如何配置到Apollo呢?

2.1 Apollo配置Swagger

可以自定义Swagger文档配置:taodong-shop.zuul.swagger.document,每个微服务的配置文件,以json数组的格式保存内容如下。

[
    {
        "name": "taodong-shop-service-member",
        "location": "/taodong-shop-service-member/v2/api-docs",
        "version": "2.0"
    },
    {
        "name": "taodong-shop-service-weixin",
        "location": "/taodong-shop-service-weixin/v2/api-docs",
        "version": "2.0"
    }
]

然后在Apollo添加配置:

发布:

2.2 项目代码配置动态获取Swagger信息

Apollo的配置已经完成了,那么代码该如何配置呢?下面直接贴上代码:

@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
@EnableSwagger2Doc
@EnableApolloConfig
public class AppGateWay {
    // 获取ApolloConfig
    @ApolloConfig
    private Config appConfig;
    public static void main(String[] args) {
        SpringApplication.run(AppGateWay.class, args);
    }
    // 添加文档来源
    @Component
    @Primary
    class DocumentationConfig implements SwaggerResourcesProvider, ConfigChangeListener {
        @Override
        public List<SwaggerResource> get() {
            // 开启监听,配置文件发生改变需要更改,onChange()回调
            appConfig.addChangeListener(DocumentationConfig.this);
            return resources();
        }
        @Override
        public void onChange(ConfigChangeEvent configChangeEvent) {
            get();
        }
        /**
         * 从阿波罗服务器中获取resources
         *
         * @return
         */
        private List<SwaggerResource> resources() {
            List resources = new ArrayList<>();
            // app-itmayiedu-order
            // 网关使用服务别名获取远程服务的SwaggerApi
            String swaggerDocJson = swaggerDocument();
            JSONArray jsonArray = JSONArray.parseArray(swaggerDocJson);
            for (Object object : jsonArray) {
                JSONObject jsonObject = (JSONObject) object;
                String name = jsonObject.getString("name");
                String location = jsonObject.getString("location");
                String version = jsonObject.getString("version");
                resources.add(swaggerResource(name, location, version));
            }
            return resources;
        }
        /**
         * 获取swaggerDocument配置
         *
         * @return
         */
        private String swaggerDocument() {
            String property = appConfig.getProperty("taodong-shop.zuul.swagger.document", "");
            return property;
        }
        private SwaggerResource swaggerResource(String name, String location, String version) {
            SwaggerResource swaggerResource = new SwaggerResource();
            swaggerResource.setName(name);
            swaggerResource.setLocation(location);
            swaggerResource.setSwaggerVersion(version);
            return swaggerResource;
        }
    }
}

3. 测试

step1:依次启动微信服务、会员服务、网关服务

step2:浏览器访问http://localhost/swagger-ui.html#/,可以看到Swagger能正常显示两个微服务的文档,配置已经成功托管到了Apollo。

step3:在配置中心里移除掉会员服务,就是把配置信息改为如下,并发布:

[
    {
        "name": "taodong-shop-service-weixin",
        "location": "/taodong-shop-service-weixin/v2/api-docs",
        "version": "2.0"
    }
]

step4:浏览器访问http://localhost/swagger-ui.html# ,可以看到选项里只有微信服务了:

总结

目录
相关文章
|
2天前
|
消息中间件 负载均衡 Java
如何设计一个分布式配置中心?
这篇文章介绍了分布式配置中心的概念、实现原理及其在实际应用中的重要性。首先通过一个面试场景引出配置中心的设计问题,接着详细解释了为什么需要分布式配置中心,尤其是在分布式系统中统一管理配置文件的必要性。文章重点分析了Apollo这一开源配置管理中心的工作原理,包括其基础模型、架构模块以及配置发布后实时生效的设计。此外,还介绍了客户端与服务端之间的交互机制,如长轮询(Http Long Polling)和定时拉取配置的fallback机制。最后,结合实际工作经验,分享了配置中心在解决多台服务器配置同步问题上的优势,帮助读者更好地理解其应用场景和价值。
31 18
|
2月前
|
数据库
如何在Seata框架中配置分布式事务的隔离级别?
总的来说,配置分布式事务的隔离级别是实现分布式事务管理的重要环节之一,需要认真对待和仔细调整,以满足业务的需求和性能要求。你还可以进一步深入研究和实践 Seata 框架的配置和使用,以更好地应对各种分布式事务场景的挑战。
49 6
|
4月前
|
NoSQL Java Redis
面试官:项目中如何实现分布式锁?
面试官:项目中如何实现分布式锁?
109 6
面试官:项目中如何实现分布式锁?
|
3月前
|
分布式计算 Hadoop
Hadoop-27 ZooKeeper集群 集群配置启动 3台云服务器 myid集群 zoo.cfg多节点配置 分布式协调框架 Leader Follower Observer
Hadoop-27 ZooKeeper集群 集群配置启动 3台云服务器 myid集群 zoo.cfg多节点配置 分布式协调框架 Leader Follower Observer
64 1
|
3月前
|
存储 SQL 消息中间件
Hadoop-26 ZooKeeper集群 3台云服务器 基础概念简介与环境的配置使用 架构组成 分布式协调框架 Leader Follower Observer
Hadoop-26 ZooKeeper集群 3台云服务器 基础概念简介与环境的配置使用 架构组成 分布式协调框架 Leader Follower Observer
58 0
|
5月前
|
资源调度 Java 调度
项目环境测试问题之Schedulerx2.0通过分布式分片任务解决单机计算瓶颈如何解决
项目环境测试问题之Schedulerx2.0通过分布式分片任务解决单机计算瓶颈如何解决
项目环境测试问题之Schedulerx2.0通过分布式分片任务解决单机计算瓶颈如何解决
|
5月前
|
UED 存储 数据管理
深度解析 Uno Platform 离线状态处理技巧:从网络检测到本地存储同步,全方位提升跨平台应用在无网环境下的用户体验与数据管理策略
【8月更文挑战第31天】处理离线状态下的用户体验是现代应用开发的关键。本文通过在线笔记应用案例,介绍如何使用 Uno Platform 优雅地应对离线状态。首先,利用 `NetworkInformation` 类检测网络状态;其次,使用 SQLite 实现离线存储;然后,在网络恢复时同步数据;最后,通过 UI 反馈提升用户体验。
120 0
|
5月前
|
机器学习/深度学习 TensorFlow 数据处理
分布式训练在TensorFlow中的全面应用指南:掌握多机多卡配置与实践技巧,让大规模数据集训练变得轻而易举,大幅提升模型训练效率与性能
【8月更文挑战第31天】本文详细介绍了如何在Tensorflow中实现多机多卡的分布式训练,涵盖环境配置、模型定义、数据处理及训练执行等关键环节。通过具体示例代码,展示了使用`MultiWorkerMirroredStrategy`进行分布式训练的过程,帮助读者更好地应对大规模数据集与复杂模型带来的挑战,提升训练效率。
127 0
|
5月前
|
Java 测试技术 Spring
分布式之配置中心
分布式之配置中心
62 1
|
5月前
|
存储 缓存 开发框架
看看 Asp.net core Webapi 项目如何优雅地使用分布式缓存
看看 Asp.net core Webapi 项目如何优雅地使用分布式缓存