当前位置:   article > 正文

Spring Cloud 学习笔记之——01微服务架构编码构建_父项目指定cloud

父项目指定cloud

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 cloudHoxton.SR
spring boot2.2.2.RELEASE
spring cloud Alibaba

2.1.0.RELEASE

javajava8
maven3.5及以上
mysql5.7及以上

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

微服务架构编码构建 

约定 > 配置 > 编码

创建父工程: cloud 2022

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

Maven 3.8(3.5以上即可)

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

 让注解生效

修改Java的版本为 1.8

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

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

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <groupId>com.yixuan.springcloud</groupId>
  6. <artifactId>cloud2022</artifactId>
  7. <version>1.0-SNAPSHOT</version>
  8. <packaging>pom</packaging>
  9. <!--统一管理jar包版本-->
  10. <properties>
  11. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  12. <maven.compiler.source>1.8</maven.compiler.source>
  13. <maven.compiler.target>1.8</maven.compiler.target>
  14. <junit.version>4.12</junit.version>
  15. <lombok.version>1.18.22</lombok.version>
  16. <log4j.version>1.2.17</log4j.version>
  17. <mysql.version>8.0.20</mysql.version>
  18. <druid.version>1.1.16</druid.version>
  19. <mybatis.spring.boot.version>1.3.0</mybatis.spring.boot.version>
  20. </properties>
  21. <!--出现dependentManagement是父工程里面的,子工程想要引用必须要自己声明,这里只是版本控制-->
  22. <!--
  23. dependencyManagement 只是声明依赖,并不实现引入,因此子项目需要显式的声明需要用的依赖
  24. 如果不在子项目中声明依赖,是不会从父项目中继承下来的;只有在子项目中写了该依赖项,
  25. 并且没有指定具体版本,才会从父项目中继承该项,并且 version 和 scope 都会读取自父 pom
  26. 如果子项目中指定版本号,那么会使用子项目中指定的 jar 版本
  27. -->
  28. <dependencyManagement>
  29. <dependencies>
  30. <!--spring boot 2.2.2-->
  31. <dependency>
  32. <groupId>org.springframework.boot</groupId>
  33. <artifactId>spring-boot-dependencies</artifactId>
  34. <version>2.2.2.RELEASE</version>
  35. <type>pom</type>
  36. <scope>import</scope>
  37. </dependency>
  38. <!--spring cloud Hoxton.SR1-->
  39. <dependency>
  40. <groupId>org.springframework.cloud</groupId>
  41. <artifactId>spring-cloud-dependencies</artifactId>
  42. <version>Hoxton.SR1</version>
  43. <type>pom</type>
  44. <scope>import</scope>
  45. </dependency>
  46. <!--spring cloud 阿里巴巴-->
  47. <dependency>
  48. <groupId>com.alibaba.cloud</groupId>
  49. <artifactId>spring-cloud-alibaba-dependencies</artifactId>
  50. <version>2.1.0.RELEASE</version>
  51. <type>pom</type>
  52. <scope>import</scope>
  53. </dependency>
  54. <!--mysql-->
  55. <dependency>
  56. <groupId>mysql</groupId>
  57. <artifactId>mysql-connector-java</artifactId>
  58. <version>${mysql.version}</version>
  59. <scope>runtime</scope>
  60. </dependency>
  61. <!-- druid-->
  62. <dependency>
  63. <groupId>com.alibaba</groupId>
  64. <artifactId>druid</artifactId>
  65. <version>${druid.version}</version>
  66. </dependency>
  67. <!--mybatis-->
  68. <dependency>
  69. <groupId>org.mybatis.spring.boot</groupId>
  70. <artifactId>mybatis-spring-boot-starter</artifactId>
  71. <version>${mybatis.spring.boot.version}</version>
  72. </dependency>
  73. <!--junit-->
  74. <dependency>
  75. <groupId>junit</groupId>
  76. <artifactId>junit</artifactId>
  77. <version>${junit.version}</version>
  78. </dependency>
  79. <!--log4j-->
  80. <dependency>
  81. <groupId>log4j</groupId>
  82. <artifactId>log4j</artifactId>
  83. <version>${log4j.version}</version>
  84. </dependency>
  85. <dependency>
  86. <groupId>org.projectlombok</groupId>
  87. <artifactId>lombok</artifactId>
  88. <version>${lombok.version}</version>
  89. <optional>true</optional>
  90. </dependency>
  91. </dependencies>
  92. </dependencyManagement>
  93. <!--maven 插件-->
  94. <build>
  95. <plugins>
  96. <plugin>
  97. <groupId>org.springframework.boot</groupId>
  98. <artifactId>spring-boot-maven-plugin</artifactId>
  99. <configuration>
  100. <fork>true</fork>
  101. <addResources>true</addResources>
  102. </configuration>
  103. </plugin>
  104. </plugins>
  105. </build>
  106. </project>

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 文件中多了一个叫做

  1. <modules>
  2. <module>cloud-provider-payment8001</module>
  3. </modules>

2、修改 POM 文件:

  1. <dependencies>
  2. <!--此处是自己写的一个模块,目前不添加也可以-->
  3. <dependency>
  4. <groupId>com.yixuan.springcloud</groupId>
  5. <artifactId>cloud-api-commons</artifactId>
  6. <version>1.0-SNAPSHOT</version>
  7. </dependency>
  8. <dependency>
  9. <groupId>org.springframework.boot</groupId>
  10. <artifactId>spring-boot-starter-web</artifactId>
  11. </dependency>
  12. <dependency>
  13. <groupId>org.springframework.boot</groupId>
  14. <artifactId>spring-boot-starter-actuator</artifactId>
  15. </dependency>
  16. <dependency>
  17. <groupId>org.mybatis.spring.boot</groupId>
  18. <artifactId>mybatis-spring-boot-starter</artifactId>
  19. </dependency>
  20. <dependency>
  21. <groupId>com.alibaba</groupId>
  22. <artifactId>druid-spring-boot-starter</artifactId>
  23. <version>1.1.10</version>
  24. </dependency>
  25. <!--mysql-connector-java-->
  26. <dependency>
  27. <groupId>mysql</groupId>
  28. <artifactId>mysql-connector-java</artifactId>
  29. </dependency>
  30. <!--jdbc-->
  31. <dependency>
  32. <groupId>org.springframework.boot</groupId>
  33. <artifactId>spring-boot-starter-jdbc</artifactId>
  34. </dependency>
  35. <!--Eureka Client 端-->
  36. <dependency>
  37. <groupId>org.springframework.cloud</groupId>
  38. <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
  39. </dependency>
  40. <!--热部署模块-->
  41. <dependency>
  42. <groupId>org.springframework.boot</groupId>
  43. <artifactId>spring-boot-devtools</artifactId>
  44. <scope>runtime</scope>
  45. <optional>true</optional>
  46. </dependency>
  47. <dependency>
  48. <groupId>org.projectlombok</groupId>
  49. <artifactId>lombok</artifactId>
  50. </dependency>
  51. <dependency>
  52. <groupId>log4j</groupId>
  53. <artifactId>log4j</artifactId>
  54. </dependency>
  55. <dependency>
  56. <groupId>org.springframework.boot</groupId>
  57. <artifactId>spring-boot-starter-test</artifactId>
  58. <scope>test</scope>
  59. </dependency>
  60. </dependencies>

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

  1. server:
  2. port: 8001
  3. spring:
  4. application:
  5. name: cloud-payment-service
  6. datasource:
  7. type: com.alibaba.druid.pool.DruidDataSource # 当前数据源操作类型
  8. driver-class-name: com.mysql.cj.jdbc.Driver # mysql 驱动包
  9. url: jdbc:mysql://服务器的IP地址:3306/db2019?useUnicode=true&characterEncoding=utf-8&useSSL=false
  10. username: root
  11. password: MySQL 的密码
  12. mybatis:
  13. mapper-locations: classpath:mapper/*.xml
  14. type-aliases-package: com.atyixuan.springcloud.entities # 所有的 entity 别名类所在包

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

  1. @SpringBootApplication
  2. public class PaymentMain8001 {
  3. public static void main(String[] args) {
  4. SpringApplication.run(PaymentMain8001.class, args);
  5. }
  6. }

5、业务类创建:

5.1、创建 MySQL 表格

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

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

  1. import lombok.AllArgsConstructor;
  2. import lombok.Data;
  3. import lombok.NoArgsConstructor;
  4. import java.io.Serializable;
  5. @Data //提供 get、set、equals、hashCode、canEqual、toString 方法
  6. @AllArgsConstructor // 提取全参构造器
  7. @NoArgsConstructor // 提供无参构造器
  8. public class Payment implements Serializable {
  9. private Long id;
  10. private String serial;
  11. }

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

  1. @Data
  2. @AllArgsConstructor
  3. @NoArgsConstructor
  4. public class CommonResult<T> {
  5. private Integer code; // 状态码, 200 或者是 非 200 异常逻辑
  6. private String message; // 一些额外的信息
  7. private T data;
  8. public CommonResult(Integer code, String message){
  9. this(code,message,null);
  10. }
  11. }

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

  1. @Mapper
  2. public interface PaymentDao {
  3. // 增加数据和获取数据
  4. public int create(Payment payment);
  5. public Payment getPamentById(@Param("id") Long id);
  6. }

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

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  3. "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  4. <mapper namespace="com.atyixuan.springcloud.dao.PaymentDao">
  5. <insert id="create" parameterType="Payment" useGeneratedKeys="true" keyProperty="id">
  6. insert into payment(serial) values (#{serial});
  7. </insert>
  8. <resultMap id="BaseResultMap" type="com.atyixuan.springcloud.entities.Payment">
  9. <id column="id" property="id" jdbcType="BIGINT"/>
  10. <id column="serial" property="serial" jdbcType="VARCHAR"/>
  11. </resultMap>
  12. <select id="getPamentById" parameterType="Long" resultMap="BaseResultMap">
  13. select * from payment where id=#{id};
  14. </select>
  15. </mapper>

5.5、Service 接口及其实现类

com.atyixuan.springcloud.service.PaymentService

  1. public interface PaymentService {
  2. public int create(Payment payment);
  3. public Payment getPamentById(Long id);
  4. }

com.atyixuan.springcloud.service.impl.PaymentServiceImpl

  1. @Service
  2. public class PaymentServiceImpl implements PaymentService {
  3. // Java 自带的注入
  4. @Resource
  5. private PaymentDao paymentDao;
  6. @Override
  7. public int create(Payment payment) {
  8. return paymentDao.create(payment);
  9. }
  10. @Override
  11. public Payment getPamentById(Long id) {
  12. return paymentDao.getPamentById(id);
  13. }
  14. }

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

  1. @Slf4j
  2. @RestController
  3. public class PaymentController {
  4. @Resource
  5. private PaymentService paymentService;
  6. /**
  7. * 集群的时候用于区分,指定端口号
  8. */
  9. @Value("${server.port}")
  10. private String serverPort;
  11. @GetMapping(value = "/payment/get/{id}")
  12. public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id) {
  13. Payment payment = paymentService.getPaymentById(id);
  14. log.info("*******查询结果:*****" + payment + "\t" + "O(n_n)O哈哈");
  15. if (payment != null) {
  16. return new CommonResult(200, "查询成功, serverPort = " + serverPort, payment);
  17. } else {
  18. return new CommonResult(444, "没有对应的记录,查询ID: " + id, null);
  19. }
  20. }
  21. @PostMapping(value = "/payment/create")
  22. public CommonResult create(Payment payment) {
  23. int result = paymentService.create(payment);
  24. log.info("*******插入结果: ****** " + result);
  25. if (result > 0) {
  26. return new CommonResult(200, "插入数据库成功, serverPort = " + serverPort, result);
  27. } else {
  28. return new CommonResult(444, "插入数据库失败", null);
  29. }
  30. }
  31. }

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

 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

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5. <parent>
  6. <artifactId>cloud2022</artifactId>
  7. <groupId>com.yixuan.springcloud</groupId>
  8. <version>1.0-SNAPSHOT</version>
  9. </parent>
  10. <modelVersion>4.0.0</modelVersion>
  11. <artifactId>cloud-consumer-order80</artifactId>
  12. <properties>
  13. <maven.compiler.source>8</maven.compiler.source>
  14. <maven.compiler.target>8</maven.compiler.target>
  15. </properties>
  16. <dependencies>
  17. <dependency>
  18. <groupId>org.springframework.boot</groupId>
  19. <artifactId>spring-boot-starter-web</artifactId>
  20. </dependency>
  21. <dependency>
  22. <groupId>org.springframework.boot</groupId>
  23. <artifactId>spring-boot-starter-actuator</artifactId>
  24. </dependency>
  25. <dependency>
  26. <groupId>org.springframework.boot</groupId>
  27. <artifactId>spring-boot-devtools</artifactId>
  28. <scope>runtime</scope>
  29. <optional>true</optional>
  30. </dependency>
  31. <dependency>
  32. <groupId>org.projectlombok</groupId>
  33. <artifactId>lombok</artifactId>
  34. <optional>true</optional>
  35. </dependency>
  36. <dependency>
  37. <groupId>org.springframework.boot</groupId>
  38. <artifactId>spring-boot-starter-test</artifactId>
  39. <scope>test</scope>
  40. </dependency>
  41. </dependencies>
  42. </project>

3、写 YML:resources/application.yml

  1. server:
  2. port: 80
  3. spring:
  4. application:
  5. name: cloud-order-service

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

  1. @SpringBootApplication
  2. public class OrderMain80 {
  3. public static void main(String[] args) {
  4. SpringApplication.run(OrderMain80.class, args);
  5. }
  6. }

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

  1. @Configuration
  2. public class ApplicationContextConfig {
  3. @Bean
  4. // @LoadBalanced // 启动负载均衡
  5. public RestTemplate getRestTemplate(){
  6. return new RestTemplate();
  7. }
  8. }

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

  1. @RestController
  2. @Slf4j
  3. public class OrderController {
  4. // 单机版是如下
  5. public static final String PAYMENT_URL = "http://localhost:8001";
  6. // 使用微服务版
  7. // public static final String PAYMENT_URL = "http://CLOUD-PAYMENT-SERVICE";
  8. @Resource
  9. private RestTemplate restTemplate;
  10. @GetMapping("/consumer/payment/create")
  11. public CommonResult<Payment> create(Payment payment) {
  12. return restTemplate.postForObject(PAYMENT_URL + "/payment/create", payment, CommonResult.class);
  13. }
  14. @GetMapping("/consumer/payment/get/{id}")
  15. public CommonResult<Payment> getPayment(@PathVariable("id") Long id) {
  16. return restTemplate.getForObject(PAYMENT_URL + "/payment/get/" + id, CommonResult.class);
  17. }
  18. }

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  文件中加入如下依赖

  1. <dependencies>
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-devtools</artifactId>
  5. <scope>runtime</scope>
  6. <optional>true</optional>
  7. </dependency>
  8. <dependency>
  9. <groupId>org.projectlombok</groupId>
  10. <artifactId>lombok</artifactId>
  11. </dependency>
  12. <dependency>
  13. <groupId>cn.hutool</groupId>
  14. <artifactId>hutool-all</artifactId>
  15. <version>5.7.17</version>
  16. </dependency>
  17. </dependencies>

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 文件中去

  1. <dependency>
  2. <groupId>com.atyixuan</groupId>
  3. <artifactId>cloud-api-commons</artifactId>
  4. <version>1.0-SNAPSHOT</version>
  5. </dependency>

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

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

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/Li_阴宅/article/detail/955809
推荐阅读
相关标签
  

闽ICP备14008679号