从浅入深 学习 SpringCloud 微服务架构(十七)--Spring Cloud config(1)
一、配置中心的 概述
1、配置中心概述
对于传统的单体应用而言,常使用配置文件来管理所有配置,比如 SpringBoot 的 application.yml 文件但是在微服务架构中全部手动修改的话很麻烦而且不易维护。微服务的配置管理一般有以下需求:
- 集中配置管理,一个微服务架构中可能有成百上千个微服务,所以集中配置管理是很重要的。
- 不同环境不同配置,比如数据源配置在不同环境(开发,生产,测试)中是不同的。
- 运行期间可动态调整。例如,可根据各个微服务的负载情况,动态调整数据源连接池大小等.
- 配置修改后可自动更新。如配置内容发生变化,微服务可以自动更新配置。
综上所述对于微服务架构而言,一套统一的、通用的管理配置机制是不可缺少的总要组成部分。常见的做法就是通过配置服务器进行管理。
2、常见配置中心
-
Spring Cloud config 为分布式系统中的外部配置提供服务器和客户端支持。
-
Apollo (阿波罗) 是携程框架部门研发的分布式配置中心,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性,适用于微服务配置
管理场景。
-
Disconf 专注于各种「分布式系统配置管理」的「通用组件」和「通用平台」,提供统一的「配置管理服务」包括 百度、滴滴出行、银联、网易、拉勾网、苏宁易购、顺丰科技 等知名互联网公司正在使用![disconf」在[2015 年度新增开源软件排名 TOP 100(0SC开源中国提供)」中排名第16强。
二、springcloudConfig:概述
1、 Spring Cloud Config 简介
Spring Cloud Config 项目是一个解决分布式系统的配置管理方案。它包含了 Client 和 Server 两个部分 server 提供配置文件的存储、以接口的形式将配置文件的内容提供出去,client 通过接口获取数据、并依据此数据初始化自己的应用。
2、Spring Cloud Config 为分布式系统中的外部配置提供服务器和客户端支持。使用 ConfigServer,您可以为所有环境中的应用程序管理其外部属性。它非常适合 spring 应用,也可以使用在其他语言的应用上。随着应用程序通过从开发到测试和生产的部署流程,您可以管理这些环境之间的配置,并确定应用程序具有迁移时需要运行的一切。服务器存储后端的默认实现使用git,因此它轻松支持标签版本的配置环境,以及可以访问用于管理内容的各种工具。
3、Spring Cloud Config 服务端特性:
- HTTP,为外部配置提供基于资源的API(键值对,或者等价的YAML内容)。
- 属性值的加密和解密(对称加密和非对称加密)。
- 通过使用 @EnableConfigServer 在 Spring boot 应用中非常简单的嵌入。
Config 客户端的特性(特指Spring应用)。 - 绑定 Config 服务端,并使用远程的属性源初始化 Spring 环境。
- 属性值的加密和解密(对称加密和非对称加密)。
三、springcloudConfig 入门案例:概述
1、Spring Cloud Config 入门案例:准备工作
-
Config Server 是一个可横向扩展、集中式的配置服务器,它用于集中管理应用程序各个环境下的配置默认使用 Git 存储配置文件内容,也可以使用 SVN 存储,或者是本地文件存储。这里使用 git 作为学习的环境。
-
使用 GitHub 时,国内的用户经常遇到的问题是访问速度太慢,有时候还会出现无法连接的情况。如果我们希望体验Git 飞一般的速度,可以使用国内的 Git 托管服务一-码云(gitee.com)。和 GitHub 相比码云也提供免费的 Git 仓库。此外,还集成了代码质量检测、项目演示等功能。对于团队协作开发,码云还提供了项目管理、代码托管、文档管理的服务。
2、Spring Cloud Config 入门案例:
2.1 Spring Cloud Config 入门案例--搭建环境,准备数据库。
--- 创建数据库:
create database shop;
--- 使用数据库:
use shop;
--- 创建数据表:
CREATE TABLE `tb_product` (
`id` int NOT NULL AUTO_INCREMENT,
`product_name` varchar(40) DEFAULT NULL COMMENT '名称',
`status` int DEFAULT NULL COMMENT '状态',
`price` decimal(10,2) DEFAULT NULL COMMENT '单价',
`product_desc` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL COMMENT '描述',
`caption` varchar(255) DEFAULT NULL COMMENT '标题',
`inventory` int DEFAULT NULL COMMENT '库存',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb3
--- 插入数据:
insert into `tb_product` (`id`, `product_name`, `status`, `price`, `product_desc`, `caption`, `inventory`) values('1','iPhone 15 Pro','1','7999.00','iPhone 15 Pro 6.7 英寸或 6.1 英寸, 超视网膜 XDR 显示屏,ProMotion 自适应刷新率技术,钛金属搭配亚光质感玻璃背板, 灵动岛功能, A17 Pro 芯片,配备 6 核图形处理器, Pro 级摄像头系统,主摄 4800 万像素 | 超广角 | 长焦, 10 倍, 支持 USB 3, 视频播放最长可达 29 小时。 ','iPhone 15 Pro 巅峰之作','99');
2.2 Spring Cloud Config 入门案例--搭建环境--打开 idea 创建父工程,创建 artifactId 名为 spring_cloud_demo 的 maven 工程。
--> idea --> File
--> New --> Project
--> Maven
Project SDK: ( 1.8(java version "1.8.0_131" )
--> Next
--> Groupld : ( djh.it )
Artifactld : ( spring_cloud_demo )
Version : 1.0-SNAPSHOT
--> Name: ( spring_cloud_demo )
Location: ( ...\spring_cloud_demo\ )
--> Finish
2.3 Spring Cloud Config:入门案例--搭建环境--在父工程 spring_cloud_demo 的 pom.xml 文件中导入依赖坐标。
<?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">
<modelVersion>4.0.0</modelVersion>
<groupId>djh.it</groupId>
<artifactId>spring_cloud_demo</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>product_service</module>
<module>order_service</module>
<module>eureka_service</module>
<module>import_eurekaserver_test</module>
<module>api_zuul_service</module>
</modules>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.4</version>
<scope>provided</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Greenwich.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<repositories>
<repository>
<id>spring-snapshots</id>
<name>Spring Snapshots</name>
<url>http://repo.spring.io/libs-snapshot-local</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>http://repo.spring.io/libs-milestone-local</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>spring-releases</id>
<name>Spring Releases</name>
<url>http://repo.spring.io/libs-release-local</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>spring-snapshots</id>
<name>Spring Snapshots</name>
<url>http://repo.spring.io/libs-snapshot-local</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>http://repo.spring.io/libs-milestone-local</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
<!-- spring_cloud_demo\pom.xml -->
3、Spring Cloud Config:入门案例--搭建环境--在父工程 spring_cloud_demo 下,创建子工程 eureka_service (子模块)。
3.1 创建 eureka_service 子工程(子模块)
--> 右键 spring_cloud_demo 父工程
--> Modules
--> Maven
--> Groupld : ( djh.it )
Artifactld : ( eureka_service )
Version : 1.0-SNAPSHOT
--> Next
--> Module name: ( eureka_service )
Content root : ( \spring_cloud_demo\eureka_service )
Module file location: ( \spring_cloud_demo\eureka_service )
--> Finish
3.2 在子工程 eureka_service (子模块)中的 pom.xml 中导入依赖
<?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">
<parent>
<artifactId>spring_cloud_demo</artifactId>
<groupId>djh.it</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>eureka_service</artifactId>
<dependencies>
<!-- springcloudgateway 的内部是通过 netty + webflux 实现。
webflux 实现和 springmvc 存在冲突,需要注销掉父工程中的 web 依赖,在各子模块中导入 web 依赖。
-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
</dependencies>
</project>
<!-- spring_cloud_demo\eureka_service\pom.xml -->
3.3 在子工程 eureka_service (子模块)中,创建配置文件 application.yml 配置文件。
## spring_cloud_demo\eureka_service\src\main\resources\application.yml
server:
port: 9000 # 启动端口 命令行注入。
spring:
application:
name: service-eureka #spring应用名, # 注意 FeignClient 不支持名字带下划线
eureka: # 配置 eureka_server
client:
register-with-eureka: false # 是否将自己注册到注册中心,不配置时,默认 true。 配置高可用时,须注销此行,或配置为 true
fetch-registry: false # 是否从 Eureka 中获取注册信息,不配置时,默认 true。 配置高可用时,须注销此行,或配置为 true
service-url: # 配置暴露给 EurekaClient 的请求地址
defaultZone: http://127.0.0.1:9000/eureka/ # 配置高可用时,须配置为另一个 EurekaServerApplication 的端口号,如:8000
3.4 在子工程 eureka_service (子模块)中,创建 启动类 EurekaServerApplication.java
/**
* spring_cloud_demo\eureka_service\src\main\java\djh\it\eureka\EurekaServerApplication.java
*
* 2024-5-11 启动类 EurekaServerApplication.java
*/
package djh.it.eureka;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
@SpringBootApplication
@EnableEurekaServer //激活 Eureka
public class EurekaServerApplication {
//运行启动类,浏览器地址栏输入:localhost:9000 进行访问测试。
public static void main(String[] args) {
SpringApplication.run(EurekaServerApplication.class, args);
}
}
3.5 在子工程 eureka_service (子模块)中,运行启动类,进行测试
浏览器地址栏输入:http://localhost:9000 输出界面如下:
4、Spring Cloud Config:入门案例--搭建环境--在父工程 spring_cloud_demo 下,创建子工程 product_service(子模块)
4.1 创建 生产者 子工程 product_service(子模块)
--> 右键 spring_cloud_demo 父工程
--> Modules
--> Maven
--> Groupld : ( djh.it )
Artifactld : ( product_service )
Version : 1.0-SNAPSHOT
--> Next
--> Module name: ( product_service )
Content root : ( spring_cloud_demo\product_service )
Module file location: ( spring_cloud_demo\product_service )
--> Finish
4.2 在 生产者 子工程 product_service (子模块)中的 pom.xml 中导入依赖
<?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">
<parent>
<artifactId>spring_cloud_demo</artifactId>
<groupId>djh.it</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>product_service</artifactId>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<!-- <version>5.1.32</version>-->
<version>8.0.26</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<!-- 引入 EurekaClient 依赖坐标 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
</dependencies>
</project>
<!-- spring_cloud_demo\product_service\pom.xml -->
4.3 在 生产者 子工程 product_service (子模块)中,创建 商品实体类 Product.java
/**
* spring_cloud_demo\product_service\src\main\java\djh\it\product\domain\Product.java
*
* 2024-5-11 商品实体类 Product.java
*/
package djh.it.product.domain;
import lombok.Data;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.Table;
import java.math.BigDecimal;
@Data
@Entity
@Table(name="tb_product") //对应数据库中的数据表
public class Product {
@Id
private Long id;
private String productName;
private Integer status;
private BigDecimal price;
private String productDesc;
private String caption;
private Integer inventory;
}
4.4 在 生产者 子工程 product_service (子模块)中,创建 dao 持久层接口类 ProductDao.java
/**
* spring_cloud_demo\product_service\src\main\java\djh\it\product\dao\ProductDao.java
*
* 2024-5-11 dao 持久层接口 ProductDao.java
*/
package djh.it.product.dao;
import djh.it.product.domain.Product;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
public interface ProductDao
extends JpaRepository<Product, Long>, JpaSpecificationExecutor<Product> {
}
4.5 在 生产者 子工程 product_service (子模块)中,创建 service 服务层 接口类 ProductService.java
/**
* spring_cloud_demo\product_service\src\main\java\djh\it\product\service\ProductService.java
*
* 2024-5-11 service 服务层 接口 ProductService.java
*/
package djh.it.product.service;
import djh.it.product.domain.Product;
public interface ProductService {
//根据id查询
Product findById(Long id);
//保存
void save(Product product);
//更新
void update(Product product);
//删除
void delete(Long id);
}
4.6、在 生产者 子工程 product_service (子模块)中,创建 service 服务层 实现类 ProductServiceImpl.java
/**
* spring_cloud_demo\product_service\src\main\java\djh\it\product\service\Impl\ProductServiceImpl.java
*
* 2024-5-11 service 服务层 实现类
*/
package djh.it.product.service.Impl;
import djh.it.product.domain.Product;
import djh.it.product.dao.ProductDao;
import djh.it.product.service.ProductService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class ProductServiceImpl implements ProductService {
@Autowired
private ProductDao productDao;
@Override
public Product findById(Long id) {
return productDao.findById(id).get();
}
@Override
public void save(Product product) {
productDao.save(product);
}
@Override
public void update(Product product) {
productDao.save(product);
}
@Override
public void delete(Long id) {
productDao.deleteById(id);
}
}
4.7 在 生产者 子工程 product_service (子模块)中,创建 商品的 controller 类 ProductController.java
/**
* spring_cloud_demo\product_service\src\main\java\djh\it\product\controller\ProductController.java
*
* 2024-5-11 商品的 controller 类 ProductController.java
*/
package djh.it.product.controller;
import djh.it.product.domain.Product;
import djh.it.product.service.ProductService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/product")
public class ProductController {
@Autowired
private ProductService productService;
@Value("${name}")
private String name;
@RequestMapping(value = "/{id}", method = RequestMethod.GET)
public Product findById(@PathVariable Long id){
return productService.findById(id);
}
@RequestMapping(value = "/test")
public String test (){
return name;
}
}
4.8 在 生产者 子工程 product_service (子模块)中,创建配置文件 application.yml
## spring_cloud_demo\product_service\src\main\resources\application.yml
server:
port: 9001 # 启动端口 命令行注入。
spring:
application:
name: service-product #spring应用名, # 注意 FeignClient 不支持名字带下划线
datasource:
driver-class-name: com.mysql.jdbc.Driver # mysql 驱动
url: jdbc:mysql://localhost:3306/shop?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
username: root
password: 12311
jpa:
database: MySQL
show-sql: true
open-in-view: true
eureka: # 配置 Eureka
client:
service-url:
defaultZone: http://localhost:9000/eureka/
instance:
prefer-ip-address: true # 使用 ip 地址注册
instance-id: ${spring.cloud.client.ip-address}:${server.port} # 向注册中心注册服务的id(IP 地址)。
name: djh
4.9 在 生产者 子工程 product_service (子模块)中,创建 启动类 ProductApplication.java
/**
* spring_cloud_demo\product_service\src\main\java\djh\it\product\ProductApplication.java
*
* 2024-5-11 启动类 ProductApplication.java
*/
package djh.it.product;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import java.io.Serializable;
@SpringBootApplication
@EntityScan("djh.it.product.domain")
@EnableEurekaClient //激活 EurekaClient, 同 @EnableDiscoveryClient 注解相同。
public class ProductApplication implements Serializable {
//运行启动类,浏览器地址栏输入:localhost:9001/product/1 进行访问测试。
public static void main(String[] args) {
SpringApplication.run(ProductApplication.class, args);
}
}
4.10 在 生产者 子工程 product_service (子模块)中,运行启动类,进行测试
浏览器地址栏输入:http://127.0.0.1:9001/product/1
输出 mysql 数据库的第一条记录:
浏览器地址栏输入:http://localhost:9001/product/test
输出:djh
上一节关联链接请点击:
# 从浅入深 学习 SpringCloud 微服务架构(十六)