Spring Cloud 学习笔记之——01微服务架构编码构建

SpringBoot 源码链接：Releases · spring-projects/spring-boot · GitHub

SpringBoot 新特性：Spring Boot 2.2 Release Notes · spring-projects/spring-boot Wiki · GitHub

SpringBoot2 官方文档：Spring Boot Reference Documentation

SpringCloud 官网文档：Spring Cloud

SpringCloud 中文文档：首页 - 《Spring Cloud中文文档》 - 书栈网 · BookStack首页 - 《Spring Cloud中文文档》 - 书栈网 · BookStack

目录

创建父工程: cloud 2022

创建第一个子项目：cloud-provider-payment8001

创建第二个子项目：cloud-consumer-order80

创建第三个子项目用于工程重构:  cloud-api-commons

---

首页 - 《Spring Cloud中文文档》 - 书栈网 · BookStack

SpringCloud 各组件的版本选型

spring cloud	Hoxton.SR
spring boot	2.2.2.RELEASE
spring cloud Alibaba	2.1.0.RELEASE
java	java8
maven	3.5及以上
mysql	5.7及以上

SpringCloud 与 SpringBoot 的版本对应关系： Spring Cloud

微服务架构编码构建 

约定 > 配置 > 编码

创建父工程: cloud 2022

创建一个普通的 maven 工程即可，此处父工程的名称指定为：cloud 2022

Maven 3.8(3.5以上即可)

打开设置，修改IDEA的文件编码配置

 让注解生效

修改Java的版本为 1.8

设置忽略的文件后缀,这些后缀的文件就会不可见 

设置好以上IDEA 的配置后，开始写父工程的 POM文件

  4.0.0

  com.yixuan.springcloud
  cloud2022
  1.0-SNAPSHOT
  pom

  
  
    UTF-8
    1.8
    1.8
    4.12
    1.18.22
    1.2.17
    8.0.20
    1.1.16
    1.3.0
  

  
  
  
    
      
      
        org.springframework.boot
        spring-boot-dependencies
        2.2.2.RELEASE
        pom
        import
      


      
      
        org.springframework.cloud
        spring-cloud-dependencies
        Hoxton.SR1
        pom
        import
      


      
      
        com.alibaba.cloud
        spring-cloud-alibaba-dependencies
        2.1.0.RELEASE
        pom
        import
      


      
      
        mysql
        mysql-connector-java
        ${mysql.version}
        runtime
      


      
      
        com.alibaba
        druid
        ${druid.version}
      


      
      
        org.mybatis.spring.boot
        mybatis-spring-boot-starter
        ${mybatis.spring.boot.version}
      


      
      
        junit
        junit
        ${junit.version}
      


      
      
        log4j
        log4j
        ${log4j.version}
      


      
        org.projectlombok
        lombok
        ${lombok.version}
        true
      

    
  


  
  
    
      
        org.springframework.boot
        spring-boot-maven-plugin
        
          true
          true
        
      
    
  

dependencyManagement
        Maven使用dependencyManagement元素来提供了一种管理依赖版本号的方式。
通常会在一个组织或者项目的最顶层的父POM中看到dependencyManagement元素。
使用pom.xml中的dependencyManagement元素能让所有在子项目中引用一个依赖而不用显 式的列出版本号；Maven会沿着父子层次向上走，直到找到一个拥有dependencyManagement元素的项目,然后它就会使用这个dependencyManagement元素中指定的版本号。

        这样做的好处就是:如果有多个子项目都引用同一个依赖，则可以避免在每个使用的子项目里都声明一个版本号,这样当想升级或切换到另一个版本时，只需要在顶层父容器里更新,而不需要一个个子项目的修改;另外如果某个子项目需要另外的一个版本，只需要声明version即可。

• dependencyManagement里只是声明依赖，并不实现引入，因此子项目需要显示的声明需要用的依赖。
• 如果不在子项目中声明依赖，不会从父项目中继承下来的;只有在子项目中写了该依赖项，并且没有指定具体版本,才会从父项目中继承该项,并且version和scope都读取自父pom;
• 如果子项目中指定了版本号,那么会使用子项目中指定的jar版本。

父工程创建完成执行mvn:install，将父工程发布到仓库方便子工程继承

创建第一个子项目：cloud-provider-payment8001

1、在上述的父项目下创建一个项目名称叫作 cloud-provider-payment8001 提供支付模块。

和父项目类似，创建普通的maven 项目，查看父项目中的 pom 文件中多了一个叫做

  cloud-provider-payment8001

2、修改 POM 文件：

 
        
        
            com.yixuan.springcloud
            cloud-api-commons
            1.0-SNAPSHOT
        

        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.boot
            spring-boot-starter-actuator
        
        
            org.mybatis.spring.boot
            mybatis-spring-boot-starter
        
        
            com.alibaba
            druid-spring-boot-starter
            1.1.10
        
        
        
            mysql
            mysql-connector-java
        
        
        
            org.springframework.boot
            spring-boot-starter-jdbc
        


        
        
            org.springframework.cloud
            spring-cloud-starter-netflix-eureka-client
        


        
        
            org.springframework.boot
            spring-boot-devtools
            runtime
            true
        

        
            org.projectlombok
            lombok
        

        
            log4j
            log4j
        

        
            org.springframework.boot
            spring-boot-starter-test
            test
        
    

3、写YML：在子模块里的 resources 目录下创建 application.yml 文件，并修改为如下配置

server:
  port: 8001


spring:
  application:
    name: cloud-payment-service
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource       # 当前数据源操作类型
    driver-class-name: com.mysql.cj.jdbc.Driver        # mysql 驱动包
    url: jdbc:mysql://服务器的IP地址:3306/db2019?useUnicode=true&characterEncoding=utf-8&useSSL=false
    username: root
    password: MySQL 的密码


mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.atyixuan.springcloud.entities   # 所有的 entity 别名类所在包

4、主启动：在java 目录下创建主启动类：com.atyixuan.springcloud.PaymentMain8001

@SpringBootApplication
public class PaymentMain8001 {

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

5、业务类创建：

5.1、创建 MySQL 表格

CREATE TABLE payment (
	`id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT 'ID',
	`serial` VARCHAR(200) DEFAULT NULL,
	PRIMARY KEY(id)
) ENGINE=INNODB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8

5.2、主实体类：就是和数据库直接相联系的类, com.atyixuan.springcloud.entities.Payment

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@Data  //提供 get、set、equals、hashCode、canEqual、toString 方法
@AllArgsConstructor // 提取全参构造器
@NoArgsConstructor  // 提供无参构造器
public class Payment implements Serializable {
    private Long id;
    private String serial;
}

5.3、由于后端返回的都是 json 数据，我们需要将写好的 Payment 类进行一次封装，让它更好的供前端使用

@Data
@AllArgsConstructor
@NoArgsConstructor
public class CommonResult {
    private Integer code;     // 状态码， 200 或者是 非 200 异常逻辑
    private String message;   // 一些额外的信息
    private T data;

    public CommonResult(Integer code, String message){
        this(code,message,null);
    }
}

5.4、dao 层接口  com.atyixuan.springcloud.dao.PaymentDao

@Mapper
public interface PaymentDao {
    // 增加数据和获取数据
    public int create(Payment payment);

    public Payment getPamentById(@Param("id") Long id);
}

Mybatis 映射接口： src/main/resources/mapper/PaymentMapper.xml

    
        insert into payment(serial) values (#{serial});
    
    
    
        
        
    
    
        select * from payment where id=#{id};
    

5.5、Service 接口及其实现类

com.atyixuan.springcloud.service.PaymentService

public interface PaymentService {
   
    public int create(Payment payment);

    public Payment getPamentById(Long id);
}

com.atyixuan.springcloud.service.impl.PaymentServiceImpl

@Service
public class PaymentServiceImpl implements PaymentService {

    // Java 自带的注入
    @Resource
    private PaymentDao paymentDao;

    @Override
    public int create(Payment payment) {
        return paymentDao.create(payment);
    }

    @Override
    public Payment getPamentById(Long id) {
        return paymentDao.getPamentById(id);
    }
}

5.6、Controller 类  com/atyixuan/springcloud/controller/PaymentController.java

@Slf4j
@RestController
public class PaymentController {

    @Resource
    private PaymentService paymentService;

    /**
     * 集群的时候用于区分，指定端口号
     */
    @Value("${server.port}")
    private String serverPort;


    @GetMapping(value = "/payment/get/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id) {
        Payment payment = paymentService.getPaymentById(id);
        log.info("*******查询结果：*****" + payment + "\t" + "O(n_n)O哈哈");

        if (payment != null) {
            return new CommonResult(200, "查询成功, serverPort = " + serverPort, payment);
        } else {
            return new CommonResult(444, "没有对应的记录，查询ID: " + id, null);
        }
    }

    @PostMapping(value = "/payment/create")
    public CommonResult create(Payment payment) {
        int result = paymentService.create(payment);
        log.info("*******插入结果： ******   " + result);

        if (result > 0) {
            return new CommonResult(200, "插入数据库成功, serverPort = " + serverPort, result);
        } else {
            return new CommonResult(444, "插入数据库失败", null);
        }
    }
}

上述工程代码目录结构图：

 6、测试：先启动改模块

在浏览器的地址栏中输入：http://localhost:8001/payment/get/31

或者是在 postman 中输入：http://localhost:8001/payment/get/31

请求结果：

在 postman 中输入：http://localhost:8001/payment/create?serial=SpringCloud

postman 软件下载链接：Postman

构建Module 的5个步骤：1、建module，2、改 POM，3、写 YML，4、主启动、5业务类

创建第二个子项目：cloud-consumer-order80

cloud-consumer-order80微服务消费者订单Module模块

1、建 module：mudule 名称   cloud-consumer-order80

2、改 POM

    
        cloud2022
        com.yixuan.springcloud
        1.0-SNAPSHOT
    
    4.0.0

    cloud-consumer-order80

    
        8
        8
    


    

        
            org.springframework.boot
            spring-boot-starter-web
        
        
        
            org.springframework.boot
            spring-boot-starter-actuator
        

        
            org.springframework.boot
            spring-boot-devtools
            runtime
            true
        
        
        
            org.projectlombok
            lombok
            true
        
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
    

3、写 YML：resources/application.yml

server:
  port: 80

spring:
  application:
    name: cloud-order-service

4、主启动类：com.atyixuan.springcloud.OrderMain80

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

5、业务类

5.1、创建entities(将cloud-provider-payment8001工程下的entities包下的两个实体类复制过来)，后面会将进行工程重构，将这两个类一个公共module 里；

RestTemplate:

RestaTemplate 提供了多种便捷访问远程 Http 服务的方法,是一种简单的范围内 restful 服务模板类，是 Spring 提供的用于访问 Rest 服务的客户端模板工具集； 完成 80 ——> 8001 的远程接口调用 类似于 HttpClient 使用：

使用：

restTemplate 访问 restful 接口非常简单 (url, requestMap, ResponsBean.class) 三个参数分别代表 REST 请求地址、请求参数、HTTP相应转换被转换成的对象类型

官方链接: InterceptingHttpAccessor (Spring Framework 5.2.2.RELEASE API)

5.2、配置类  com.atyixuan.springcloud.config.ApplicationContextConfig

@Configuration
public class ApplicationContextConfig {
    @Bean
   //  @LoadBalanced  // 启动负载均衡
    public RestTemplate getRestTemplate(){
        return new RestTemplate();
    }
}

5.3、创建 Controller 类: com.atyixuan.springcloud.controller.OrderController

@RestController
@Slf4j
public class OrderController {

//    单机版是如下
    public static final String PAYMENT_URL = "http://localhost:8001";

    // 使用微服务版
    // public static final String PAYMENT_URL = "http://CLOUD-PAYMENT-SERVICE";

    @Resource
    private RestTemplate restTemplate;

    @GetMapping("/consumer/payment/create")
    public CommonResult create(Payment payment) {
        return restTemplate.postForObject(PAYMENT_URL + "/payment/create", payment, CommonResult.class);
    }

    @GetMapping("/consumer/payment/get/{id}")
    public CommonResult getPayment(@PathVariable("id") Long id) {
        return restTemplate.getForObject(PAYMENT_URL + "/payment/get/" + id, CommonResult.class);
    }
}

6、测试

1、先启动cloud-provider-payment8001

2、再启动cloud-consumer-order80 

3、浏览器输入： http://localhost/consumer/payment/get/32

由于 80 是默认端口，这里不写端口号也可以

创建第三个子项目用于工程重构:  cloud-api-commons

由于 cloud-consumer-order80 和 cloud-provider-payment8001 两个项目中都含有 entity 包，包中的内容完全相同，存在代码冗余，我们将重复的代码专门放在一个叫做 cloud-api-commons的模块中，然后让  cloud-consumer-order80 和 cloud-provider-payment8001 引用即可，以达到减少代码重复的目的。

1.创建普通的 maven项目 命名为 cloud-api-commons

2.修改 POM 文件，在 POM  文件中加入如下依赖

    
        org.springframework.boot
        spring-boot-devtools
        runtime
        true
    

    
       org.projectlombok
       lombok
    

    
       cn.hutool
       hutool-all
       5.7.17
    

3、创建一个叫做 com.atyixuan.springcloud.entities 的包，将 cloud-consumer-order80 中 entity 包中的两个类复制到 创建好的 entities 包中去

当前的目录结构如下： 

4、选中 cloud-api-commons 项目名称，打开右侧的 maven 工具，按下图所示的顺序依次进行，第一步是为了跳过测试，第二步双击clean 测试maven 环境的配置，第三步 install 到本地库中去

 5、依次改造cloud-consumer-order80 和 cloud-provider-payment8001 两个模块，分别删除 entities 包，分别将 common 的配置添加到各自的 pom 文件中去

    com.atyixuan
    cloud-api-commons
    1.0-SNAPSHOT

6、分别测试两个模块重构之后的情况

 到目前为止，完成了 创建了三个模块，其中 cloud-consumer-order80 可以通过 RestTemplate 调用  cloud-provider-payment8001 里的功能模块