【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记（二）Rest微服务工程搭建

超、凢脫俗 2023-09-25 22:32 192阅读 0赞

Rest微服务工程搭建—-学习笔记2/9

      • 1、简单架构示意图
      • 2、创建Cloud-provider-payment8001 微服务提供者Module模块
        • 2.1. 建Module
        • 2.2. 改pom
        • 2.3. 写yml
        • 2.4. 主启动
        • 2.5. 业务类
      • 3、创建Cloud-consumer-order80 微服务消费者订单Module模块
        • 3.1. 建Module
        • 3.2. 改pom
        • 3.3. 写yml
        • 3.4. 主启动
        • 3.5. 业务类
      • 4、工程重构
        • 4.1 新建一个 cloud-api-commons 子模块
        • 4.2 mvn跳过test，mvc clean，mvn install

1、简单架构示意图

两个模块，一个是服务提供者模块，另一个是服务消费者模块
在这里插入图片描述

2、创建Cloud-provider-payment8001 微服务提供者Module模块

2.1. 建Module

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述
创建完成后回到父工程查看pom文件变化

  1. <?xml version="1.0" encoding="UTF-8"?>
  3. <project xmlns="http://maven.apache.org/POM/4.0.0" 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.   <modelVersion>4.0.0</modelVersion>
  7.   <groupId>com.tigerhhzz.springcloud</groupId>
  8.   <artifactId>springcloud2023</artifactId>
  9.   <version>1.0-SNAPSHOT</version>
  11.   <modules>
  12.     <module>Cloud-provider-payment8001</module>
  13.   </modules>
  15.   <packaging>pom</packaging>
  17.   <name>Maven</name>
  18.   <!-- FIXME change it to the project's website -->
  19.   <url>http://maven.apache.org/</url>
  20.   <inceptionYear>2001</inceptionYear>
  22.   <distributionManagement>
  23.     <site>
  24.       <id>website</id>
  25.       <url>scp://webhost.company.com/www/website</url>
  26.     </site>
  27.   </distributionManagement>
  29.   <!-- 统一管理jar包版本 -->
  30.   <properties>
  31.     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  32.     <maven.compiler.source>1.8</maven.compiler.source>
  33.     <maven.compiler.target>1.8</maven.compiler.target>
  34.     <junit.version>4.13.2</junit.version>
  35.     <log4j.version>1.2.17</log4j.version>
  36.     <lombok.version>1.18.26</lombok.version>
  37.     <mysql.version>8.0.32</mysql.version>
  38.     <druid.version>1.2.16</druid.version>
  39.     <mybatis.spring.boot.version>3.0.1</mybatis.spring.boot.version>
  40.   </properties>
  42.   <!-- 1、只是声明依赖，并不实际引入，子项目按需声明使用的依赖 -->
  43.   <!-- 2、子项目可以继承父项目的 version 和 scope -->
  44.   <!-- 3、子项目若指定了 version 和 scope，以子项目为准 -->
  45.   <dependencyManagement>
  46.     <dependencies>
  47.       <!--spring boot 2.2.2-->
  48.       <dependency>
  49.         <groupId>org.springframework.boot</groupId>
  50.         <artifactId>spring-boot-dependencies</artifactId>
  51.         <version>3.0.5</version>
  52.         <type>pom</type>
  53.         <scope>import</scope>
  54.       </dependency>
  55.       <!--spring cloud Hoxton.SR1-->
  56.       <dependency>
  57.         <groupId>org.springframework.cloud</groupId>
  58.         <artifactId>spring-cloud-dependencies</artifactId>
  59.         <version>2022.0.2</version>
  60.         <type>pom</type>
  61.         <scope>import</scope>
  62.       </dependency>
  63.       <!--spring cloud alibaba 2.1.0.RELEASE-->
  64.       <dependency>
  65.         <groupId>com.alibaba.cloud</groupId>
  66.         <artifactId>spring-cloud-alibaba-dependencies</artifactId>
  67.         <version>2021.0.4.0</version>
  68.         <type>pom</type>
  69.         <scope>import</scope>
  70.       </dependency>
  72.       <dependency>
  73.         <groupId>mysql</groupId>
  74.         <artifactId>mysql-connector-java</artifactId>
  75.         <version>${
  76.     mysql.version}</version>
  77.       </dependency>
  78.       <dependency>
  79.         <groupId>com.alibaba</groupId>
  80.         <artifactId>druid</artifactId>
  81.         <version>${
  82.     druid.version}</version>
  83.       </dependency>
  84.       <dependency>
  85.         <groupId>org.mybatis.spring.boot</groupId>
  86.         <artifactId>mybatis-spring-boot-starter</artifactId>
  87.         <version>${
  88.     mybatis.spring.boot.version}</version>
  89.       </dependency>
  90.       <dependency>
  91.         <groupId>junit</groupId>
  92.         <artifactId>junit</artifactId>
  93.         <version>${
  94.     junit.version}</version>
  95.       </dependency>
  96.       <dependency>
  97.         <groupId>log4j</groupId>
  98.         <artifactId>log4j</artifactId>
  99.         <version>${
  100.     log4j.version}</version>
  101.       </dependency>
  102.       <dependency>
  103.         <groupId>org.projectlombok</groupId>
  104.         <artifactId>lombok</artifactId>
  105.         <version>${
  106.     lombok.version}</version>
  107.         <optional>true</optional>
  108.       </dependency>
  109.     </dependencies>
  110.   </dependencyManagement>
  112.   <build>
  113.     <plugins>
  114.       <plugin>
  115.         <groupId>org.springframework.boot</groupId>
  116.         <artifactId>spring-boot-maven-plugin</artifactId>
  117.         <configuration>
  118.           <fork>true</fork>
  119.           <addResources>true</addResources>
  120.         </configuration>
  121.       </plugin>
  122.     </plugins>
  123.   </build>
  125. </project>
2.2. 改pom

修改本模块的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>springcloud2023</artifactId>
  7.         <groupId>com.tigerhhzz.springcloud</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>Cloud-provider-payment8001</artifactId>
  14.     <properties>
  15.         <maven.compiler.source>8</maven.compiler.source>
  16.         <maven.compiler.target>8</maven.compiler.target>
  17.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-web</artifactId>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <!--这个和web要写到一块-->
  27.             <artifactId>spring-boot-starter-actuator</artifactId>
  28.         </dependency>
  30.         <dependency>
  31.             <groupId>org.mybatis.spring.boot</groupId>
  32.             <artifactId>mybatis-spring-boot-starter</artifactId>
  33.         </dependency>
  34.         <dependency>
  35.             <groupId>com.alibaba</groupId>
  36.             <artifactId>druid-spring-boot-starter</artifactId>
  37.             <version>1.1.10</version>
  38.         </dependency>
  39.         <!--mysql-connector-java-->
  40.         <dependency>
  41.             <groupId>mysql</groupId>
  42.             <artifactId>mysql-connector-java</artifactId>
  43.         </dependency>
  44.         <!--jdbc-->
  45.         <dependency>
  46.             <groupId>org.springframework.boot</groupId>
  47.             <artifactId>spring-boot-starter-jdbc</artifactId>
  48.         </dependency>
  50.         <dependency>
  51.             <groupId>org.projectlombok</groupId>
  52.             <artifactId>lombok</artifactId>
  53.             <optional>true</optional>
  54.         </dependency>
  55.         <dependency>
  56.             <groupId>org.springframework.boot</groupId>
  57.             <artifactId>spring-boot-starter-test</artifactId>
  58.             <scope>test</scope>
  59.         </dependency>
  61.     </dependencies>
  63. </project>
2.3. 写yml

编写application.yml配置文件

  1. server:
  2.   port: 8001
  4. spring:
  5.   application:
  6.     name: cloud-provider-payment8001
  7.   datasource:
  8.     type: com.alibaba.druid.pool.DruidDataSource
  9.     driver-class-name: com.mysql.jdbc.Driver
  10.     url: jdbc:mysql://localhost:3306/springcloud-tigerhhzz?useUnicode=true&characterEncoding=utf-8&useSSL=false
  11.     username: root
  12.     password: 123456
  13. mybatis:
  14.   mapper-locations: classpath:mapper/*.xml
  15.   type-aliases-package: com.dkf.springcloud.entities  # 所有Entity 别名类所在包

热部署：这里我使用的Jrebel插件。

2.4. 主启动
  1. package com.tigerhhzz.springcloud;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  8. /**
  9.  * @author Administrator
  10.  */
  11. @SpringBootApplication
  12. public class PaymentMain8001 {
  14.     public static void main(String[] args){
  16.         SpringApplication.run(PaymentMain8001.class, args);
  17.     }
  18. }
2.5. 业务类

下面的常规操作：

  1. 建表SQL

    create table payment(

    1. `id` bigint(20) not null auto_increment comment 'ID',
    2. `serial` varchar(200) default '',
    3. PRIMARY KEY (`id`)

    )ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8

    select * from payment;

entities

  1. import lombok.AllArgsConstructor;
  2. import lombok.Data;
  3. import lombok.NoArgsConstructor;
  5. import java.io.Serializable;
  7. @Data   //set/get方法
  8. @AllArgsConstructor //有参构造器
  9. @NoArgsConstructor  //无参构造器
  10. public class Payment implements Serializable {
  12.   private long id;//数据库是bigint
  13.   private String serial;
  14. }

通用结果返回类实体：

  1. import lombok.AllArgsConstructor;
  2. import lombok.Data;
  3. import lombok.NoArgsConstructor;
  5. //返回给前端的通用json数据串
  6. @Data   //set/get方法
  7. @AllArgsConstructor //有参构造器
  8. @NoArgsConstructor  //无参构造器
  9. public class CommonResult<T> {
  11.   private Integer code;
  12.   private String message;
  13.   private T data; //泛型，对应类型的json数据
  15.   //自定义两个参数的构造方法
  16.   public CommonResult(Integer code, String message){
  18.       this(code, message, null);
  19.   }
  20. }

dao

  1. @Mapper // 是ibatis下面的注解 //@Repositoty有时候会有问题
  2. public interface PaymentDao {
  5.   int create(Payment payment);
  7.   Payment getPaymentById(@Param("id") Long id);
  8. }

resource下创建mapper文件夹，新建PaymentMapper.xml。在yml里有所有entity别名类所在包，所有payment不用写全类名

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

@Param注解

service

  1. public interface PaymentService {
  3.   int create(Payment payment);
  5.   Payment getPaymentById(@Param("id") Long id);
  6. }
  8. @Service
  9. public class PaymentServiceImpl implements PaymentService {
  12.   @Autowired
  13.   private PaymentDao paymentDao;
  15.   @Override
  16.   public int create(Payment payment) {
  18.       return paymentDao.create(payment);
  19.   }
  21.   @Override
  22.   public Payment getPaymentById(Long id) {
  24.       return paymentDao.getPaymentById(id);
  25.   }
  26. }

controller

  1. @RestController   //必须是这个注解，因为是模拟前后端分离的restful风格的请求，要求每个方法返回 json
  2. @Slf4j
  3. public class PaymentController {
  6.   @Resource
  7.   private PaymentService paymentService;
  9.   @PostMapping(value = "/payment/create")
  10.   //        注意这里的 @RequestBody  是必须要写的，虽然 MVC可以自动封装参数成为对象，
  11.   //      但是当消费者项目调用，它传参是 payment 整个实例对象传过来的， 即Json数据，因此需要写这个注解
  12.   public CommonResult create(@RequestBody Payment payment){
  14.       int result = paymentService.create(payment);
  15.       log.info("****插入结果：" + result);
  16.       if(result > 0){
  18.           return new CommonResult(200, "插入数据库成功", result);
  19.       }
  20.       return new CommonResult(444, "插入数据库失败", null);
  21.   }
  23.   @GetMapping(value = "/payment/{id}")
  24.   public CommonResult getPaymentById(@PathVariable("id")Long id){
  26.       Payment result = paymentService.getPaymentById(id);
  27.       log.info("****查询结果：" + result);
  28.       if(result != null){
  30.           return new CommonResult(200, "查询成功", result);
  31.       }
  32.       return new CommonResult(444, "没有对应id的记录", null);
  33.   }
  34. }

启动8001模块
在这里插入图片描述
在这里插入图片描述

对应POST方式的请求，要学会用POSTMAN工具
测试插入一条数据
在这里插入图片描述

微服务多了之后就使用run dashboard

不但编译有个别地方会报错，启动也会报错，但是测试两个接口都是没问题的，推测启动报错是因为引入了下面才会引入的jar包，目前不影响。

3、创建Cloud-consumer-order80 微服务消费者订单Module模块

3.1. 建Module

在这里插入图片描述

3.2. 改pom

修改本模块的pom文件如下：

3.3. 写yml

编写application.yml配置文件

  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>springcloud2023</artifactId>
  7.         <groupId>com.tigerhhzz.springcloud</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>Cloud-consumer-order80</artifactId>
  14.     <properties>
  15.         <maven.compiler.source>8</maven.compiler.source>
  16.         <maven.compiler.target>8</maven.compiler.target>
  17.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-web</artifactId>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-actuator</artifactId>
  27.         </dependency>
  29.         <dependency>
  30.             <groupId>org.springframework.boot</groupId>
  31.             <artifactId>spring-boot-devtools</artifactId>
  32.             <scope>runtime</scope>
  33.             <optional>true</optional>
  34.         </dependency>
  35.         <dependency>
  36.             <groupId>org.projectlombok</groupId>
  37.             <artifactId>lombok</artifactId>
  38.             <optional>true</optional>
  39.         </dependency>
  40.         <dependency>
  41.             <groupId>org.springframework.boot</groupId>
  42.             <artifactId>spring-boot-starter-test</artifactId>
  43.             <scope>test</scope>
  44.         </dependency>
  46.     </dependencies>
  48. </project>
3.4. 主启动

OrderMain80.java

  1. package com.tigerhhzz.springcloud;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. @SpringBootApplication
  7. public class OrderMain80{
  9.     public static void main(String[] args){
  11.         SpringApplication.run(OrderMain80.class,args);
  12.     }
  13. }
3.5. 业务类

entites包中的类也拷贝到本项目中

entities/CommonResult.java
entities/Payment.java

配置RestTemplate
ApplicationContextConfig 内容：

  1. package com.tigerhhzz.springcloud.config;
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.web.client.RestTemplate;
  7. /**
  8.  * @author tigerhhzz
  9.  * @date 2023/4/8 22:52
  10.  */
  11. @Configuration
  12. public class ApplicationContextConfig {
  15.     @Bean
  16.     public RestTemplate getRestTemplate(){
  18.         return new RestTemplate();
  19.         /*
  20.         RestTemplate提供了多种便捷访问远程http服务的方法，
  21.         是一种简单便捷的访问restful服务模板类，是spring提供的用于rest服务的客户端模板工具集
  22.         */
  23.     }
  24. }

controller

  1. package com.tigerhhzz.springcloud.controller;
  3. import com.tigerhhzz.springcloud.entities.CommonResult;
  4. import com.tigerhhzz.springcloud.entities.Payment;
  5. import lombok.extern.slf4j.Slf4j;
  6. import org.springframework.web.bind.annotation.GetMapping;
  7. import org.springframework.web.bind.annotation.PathVariable;
  8. import org.springframework.web.bind.annotation.PostMapping;
  9. import org.springframework.web.bind.annotation.RestController;
  10. import org.springframework.web.client.RestTemplate;
  12. import javax.annotation.Resource;
  14. @RestController
  15. @Slf4j
  16. public class OrderController {
  19.     //远程调用的 地址
  20.     public static final String PAYMENY_URL = "http://localhost:8001";
  22.     @Resource
  23.     private RestTemplate restTemplate;
  25.     @PostMapping("customer/payment/create")
  26.     public CommonResult<Payment> create (Payment payment){
  29.         return restTemplate.postForObject(PAYMENY_URL + "/payment/create",//请求地址
  30.                                           payment,//请求参数
  31.                                           CommonResult.class);//返回类型
  32.     }
  34.     @GetMapping("customer/payment/{id}")
  35.     public CommonResult<Payment> getPaymentById(@PathVariable("id")Long id){
  37.         return restTemplate.getForObject(PAYMENY_URL + "/payment/" + id,//请求地址
  38.                                          CommonResult.class);//返回类型
  39.     }
  40. }

如果 runDashboard 控制台没有出来，右上角搜索 即可

运用spring cloud框架基于spring boot构建微服务，一般需要启动多个应用程序，在idea开发工具中，多个同时启动的应用

需要在RunDashboard运行仪表盘中可以更好的管理，但有时候idea中的RunDashboard窗口没有显示出来，也找不到直接的开启按钮

80调用8001服务测试成功：

在这里插入图片描述

4、工程重构

将两个微服务模块中公共的部分，例如实体类等放到新建的微服务公共模块中

上面 两个子项目，有多次重复的 导入 jar，和重复的 Entity 实体类。可以把 多余的部分，加入到一个独立的模块中，将这个模块打包，并提供给需要使用的 module

4.1 新建一个 cloud-api-commons 子模块

将 entities 包里面的实体类放到这个子模块中，也将 pom 文件中，重复导入的 jar包放到这个新建的 模块的 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>springcloud2023</artifactId>
  7.         <groupId>com.tigerhhzz.springcloud</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>Cloud-api-commons</artifactId>
  14.     <dependencies>
  16.         <dependency>
  17.             <groupId>org.projectlombok</groupId>
  18.             <artifactId>lombok</artifactId>
  19.             <optional>true</optional>
  20.         </dependency>
  22.         <!-- 这个是新添加的，之前没用到，后面会用到。关于这个hutool 是个功能强大的工具包，官网：https://hutool.cn/ -->
  23.         <dependency>
  24.             <groupId>cn.hutool</groupId>
  25.             <artifactId>hutool-all</artifactId>
  26.             <version>5.1.0</version>
  27.         </dependency>
  28.     </dependencies>
  31. </project>
4.2 mvn跳过test，mvc clean，mvn install

将此项目打包 install 到 maven仓库。

将 提供者 和 消费者 两个项目中的 entities 包删除，并删除掉加入到 cloud-api-commons 模块的 依赖配置。
将 打包到 maven 仓库的 cloud-api-commons 模块，引入到 提供者 和 消费者的 pom 文件中，如下所示

  1. <!-- 引入自己定义的api通用包 -->
  2.       <dependency>
  3.         <groupId>com.tigerhhzz.springcloud</groupId>
  4.         <artifactId>Cloud-api-commons</artifactId>
  5.         <version>1.0-SNAPSHOT</version>
  6.         <scope>compile</scope>
  7.       </dependency>

post测试插入数据成功
在这里插入图片描述

发表评论

表情：
评论列表 （有 0 条评论，192人围观）

还没有评论，来说两句吧...

相关阅读