首页手记 SpringCloud项目开发入门指南

SpringCloud项目开发入门指南

标签：

Spring Cloud 微服务

概述

本文介绍了SpringCloud项目开发的入门指南，涵盖了SpringCloud的基本概念、核心组件、优势及应用场景。详细讲解了从准备开发环境到搭建SpringCloud项目的基础结构，以及如何实现服务发现与注册、微服务间通信、配置中心与服务网关等关键步骤。

SpringCloud项目开发入门指南

SpringCloud简介

SpringCloud是什么

Spring Cloud是一套基于Spring Boot的微服务开发框架。它提供了服务发现、配置管理、负载均衡、断路器、微服务网关等功能，使得构建分布式系统更加简单、高效。Spring Cloud的目标是提供一系列框架和工具，以便开发者能够快速搭建出分布式系统中的常见模式，如配置管理、服务发现、断路器、路由、微代理、控制总线等。

SpringCloud的核心组件

Spring Cloud的核心组件包括：

Eureka：服务注册与发现组件。
Ribbon：客户端负载均衡工具。
Feign：声明式服务调用工具。
Hystrix：断路器工具，用于处理分布式系统中的延迟和容错。
Zuul：API网关组件。
Spring Cloud Config：配置中心组件。
Spring Cloud Stream：消息流处理。
Spring Cloud Sleuth：服务跟踪组件。

SpringCloud的优势与应用场景

优势

简化微服务开发：使用Spring Cloud可以快速搭建微服务架构，减少开发复杂度。
自动化配置：提供一系列配置选项，简化配置过程。
服务治理：提供服务注册、发现、负载均衡、断路器等功能。
分布式跟踪：通过Spring Cloud Sleuth实现分布式系统的跟踪功能。
API网关：通过Spring Cloud Gateway或Zuul实现API网关功能，提供统一的入口点。

应用场景

电商系统：支持高并发下的商品推荐、订单处理等功能。
金融系统：提供稳定、可靠的支付、转账等功能。
物流系统：支持实时追踪物流信息，提升用户体验。

SpringCloud项目搭建

准备开发环境

安装Java：确保安装了JDK 8或更高版本。
安装Maven：用于构建项目。
安装IDE：推荐使用IntelliJ IDEA或Eclipse。
安装Git（可选）：便于版本控制。
STS（Spring Tool Suite）（可选）：专门为Spring项目定制的IDE。

使用STS或Eclipse创建Spring Boot项目时，需在新建项目向导中选择Spring Initializr，并启用Spring Boot支持。

创建SpringBoot项目基础结构

创建一个新的SpringBoot项目，可以使用STS或直接使用Maven创建。这里以Maven为例。

创建一个新的Maven项目。

<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>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>2021.0.0</spring-cloud.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-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

在src/main/java目录下创建包结构，例如：com.example.demo。
在src/main/resources目录下创建application.properties或application.yml文件，配置基本的Spring Boot属性。

添加SpringCloud相关依赖

为了使用Spring Cloud，需要在pom.xml中添加相关依赖。例如，添加Eureka服务注册与发现依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>

服务发现与注册

使用Eureka实现服务注册与发现

Eureka是Spring Cloud中用于服务注册与发现的组件，它通过提供服务注册和发现的功能，帮助微服务架构中各个服务之间的发现和调用。

Eureka服务端

创建一个新的Spring Boot项目。
在pom.xml中添加Eureka服务端依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>

配置application.yml文件，启用Eureka服务端：

server:
  port: 8761

eureka:
  Client:
  serviceUrl:
    defaultZone: http://localhost:8761/eureka/

在主类中添加@EnableEurekaServer注解：

package com.example.eurekaserver;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

@SpringBootApplication
@EnableEurekaServer
public class EurekaServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(EurekaServerApplication.class, args);
    }
}

服务提供者

创建一个新的Spring Boot项目。
在pom.xml中添加Eureka客户端依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

配置application.yml文件，注册服务到Eureka服务器：

spring:
  application:
    name: service-provider

server:
  port: 8080

eureka:
  client:
  serviceUrl:
    defaultZone: http://localhost:8761/eureka/

在主类中添加@EnableDiscoveryClient注解：

package com.example.serviceprovider;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class ServiceProviderApplication {

    public static void main(String[] args) {
        SpringApplication.run(ServiceProviderApplication.class, args);
    }
}

实现服务提供者功能，例如创建一个简单的RESTful接口：

package com.example.serviceprovider;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class ServiceProviderController {

    @GetMapping("/greeting")
    public String greeting() {
        return "Hello from Service Provider!";
    }
}

服务消费者

创建一个新的Spring Boot项目。
在pom.xml中添加Eureka客户端依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

配置application.yml文件，注册服务到Eureka服务器：

spring:
  application:
    name: service-consumer

server:
  port: 8081

eureka:
  client:
  serviceUrl:
    defaultZone: http://localhost:8761/eureka/

在主类中添加@EnableDiscoveryClient注解：

package com.example.serviceconsumer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class ServiceConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(ServiceConsumerApplication.class, args);
    }
}

实现服务消费者功能，通过RestTemplate调用服务提供者：

package com.example.serviceconsumer;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
public class ServiceConsumerApplication {

    @Autowired
    private DiscoveryClient discoveryClient;

    @Autowired
    private RestTemplate restTemplate;

    @RequestMapping("/consume")
    public String consumeService() {
        ServiceInstance serviceInstance = discoveryClient.getInstances("service-provider").get(0);
        String url = "http://" + serviceInstance.getHostname() + ":" + serviceInstance.getPort() + "/api/greeting";
        return restTemplate.getForObject(url, String.class);
    }

    public static void main(String[] args) {
        SpringApplication.run(ServiceConsumerApplication.class, args);
    }
}

创建一个控制器来暴露服务消费者接口：

package com.example.serviceconsumer;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/consumer")
public class ServiceConsumerController {

    @GetMapping("/greeting")
    public String greeting() {
        return "Hello from Service Consumer!";
    }

    @GetMapping("/consume")
    public String consumeService() {
        return serviceConsumerApplication.consumeService();
    }
}

微服务间通信

RESTful风格的服务调用

服务提供者

为了提供RESTful服务，我们可以在服务提供者中定义RESTful接口。例如，提供一个简单的服务接口：

package com.example.serviceprovider;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class ServiceProviderController {

    @GetMapping("/greeting")
    public String greeting() {
        return "Hello from Service Provider!";
    }
}

服务消费者

服务消费者可以通过RestTemplate或者Spring 5.0引入的WebClient来调用服务提供者。

package com.example.serviceconsumer;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
public class ServiceConsumerApplication {

    @Autowired
    private DiscoveryClient discoveryClient;

    @Autowired
    private RestTemplate restTemplate;

    @RequestMapping("/consume")
    public String consumeService() {
        ServiceInstance serviceInstance = discoveryClient.getInstances("service-provider").get(0);
        String url = "http://" + serviceInstance.getHostname() + ":" + serviceInstance.getPort() + "/api/greeting";
        return restTemplate.getForObject(url, String.class);
    }

    public static void main(String[] args) {
        SpringApplication.run(ServiceConsumerApplication.class, args);
    }
}

使用Feign简化服务调用

Feign是Netflix开源的一个HTTP请求的声明式客户端，使用Feign可以非常快速地写出一个HTTP请求。Feign与Ribbon和Eureka可以直接集成，当使用Feign进行远程调用时，可以自动实现负载均衡。

服务提供者

在服务提供者中，定义一个简单的RESTful服务：

package com.example.serviceprovider;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class ServiceProviderController {

    @GetMapping("/greeting")
    public String greeting() {
        return "Hello from Service Provider!";
    }
}

服务消费者

在服务消费者中使用Feign客户端来调用服务提供者：

添加Feign依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

开启Feign客户端支持：

package com.example.serviceconsumer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class ServiceConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(ServiceConsumerApplication.class, args);
    }
}

创建Feign客户端接口：

package com.example.serviceconsumer;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;

@FeignClient(name = "service-provider")
public interface ServiceProviderClient {

    @GetMapping("/api/greeting")
    String greeting();
}

在控制器中使用Feign客户端：

package com.example.serviceconsumer;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/consumer")
public class ServiceConsumerController {

    @Autowired
    private ServiceProviderClient serviceProviderClient;

    @GetMapping("/greeting")
    public String greeting() {
        return "Hello from Service Consumer!";
    }

    @GetMapping("/consume")
    public String consumeService() {
        return serviceProviderClient.greeting();
    }
}

实现服务熔断与降级

Hystrix是一个用于处理延迟和容错的开源框架，它旨在提高分布式系统中关键任务的响应速度和可靠性。Hystrix可以在服务提供者和消费者之间提供熔断器，防止服务故障传播和扩散。

添加Hystrix依赖

在pom.xml中添加Hystrix依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>

配置Hystrix

在application.yml中配置Hystrix：

hystrix:
  command:
    default:
      execution:
        isolation:
          thread:
            timeoutInMilliseconds: 1000
      circuitBreaker:
        requestVolumeThreshold: 10
        sleepWindowInMilliseconds: 5000

使用Hystrix实现服务熔断与降级

在Feign客户端接口中添加Hystrix逻辑：

package com.example.serviceconsumer;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;

@FeignClient(name = "service-provider", fallback = ServiceProviderClientFallback.class)
public interface ServiceProviderClient {

    @GetMapping("/api/greeting")
    String greeting();
}

在ServiceProviderClientFallback类中实现降级逻辑：

package com.example.serviceconsumer;

public class ServiceProviderClientFallback implements ServiceProviderClient {

    @Override
    public String greeting() {
        return "Service Provider is down, please try again later.";
    }
}

配置中心与服务网关

介绍SpringCloudConfig配置中心

Spring Cloud Config是Spring Cloud项目中用于集中化管理配置文件的服务组件。它支持本地文件系统、Git仓库、SVN仓库等多种配置存储方式，支持配置文件的版本控制。

创建配置中心服务

创建一个新的Spring Boot项目。
在pom.xml中添加Spring Cloud Config Server依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>

配置application.yml文件，启用Config Server：

spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-repo/config-repo
          username: your-username
          password: your-password
server:
  port: 8888

在主类中添加@EnableConfigServer注解：

package com.example.configserver;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(ConfigServerApplication.class, args);
    }
}

使用SpringCloudGateway实现服务网关

Spring Cloud Gateway是Spring Cloud中的API网关组件，它基于Spring Boot 2.0和Spring Framework 5.0的响应式框架WebFlux实现。它提供了路由、过滤等功能，支持多种路由策略。

创建网关服务

创建一个新的Spring Boot项目。
在pom.xml中添加Spring Cloud Gateway依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

配置application.yml文件，启用Gateway：

spring:
  application:
    name: gateway-server
server:
  port: 8080

spring:
  cloud:
  gateway:
    routes:
    - id: service-provider
      uri: lb://service-provider
      predicates:
      - Path=/api/**

在主类中添加@EnableDiscoveryClient注解：

package com.example.gatewayserver;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class GatewayServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(GatewayServerApplication.class, args);
    }
}

项目实战

构建一个简单的微服务系统

我们构建一个简单的微服务系统，包括一个服务注册中心，两个微服务（服务提供者和服务消费者），以及一个API网关。

服务注册中心

使用Eureka服务注册中心创建服务注册中心。
配置application.yml文件启用Eureka服务端。

server:
  port: 8761

eureka:
  Client:
  serviceUrl:
    defaultZone: http://localhost:8761/eureka/

服务提供者

创建服务提供者。
配置application.yml文件，注册服务到Eureka服务器。

spring:
  application:
    name: service-provider

server:
  port: 8080

eureka:
  client:
  serviceUrl:
    defaultZone: http://localhost:8761/eureka/

实现服务提供者功能，暴露RESTful接口。

package com.example.serviceprovider;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class ServiceProviderController {

    @GetMapping("/greeting")
    public String greeting() {
        return "Hello from Service Provider!";
    }
}

服务消费者

创建服务消费者。
配置application.yml文件，注册服务到Eureka服务器。

spring:
  application:
    name: service-consumer

server:
  port: 8081

eureka:
  client:
  serviceUrl:
    defaultZone: http://localhost:8761/eureka/

实现服务消费者功能，通过Feign调用服务提供者。

package com.example.serviceconsumer;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class ServiceConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(ServiceConsumerApplication.class, args);
    }
}

@RestController
@RequestMapping("/consumer")
public class ServiceConsumerController {

    @Autowired
    private ServiceProviderClient serviceProviderClient;

    @GetMapping("/greeting")
    public String greeting() {
        return "Hello from Service Consumer!";
    }

    @GetMapping("/consume")
    public String consumeService() {
        return serviceProviderClient.greeting();
    }
}

@FeignClient(name = "service-provider")
public interface ServiceProviderClient {

    @GetMapping("/api/greeting")
    String greeting();
}

API网关

创建API网关服务。
配置application.yml文件，启用Gateway，并配置路由规则。

spring:
  application:
    name: gateway-server

server:
  port: 8080

spring:
  cloud:
  gateway:
    routes:
    - id: service-provider
      uri: lb://service-provider
      predicates:
      - Path=/api/**

在主类中添加@EnableDiscoveryClient注解。

package com.example.gatewayserver;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class GatewayServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(GatewayServerApplication.class, args);
    }
}

部署与测试

部署步骤

启动Eureka服务注册中心。
启动服务提供者。
启动服务消费者。
启动API网关。

测试步骤

访问Eureka服务注册中心，确保所有服务都注册成功。
访问服务提供者的接口，确保服务提供者正常运行。
通过服务消费者调用服务提供者的接口，确保服务消费者能够正常调用服务提供者。
通过API网关访问服务提供者的接口，确保网关能够正确路由请求到服务提供者。

以上是Spring Cloud入门指南的详细步骤和示例代码，希望对你有所帮助。如需进一步学习，可以参考Muok网上的相关课程。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

精慕HU

手记
篇

粉丝

24

获赞与收藏

116

关注作者，订阅最新文章

阅读免费教程

Spring Cloud Hystrix

15个小节 6193 121

后端通用面试教程

41个小节 31246 346

网络编程入门教程

20个小节 12759 240

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空

SpringCloud项目开发入门指南

SpringCloud是什么

SpringCloud的核心组件

SpringCloud的优势与应用场景

优势

应用场景

准备开发环境

创建SpringBoot项目基础结构

添加SpringCloud相关依赖

使用Eureka实现服务注册与发现

Eureka服务端

服务提供者

服务消费者

RESTful风格的服务调用

服务提供者

服务消费者

使用Feign简化服务调用

服务提供者

服务消费者

实现服务熔断与降级

添加Hystrix依赖

配置Hystrix

使用Hystrix实现服务熔断与降级

介绍SpringCloudConfig配置中心

创建配置中心服务

使用SpringCloudGateway实现服务网关

创建网关服务

构建一个简单的微服务系统

服务注册中心

服务提供者

服务消费者

API网关

部署与测试

部署步骤

测试步骤

阅读免费教程