淘东电商项目(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# ,可以看到选项里只有微信服务了:

总结

目录
相关文章
|
1月前
|
NoSQL 调度 Redis
19- 你的项目中哪里用到了分布式锁
在一个项目中,为解决集群环境下SpringTask定时任务的重复执行问题,采用了Redis实现分布式锁来管理任务调度,防止资源浪费。后来因任务量和执行规则增加,以及单节点效率限制,系统改用XXL-JOB,分布式锁不再使用。
27 2
|
5月前
|
Java 调度 Maven
【分布式任务调度平台 XXL-JOB 急速入门】从零开始将 XXL-JOB 接入到自己的项目(下)
【分布式任务调度平台 XXL-JOB 急速入门】从零开始将 XXL-JOB 接入到自己的项目(下)
121 0
|
2月前
|
缓存 NoSQL Java
分布式项目中锁的应用(本地锁-_redis【setnx】-_redisson-_springcache)-fen-bu-shi-xiang-mu-zhong-suo-de-ying-yong--ben-de-suo--redissetnx-springcache-redisson(一)
分布式项目中锁的应用(本地锁-_redis【setnx】-_redisson-_springcache)-fen-bu-shi-xiang-mu-zhong-suo-de-ying-yong--ben-de-suo--redissetnx-springcache-redisson
61 0
|
2月前
|
SpringCloudAlibaba Java 持续交付
【构建一套Spring Cloud项目的大概步骤】&【Springcloud Alibaba微服务分布式架构学习资料】
【构建一套Spring Cloud项目的大概步骤】&【Springcloud Alibaba微服务分布式架构学习资料】
197 0
|
5月前
|
SQL 负载均衡 监控
【分布式任务调度平台 XXL-JOB 急速入门】从零开始将 XXL-JOB 接入到自己的项目(上)
【分布式任务调度平台 XXL-JOB 急速入门】从零开始将 XXL-JOB 接入到自己的项目
110 0
|
2月前
|
XML NoSQL Java
Java单体项目和分布式项目中的锁
Java单体项目和分布式项目中的锁 Java单体项目和分布式项目中的锁
32 2
|
2月前
|
缓存 NoSQL Redis
分布式项目中锁的应用(本地锁-_redis【setnx】-_redisson-_springcache)-fen-bu-shi-xiang-mu-zhong-suo-de-ying-yong--ben-de-suo--redissetnx-springcache-redisson(二)
分布式项目中锁的应用(本地锁-_redis【setnx】-_redisson-_springcache)-fen-bu-shi-xiang-mu-zhong-suo-de-ying-yong--ben-de-suo--redissetnx-springcache-redisson
40 0
|
3月前
|
Java Linux Spring
Zookeeper实现分布式服务配置中心
Zookeeper实现分布式服务配置中心
50 0
|
3月前
|
存储 NoSQL 文件存储
C++ 哈希表企业级项目运用---淘宝分布式文件系统
C++ 哈希表企业级项目运用---淘宝分布式文件系统
|
4月前
|
网络协议 Devops 大数据
【分布式】大型互联网项目特点
【1月更文挑战第25天】【分布式】大型互联网项目特点