阿里云应用配置管理 ACM使用 ACM 简化 Spring Cloud 微服务环境配置管理

配置的环境属性

在系统持续交付的过程中，运行环境的多样性和复杂性增加了配置管理工作的负担。这一点在 Eugen Paraschiv 的博文 Configuration Must Be Environment Specific 里有简单的阐述，在博文《现代应用架构中的配置管理面临的挑战》的容器化、调度与配置管理小节有深入阐述。

环境配置的差异导致了应用的构建物（artifact）在各个环境不能保持一致，而且有时候 Docker 无法轻易达成“Build Once, Run Anywhere!”。以下列举一些简单的例子来帮助您理解：

• 在开发环境中 logLevel 应设置为 DEBUG，在预发环境中为 INFO，在生产环境中为 WARNING。
• 在开发环境中使用 4 核 8G 的机器运行数据库，而在生产中用 32 核 96G 的机器运行数据库。
• 在日常环境执行线程池的最大线程数应该设置为 15，而生产环境上该值应该大一些，默认设为 150。
• 在线上环境中，中心机房内应用数据源需要连接 A 库，而深圳机房，应用应该就近连接 B 库。
• 在且仅在小淘宝环境，双向同步开关需关闭。
• 新的特性仅在线上的杭州单元开放，其他单元环境暂缓。

下文中，简要介绍了使用阿里云 ACM 配置管理产品在 Spring Cloud 中替代 Spring Cloud Config 的方法，帮助您理解基于 ACM 简化微服务环境配置管理的方案。此外，下文还将简要比较说明 ACM 与 Spring Cloud Config 方案的优劣。

场景故事

为帮助您理解需求和场景，我们一般会以用户故事（User Story）的方式预设一个简单的场景，以此来做阐释和交流。下面是一张早期的布道图：

以 Movie Service 为例，假设需要从关系数据库 MySQL(RDS) 检索所有电影信息列表，但是只有生产库需要顶配的机器，测试、预发和生产环境需要使用不同的数据库，因此应用需要在不同的环境下具备不同的数据源配置、连接池配置、数据库安全配置等。

下图介绍了如何基于阿里云 ACM 的 Namespace 映射不同环境，为 Movie Service 在不同运行环境下设置不同的数据源配置。

创建微服务 Movie Service

• 新建 Spring Boot Starter 微服务应用 movie service

  movie service 的业务逻辑很简单——列出 MySQL(RDS) 中所有的 movie：

  
  

  这里我们创建了一个标准的 JPA 应用（类似于 Spring 官网的样例工程 Accessing data with MySQL）。工程结构如图所示：

  
  

• 引入 JPA、MySQL、连接池 HikariCP 以及 WEB 依赖

  <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-data-jpa</artifactId>
  </dependency>
  <dependency>
     <groupId>mysql</groupId>
     <artifactId>mysql-connector-java</artifactId>
     <scope>runtime</scope>
  </dependency>
  <dependency>
     <groupId>com.zaxxer</groupId>
     <artifactId>HikariCP</artifactId>
     <version>2.7.6</version>
  </dependency>

• 创建 MySQL(RDS) 数据库及用户

  mysql> create database db_example; -- Create the new database
  mysql> create user 'springuser'@'localhost' identified by 'ThePassword'; -- Creates the user
  mysql> grant all on db_example.* to 'springuser'@'localhost'; -- Gives all the privileges to the new user on the newly created database

  详细步骤可参考 Accessing data with MySQL 中的“Create the database”小节。

• 创建 WEB Controller

  package com.alibaba.demo.microsvc.controller;
   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.web.bind.annotation.RequestMapping;
   import org.springframework.web.bind.annotation.ResponseBody;
   import org.springframework.web.bind.annotation.RestController;
   import com.alibaba.demo.microsvc.dao.MovieRepository;
   import com.alibaba.demo.microsvc.model.Movie;
   @RestController
   public class MovieController {
       @Autowired
       MovieRepository movieRepository;
       @RequestMapping("/list-movies")
       public @ResponseBody Iterable<Movie> listMovies() {
             return movieRepository.findAll();
       }    
  }

在 ACM 中使用 Namespace 创建隔离的环境配置

说明 在阿里云上使用 ACM 的前提是开通该项服务，开通流程可参考开通 ACM 服务。开通服务并登录后，即可进入 ACM 控制台创建命名空间及配置。

• 在 ACM 中创建 3 个环境（dev、stage、prod）

  
  

• 为 dev、stage、prod 环境分别创建配置

  
  

在上一步中，我们为相同配置项针对不同环境设置了不同的值，例如 spring.datasource.url 这个配置项，我们通过设置不同的 url 来为各环境连接不同的数据库，并且仅在生产环境开启 SSL (useSSL=true)。

dev:
    spring.datasource.url=jdbc:mysql://localhost:3306/db_example?useSSL=false
prod:
    spring.datasource.url=jdbc:mysql://30.5.101.169:3306/db_example?useSSL=true

同时，我们也为生产环境（prod）设置了更大的数据库连接池和更小的连接超时时间。

dev:
    spring.datasource.hikari.connection-timeout=60000
    spring.datasource.hikari.maximum-pool-size=10
prod:
    spring.datasource.hikari.connection-timeout=15000
    spring.datasource.hikari.maximum-pool-size=200

而为了方便开发调试，我们仅在开发环境打开了 SQL Trace。

dev:
    spring.jpa.show-sql=true

Movie Service 与配置中心 ACM 集成

现在我们将集成 Movie Service 与 ACM，以便从 ACM 中获取对应环境的配置。关于如何在 Spring Cloud 中使用 ACM，请参考 Spring Cloud ACM。

• 为 movie service 引入 ACM 依赖

  <dependency>
     <groupId>com.alibaba.cloud</groupId>
     <artifactId>spring-cloud-starter-acm</artifactId>
     <version>1.0.1</version>
  </dependency>

• 在 application.properties 配置 ACM 连接信息、namespace、accessKey、secretKey 等信息

  spring.application.name=movie-service
  spring.application.group=com.alibaba.cloud.acm
  alibaba.acm.endpoint=acm.aliyun.com
  alibaba.acm.namespace=<your_namespace_id>
  alibaba.acm.accessKey=<your_ak>        
  alibaba.acm.secretKey=<your_sk>

说明

您可以在 ACM 的“命名空间详情”或者“配置的示例代码”里找到您的 namespace_id、accessKey、secretKey 等信息。

在浏览器里访问 Movie Service

查看 ACM 配置推送刷新信息

如果在 movie service 引入了 spring-boot-starter-actuator 依赖，并且在 application.properties 设置了 management.security.enabled=false，则可以通过端点 http://<<ip:port>>/acm 看到应用的配置消费及刷新情况。

也可以在 ACM 控制台上查看配置的推送轨迹、配置版本等信息。具体使用方法可参考 ACM 用户指南。

ACM 与 Spring Cloud Config 的简单对比

工程下载

本文的样例工程可以从 movie-service.tar.gz 下载。

该工程在以下版本环境测试通过：

• Spring Cloud Edgware.RELEASE
• Spring Boot 1.5.9.RELEASE
• HikariCP 2.7.6
• MySQL 5.7.11
• ACM 4.2.0
• ACM Spring Cloud SDK 1.0.1

说明 在本地运行该工程前，请务必在 application.properties 里设置您自己的 ACM accessKey 和 secretKey。