Day01——微服务服务注册与发现

目录

  • 学习目标
  • 搭建环境
  • 1.认识微服务
    • [1.1 单体架构](#1.1 单体架构)
    • [1.2 微服务架构](#1.2 微服务架构)
    • [1.3. 扩展](#1.3. 扩展)
    • [1.4 面试题](#1.4 面试题)
  • [2 构建微服务工程](#2 构建微服务工程)
    • [2.1 熟悉黑马商城](#2.1 熟悉黑马商城)
      • [2.1.1 运行项目](#2.1.1 运行项目)
      • [2.1.2. 熟悉项目](#2.1.2. 熟悉项目)
        • [2.1.2.1 登录功能](#2.1.2.1 登录功能)
        • [2.1.2.2 搜索商品](#2.1.2.2 搜索商品)
        • [2.1.2.3 购物车](#2.1.2.3 购物车)
        • [2.1.2.4 下单](#2.1.2.4 下单)
        • [2.1.2.5 支付](#2.1.2.5 支付)
      • [2.1.2.6 小结](#2.1.2.6 小结)
    • [2.2 创建微服务工程](#2.2 创建微服务工程)
      • [2.2.1. 系统架构](#2.2.1. 系统架构)
        • [2.2.1.1 系统架构图](#2.2.1.1 系统架构图)
        • [2.2.1.2 认识Spring Cloud](#2.2.1.2 认识Spring Cloud)
        • [2.2.1.3 面试题](#2.2.1.3 面试题)
      • [2.2.2. 创建基础工程](#2.2.2. 创建基础工程)
        • [2.2.2.1 创建父工程](#2.2.2.1 创建父工程)
        • [2.2.2.2 创建common工程](#2.2.2.2 创建common工程)
      • 2.2.3.商品服务
        • [2.2.3.1 创建数据库](#2.2.3.1 创建数据库)
        • [2.2.3.2 创建工程](#2.2.3.2 创建工程)
        • [2.2.3.3 复制并修改代码](#2.2.3.3 复制并修改代码)
        • [2.2.3.4 创建配置文件](#2.2.3.4 创建配置文件)
        • [2.2.3.5 启动微服务](#2.2.3.5 启动微服务)
        • [2.2.3.6 测试微服务](#2.2.3.6 测试微服务)
        • [2.2.3.7. 小节](#2.2.3.7. 小节)
      • 2.2.4.购物车服务(练习)
        • [2.2.4.1 创建数据库](#2.2.4.1 创建数据库)
        • [2.2.4.2 创建工程](#2.2.4.2 创建工程)
        • [2.2.4.3 复制与修改代码](#2.2.4.3 复制与修改代码)
        • [2.2.4.4 创建配置文件](#2.2.4.4 创建配置文件)
        • [2.2.4.5 启动微服务](#2.2.4.5 启动微服务)
      • [2.2.5. 小结](#2.2.5. 小结)
    • [2.3 RestTemplate](#2.3 RestTemplate)
      • [2.3.1. Java远程调用技术介绍](#2.3.1. Java远程调用技术介绍)
      • 2.3.2.RestTemplate实现远程调用
        • [2.3.2.1 明确需求](#2.3.2.1 明确需求)
        • [2.3.2.2 注入RestTemplate](#2.3.2.2 注入RestTemplate)
        • [2.3.2.3 实现远程调用](#2.3.2.3 实现远程调用)
        • [2.3.2.4 测试](#2.3.2.4 测试)
      • [2.3.3. 小结](#2.3.3. 小结)
      • [2.3.4 面试题](#2.3.4 面试题)
  • [3 服务注册和发现](#3 服务注册和发现)
    • [3.1. Nginx负载均衡](#3.1. Nginx负载均衡)
      • [3.1.1 问题说明](#3.1.1 问题说明)
      • [3.1.2 Nginx负载均衡](#3.1.2 Nginx负载均衡)
      • [3.1.3 面试题](#3.1.3 面试题)
    • [3.3. 服务注册与发现流程](#3.3. 服务注册与发现流程)
      • [3.3.1 区分客户端与服务端负载均衡](#3.3.1 区分客户端与服务端负载均衡)
      • [3.3.2 服务注册与发现流程](#3.3.2 服务注册与发现流程)
      • [3.3.3 面试题](#3.3.3 面试题)
    • 3.3.Nacos安装配置
      • [3.3.1 介绍](#3.3.1 介绍)
      • [3.3.2 安装数据库](#3.3.2 安装数据库)
      • [3.3.3 创建容器](#3.3.3 创建容器)
      • [3.3.4 访问nacos](#3.3.4 访问nacos)
      • [3.3.5 小结](#3.3.5 小结)
    • [3.4. 服务注册](#3.4. 服务注册)
      • [3.4.1 添加依赖](#3.4.1 添加依赖)
      • [3.4.2 配置Nacos](#3.4.2 配置Nacos)
      • [3.4.3 启动服务实例](#3.4.3 启动服务实例)
      • [3.4.4 查看服务注册信息](#3.4.4 查看服务注册信息)
      • [3.4.5 小结](#3.4.5 小结)
    • [3.5. 服务发现](#3.5. 服务发现)
      • [3.5.1 引入依赖](#3.5.1 引入依赖)
      • [3.5.2 配置Nacos地址](#3.5.2 配置Nacos地址)
      • [3.5.3 服务发现并调用服务](#3.5.3 服务发现并调用服务)
        • [3.5.3.1 方法1](#3.5.3.1 方法1)
        • [3.5.2.2 方法2](#3.5.2.2 方法2)
      • [3.5.4 小结](#3.5.4 小结)
    • [3.6. Spring Cloud Loadbalancer 原理](#3.6. Spring Cloud Loadbalancer 原理)
      • [3.6.1 源码解析](#3.6.1 源码解析)
      • [3.6.2 面试题](#3.6.2 面试题)
  • [4 OpenFeign](#4 OpenFeign)
    • [4.1. 认识OpenFeign](#4.1. 认识OpenFeign)
    • 4.2.快速入门
      • [4.2.1 引入依赖](#4.2.1 引入依赖)
      • [4.2.2 编写OpenFeign客户端](#4.2.2 编写OpenFeign客户端)
      • [4.2.3 使用FeignClient](#4.2.3 使用FeignClient)
      • [4.2.4 启用OpenFeign](#4.2.4 启用OpenFeign)
      • [4.2.5 测试](#4.2.5 测试)
      • [4.2.6 小结](#4.2.6 小结)
    • [4.2 最佳实践](#4.2 最佳实践)
      • [4.2.1. OkHttp](#4.2.1. OkHttp)
        • [4.2.1.1 介绍](#4.2.1.1 介绍)
        • [4.2.1.2 更换为okhttp](#4.2.1.2 更换为okhttp)
      • [4.2.2. 抽取API工程](#4.2.2. 抽取API工程)
        • [4.2.2.1 思路分析](#4.2.2.1 思路分析)
        • [4.2.2.2 抽取API工程](#4.2.2.2 抽取API工程)
        • [4.2.2.3 使用API](#4.2.2.3 使用API)
      • [4.2.3. 完善服务接口](#4.2.3. 完善服务接口)
    • [4.3 面试题](#4.3 面试题)
  • [5 作业](#5 作业)
    • [5.1 创建用户微服务](#5.1 创建用户微服务)
    • [5.2 创建交易微服务](#5.2 创建交易微服务)
    • [5.3 创建支付微服务](#5.3 创建支付微服务)
  • [6 作业参考](#6 作业参考)
  • [6.1 用户服务](#6.1 用户服务)

学习目标

  1. 能够说出单体架构与微服务架构的优缺点
  2. 能够了解分布式架构和云原生架构
  3. 能够搭建黑马商城项目环境
  4. 能够测试黑马商城项目的业务流程
  5. 能够说出商城项目的业务模块及技术架构
  6. 能够创建商品服务、购物车服务
  7. 能够使用RestTemplate实现远程调用
  8. 能够说出服务注册与发现流程
  9. 能够使用Nacos实现服务注册与发现
  10. 会使用OpenFeign实现远程调用
  11. 能够抽取API工程

搭建环境

在开始本课程之前请参考" 环境搭建" 文档搭建黑马商城项目运行环境,最终将黑马商城项目跑起来。

黑马商城项目是一个单体项目,基于Spring Boot开发,数据库使用MySQL。

微服务框架阶段的课程以黑马商城项目作为案例驱动,使用微服务架构去构建黑马商城项目,并解决其中出现的各种问题。

1.认识微服务

之前我们学习的项目一是单体项目,可以满足小型项目或传统项目的开发。而在互联网时代,越来越多的公司采用微服务架构。

这一章我们从单体架构的优缺点来分析,看看开发大型项目采用单体架构存在哪些问题,而微服务架构又是如何解决这些问题的。

1.1 单体架构

单体架构(monolithic structure):整个项目只有一个工程,所有业务模块都在这一个工程中,并采用一个数据库,如下图:

项目部署时需要对所有模块一起编译、打包,打成一个jar包或war包,如下图:

当项目规模较小时,这种模式上手快,部署、运维也都很方便,因此早期很多小型项目都采用这种模式。
优点:

1.整个项目只有一个工程,结构简单,开发周期短。

2.部署简单。
缺点:

随着项目的规模越来越大,团队开发人员也不断增加,单体架构就呈现出越来越多的问题:

1.团队协作成本高 :试想一下,你们团队数十个人同时协作开发同一个Java工程,由于所有模块都在一个工程中,最终要把所有模块代码合并到一个分支,代码冲突率增加,团队协作成本增加。

2.系统发布效率低 :任何模块变更都需要发布整个系统,任何一处出现问题都会导致发布失败,往往一次发布需要数十分钟甚至数小时。

3.扩展困难 ,在单体架构中,所有功能紧密集成,这意味着当某一部分(如订单处理)需要更多资源时,整个系统必须一起扩展。例如,在双十一期间订单量激增,不仅订单接口需要更多支持,支付接口也是如此。但由于采用了单体架构,我们不能单独扩展这些服务,而是需要增加整个系统的资源或者部署更多服务器节点,这可能会导致其他部分资源的浪费。

如下图,单体架构通常用集群的方式提高系统的能力。

应用场景:

单体架构适合小型项目。

1.2 微服务架构

随着软件业的兴起,以及互联网的发展,对于一些大型的软件项目,单体架构已不能适应需求,软件架构经过的几代的演变,如今对于大型项目更多的会采用微服务架构。

微服务架构,将整个项目分为多个服务,每个服务是一个工程,通常是根据业务模块去划分,比如:电商项目如果按微服务架构开发就需要独立出来:商品服务、用户服务、交易服务、支付服务等多个服务,这些服务最主要的是要做到边界清晰,单一职责,服务的功能范围可以很小,所以称为微服务架构。

例如,黑马商城项目,我们就可以把商品、用户、购物车、交易等模块拆分,交给不同的团队去开发,并独立部署:

微服务架构的一些特点:

  1. 单一职责原则:每个微服务专注于执行单一业务功能,并且尽量减少对外部服务的依赖,实现高内聚低耦合。
  2. 团队自治:每个微服务通常由一个小团队(通常不超过10人,即所谓的"两块披萨团队")负责,包括开发、测试、部署和运维等全过程。
  3. 服务自治:每个微服务都是独立的,可以独立部署、扩展和维护,拥有自己的数据库实例,以确保服务之间的隔离性和最小化相互影响。

以上可以简单理解为:微服务架构就是由若干小的单体系统组成的

单体架构存在的问题可以通过采用微服务架构来解决:

  1. 问题 :团队协作成本高
    解决:通过服务拆分,每个服务的代码量相对较小,每个服务通常由1至3名开发者维护,显著降低了协作成本。
  2. 问题 :系统发布效率低
    解决:每个服务都是独立部署的,当某个服务需要更新时,只需对该服务进行打包和部署,提高了发布效率并减少了风险。
  3. 问题 :系统可用性差
    解决:通过将服务独立部署,并确保每个服务都有自己的资源(如独立的数据库),可以有效防止一个服务的问题影响到其他服务。
  4. 问题 :扩展困难
    解决:微服务架构允许根据实际需求有针对性地对特定服务进行扩展或升级,而不需要对整个系统进行扩展,提高了资源利用率和灵活性。

根据上述内容,我们可以总结出微服务架构的优点和缺点如下:

优点

  • 有利于项目的扩展与维护
    • 服务之间解耦,易于理解和维护。
    • 每个服务可以独立扩展,提高资源利用效率。

缺点

  • 项目复杂性增加
    • 每个服务需要独立的设计、开发和测试,增加了项目的复杂度。
    • 管理多个服务间的依赖关系变得更加困难,例如交易服务可能依赖于商品服务和用户服务。
  • 运维成本增加
    • 需要管理和监控多个服务实例,增加了运维的复杂度。
    • 每个服务都需要单独部署、监控和维护,这可能需要更多的自动化工具和技术支持。
      综上所述,虽然微服务架构带来了更好的扩展性和维护性,但也引入了额外的复杂性和运维挑战。

应用场景:

微服务架构是适合大型项目

1.3. 扩展

AI:分布式架构是什么?

分布式架构是指由多个独立计算机组成的一个系统,即一个系统由多个部分组成,每个部分分别部署在不同的计算机上,这些计算机通过网络互相连接,并且能够协同工作以完成共同的任务。

早期的分布式架构是将整个项目拆分成多个系统,相比微服务架构划分服务的粒度是粗的,比如:一个电商项目包括了认证系统,门户,主站等。

发展到微服务架构会将一个项目划分为多个微服务,例如电商项目包括:商品服务、用户服务、认证服务、订单服务等微服务。

所以,微服务架构就是一种分布式架构,将各个服务分布在不同的计算机上,这些服务之间通过协作去完成业务流程。

下面分享几个微服务架构图:


AI:云原生架构是什么?

云原生(Cloud Native)应用程序是为云环境而设计的,能够利用云平台的弹性、可扩展性和服务导向的特性。云原生架构的核心理念包括容器化、微服务、持续交付和DevOps实践。

云原生架构就可以理解为微服务架构的项目使用云平台(阿里云、腾讯云等)去构建。
主要特征

  1. 容器化
    • 应用程序运行在容器内,如Docker容器,以便于标准化、隔离和移植。
    • 容器化提供了轻量级的虚拟化,使应用程序能够在任何环境中一致地运行。
  2. 微服务
    • 将应用程序分解为一组小型、独立的服务,每个服务都实现了特定的功能。
    • 微服务可以独立部署、扩展和更新,提高了应用程序的可维护性和灵活性。
  3. 持续交付
    • 采用自动化工具和流程来频繁地部署和更新应用程序。
    • 通过持续集成和持续部署(CI/CD)管道实现快速迭代和反馈循环。
  4. DevOps文化
    • 强调开发人员和运维团队之间的紧密合作。
    • 通过自动化和协作工具促进敏捷开发、快速部署和持续改进。
  5. 弹性与可扩展性
    • 设计应用程序以适应不断变化的工作负载,能够自动伸缩资源。
    • 利用云平台提供的服务,如自动扩展、负载均衡和冗余机制,以保证高可用性和性能。

1.4 面试题

你们的项目为什么要用微服务架构?

2 构建微服务工程

2.1 熟悉黑马商城

2.1.1 运行项目

接下来,我们就一起使用微服务架构去构建黑马商城项目,并解决其中出现的各种问题。

还没有完成环境搭建的同学请参考" 环境搭建" 文档搭建黑马商城项目运行环境,最终将黑马商城项目跑起来。

本项目是为教学需求而设计的简化版项目,在后期的互相网项目阶段我们会接触完整的电商项目。

2.1.2. 熟悉项目

2.1.2.1 登录功能

首先来看一下登录业务流程,下图黄色框内。

登录入口在com.hmall.controller.UserController中的login方法:

2.1.2.2 搜索商品

在首页搜索框输入关键字,点击搜索即可进入搜索列表页面:

该页面会调用接口:/search/list,对应的服务端入口在com.hmall.controller.SearchController中的search方法:

这里目前是利用数据库实现了简单的分页查询。

2.1.2.3 购物车

在搜索到的商品列表中,点击按钮加入购物车,即可将商品加入购物车:

加入成功后即可进入购物车列表页,查看自己购物车商品列表:

同时这里还可以对购物车实现修改、删除等操作。

相关功能全部在com.hmall.controller.CartController中:

2.1.2.4 下单

在购物车页面点击结算按钮,会进入订单结算页面:

点击提交订单,会提交请求到服务端,服务端做3件事情:

  • 创建一个新的订单
  • 扣减商品库存
  • 清理购物车中商品

业务入口在com.hmall.controller.OrderController中的createOrder方法:

2.1.2.5 支付

下单完成后会跳转到支付页面,目前只支持余额支付:

在选择余额支付这种方式后,会发起请求到服务端,服务端会立刻创建一个支付流水单,并返回支付流水单号到前端。

当用户输入用户密码,然后点击确认支付时,页面会发送请求到服务端,而服务端会做几件事情:

  • 校验用户密码
  • 扣减余额
  • 修改支付流水状态
  • 修改交易订单状态

支付成功:

请求入口在com.hmall.controller.PayController中:

支付成功可以查看user表的余额字段是否减少

bug修复

Bug描述: 在测试中发现支付成功后用户表的余额字段并没有减少相应的金额。

请排查问题并进行修复。

修复后进行测试。

2.1.2.6 小结

如何去熟悉一个项目?

首先要去熟悉项目的业务需求、业务流程、业务模块等。

然后再去熟悉项目的技术架构,以及所用到的技术点,可以通过阅读代码、系统测试,分模块去熟悉项目。

黑马商城项目包括几个模块:

认证模块、用户管理、商品管理、购物车、交易模块、支付模块等。

黑马商城项目用的什么技术架构:

黑马商城单体项目使用Spring Boot 2.7.X版本开发,数据库用的MySQL8,还用到了MQ、Redis、Elasticsearch等中间件。

2.2 创建微服务工程

本节我们开始使用微服务架构去开发黑马商城项目。

2.2.1. 系统架构

2.2.1.1 系统架构图

我们用微服务架构开发黑马商城项目首先需要划分微服务,通常是按照业务模块进行划分,同时也会将一些通用的功能抽取成一个微服务,微服务要做到单一职责,高内聚低耦合。

用户端请统一请求到网关(比如nginx),由网关将请求转发到微服务。

每个微服务是一个Spring Boot工程,微服务的地址统一由服务注册中心管理。

每个微服务有自己的数据库,比如:商品数据库、用户数据库。

在数据层除了MySQL之外还有非关系数据库Redis、ES等,满足不同的需求。

系统架构图如下:

2.2.1.2 认识Spring Cloud

每个微服务是一个SpringBoot工程,微服务之间的通信协作、服务保护等各种问题都有对应的解决方案和微服务组件,SpringCloud框架可以说是目前Java领域最全面的微服务组件的集合了,如下图:

Spring Cloud 是一个基于 Spring Boot 的微服务开发框架,它依托于SpringBoot的自动装配能力,它提供了一套完整的微服务解决方案。Spring Cloud 旨在帮助开发者快速构建分布式系统中的服务,包括服务发现、配置管理、API 网关、断路器、智能路由、负载均衡、消息总线、服务间通信等功能。Spring Cloud 是一个非常强大的工具集,可以帮助开发者快速构建健壮的微服务架构。https://spring.io/projects/spring-cloud#overview

Spring Cloud主要组件包括:

  • Eureka:服务发现与注册。
  • Zuul 或 Spring Cloud Gateway:API 网关。
  • Hystrix:断路器。
  • Ribbon,Spring Cloud LoadBalancer:客户端负载均衡。
  • Feign、OpenFeign:声明式服务调用。
  • Config Server:外部配置中心。

以下是SpringCloud和SpringBoot的版本对应关系,SpringCloud依赖SpringBoot:

当前SpringBoot版本为3.3.x版本,目前在企业中大部分还在使用 2.7.x及以下版本,所以我们的课程使用:Spring Cloud 2021.0.x以及Spring Boot 2.7.x版本,重点讲解Spring Cloud Alibaba 框架的核心组件。

Spring Cloud Alibaba 是阿里巴巴基于 Spring Cloud 开发的一套微服务开发工具包在当前非常流行,它针对 Spring Cloud 的一些组件进行了扩展和替换 ,以便更好地适应中国开发者的需求和阿里巴巴集团内部的技术栈。

Spring Cloud Alibaba主要组件包括:

  • Nacos:服务发现和配置中心。
  • Sentinel:流量控制组件。
  • Dubbo:RPC 框架的 Spring Cloud 支持。
  • RocketMQ:消息中间件的支持。

Spring Cloud Alibaba与Spring Cloud 的联系:

  • 基于 Spring Boot:两者都是基于 Spring Boot 的微服务框架。
  • Spring Cloud 核心理念:Spring Cloud Alibaba 遵循 Spring Cloud 的设计理念和模式。
  • 组件兼容:Spring Cloud Alibaba 的组件可以与 Spring Cloud 的其他组件配合使用。

Spring Cloud Alibaba与Spring Cloud 的区别:

  • 服务发现:Spring Cloud 使用的是 Netflix Eureka,而 Spring Cloud Alibaba 使用的是 Nacos。
  • 断路器:Spring Cloud 原生支持 Hystrix,而 Spring Cloud Alibaba 推荐使用 Sentinel。
  • 配置管理:Spring Cloud 使用 Spring Cloud Config Server,而 Spring Cloud Alibaba 使用 Nacos 作为配置中心。
  • 负载均衡:Spring Cloud LoadBalancer结合 Nacos实现负载均衡。
  • 远程调用支持:Spring Cloud Alibaba 支持 Dubbo 作为 RPC 调用框架,而 Spring Cloud 默认不包含 RPC 支持。
2.2.1.3 面试题

SpringBoot和SpringCloud,请你谈谈对他们的理解?

Spring Cloud Alibaba与Spring Cloud区别和联系?

你们Spring Cloud用的什么版本?

2.2.2. 创建基础工程

2.2.2.1 创建父工程

本课程使用maven创建微服务架构的电商项目,首先需要创建父工程,在父工程中主要是要pom.xml中规范依赖的版本,我们已经明确使用Spring Cloud Alibaba ,且SpringBoot的版本使用 2.7.x版本。

本课程提供的git仓库:https://gitee.com/mrt-springcloudv1/hmall-micro.git

先fork本仓库,再从自己空间拉取hmall-micro的代码。

切换到dev_01分支。

创建成功,如下图:

在项目根目录创建pom.xml

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>com.hmall</groupId>
    <artifactId>hmall-parent</artifactId>
    <packaging>pom</packaging>
    <version>1.0.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.12</version>
        <relativePath/>
    </parent>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <org.projectlombok.version>1.18.20</org.projectlombok.version>
        <spring-cloud.version>2021.0.3</spring-cloud.version>
        <spring-cloud-alibaba.version>2021.0.4.0</spring-cloud-alibaba.version>
        <mybatis-plus.version>3.4.3</mybatis-plus.version>
        <hutool.version>5.8.11</hutool.version>
        <mysql.version>8.0.23</mysql.version>
    </properties>

    <!-- 对依赖包进行管理 -->
    <dependencyManagement>
        <dependencies>
            <!--spring cloud-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <!--   type=pom ,scope=import 表示继承 和 parent 作用一样             -->
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--spring cloud alibaba-->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- 数据库驱动包管理 -->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>${mysql.version}</version>
            </dependency>
            <!-- mybatis plus 管理 -->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>${mybatis-plus.version}</version>
            </dependency>
            <!--hutool工具包-->
            <dependency>
                <groupId>cn.hutool</groupId>
                <artifactId>hutool-all</artifactId>
                <version>${hutool.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <dependencies>
        <!-- lombok 管理 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${org.projectlombok.version}</version>
        </dependency>
        <!--单元测试-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.1</version>
                    <configuration>
                        <source>11</source> <!-- depending on your project -->
                        <target>11</target> <!-- depending on your project -->
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

如果pom.xml文件图标不是pom字样需要右键点击

如下图:

选择jdk版本为11:

在pom.xml中重点定义了Spring Boot、Spring Cloud和Spring Cloud Alibaba的版本号:

对应的版本:

2.2.2.2 创建common工程

将原项目的hm-common拷贝到新项目目录下

如果pom.xml文件图标不是pom字样需要右键点击

如下图:

2.2.3.商品服务

接下来,我们先把商品管理功能、购物车功能抽取为两个独立的微服务,其它的微服务根据教学的需求大家请自行创建。

2.2.3.1 创建数据库

接下来创建商品服务。

首先创建商品服务的数据库,导入数据库表。默认的数据库连接的是虚拟机,在你docker数据库执行课前资料提供的SQL文件:

最终,会在数据库创建一个名为hm-item的database,将来的每一个微服务都会有自己的一个database:

注意:虚拟机已经存在hm-item数据库,可不用重复创建。

2.2.3.2 创建工程

在项目中创建module:

选择maven模块,设定JDK版本为11,模块名为item-service

引入依赖:

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>hmall-parent</artifactId>
        <groupId>com.hmall</groupId>
        <version>1.0.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>item-service</artifactId>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>
    <dependencies>
        <!--common-->
        <dependency>
            <groupId>com.hmall</groupId>
            <artifactId>hm-common</artifactId>
            <version>1.0.0</version>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--数据库-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>
        <!--单元测试-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    </dependencies>
    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
2.2.3.3 复制并修改代码

拷贝hm-service中与商品管理有关的代码到item-service,按照模型、持久层、业务层、控制层的顺序拷贝代码,最终效果如下图:

ItemMapper.xml文件中需要修改包路径。

这也是因为ItemMapper的所在包发生了变化,因此这里代码必须修改包路径。

编写启动类,代码如下:

java 复制代码
package com.hmall.item;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@MapperScan("com.hmall.item.mapper")
@SpringBootApplication
public class ItemServiceApplication {

    public static void main(String[] args) {
        SpringApplication.run(ItemServiceApplication.class, args);
    }
}
2.2.3.4 创建配置文件

接下来是配置文件,可以从hm-service中拷贝:

其中,application.yaml内容如下:

注意设置端口号、服务名、数据库账号和密码、swagger接口的包路径com.hmall.item.controller

yaml 复制代码
server:
  port: 8081
spring:
  application:
    name: item-service
  profiles:
    active: dev
  datasource:
    url: jdbc:mysql://${hm.db.host}:3306/hm-item?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: ${hm.db.pw}
mybatis-plus:
  configuration:
    default-enum-type-handler: com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler
  global-config:
    db-config:
      update-strategy: not_null
      id-type: auto
logging:
  level:
    com.hmall: debug
  pattern:
    dateformat: HH:mm:ss:SSS
  file:
    path: "logs/${spring.application.name}"
knife4j:
  enable: true
  openapi:
    title: 商品服务接口文档
    description: "商品服务接口文档"
    url: https://www.itcast.cn
    version: v1.0.0
    group:
      default:
        group-name: default
        api-rule: package
        api-rule-resources:
          - com.hmall.item.controller

剩下的application-dev.yamlapplication-local.yaml直接从hm-service拷贝即可。

2.2.3.5 启动微服务

直接运行启动类

启动成功:

2.2.3.6 测试微服务

访问商品微服务的swagger接口文档:http://localhost:8081/doc.html

然后测试其中的根据id批量查询商品这个接口:

我们从hm-item数据库的item表找几条商品的id进行测试

测试参数:100002672302,100002624500,100002533430,结果如下:

说明商品微服务创建成功了。

2.2.3.7. 小节

创建商品服务步骤:

  1. 创建一个SpringBoot工程
  2. 创建controller、service、mapper、domain包结构
  3. 拷贝修改代码
  4. 创建修改配置文件
  5. 启动微服务

2.2.4.购物车服务(练习)

2.2.4.1 创建数据库

下边创建购物车服务。

首先创建购物车服务的数据库,执行数据库脚本:hm-cart.sql,执行成功查看数据库

2.2.4.2 创建工程

与商品服务类似,在hmall下创建一个新的module,起名为cart-service

引入依赖:

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>hmall-parent</artifactId>
        <groupId>com.hmall</groupId>
        <version>1.0.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cart-service</artifactId>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>
    <dependencies>
        <!--common-->
        <dependency>
            <groupId>com.hmall</groupId>
            <artifactId>hm-common</artifactId>
            <version>1.0.0</version>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--数据库-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>
        <!--单元测试-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    </dependencies>
    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
2.2.4.3 复制与修改代码

hm-service中的与购物车有关功能拷贝过来,最终的项目结构如下:

注意:需要修改CartMapper.xml文件中的包路径。

特别注意的是com.hmall.cart.service.impl.CartServiceImpl,其中有两个地方获取当前的用户id,目前我们还没有创建用户服务所以修改UserContextgetUser()方法固定返回1。

屏蔽ItemService相关代码

编写启动类:

java 复制代码
package com.hmall.cart;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@MapperScan("com.hmall.cart.mapper")
@SpringBootApplication
public class CartServiceApplication {

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

}
2.2.4.4 创建配置文件

拷贝商品服务的配置文件到购物车服务下。

购物车服务的application.yaml内容如下,注意设置端口号、服务名、数据库名、swagger文档的包路径com.hmall.cart.controller

yaml 复制代码
server:
  port: 8082
spring:
  application:
    name: cart-service
  profiles:
    active: dev
  datasource:
    url: jdbc:mysql://${hm.db.host}:3306/hm-cart?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: ${hm.db.pw}
mybatis-plus:
  configuration:
    default-enum-type-handler: com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler
  global-config:
    db-config:
      update-strategy: not_null
      id-type: auto
logging:
  level:
    com.hmall: debug
  pattern:
    dateformat: HH:mm:ss:SSS
  file:
    path: "logs/${spring.application.name}"
knife4j:
  enable: true
  openapi:
    title: 购物车服务接口文档
    description: "购物车服务接口文档"
    url: https://www.itcast.cn
    version: v1.0.0
    group:
      default:
        group-name: default
        api-rule: package
        api-rule-resources:
          - com.hmall.cart.controller
2.2.4.5 启动微服务

直接运行启动类启动微服务。

然后启动CartApplication,访问swagger文档页面:http://localhost:8082/doc.html

我们测试其中的查询我的购物车列表接口:

在测试前查询hm-cart数据库下的cart表,如果cart表为空则需要导入以下数据

sql 复制代码
INSERT INTO `cart` (`id`, `user_id`, `item_id`, `num`, `name`, `spec`, `price`, `image`, `create_time`, `update_time`) VALUES
        (7, 1, 100000006163, 1, '巴布豆(BOBDOG)柔薄悦动婴儿拉拉裤XXL码80片(15kg以上)', '{}', 67100, 'https://m.360buyimg.com/mobilecms/s720x720_jfs/t23998/350/2363990466/222391/a6e9581d/5b7cba5bN0c18fb4f.jpg!q70.jpg.webp', '2023-05-20 13:07:09', '2023-05-20 13:07:09');

下边继续测试接口,无需填写参数,直接访问:

我们注意到,其中与商品有关的几个字段值都为空!这就是因为刚才我们注释掉了查询购物车时,查询商品信息的相关代码。

那么,我们该如何在cart-service服务中实现对item-service服务的查询呢?

2.2.5. 小结

如何创建微服务工程?

  1. 首先确定Spring Cloud、Spring Boot版本,在父工程pom.xml中设定版本号。
  2. 每个微服务创建独立的数据库。
  3. 每个微服务创建Spring Boot工程,继承父工程,并在application.yaml配置端口号、服务名、数据库连接池、日志、swagger文件等配置信息。
  4. 每个微服务工程的目标结构包括:
    config:配置类
    controller:web接口
    service:服务接口
    domain:模型类
    mapper:数据库mapper

2.3 RestTemplate

2.3.1. Java远程调用技术介绍

我们发现一个问题:就是购物车业务中需要查询商品信息,但商品信息查询的逻辑全部迁移到了item-service服务,导致我们无法查询,查询端口信息的代码已经屏蔽:

最终结果就是查询到的购物车数据不完整,因此要想解决这个问题就需要通过远程调用技术。

一个微服务架构的项目会包括很多的微服务,一次业务操作会由多个微服务互相协作完成,比如:一次下单操作的执行流程如下:

执行流程如下:

1.用户请求订单服务提交订单

2.订单服务在数据库创建订单

3.订单服务请求账户服务扣减余额

4.订单服务请求库存服务扣减库存

从以上执行流程可以看出提交订单是通过订单服务、账户服务、库存服务三个微服务共同协作完成的。

服务之间进行交互是通过网络协议进行通信,在Spring Cloud中是通过HTTP协议进行通信。

拿上图举例:

订单服务提供"提交订单接口"供手机客户端调用,手机为客户端,订单服务为服务端。

账户服务提供"扣减余额接口"供订单服务调用,订单服务为客户端,账户服务为服务端。

库存服务提供"扣减库存接口"供订单服务调用,订单服务为客户端,库存服务为服务端。
总结:调用方为客户端,被调方为服务端,客户端为消费者,服务端为生产者。

AI:在Java中客户端与服务端远程调用(Remote Procedure Call, RPC)的技术有哪些?

常用的如下:

  • RMI (Remote Method Invocation)
    • RMI 是 Java 提供的一种标准远程过程调用机制。
    • 客户端可以像调用本地对象一样调用远程对象的方法。
    • RMI 使用 Java 序列化机制来传输对象。
  • .REST (Representational State Transfer)
    • RESTful 服务使用 HTTP 协议来访问资源。
    • 它通常使用 JSON 或 XML 格式来传输数据。
    • REST 是一种轻量级的架构风格,广泛应用于现代 Web 服务。
  • Apache Dubbo
    • Dubbo 是一个高性能、轻量级的微服务框架。
    • Dubbo 支持多种协议远程调用,如 Dubbo 协议、HTTP 协议等。

不管哪种技术它们的底层还是通过TCP、UDP网络协议进行通信。

请大家课下自行用AI学习Java提供的远程调用技术。

比如:

AI:写一个java rmi远程调用的例子

我们现在要在Spring Boot工程中实现远程调用,我们通过AI看下在Spring Boot中有哪些远程调用技术

AI:Spring Boot中远程调用的技术

摘要信息如下:

  • Feign
    • Feign 是一个声明式的HTTP客户端,它简化了HTTP请求的发送。
    • 使用Feign,你可以通过定义接口来创建客户端,Feign会自动生成调用逻辑。
    • Feign支持多种序列化库,如Jackson和Gson。
    • Feign可以与Spring Cloud Discovery Client集成,实现服务发现。
  • RestTemplate
    • RestTemplate 是Spring提供的一个模板类,用于简化HTTP请求的发送。
    • 通过RestTemplate,你可以轻松地发起GET、POST等请求,并处理响应。
    • RestTemplate支持多种数据格式,如JSON和XML。
    • RestTemplate常用于简单的HTTP调用,但在Spring Cloud中也有广泛应用。

RestTemplate不依赖SpringCloud框架,Feign依赖SpringCloud框架。

AI: RestTemplate远程调用例子

其中提供了大量的方法,方便我们发送Http请求,例如:

可以看到常见的Get、Post、Put、Delete请求都支持,如果请求参数比较复杂,还可以使用exchange方法来构造请求。

2.3.2.RestTemplate实现远程调用

2.3.2.1 明确需求

刚开始学习我们用一个简单点的例子,在购物车中需要显示商品信息,而商品信息在item-service服务,因此要想在购物车拿到商品信息就需要购物车服务远程调用商品服务去获取商品信息,流程图如下:

代码中需要变化的就是这一步:

2.3.2.2 注入RestTemplate

现在需求明确,在购物车服务中远程调用商品服务查询商品信息。

首先在商品服务提供一个RESTful接口,传入商品id查询商品信息后返回。

然后在购物车服务用RestTemplate去请求商品服务的商品查询接口。

我们在cart-service服务中定义一个配置类:

先将RestTemplate注册为一个Bean:

java 复制代码
package com.hmall.cart.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

/**
 * @author Mr.M
 * @version 1.0
 * @description RestTemplate配置类
 * @date 2024/8/2 19:46
 */

@Configuration
public class RemoteCallConfig {

 @Bean
 public RestTemplate restTemplate() {
  return new RestTemplate();
 }
}

接下来,我们修改cart-service中的com.hmall.cart.service.impl.CartServiceImplhandleCartItems方法,发送http请求到item-service

首先在CartServiceImpl中注入RestTemplate

java 复制代码
...
public class CartServiceImpl extends ServiceImpl<CartMapper, Cart> implements ICartService {

//    private final IItemService itemService;

    private final RestTemplate restTemplate;
    ...
2.3.2.3 实现远程调用

接下来修改代码,使用RestTemplate实现远程调用,使用RestTemplate进行远程调用的代码如下:

可以看到,利用RestTemplate发送http请求与前端ajax发送请求非常相似,都包含四部分信息:

  • 请求方式
  • 请求路径
  • 请求参数
  • 返回值类型
2.3.2.4 测试

好了,现在重启cart-service,再次测试查询我的购物车列表接口:

可以发现,所有商品相关数据都已经查询到了。

在这个过程中,item-service提供了查询接口,cart-service利用Http请求调用该接口。因此item-service可以称为服务的提供者,而cart-service则称为服务的消费者或服务调用者。

2.3.3. 小结

微服务之间的远程调用被称为RPC,即远程过程调用。RPC的实现方式有很多,比如:

  • 基于Http协议
  • 基于Dubbo协议

我们课堂中使用的是Http方式,这种方式不关心服务提供者的具体技术实现,只要对外暴露Http接口即可,更符合微服务的需要。

Java使用Spring提供的RestTemplate向服务端接口发送http请求,基本步骤如下:

  • 注册RestTemplate到Spring容器
  • 调用RestTemplate的API发送请求,常见方法有:
    • getForObject:发送Get请求并返回指定类型对象
    • PostForObject:发送Post请求并返回指定类型对象
    • put:发送PUT请求
    • delete:发送Delete请求
    • exchange:发送任意类型请求,返回ResponseEntity
  • 解析响应结果

2.3.4 面试题

说几个Java远程调用的技术?你们项目用的什么技术?

3 服务注册和发现

3.1. Nginx负载均衡

3.1.1 问题说明

在上一章我们实现了微服务的构建以及微服务之间的远程调用。不过这种手动发送Http请求的方式存在一些问题。

试想一下,假如商品微服务被调用较多,为了应对更高的并发,我们进行了多实例部署,如图:

此时,每个item-service的实例其IP或端口不同,问题来了:

  • item-service这么多实例,cart-service如何知道每一个实例的地址?
  • http请求要写url地址,cart-service服务到底该调用哪个实例呢?
  • 如果在运行过程中,某一个item-service实例宕机,cart-service依然在调用该怎么办?
  • 如果并发太高,item-service临时多部署了N台实例,cart-service如何知道新实例的地址?

3.1.2 Nginx负载均衡

如何解决上边的问题?

要解决上边的问题需要引入负载均衡器,比如:Nginx就提供负载均衡的功能,负载均衡器是一种网络设备或软件组件,用于在多台服务器之间分发网络流量。这有助于提高应用程序的可用性和响应速度,同时也能增加系统的容错能力。

Nginx 不仅是一个高性能的 Web 服务器,也是一个强大的反向代理,可以做为负载均衡器。

它可以支持多种负载均衡算法,包括轮询、最少连接、IP 哈希:

  1. 轮询 (默认)
    • 按照顺序将请求分发给不同的服务器。
  2. 最少连接
    • 将请求发送到当前活跃连接数最少的服务器。
  3. IP 哈希
    • 根据客户端 IP 地址进行哈希计算,使得来自同一客户端的请求始终被路由到同一台服务器。

通过nginx实现负载均衡的结构图如下:

在nginx的配置方法也非常简单,只要配置上游服务器和具体的代理位置即可,大家可作为参考

conf 复制代码
http {
    upstream item_services {
        server 127.0.0.1:8081 weight=3;  # 分配较高权重
        server 127.0.0.1:7081 weight=2;  # 分配中等权重
        server 127.0.0.1:6081 weight=1;  # 分配较低权重
    }

    server {
        listen       80;  # 监听 80 端口,也可以根据需要更改
        server_name  localhost;  # 更改为你的域名或 IP 地址

        location /items {  # 这里可以根据需要调整路径前缀
            proxy_pass http://item_services;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;

            # 其他可选配置
            proxy_redirect off;
            proxy_buffering off;
            proxy_read_timeout 90;
        }
    }
}

说明:

  1. upstream 块定义了一个名为 item_services 的服务器组,包含三个服务器实例。你可以通过修改 server 行中的地址和端口来指向实际的服务实例。
  2. server 块定义了 Nginx 的监听端口和服务名称。
  3. location 块指定了路径 /items/ 下的所有请求将被代理到 item_services 上游组。
  4. proxy_pass 指令指定了代理目标。
  5. proxy_set_header 指令设置了转发给后端服务的 HTTP 头。

这种方案在我们学习nginx就接触到了,这是一种服务端负载均衡的做法,即客户端(cart-service)请求nginx(服务端),由nginx负载均衡器完成将请求转发到具体的服务实例。

如果增加了服务实例可以在nginx的upstream 上配置服务实例地址即可。

下边进行测试

首先在nginx的nginx.conf配置文件中配置upstream 和虚拟目录

cmd进入nginx目录,输入下边的命令加载配置:

然后在idea中启动多个商品服务:

注意:为了避免多个服务端口冲突这里需要指定端口

产生复制一个启动配置

然后再修改启动参数,添加启动参数

在启动参数中传入:server.port=7081如下图:

启动成功如下:

两个商品服务实例,一个购物车服务实例。

然后修改购物车服务中远程调用商品服务地址为nginx虚拟目录的地址:http://localhost:80/items?ids={ids}

重启购物车服务。

重新测试查询购物车接口,观察两个商品服务的控制台,购物车服务通过nginx请求商品服务时通过轮询算法请求商品服务

3.1.3 面试题

如何使用nginx实现负载均衡?

Nginx是反向代理,为什么叫反向代理?

3.3. 服务注册与发现流程

3.3.1 区分客户端与服务端负载均衡

刚才使用nginx实现负载均衡解决了我们面临的问题。

nginx作为服务端,客户端请求nginx服务端,通过Nginx负载均衡器将请求转发到不同的后端服务,这是一种服务端负载均衡。
服务端负载均衡 是客户端请求到Nginx服务端由Nginx实现负载均衡。

接下来我们再讲一种客户端负载均衡的做法来解决我们面临的问题。
客户端负载均衡 是客户端在发起调用时自己实现了负载均衡的作用,自己通过负载均衡算法找到一个目标服务进行调用。

如下图:

购物车服务自己通过负载均衡器挑选一个目标地址进行远程调用。

3.3.2 服务注册与发现流程

接下来我们讲的服务注册与发现流程正是用于实现客户端负载均衡。

首先引入注册中心的概念。

在微服务远程调用的过程中,包括两个角色:

  • 服务提供者:提供接口供其它微服务访问,比如item-service
  • 服务消费者:调用其它微服务提供的接口,比如cart-service

在大型微服务项目中,服务提供者的数量会非常多,为了管理服务提供者就引入了注册中心的概念。注册中心、服务提供者、服务消费者三者间关系如下:

三者的分工如下:

1 注册中心:提供服务注册接口,接收服务注册请求,保存服务实例的信息。

目前开源的注册中心中间件有很多,国内比较常见的有:

  • Eureka:Netflix公司出品,目前被集成在SpringCloud当中,一般用于Java应用
  • Nacos:Alibaba公司出品,目前被集成在SpringCloudAlibaba中,一般用于Java应用,我们项目使用Nacos。
  • Consul:HashiCorp公司出品,目前集成在SPringCloud中,不限制微服务语言

2 服务提供者:服务接口提供方,请求注册中心将服务信息注册到注册中心。

3 服务调用者:远程调用的客户端,请求注册中心查询服务地址,通过负载均衡选取目标服务地址进行远程调用。

  • 服务注册与发现流程如下:
    • 服务启动时就会注册自己的服务信息(服务名、IP、端口)到注册中心
    • 调用者可以从注册中心订阅想要的服务,获取服务对应的实例列表(1个服务可能多实例部署)
    • 调用者作为客户端自己通过负载均衡算法挑选一个服务提供者实例进行远程调用,即客户端负载均衡
    • 调用者向该实例发起远程调用
  • 当服务提供者的实例宕机或者启动新实例时,调用者如何得知呢?
    • 服务提供者会定期向注册中心发送请求,报告自己的健康状态(心跳请求)
    • 当注册中心长时间收不到提供者的心跳时,会认为该实例宕机,将其从服务的实例列表中剔除
    • 当服务有新实例启动时,会发送注册服务请求,其信息会被记录在注册中心的服务实例列表
    • 当注册中心服务列表变更时,会主动通知微服务,更新本地服务列表

3.3.3 面试题

说一下服务注册与发现流程?

3.3.Nacos安装配置

3.3.1 介绍

接下来我们就去实现整个服务注册与发现的流程。

Nacos是国内产品,中文文档比较丰富,而且同时具备配置管理功能(后面会学习),因此在国内使用较多,课堂中我们会Nacos为例来学习。

官方网站如下:https://nacos.io/zh-cn/docs/v2/what-is-nacos.html

3.3.2 安装数据库

我们基于Docker来部署Nacos的注册中心,首先我们要准备MySQL数据库表,用来存储Nacos的数据。由于是Docker部署,所以大家需要将资料中的SQL文件导入到你Docker中的MySQL容器中

最终表结构如下:

3.3.3 创建容器

然后,找到课前资料下的nacos文件夹和nacos.2.4.tar,全部上传到/root下:

nacos.2.4.tar是nacos的镜像文件,nacos文件夹下是nacos配置文件。

其中的nacos/custom.env文件中,注意:有一个MYSQL_SERVICE_HOST也就是mysql地址,需要修改为你自己的虚拟机IP地址

然后,将课前资料中的nacos目录上传至虚拟机的/root目录。

首先导入nacos.tar镜像文件:

shell 复制代码
docker load -i nacos.2.4.tar

进入root目录,然后执行下面的docker命令:

shell 复制代码
docker run -d \
--name nacos \
--env-file ./nacos/custom.env \
-p 8848:8848 \
-p 9848:9848 \
-p 9849:9849 \
--restart=always \
nacos/nacos-server:v2.4.0.1

3.3.4 访问nacos

启动完成后,访问下面地址:http://192.168.101.68:8848/nacos/,注意将192.168.101.68替换为你自己的虚拟机IP地址。

进入首页:

注意:2.4版本开始nacos默认不进行认证直接进入首页,以前的版本首次访问会跳转到登录页,账号密码都是nacos

3.3.5 小结

Nacos安装步骤小结:

  1. 导入nacos.sql 创建nacos数据库
  2. 上传nacos 镜像 及配置(配置需要修改为自己虚拟机的ip)
  3. docker load -i nacos.2.4.tar 加载镜像
  4. 运行docker 启动命令

3.4. 服务注册

接下来,我们把item-service注册到Nacos,步骤如下:

  • 引入依赖
  • 配置Nacos地址
  • 重启

3.4.1 添加依赖

在父工程需要添加Spring Cloud及Spring Cloud Alibaba的版本约束,如果已添加不用重复添加

xml 复制代码
<!--spring cloud-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-dependencies</artifactId>
    <version>${spring-cloud.version}</version>
    <!--   type=pom ,scope=import 表示继承 和 parent 作用一样             -->
    <type>pom</type>
    <scope>import</scope>
</dependency>
<!--spring cloud alibaba-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
    <version>${spring-cloud-alibaba.version}</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

因为我们安装的是2.4.0版本的nacos,Spring Boot默认使用的Nacos比该版本低,所以需要在父pom.xml中约定nacos-client版本,如下:

xml 复制代码
<dependency>
    <groupId>com.alibaba.nacos</groupId>
    <artifactId>nacos-client</artifactId>
    <version>2.4.0</version>
</dependency>

item-servicepom.xml中添加依赖:

xml 复制代码
<!--nacos 服务注册发现-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

3.4.2 配置Nacos

item-serviceapplication.yml中添加nacos地址配置:

yml 复制代码
spring:
  application:
    name: item-service # 服务名称
  cloud:
    nacos:
      server-addr: 192.168.101.68:8848 # nacos地址

注意:修改nacos的ip和端口。

3.4.3 启动服务实例

启动两个商品服务实例。

启动过程中观察日志,发现如下日志则表示注册成功

shell 复制代码
Success to connect to server [192.168.101.68:8848] on start up, connectionId ...

3.4.4 查看服务注册信息

访问nacos控制台,可以发现服务注册成功:

点击详情,可以查看到item-service服务的两个实例信息:

3.4.5 小结

服务注册过程:

  1. 在微服务添加spring-cloud-starter-alibaba-nacos-discovery 依赖。
  2. application.yml中添加nacos地址配置,微服务根据配置连接nacos进行注册。
  3. 可通过nacos的服务列表查询服务注册信息。

3.5. 服务发现

服务的消费者要去nacos订阅服务,这个过程就是服务发现,步骤如下:

  • 引入依赖
  • 配置Nacos地址
  • 发现并调用服务

3.5.1 引入依赖

服务发现除了要引入nacos依赖以外,由于还需要负载均衡,因此要引入SpringCloud提供的LoadBalancer依赖。

我们在cart-service中的pom.xml中添加下面的依赖:

xml 复制代码
<!--nacos 服务注册发现-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!--负载均衡器-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>

可以发现,这里Nacos的依赖于服务注册时一致,这个依赖中同时包含了服务注册和发现的功能。因为任何一个微服务都可以调用别人,也可以被别人调用,即可以是调用者,也可以是提供者。

因此,等一会儿cart-service启动,同样会注册到Nacos

3.5.2 配置Nacos地址

cart-serviceapplication.yml中添加nacos地址配置:

yml 复制代码
spring:
  cloud:
    nacos:
      server-addr: 192.168.101.68:8848

3.5.3 服务发现并调用服务

接下来,服务调用者cart-service就可以去订阅item-service服务了,它的底层使用了Spring Cloud Loadbalancer组件实现客户端负载均衡,常见的负载均衡算法有:

  • 随机
  • 轮询
  • IP的hash
  • 最近最少访问
  • ...

下边介绍两种服务发现的方法。

3.5.3.1 方法1

使用DiscoveryClient工具实现服务发现,SpringCloud已经帮我们自动装配,我们可以直接注入使用:

接下来,我们就可以对原来的远程调用做修改了,之前调用时我们需要写死服务提供者的IP和端口:

但现在不需要了,我们通过DiscoveryClient发现服务实例列表,然后通过负载均衡算法,选择一个实例去调用:

经过swagger测试,并进行断点跟踪,成功从注册中心获取两个实例

通过负载均衡算法随机获取一个实例并拿该实例的uri

3.5.2.2 方法2

上边的例子是我们手动通过discoveryClient去注册中心查询服务列表,然后再手动随机取出一个服务地址进行远程调用,Spring Cloud Loadbalancer 提供了现成的客户端负载均衡器可以非常方便的实现客户端负载均衡。

修改RemoteCallConfig类,使用@LoadBalanced注解标识RestTemplate,如下:

java 复制代码
@Configuration
public class RemoteCallConfig {

 @Bean
 @LoadBalanced
 public RestTemplate restTemplate() {
  return new RestTemplate();
 }
}

修改代码,屏蔽使用discoveryClient从注册中心查询服务列表以及随机选择服务实例的代码,RestTemplate在远程调用时指定服务名"item-service",如下:

重启cart-service,测试查询购物车列表接口,功能正常,并且连续请求接口通过观察两个商品服务实例的控制台都输出商品查询的日志,说明实现了负载均衡。

3.5.4 小结

服务发现流程:

  1. 在服务调用方引入依赖spring-cloud-starter-alibaba-nacos-discovery
  2. 在服务调用方配置Nacos地址
  3. 发现并调用服务

两种方法:

  1. 使用discoveryClient从nacos获取目标服务的所有服务实例地址,再通过负载均衡算法选取一个服务地址,通过RestTemplate进行远程调用。
  2. 使用@LoadBalanced注解标识RestTemplate,RestTemplate在远程调用时指定目标服务名即可。

3.6. Spring Cloud Loadbalancer 原理

3.6.1 源码解析

为什么我们只输入了service名称就可以访问了呢?之前还要获取ip和端口。 显然有人帮我们根据service名称,获取到了服务实例的ip和端口。这就是 @LoadBalanced注解起到的作用。

@LoadBalanced注解是如何实现负载均衡呢?

首先在创建RestTemplate的bean时添加@LoadBalanced注解,LoadBalancerAutoConfiguration自动配置筛选出添加@LoadBalanced注解的RestTemplate,为RestTemplate设置LoadBalancerInterceptor。

LoadBalancerInterceptor会在对RestTemplate的请求进行拦截,然后从nacos中根据服务id获取服务列表,随后利用负载均衡算法得到真实的服务地址信息,替换服务id。

下边通过跟踪源代码解释整个执行过程。

可以看到这里的intercept方法,拦截了用户的HttpRequest请求,然后做了几件事:

request.getURI() :获取请求uri,本例中就是http://item-service/items?ids=100000006163

originalUri.getHost() :获取uri路径的主机名,其实就是服务id, item-service

this.loadBalancer.execute() :处理服务id,和用户请求。

这里的 this.loadBalancer 是 LoadBalancerClient 类型,LoadBalancerClient 会根据负载均衡算法选择一个实例并发起请求,我们继续跟入。

调用choose方法根据负载均衡算法选择一个服务实例,继续跟入

默认使用的负载均衡策略是轮询,通过RoundRobinLoadBalancer实现

最终选择一个服务实例

放行继续执行。

继续测试该接口,因为是轮询策略,下次会选择另一个服务实例

在Spring Cloud 2020版本以前客户端负载均衡使用的是Netflix公司的Ribbon组件,由于Netflix公司对一些组件不再更新,Spring Cloud之后的版本就移除了Ribbon,使用Spring Cloud LoadBalance实现客户端负载均衡。

3.6.2 面试题

微服务是怎么实现远程调用的?

4 OpenFeign

4.1. 认识OpenFeign

在上一章,我们利用Nacos实现了服务的治理,利用RestTemplate实现了服务的远程调用,虽然ip和端口换成了服务名,但是远程调用的代码还有些复杂:

有没有一种类似调用本地service方法的方式去实现远程调用呢?

接下来我们讲解的OpenFeign技术就可以让远程调用像本地方法调用一样简单

AI:OpenFeign是什么

Spring Cloud早期版本使用的Feign组件实现远程调用,Feign中集成了Ribbon,随着Netflix公司不再维护Feign,Spring Cloud在Feign基础上新建了一个开源项目OpenFeign,OpenFeign 是一个声明式的 HTTP 客户端框架,它简化了编写 REST 客户端的过程。
使用 OpenFeign 的步骤

  • 添加依赖:
    • 在你的项目中添加 OpenFeign 的依赖。如果你使用 Maven,可以添加以下依赖:
xml 复制代码
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
  • 创建 Feign 客户端接口:
    • 定义一个接口来描述你的远程服务。
    • 使用 @FeignClient 注解来标识远程调用接口,并指定服务名、接口路径。用的都是SpringMVC的注解,开发简单。
java 复制代码
@FeignClient(name = "item-service")
public interface ItemClient {
    @GetMapping("/items/{id}")
    Item getItem(@PathVariable("id") String id);
}
  • 注入FeignClient
    • 接下来在购物车服务注入 Feign 客户端,通过Feign客户端进行远程调用。
java 复制代码
@RestController
public class CartController {
    @Autowired
    private ItemClient itemClient;
    @GetMapping("/carts/{id}/items/{itemId}")
    public ResponseEntity<Item> getCartItem(@PathVariable("id") String cartId, @PathVariable("itemId") String itemId) {
        Item item = itemClient.getItem(itemId);
       // 处理 item 数据...
        return ResponseEntity.ok(item);
    }
}

使用OpenFeign是非常简单的,只需要定义一个接口,用FeignClient标识目标服务的名称,在接口中定义要调用的接口,使用Spring MVC注解进行标识。在其它bean中注入此接口即可使用。

其实远程调用的关键点就在于四个:

  • 请求方式
  • 请求路径
  • 请求参数
  • 返回值类型

所以,OpenFeign就利用SpringMVC的相关注解来声明上述4个参数,然后基于动态代理帮我们生成远程调用的代码,而无需我们手动再编写,非常方便。

接下来,我们就通过一个快速入门的案例来体验一下OpenFeign的便捷吧。

4.2.快速入门

我们还是以cart-service中的查询我的购物车为例。因此下面的操作都是在cart-service中进行。

4.2.1 引入依赖

在消费者端即cart-service服务的pom.xml中引入OpenFeign的依赖和loadBalancer依赖:

xml 复制代码
  <!--openFeign-->
  <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-openfeign</artifactId>
  </dependency>
  <!--负载均衡器-->
  <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-loadbalancer</artifactId>
  </dependency>

4.2.2 编写OpenFeign客户端

cart-service中,定义一个新的接口,该接口将来通过OpenFeign去访问商品服务中ItemController类的方法,所以参考商品服务的ItemController类去编写Feign接口

其中代码如下:

java 复制代码
package com.hmall.cart.client;

import com.hmall.cart.domain.dto.ItemDTO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.Collection;
import java.util.List;

/**
 * @author Mr.M
 * @version 1.0
 * @description 商品服务Feign接口
 * @date 2024/8/3 16:21
 */
@FeignClient(name="item-service",path = "/items")
public interface ItemClient {
    @GetMapping
    List<ItemDTO> queryItemByIds(@RequestParam("ids") Collection<Long> ids);
}

这里只需要声明接口,无需实现方法。接口中的几个关键信息:

  • @FeignClient(name="item-service") :声明服务名称
  • @FeignClient(path = "/items"): 相当于ItemController类上的@RequestMapping("/items")指定的路径
  • @GetMapping :声明请求方式
  • @RequestParam("ids") Collection ids :声明请求参数
  • List :返回值类型

有了上述信息,OpenFeign就可以利用动态代理帮我们实现这个方法,并且向http://item-service/items发送一个GET请求,携带ids请求参数,并自动将返回值处理为List。

我们只需要直接调用这个方法,即可实现远程调用了。

4.2.3 使用FeignClient

最后,我们在cart-servicecom.hmall.cart.service.impl.CartServiceImpl中改造代码,直接调用ItemClient的方法:

feign替我们完成了服务拉取、负载均衡、发送http请求的所有工作,是不是看起来优雅多了。

而且,这里我们不再需要RestTemplate了,还省去了RestTemplate的注册。

4.2.4 启用OpenFeign

接下来,我们在cart-service的CartApplication启动类上添加注解,启动OpenFeign功能:

@EnableFeignClients注解的作用寻找使用 @FeignClient 注解的接口生成Feign客户端(代理对象),自动配置 Feign 客户端与 Spring Cloud LoadBalancer 的集成。

4.2.5 测试

通过我们购物车接口测试OpenFeign实现远程调用。

4.2.6 小结

OpenFeign的使用过程?

  1. 将服务提供方提供的接口定义为Interface接口,并且@FeignClient注解标识,在接口方法上使用SpringMVC注解标识方法的路径、参数等。
  2. 在服务调用方注入FeignClient接口,OpenFeign组件会根据接口生成代理对象,服务调用方通过FeignClient接口的代理对象进行远程调用。
  3. 在服务调用方启动类上添加@EnableFeignClients

4.2 最佳实践

4.2.1. OkHttp

4.2.1.1 介绍

Feign底层发起http请求,依赖于第三方的http客户端框架。常用的http客户端有:

  • HttpURLConnection:默认实现,不支持连接池
    HttpURLConnection 是 Java 标准库中用于发送 HTTP 请求和接收 HTTP 响应的一个类。它位于 java.net 包中,提供了一组丰富的 API 来处理 HTTP 连接。HttpURLConnection 可以用于发送 GET、POST、PUT、DELETE 等各种 HTTP 方法的请求,并允许设置请求头、请求体等。
  • Apache HttpClient :支持连接池
    Apache HttpClient 是一个用于发送 HTTP 请求和接收 HTTP 响应的强大客户端库,它是 Apache HttpComponents 项目的一部分。这个库为 Java 开发者提供了高级别的 API 来处理 HTTP 和 HTTPS 协议,同时也提供了低级别的组件来构建和定制 HTTP 客户端。
  • OKHttp:支持连接池
    OkHttp 是一个高效的 HTTP 客户端库,由 Square Inc. 开发和维护。它最初是为了提高 Android 应用程序中的网络请求效率而设计的,但现在也被广泛用于 Java 应用程序中。OkHttp 提供了许多高级功能,以简化 HTTP 请求的处理并提高性能。
    因此我们通常会使用带有连接池的客户端来代替默认的HttpURLConnection。比如,我们使用OKHttp,使用连接池可以提升 HTTP 请求的效率。
    首先我们跟踪源代码,查看当前默认的Client底层是HttpURLConnection,请求查询购物车接口,在远程调用商品服务处打断点:

    继续跟入

    继续跟入

    继续跟入

    使用的是默认的Client客户端,继续跟入

    继续跟入,Client执行使用HttpURLConnection请求http
4.2.1.2 更换为okhttp

下边我们更换Client为okhttp

cart-service的pom.xml中引入依赖:

xml 复制代码
<!--OK http 的依赖 -->
<dependency>
  <groupId>io.github.openfeign</groupId>
  <artifactId>feign-okhttp</artifactId>
</dependency>

cart-serviceapplication.yml配置文件中开启Feign的连接池功能:

yml 复制代码
feign:
  okhttp:
    enabled: true # 开启OKHttp功能

重启服务,okhttp就生效了。

重新请求查询购物车接口,跟踪源代码查看Client的代理已变为OkHttpClient。

继续跟入代码,使用OkHttpClient发起请求并拿到响应结果。

4.2.2. 抽取API工程

4.2.2.1 思路分析

上边学习了使用OpenFeign方式实现微服务接口的远程调用,每个微服务都可能需要提供接口供其它微服务调用,仍然拿商品服务举例,除了购物车服务需要调用商品服务的接口以外,订单服务也需要调用商品服务,实现的方式可参考购物车服务,在订单服务中编写Feign接口,或者直接将购物车服务中的Feign接口拷贝到订单服务。

这不是重复编码吗? 有什么办法可以避免重复编码呢?

避免重复编码的办法就是抽取。不过这里有两种抽取思路:

  • 思路一:抽取到微服务之外的公共module
  • 思路二:每个微服务自己抽取一个module

如图:

方案一抽取更加简单,所有微服务提供的外部接口都在一个工程中,工程结构也比较清晰,但缺点是整个项目耦合度偏高,比如:hm-api中包括了A、B、C三个微服务的接口,D服务即使只用A,只要依赖hm-api工程就会自动依赖B、C。

方案二抽取相对麻烦,每个微服务工程都需要有一个api模块,但服务之间耦合度降低。比如:A、B、C三个微服务D服务用A只需要依赖A服务下的api模块即可。

对于中小型项目规模通常选择方案一,不用维护太多的api的工程,简单高效。

4.2.2.2 抽取API工程

下边我们将黑马商城项目的api按方案一抽取。

在hmall下定义一个新的module,命名为hm-api

其依赖如下:

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>
        <groupId>com.hmall</groupId>
        <artifactId>hmall-parent</artifactId>
        <version>1.0.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>hm-api</artifactId>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>

    <dependencies>
        <!--open feign-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <!-- load balancer-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>
        <dependency>
            <groupId>com.hmall</groupId>
            <artifactId>hm-common</artifactId>
            <version>1.0.0</version>
        </dependency>
        <!-- swagger 注解依赖 -->
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>1.6.6</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>
</project>

然后把ItemDTO和ItemClient都移动到hm-api工程中,最终结构如下:

注意:ItemDTO和ItemClient在购物车工程不存在了。

下图中:com.hmall.api.item包为商品服务接口包,后期还会创建与com.hmall.api.item包平级的其它服务的接口包。

现在,任何微服务要调用item-service中的接口,只需要引入hm-api模块依赖即可,无需自己编写Feign客户端了。

4.2.2.3 使用API

接下来,我们在cart-service的pom.xml中引入hm-api模块:

xml 复制代码
  <!--feign模块-->
  <dependency>
      <groupId>com.hmall</groupId>
      <artifactId>hm-api</artifactId>
      <version>1.0.0</version>
  </dependency>

删除cart-service中原来的ItemDTO和ItemClient,重启项目发现报错了:

这里因为ItemClient现在定义到了com.hmall.api.item包下,而cart-service的启动类定义在com.hmall.cart包下,扫描不到ItemClient,所以报错了。

解决办法很简单,在cart-service的启动类上添加声明即可,两种方式:

  • 方式1:声明扫描包:(推荐此方式)
  • 方式2:声明要用的FeignClient

    推荐方式一。

4.2.3. 完善服务接口

目前为止我们把商品服务的查询商品信息接口作为Feign接口抽取到了hm-api工程中,假设有一天接变更了该怎么办?比如:商品查询接口加了一个参数,首先需要修改商品服务的商品查询Controller方法,添加一个参数,然后修改hm-api工程的对应的接口添加一个参数。

这两个地方都要改,一个是服务端的接口,一个是于服务端接口对应的Feign接口。

如果忘记修改其中一个地方或两个地方修改的不一致则会导致接口无法正常调用。为了解决这个问题我们可以让服务端controller类去实现hm-api中的Feign接口,这样一来要改就一起修改了。

首先在商品服务引入hm-api

xml 复制代码
<dependency>
    <groupId>com.hmall</groupId>
    <artifactId>hm-api</artifactId>
    <version>1.0.0</version>
</dependency>

然后让ItemController类实现ItemClient接口

java 复制代码
package com.hmall.item.controller;


import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.hmall.api.item.ItemClient;
import com.hmall.common.domain.PageDTO;
import com.hmall.common.domain.PageQuery;
import com.hmall.common.utils.BeanUtils;
import com.hmall.item.domain.dto.ItemDTO;
import com.hmall.item.domain.dto.OrderDetailDTO;
import com.hmall.item.domain.po.Item;
import com.hmall.item.service.IItemService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;

import java.time.LocalDateTime;
import java.util.List;
import java.util.concurrent.TimeUnit;

@Api(tags = "商品管理相关接口")
@RestController
@RequestMapping("/items")
@RequiredArgsConstructor
public class ItemController implements ItemClient {
....

@ApiOperation("根据id批量查询商品")
@GetMapping
public List<ItemDTO> queryItemByIds(@RequestParam("ids") Collection<Long> ids){
    System.out.println(LocalDateTime.now());
    //休眠10秒
    try {
        Thread.sleep(5000);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
    return itemService.queryItemByIds(ids);
}

代码报错,发现是ItemDTO冲突,删除商品服务中的ItemDTO,统一使用hm-api中的ItemDTO。

修改完成重启商品服务和购物车服务测试查询购物车接口。

4.3 面试题

OpenFeign的工作原理?

5 作业

5.1 创建用户微服务

hm-service中用户管理相关的业务抽取出来,创建用户微服务user-service

注意事项

当业务代码中需要知道当前登录用户是谁,目前暂未实现,先将用户id写死,如下:

user-service也需要自己的独立的database,向MySQL中导入课前资料提供的SQL:

注意:即使虚拟机已存在hm-user数据库也需要运行此脚本。

导入结果如下:

测试

启动UserApplication,访问http://localhost:8084/doc.html#/default/用户相关接口/loginUsingPOST,测试登录接口:

用户服务测试通过。

5.2 创建交易微服务

hm-service中交易相关的业务抽取出来,创建交易微服务trade-service

当业务代码中需要知道当前登录用户是谁,目前暂未实现,先将用户id写死。

提示

在交易服务中,用户下单时需要做下列事情:

  • 根据id查询商品列表
  • 计算商品总价
  • 保存订单
  • 扣减库存
  • 清理购物车商品

其中,查询商品、扣减库存都是与商品有关的业务,在item-service中有相关功能;清理购物车商品是购物车业务,在cart-service中有相关功能。

因此交易服务要调用他们,必须通过OpenFeign远程调用。我们需要将上述功能抽取为FeignClient.

在抽取FeignClient的过程中,接口涉及的DTO需要迁移到hm-api工程中。

比如:

OrderDetailDTO抽取到hm-api模块的com.hmall.api.item.dto包下,删除原来商品服务下的OrderDetailDTO

注意:删除原来商品服务下的OrderDetailDTO后很多代码报错,需要细心修改OrderDetailDTO的最新包路径。

抽取FeignClient接口完成后需要改造OrderServiceImpl中的createOrder方法,将查询商品、扣减库存、清理购物车这三个本地方法调用改造为基于FeignClient的调用。

测试

启动TradeApplication,访问http://localhost:8085/doc.html

测试创建订单接口。

测试参数说明:

代码中目前我们将用户ID硬编码为 1,用户名为jack,在hm-user数据库的user表中。

addressId:收货地址,在hm-user数据库的address表中。

itemId: 购买商品的id,在hm-item数据库的item表中。

num:购买数量。

paymentType:支付方式,1:支付宝、2:微信,3:余额支付。

测试效果如下:

创建订单成功返回订单ID。

测试查询订单接口:

使用上个测试返回的订单ID测试查询订单信息接口。

5.3 创建支付微服务

hm-service中支付相关的业务抽取出来,创建支付微服务pay-service

当业务代码中需要知道当前登录用户是谁,目前暂未实现,先将用户id写死。

提示

在支付服务中,基于用户余额支付时需要做下列事情:

  • 扣减用户余额
  • 标记支付单状态为已支付
  • 标记订单状态为已支付

其中,扣减用户余额 是在user-service中有相关功能;标记订单状态 则是在trade-service中有相关功能。因此交易服务要调用他们,必须通过OpenFeign远程调用。我们需要将上述功能抽取为FeignClient.

抽取FeignClient完成后就可以改造PayOrderServiceImpl中的逻辑,将扣减用户余额、标记订单状态为已支付这两个本地方法调用改造为基于FeignClient的调用。

测试

启动PayApplication,访问http://localhost:8086/doc.html

测试创建支付单。

接口参数说明:

bizOrderNo:业务订单号,在测试交易服务创建订单接口生成的订单ID,对应hm-trade数据库的order表的ID。

amount:订单金额,单位:分,对应hm-trade数据库的order表的total_fee字段

payChannelCode:支付渠道编码,余额支付渠道编码为balance,支付渠道编码在枚举类PayChannel中定义。

payType:余额支付类型为5

orderInfo:订单信息字符串。

测试成功返回支付单ID,对应hm-pay数据库中的pay-order表的ID。

测试余额支付接口:

参数测试:

Id: 支付单ID

pw:支付密码,即用户的登录密码,账号为1的用户密码为123.

支付成功可以从hm-pay数据库中的pay-order表找到对应的记录,查看status字段值是否为3(表示支付成功)

6 作业参考

作业尽量自己完成,实在觉得有困难的,再来查看本篇内容

6.1 用户服务

6.1.1 创建微服务工程

在hmall下新建一个module,命名为user-service.

6.1.2.依赖

user-servicepom.xml文件内容如下:

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>hmall-parent</artifactId>
        <groupId>com.hmall</groupId>
        <version>1.0.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>user-service</artifactId>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>

    <dependencies>
        <!--common-->
        <dependency>
            <groupId>com.hmall</groupId>
            <artifactId>hm-common</artifactId>
            <version>1.0.0</version>
        </dependency>
        <!--api-->
        <dependency>
            <groupId>com.hmall</groupId>
            <artifactId>hm-api</artifactId>
            <version>1.0.0</version>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--数据库-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>
        <!--nacos 服务注册发现-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
    </dependencies>
    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

6.1.3.启动类

user-service中的com.hmall.user包下创建启动类:

java 复制代码
package com.hmall.user;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@MapperScan("com.hmall.user.mapper")
@SpringBootApplication
public class UserApplication {
    public static void main(String[] args) {
        SpringApplication.run(UserApplication.class, args);
    }
}

6.1.4.配置文件

hm-service项目中复制3个yaml配置文件到user-serviceresource目录。

其中application-dev.yaml和application-local.yaml保持不变。application.yaml如下:

yml 复制代码
server:
  port: 8084
spring:
  application:
    name: user-service # 服务名称
  profiles:
    active: dev
  datasource:
    url: jdbc:mysql://${hm.db.host}:3306/hm-user?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: ${hm.db.pw}
  cloud:
    nacos:
      server-addr: 192.168.101.68 # nacos地址
mybatis-plus:
  configuration:
    default-enum-type-handler: com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler
  global-config:
    db-config:
      update-strategy: not_null
      id-type: auto
logging:
  level:
    com.hmall: debug
  pattern:
    dateformat: HH:mm:ss:SSS
  file:
    path: "logs/${spring.application.name}"
knife4j:
  enable: true
  openapi:
    title: 用户服务接口文档
    description: "信息"
    url: https://www.itcast.cn
    version: v1.0.0
    group:
      default:
        group-name: default
        api-rule: package
        api-rule-resources:
          - com.hmall.user.controller
hm:
  jwt:
    location: classpath:hmall.jks
    alias: hmall
    password: hmall123
    tokenTTL: 30m

hm-service下的hmall.jks文件拷贝到user-service下的resources目录,这是JWT加密的秘钥文件

6.1.5.代码

复制hm-service中所有与useraddressjwt有关的代码,最终项目结构如下:

6.1.6.数据库

user-service也需要自己的独立的database,向MySQL中导入课前资料提供的SQL:

注意:即使虚拟机已存在hm-user数据库也需要运行此脚本。

导入结果如下:

6.1.7.启动微服务

运行user-service服务的启动类。

6.1.8.测试

启动UserApplication,访问http://localhost:8084/doc.html#/default/用户相关接口/loginUsingPOST,测试登录接口:

用户服务测试通过。

6.2.交易服务

6.2.1.创建微服务工程

在hmall下新建一个module,命名为trade-service.

6.2.2.依赖

trade-servicepom.xml文件内容如下:

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>hmall-parent</artifactId>
        <groupId>com.hmall</groupId>
        <version>1.0.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>trade-service</artifactId>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>

    <dependencies>
        <!--common-->
        <dependency>
            <groupId>com.hmall</groupId>
            <artifactId>hm-common</artifactId>
            <version>1.0.0</version>
        </dependency>
        <!--api-->
        <dependency>
            <groupId>com.hmall</groupId>
            <artifactId>hm-api</artifactId>
            <version>1.0.0</version>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--数据库-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>
        <!--nacos 服务注册发现-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
    </dependencies>
    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

6.2.3.启动类

trade-service中的com.hmall.trade包下创建启动类:

java 复制代码
package com.hmall.trade;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@EnableFeignClients(basePackages = "com.hmall.api")
@MapperScan("com.hmall.trade.mapper")
@SpringBootApplication
public class TradeApplication {
    public static void main(String[] args) {
        SpringApplication.run(TradeApplication.class, args);
    }
}

6.2.4.配置文件

hm-service项目中复制3个yaml配置文件到trade-serviceresource目录。

其中application-dev.yaml和application-local.yaml保持不变。application.yaml如下:

yml 复制代码
server:
  port: 8085
spring:
  application:
    name: trade-service # 服务名称
  profiles:
    active: dev
  datasource:
    url: jdbc:mysql://${hm.db.host}:3306/hm-trade?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: ${hm.db.pw}
  cloud:
    nacos:
      server-addr: 192.168.101.68 # nacos地址
mybatis-plus:
  configuration:
    default-enum-type-handler: com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler
  global-config:
    db-config:
      update-strategy: not_null
      id-type: auto
logging:
  level:
    com.hmall: debug
  pattern:
    dateformat: HH:mm:ss:SSS
  file:
    path: "logs/${spring.application.name}"
knife4j:
  enable: true
  openapi:
    title: 交易服务接口文档
    description: "信息"
    url: https://www.itcast.cn
    version: v1.0.0
    group:
      default:
        group-name: default
        api-rule: package
        api-rule-resources:
          - com.hmall.trade.controller

6.2.5.代码

6.2.5.1.基础代码

复制hm-service中所有与trade有关的代码,最终项目结构如下:

在交易服务中,用户下单时需要做下列事情:

  • 根据id查询商品列表
  • 计算商品总价
  • 保存订单
  • 扣减库存
  • 清理购物车商品

其中,查询商品、扣减库存都是与商品有关的业务,在item-service中有相关功能;清理购物车商品是购物车业务,在cart-service中有相关功能。

因此交易服务要调用他们,必须通过OpenFeign远程调用。我们需要将上述功能抽取为FeignClient.

2.5.2.抽取ItemClient接口

首先是扣减库存 ,在item-service中的对应业务接口如下:

我们将这个接口抽取到hm-api模块的com.hmall.api.item.ItemClient中:

将接口参数的OrderDetailDTO抽取到hm-api模块的com.hmall.api.item.dto包下,删除原来商品服务下的OrderDetailDTO

注意:删除原来商品服务下的OrderDetailDTO后很多代码报错,需要细心修改OrderDetailDTO的最新包路径。

6.2.5.3.抽取CartClient接口

接下来是清理购物车商品 ,在 cart-service 中的对应业务接口如下:

我们在hm-api模块的com.hmall.api.cart包下定义一个CartClient接口:

代码如下:

java 复制代码
package com.hmall.api.cart;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.Collection;

@FeignClient("cart-service")
public interface CartClient {
    @DeleteMapping("/carts")
    void deleteCartItemByIds(@RequestParam("ids") Collection<Long> ids);
}
6.2.5.4.改造OrderServiceImpl

接下来,就可以改造OrderServiceImpl中的逻辑,将本地方法调用改造为基于FeignClient的调用,完整代码如下:

java 复制代码
package com.hmall.trade.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.hmall.api.cart.CartClient;
import com.hmall.api.item.ItemClient;
import com.hmall.api.item.dto.ItemDTO;
import com.hmall.api.item.dto.OrderDetailDTO;
import com.hmall.common.exception.BadRequestException;
import com.hmall.common.utils.UserContext;
import com.hmall.trade.domain.dto.OrderFormDTO;
import com.hmall.trade.domain.po.Order;
import com.hmall.trade.domain.po.OrderDetail;
import com.hmall.trade.mapper.OrderMapper;
import com.hmall.trade.service.IOrderDetailService;
import com.hmall.trade.service.IOrderService;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * <p>
 * 服务实现类
 * </p>
 */
@Service
@RequiredArgsConstructor
public class OrderServiceImpl extends ServiceImpl<OrderMapper, Order> implements IOrderService {

    private final ItemClient itemClient;
    private final IOrderDetailService detailService;
    private final CartClient cartClient;

    @Override
    @Transactional
    public Long createOrder(OrderFormDTO orderFormDTO) {
        // 1.订单数据
        Order order = new Order();
        // 1.1.查询商品
        List<OrderDetailDTO> detailDTOS = orderFormDTO.getDetails();
        // 1.2.获取商品id和数量的Map
        Map<Long, Integer> itemNumMap = detailDTOS.stream()
                .collect(Collectors.toMap(OrderDetailDTO::getItemId, OrderDetailDTO::getNum));
        Set<Long> itemIds = itemNumMap.keySet();
        // 1.3.查询商品
        List<ItemDTO> items = itemClient.queryItemByIds(itemIds);
        if (items == null || items.size() < itemIds.size()) {
            throw new BadRequestException("商品不存在");
        }
        // 1.4.基于商品价格、购买数量计算商品总价:totalFee
        int total = 0;
        for (ItemDTO item : items) {
            total += item.getPrice()  itemNumMap.get(item.getId());
        }
        order.setTotalFee(total);
        // 1.5.其它属性
        order.setPaymentType(orderFormDTO.getPaymentType());
        order.setUserId(UserContext.getUser());
        order.setStatus(1);
        // 1.6.将Order写入数据库order表中
        save(order);

        // 2.保存订单详情
        List<OrderDetail> details = buildDetails(order.getId(), items, itemNumMap);
        detailService.saveBatch(details);

        // 3.扣减库存
        try {
            itemClient.deductStock(detailDTOS);
        } catch (Exception e) {
            throw new RuntimeException("库存不足!");
        }

        // 4.清理购物车商品
        cartClient.deleteCartItemByIds(itemIds);
        return order.getId();
    }

    private List<OrderDetail> buildDetails(Long orderId, List<ItemDTO> items, Map<Long, Integer> numMap) {
        List<OrderDetail> details = new ArrayList<>(items.size());
        for (ItemDTO item : items) {
            OrderDetail detail = new OrderDetail();
            detail.setName(item.getName());
            detail.setSpec(item.getSpec());
            detail.setPrice(item.getPrice());
            detail.setNum(numMap.get(item.getId()));
            detail.setItemId(item.getId());
            detail.setImage(item.getImage());
            detail.setOrderId(orderId);
            details.add(detail);
        }
        return details;
    }
}

6.2.6.数据库

trade-service也需要自己的独立的database,向MySQL中导入课前资料提供的SQL:

导入结果如下:

6.2.7.启动微服务

运行trade-service的启动类。

6.2.8.测试

启动TradeApplication,访问http://localhost:8085/doc.html

测试创建订单接口。

测试参数说明:

代码中目前我们将用户ID硬编码为 1,用户名为jack,在hm-user数据库的user表中。

addressId:收货地址,在hm-user数据库的address表中。

itemId: 购买商品的id,在hm-item数据库的item表中。

num:购买数量。

paymentType:支付方式,1:支付宝、2:微信,3:余额支付。

测试效果如下:

创建订单成功返回订单ID。

测试查询订单接口:

使用上个测试返回的订单ID测试查询订单信息接口。

6.3.支付服务

6.3.1.创建微服务工程

在hmall下新建一个module,命名为pay-service.

6.3.2.依赖

pay-servicepom.xml文件内容如下:

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>hmall-parent</artifactId>
        <groupId>com.hmall</groupId>
        <version>1.0.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>pay-service</artifactId>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>

    <dependencies>
        <!--common-->
        <dependency>
            <groupId>com.hmall</groupId>
            <artifactId>hm-common</artifactId>
            <version>1.0.0</version>
        </dependency>
        <!--api-->
        <dependency>
            <groupId>com.hmall</groupId>
            <artifactId>hm-api</artifactId>
            <version>1.0.0</version>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--数据库-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>
        <!--nacos 服务注册发现-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
    </dependencies>
    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

6.3.3.启动类

pay-service中的com.hmall.pay包下创建启动类:

java 复制代码
package com.hmall.pay;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@EnableFeignClients(basePackages = "com.hmall.api")
@MapperScan("com.hmall.pay.mapper")
@SpringBootApplication
public class PayApplication {
    public static void main(String[] args) {
        SpringApplication.run(PayApplication.class, args);
    }
}

6.3.4.配置文件

hm-service项目中复制3个yaml配置文件到trade-serviceresource目录。

其中application-dev.yaml和application-local.yaml保持不变。application.yaml如下:

yml 复制代码
server:
  port: 8086
spring:
  application:
    name: pay-service
  profiles:
    active: dev
  datasource:
    url: jdbc:mysql://${hm.db.host}:3306/hm-pay?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: ${hm.db.pw}
  cloud:
    nacos:
      server-addr: 192.168.101.68
mybatis-plus:
  configuration:
    default-enum-type-handler: com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler
  global-config:
    db-config:
      update-strategy: not_null
      id-type: auto
logging:
  level:
    com.hmall: debug
  pattern:
    dateformat: HH:mm:ss:SSS
  file:
    path: "logs/${spring.application.name}"
knife4j:
  enable: true
  openapi:
    title: 支付服务接口文档
    description: "支付服务接口文档"
    url: https://www.itcast.cn
    version: v1.0.0
    group:
      default:
        group-name: default
        api-rule: package
        api-rule-resources:
          - com.hmall.pay.controller

6.3.5.代码

6.3.5.1.基础代码

复制hm-service中所有与支付有关的代码,最终项目结构如下:

在支付服务中,基于用户余额支付时需要做下列事情:

  • 扣减用户余额
  • 标记支付单状态为已支付
  • 标记订单状态为已支付

其中,扣减用户余额是在user-service中有相关功能;标记订单状态则是在trade-service中有相关功能。因此交易服务要调用他们,必须通过OpenFeign远程调用。我们需要将上述功能抽取为FeignClient.

6.2.5.2.抽取UserClient接口

首先是扣减用户余额,在user-service中的对应业务接口如下:

我们将这个接口抽取到hm-api模块的com.hmall.api.user.UserClient中:

具体代码如下:

java 复制代码
package com.hmall.api.user;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestParam;

@FeignClient("user-service")
public interface UserClient {
    @PutMapping("/users/money/deduct")
    void deductMoney(@RequestParam("pw") String pw,@RequestParam("amount") Integer amount);
}
6.2.5.3.抽取TradeClient接口

接下来是标记订单状态,在trade-service中的对应业务接口如下:

我们将这个接口抽取到hm-api模块的com.hmall.api.trade.TradeClient中:

代码如下:

java 复制代码
package com.hmall.api.trade;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PutMapping;

@FeignClient("trade-service")
public interface TradeClient {
    @PutMapping("/orders/{orderId}")
    void markOrderPaySuccess(@PathVariable("orderId") Long orderId);
}
6.2.5.4.改造PayOrderServiceImpl

接下来,就可以改造PayOrderServiceImpl中的逻辑,将本地方法调用改造为基于FeignClient的调用,完整代码如下:

java 复制代码
package com.hmall.pay.service.impl;

import com.baomidou.mybatisplus.core.toolkit.IdWorker;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.hmall.api.trade.TradeClient;
import com.hmall.api.user.UserClient;
import com.hmall.common.exception.BizIllegalException;
import com.hmall.common.utils.BeanUtils;
import com.hmall.common.utils.UserContext;
import com.hmall.pay.domain.dto.PayApplyDTO;
import com.hmall.pay.domain.dto.PayOrderFormDTO;
import com.hmall.pay.domain.po.PayOrder;
import com.hmall.pay.enums.PayStatus;
import com.hmall.pay.mapper.PayOrderMapper;
import com.hmall.pay.service.IPayOrderService;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.time.LocalDateTime;

/**
 * <p>
 * 支付订单 服务实现类
 * </p>
 *
 */
@Service
@RequiredArgsConstructor
public class PayOrderServiceImpl extends ServiceImpl<PayOrderMapper, PayOrder> implements IPayOrderService {

    private final UserClient userClient;

    private final TradeClient tradeClient;

    @Override
    public String applyPayOrder(PayApplyDTO applyDTO) {
        // 1.幂等性校验
        PayOrder payOrder = checkIdempotent(applyDTO);
        // 2.返回结果
        return payOrder.getId().toString();
    }

    @Override
    @Transactional
    public void tryPayOrderByBalance(PayOrderFormDTO payOrderDTO) {
        // 1.查询支付单
        PayOrder po = getById(payOrderDTO.getId());
        // 2.判断状态
        if(!PayStatus.WAIT_BUYER_PAY.equalsValue(po.getStatus())){
            // 订单不是未支付,状态异常
            throw new BizIllegalException("交易已支付或关闭!");
        }
        // 3.尝试扣减余额
        userClient.deductMoney(payOrderDTO.getPw(), po.getAmount());
        // 4.修改支付单状态
        boolean success = markPayOrderSuccess(payOrderDTO.getId(), LocalDateTime.now());
        if (!success) {
            throw new BizIllegalException("交易已支付或关闭!");
        }
        // 5.修改订单状态
        tradeClient.markOrderPaySuccess(po.getBizOrderNo());
    }

    public boolean markPayOrderSuccess(Long id, LocalDateTime successTime) {
        return lambdaUpdate()
                .set(PayOrder::getStatus, PayStatus.TRADE_SUCCESS.getValue())
                .set(PayOrder::getPaySuccessTime, successTime)
                .eq(PayOrder::getId, id)
                // 支付状态的乐观锁判断
                .in(PayOrder::getStatus, PayStatus.NOT_COMMIT.getValue(), PayStatus.WAIT_BUYER_PAY.getValue())
                .update();
    }


    private PayOrder checkIdempotent(PayApplyDTO applyDTO) {
        // 1.首先查询支付单
        PayOrder oldOrder = queryByBizOrderNo(applyDTO.getBizOrderNo());
        // 2.判断是否存在
        if (oldOrder == null) {
            // 不存在支付单,说明是第一次,写入新的支付单并返回
            PayOrder payOrder = buildPayOrder(applyDTO);
            payOrder.setPayOrderNo(IdWorker.getId());
            save(payOrder);
            return payOrder;
        }
        // 3.旧单已经存在,判断是否支付成功
        if (PayStatus.TRADE_SUCCESS.equalsValue(oldOrder.getStatus())) {
            // 已经支付成功,抛出异常
            throw new BizIllegalException("订单已经支付!");
        }
        // 4.旧单已经存在,判断是否已经关闭
        if (PayStatus.TRADE_CLOSED.equalsValue(oldOrder.getStatus())) {
            // 已经关闭,抛出异常
            throw new BizIllegalException("订单已关闭");
        }
        // 5.旧单已经存在,判断支付渠道是否一致
        if (!StringUtils.equals(oldOrder.getPayChannelCode(), applyDTO.getPayChannelCode())) {
            // 支付渠道不一致,需要重置数据,然后重新申请支付单
            PayOrder payOrder = buildPayOrder(applyDTO);
            payOrder.setId(oldOrder.getId());
            payOrder.setQrCodeUrl("");
            updateById(payOrder);
            payOrder.setPayOrderNo(oldOrder.getPayOrderNo());
            return payOrder;
        }
        // 6.旧单已经存在,且可能是未支付或未提交,且支付渠道一致,直接返回旧数据
        return oldOrder;
    }

    private PayOrder buildPayOrder(PayApplyDTO payApplyDTO) {
        // 1.数据转换
        PayOrder payOrder = BeanUtils.toBean(payApplyDTO, PayOrder.class);
        // 2.初始化数据
        payOrder.setPayOverTime(LocalDateTime.now().plusMinutes(120L));
        payOrder.setStatus(PayStatus.WAIT_BUYER_PAY.getValue());
        payOrder.setBizUserId(UserContext.getUser());
        return payOrder;
    }
    public PayOrder queryByBizOrderNo(Long bizOrderNo) {
        return lambdaQuery()
                .eq(PayOrder::getBizOrderNo, bizOrderNo)
                .one();
    }
}

6.2.6.数据库

pay-service也需要自己的独立的database,向MySQL中导入课前资料提供的SQL:

导入结果如下:

6.2.7.启动微服务

运行pay-service启动类启动微服务。

6.2.8.测试

启动PayApplication,访问http://localhost:8086/doc.html

测试创建支付单。

接口参数说明:

bizOrderNo:业务订单号,在测试交易服务创建订单接口生成的订单ID,对应hm-trade数据库的order表的ID。

amount:订单金额,单位:分,对应hm-trade数据库的order表的total_fee字段

payChannelCode:支付渠道编码,余额支付渠道编码为balance,支付渠道编码在枚举类PayChannel中定义。

payType:余额支付类型为5

orderInfo:订单信息字符串。

测试成功返回支付单ID,对应hm-pay数据库中的pay-order表的ID。

测试余额支付接口:

参数测试:

Id: 支付单ID

pw:支付密码,即用户的登录密码,账号为1的用户密码为123.

支付成功可以从hm-pay数据库中的pay-order表找到对应的记录,查看status字段值是否为3(表示支付成功)

相关推荐
JMchen1231 小时前
现代Android图像处理管道:从CameraX到OpenGL的60fps实时滤镜架构
android·图像处理·架构·kotlin·android studio·opengl·camerax
Jing_jing_X4 小时前
CPU 架构:x86、x64、ARM 到底是什么?为什么程序不能通用?
arm开发·架构·cpu
江畔何人初5 小时前
pod的定义以及创建过程
linux·运维·云原生
qq_177767376 小时前
React Native鸿蒙跨平台自定义复选框组件,通过样式数组实现选中/未选中状态的样式切换,使用链式调用替代样式数组,实现状态驱动的样式变化
javascript·react native·react.js·架构·ecmascript·harmonyos·媒体
m0_740043736 小时前
【无标题】
java·spring boot·spring·spring cloud·微服务
小程故事多_807 小时前
深度搜索Agent架构全解析:从入门到进阶,解锁复杂问题求解密码
人工智能·架构·aigc
●VON8 小时前
React Native for OpenHarmony:项目目录结构与跨平台构建流程详解
javascript·学习·react native·react.js·架构·跨平台·von
Gary董8 小时前
高并发的微服务架构如何设计
微服务·云原生·架构
东哥爱编程8 小时前
使用Runpod进行gpu serverless推理
云原生·serverless
ujainu8 小时前
Flutter + OpenHarmony 实战:《圆环跳跃》——完整游戏架构与视觉优化
flutter·游戏·架构·openharmony