1、介绍

  • 我们会使用一个Dept部门模块做一个微服务通用案例Consumer消费者(Client)通过REST调用Provider提供者(Server)提供的服务。
  • 回顾Spring，SpringMVC，Mybatis等以往学习的知识。
  • Maven的分包分模块架构复习。

一个父工程带着多个Moudule子模块

MicroServiceCloud父工程(Project)下初次带着3个子模块(Module)

  • microservicecloud-api 【封装的整体entity/接口/公共配置等】
  • microservicecloud-consumer-dept-80 【服务提供者】
  • microservicecloud-provider-dept-8001 【服务消费者】

2、新建三个数据库

SpringCloud04：SpringCloud Rest学习环境搭建 - 图1

SpringCloud04：SpringCloud Rest学习环境搭建 - 图2.

SpringCloud04：SpringCloud Rest学习环境搭建 - 图3.

SpringCloud04：SpringCloud Rest学习环境搭建 - 图4.

  1. -- springcloud-db01
  2. -- begin
  3. CREATE DATABASE IF NOT EXISTS `springcloud-db01`;
  4. USE `springcloud-db01`;
  6. CREATE TABLE IF NOT EXISTS `dept` (
  7.   `deptno` int NOT NULL AUTO_INCREMENT,
  8.   `dname` varchar(50) NOT NULL DEFAULT '',
  9.   `db_source` varchar(50) NOT NULL DEFAULT '',
  10.   PRIMARY KEY (`deptno`)
  11. ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='部门表';
  13. INSERT INTO `dept` (`deptno`, `dname`, `db_source`) VALUES
  14.     (1, '开发部', 'db01'),
  15.     (2, '财务部', 'db01'),
  16.     (3, '人事部', 'db01'),
  17.     (4, '市场部', 'db01'),
  18.     (5, '运维部', 'db01');
  19. -- end
  23. -- springcloud-db02
  24. -- begin
  25. CREATE DATABASE IF NOT EXISTS `springcloud-db02`;
  26. USE `springcloud-db02`;
  28. CREATE TABLE IF NOT EXISTS `dept` (
  29.   `deptno` int NOT NULL AUTO_INCREMENT,
  30.   `dname` varchar(50) NOT NULL DEFAULT '',
  31.   `db_source` varchar(50) NOT NULL DEFAULT '',
  32.   PRIMARY KEY (`deptno`)
  33. ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='部门表';
  35. INSERT INTO `dept` (`deptno`, `dname`, `db_source`) VALUES
  36.     (1, '开发部', 'db02'),
  37.     (2, '财务部', 'db02'),
  38.     (3, '人事部', 'db02'),
  39.     (4, '市场部', 'db02'),
  40.     (5, '运维部', 'db02');
  41. -- end
  45. -- springcloud-db03
  46. -- begin    
  47. CREATE DATABASE IF NOT EXISTS `springcloud-db03`;
  48. USE `springcloud-db03`;
  50. CREATE TABLE IF NOT EXISTS `dept` (
  51.   `deptno` int NOT NULL AUTO_INCREMENT,
  52.   `dname` varchar(50) NOT NULL DEFAULT '',
  53.   `db_source` varchar(50) NOT NULL DEFAULT '',
  54.   PRIMARY KEY (`deptno`)
  55. ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='部门表';
  57. INSERT INTO `dept` (`deptno`, `dname`, `db_source`) VALUES
  58.     (1, '开发部', 'db03'),
  59.     (2, '财务部', 'db03'),
  60.     (3, '人事部', 'db03'),
  61.     (4, '市场部', 'db03'),
  62.     (5, '运维部', 'db03');
  63. -- end

3、创建父工程

  • 新建父工程项目springcloud，切记packaging是pom模式
  • 主要是定义POM文件，将后续各个子模块公用的jar包等统一提取出来，类似一个抽象父类

pom.xml

  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.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>com.godfrey</groupId>
  8.     <artifactId>spring-cloud-study</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  10.     <packaging>pom</packaging>
  12.     <properties>
  13.         <maven.compiler.source>1.8</maven.compiler.source>
  14.         <maven.compiler.target>8</maven.compiler.target>
  15.         <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
  16.         <spring-boot.version>2.3.5.RELEASE</spring-boot.version>
  17.         <mysql.version>8.0.22</mysql.version>
  18.         <druid.version>1.1.23</druid.version>
  19.         <mybatis.version>1.3.2</mybatis.version>
  20.         <lombok.version>1.18.16</lombok.version>
  21.     </properties>
  23.     <dependencyManagement>
  24.         <dependencies>
  25.             <!--springCloud的依赖-->
  26.             <dependency>
  27.                 <groupId>org.springframework.cloud</groupId>
  28.                 <artifactId>spring-cloud-dependencies</artifactId>
  29.                 <version>${spring-cloud.version}</version>
  30.                 <type>pom</type>
  31.                 <scope>import</scope>
  32.             </dependency>
  33.             <!--SpringBoot-->
  34.             <dependency>
  35.                 <groupId>org.springframework.boot</groupId>
  36.                 <artifactId>spring-boot-dependencies</artifactId>
  37.                 <version>${spring-boot.version}</version>
  38.                 <type>pom</type>
  39.                 <scope>import</scope>
  40.             </dependency>
  41.             <!--数据库-->
  42.             <dependency>
  43.                 <groupId>mysql</groupId>
  44.                 <artifactId>mysql-connector-java</artifactId>
  45.                 <version>${mysql.version}</version>
  46.             </dependency>
  47.             <dependency>
  48.                 <groupId>com.alibaba</groupId>
  49.                 <artifactId>druid</artifactId>
  50.                 <version>${druid.version}</version>
  51.             </dependency>
  52.             <!--Mybatis 启动器-->
  53.             <dependency>
  54.                 <groupId>org.mybatis.spring.boot</groupId>
  55.                 <artifactId>mybatis-spring-boot-starter</artifactId>
  56.                 <version>${mybatis.version}</version>
  57.             </dependency>
  58.             <!--Lombok-->
  59.             <dependency>
  60.                 <groupId>org.projectlombok</groupId>
  61.                 <artifactId>lombok</artifactId>
  62.                 <version>${lombok.version}</version>
  63.             </dependency>
  64.         </dependencies>
  65.     </dependencyManagement>
  66. </project>

4、新建springcloud-api模块

4.1 pom.xml

  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>spring-cloud-study</artifactId>
  7.         <groupId>com.godfrey</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>springcloud-api</artifactId>
  14.     <dependencies>
  15.         <dependency>
  16.             <groupId>org.projectlombok</groupId>
  17.             <artifactId>lombok</artifactId>
  18.         </dependency>
  19.     </dependencies>
  20. </project>

4.2 在com.godfrey.springcloud.pojo包下，新建实体类Dept

  1. package com.godfrey.springcloud.pojo;
  3. import lombok.Data;
  4. import lombok.NoArgsConstructor;
  5. import lombok.experimental.Accessors;
  7. import java.io.Serializable;
  9. @Data
  10. @NoArgsConstructor
  11. @Accessors(chain = true)
  12. public class Dept implements Serializable {
  14.     private Long deptno;
  15.     private String dname;
  16.     private String db_source;
  18.     public Dept(String dname) {
  19.         this.dname = dname;
  20.     }
  21. }

5、新建服务提供者springcloud-provider-dept-8001模块

5.1 pom.xml

  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>spring-cloud-study</artifactId>
  7.         <groupId>com.godfrey</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>springcloud-provider-dept-8001</artifactId>
  14.     <dependencies>
  15.         <dependency>
  16.             <groupId>com.godfrey</groupId>
  17.             <artifactId>springcloud-api</artifactId>
  18.             <version>1.0-SNAPSHOT</version>
  19.         </dependency>
  21.         <dependency>
  22.             <groupId>mysql</groupId>
  23.             <artifactId>mysql-connector-java</artifactId>
  24.         </dependency>
  25.         <dependency>
  26.             <groupId>com.alibaba</groupId>
  27.             <artifactId>druid</artifactId>
  28.         </dependency>
  29.         <dependency>
  30.             <groupId>org.mybatis.spring.boot</groupId>
  31.             <artifactId>mybatis-spring-boot-starter</artifactId>
  32.         </dependency>
  33.         <dependency>
  34.             <groupId>org.springframework.boot</groupId>
  35.             <artifactId>spring-boot-starter-web</artifactId>
  36.         </dependency>
  37.     </dependencies>
  38. </project>

5.2 配置文件application.yml

  1. server:
  2.   port: 8001
  4. # mybatis的配置
  5. mybatis:
  6.   type-aliases-package: com.godfrey.springcloud.pojo
  7.   config-location: classpath:mybatis/mybatis-config.xml
  8.   mapper-locations: classpath:mybatis/mapper/*.xml
  10. # spring的配置
  11. spring:
  12.   application:
  13.     name: springcloud-provider-dept
  14.   datasource:
  15.     type: com.alibaba.druid.pool.DruidDataSource #数据库
  16.     driver-class-name: com.mysql.jdbc.Driver
  17.     url: jdbc:mysql://localhost:3306/springcloud-db01?serverTimezone=GMT%2B8
  18.     username: root
  19.     password: root123

在resources目录下Mybatis配置文件，开启耳机缓存，mybatis.config.xml

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE configuration
  3.         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-3-config.dtd">
  5. <configuration>
  6.     <settings>
  7.         <setting name="cacheEnabled" value="true"/>
  8.     </settings>
  9. </configuration>

接下来，新建项目结构

SpringCloud04：SpringCloud Rest学习环境搭建 - 图5.

5.3 DeptMapper

  1. package com.godfrey.springcloud.mapper;
  3. import com.godfrey.springcloud.pojo.Dept;
  4. import org.apache.ibatis.annotations.Mapper;
  5. import org.springframework.stereotype.Repository;
  7. import java.util.List;
  9. /**
  10.  * @author godfrey
  11.  * @since 2020-11-16
  12.  */
  13. @Mapper
  14. @Repository
  15. public interface DeptMapper {
  17.     boolean addDept(Dept dept);
  19.     Dept queryById(Long id);
  21.     List<Dept> queryAll();
  22. }

DeptMapper.xml

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper
  3.         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  5. <mapper namespace="com.godfrey.springcloud.mapper.DeptMapper">
  7.     <insert id="addDept" parameterType="Dept">
  8.         insert into dept (deptno, dname, db_source)
  9.         values (#{dname}, DATABASE())
  10.     </insert>
  12.     <select id="queryById" resultType="com.godfrey.springcloud.pojo.Dept" parameterType="Long">
  13.         select *
  14.         from dept
  15.         where deptno = #{deptno};
  16.     </select>
  18.     <select id="queryAll" resultType="Dept">
  19.         select *
  20.         from dept;
  21.     </select>
  23. </mapper>

5.4 DeptService

  1. package com.godfrey.springcloud.service;
  3. import com.godfrey.springcloud.pojo.Dept;
  5. import java.util.List;
  7. /**
  8.  * @author godfrey
  9.  * @since 2020-11-16
  10.  */
  11. public interface DeptService {
  13.     /**
  14.      * 增加部门
  15.      *
  16.      * @return boolean
  17.      */
  18.     boolean addDept(Dept dept);
  21.     /**
  22.      * 通过id查询部门
  23.      *
  24.      * @return Dept
  25.      */
  26.     Dept queryById(Long id);
  28.     /**
  29.      * 查询所有部门
  30.      *
  31.      * @return java.util.List<com.godfrey.springcloud.pojo.Dept>
  32.      */
  33.     List<Dept> queryAll();
  34. }

5.5 DeptController

  1. package com.godfrey.springcloud.controller;
  3. import com.godfrey.springcloud.pojo.Dept;
  4. import com.godfrey.springcloud.service.DeptService;
  5. import org.springframework.web.bind.annotation.GetMapping;
  6. import org.springframework.web.bind.annotation.PathVariable;
  7. import org.springframework.web.bind.annotation.PostMapping;
  8. import org.springframework.web.bind.annotation.RestController;
  10. import java.util.List;
  12. /**
  13.  * @author godfrey
  14.  * @since 2020-11-16
  15.  */
  16. @RestController
  17. public class DeptController {
  19.     private final DeptService deptService;
  21.     public DeptController(DeptService deptService) {
  22.         this.deptService = deptService;
  23.     }
  25.     @PostMapping("/dept/add")
  26.     public boolean addDept(Dept dept) {
  27.         return deptService.addDept(dept);
  28.     }
  30.     @GetMapping("/dept/get/{id}")
  31.     public Dept queryById(@PathVariable("id") Long id) {
  32.         Dept dept = deptService.queryById(id);
  33.         if (dept == null) {
  34.             throw new RuntimeException("Fail");
  35.         }
  36.         return dept;
  37.     }
  39.     @GetMapping("/dept/list")
  40.     public List<Dept> queryAll() {
  41.         return deptService.queryAll();
  42.     }
  43. }

5.6 启动类

  1. package com.godfrey.springcloud;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. @SpringBootApplication
  7. public class DeptProvider_8001 {
  8.     public static void main(String[] args) {
  9.         SpringApplication.run(DeptProvider_8001.class, args);
  10.     }
  11. }

6、新建消费者springcloud-consumer-dept-80模块

6.1 pom.xml

  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>spring-cloud-study</artifactId>
  7.         <groupId>com.godfrey</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>springcloud-consumer-dept-80</artifactId>
  15.     <dependencies>
  16.         <dependency>
  17.             <groupId>com.godfrey</groupId>
  18.             <artifactId>springcloud-api</artifactId>
  19.             <version>1.0-SNAPSHOT</version>
  20.         </dependency>
  21.         <dependency>
  22.             <groupId>org.springframework.boot</groupId>
  23.             <artifactId>spring-boot-starter-web</artifactId>
  24.         </dependency>
  25.     </dependencies>
  27. </project>

6.2 配置文件application.yml

  1. server:
  2.   port: 80

接下来，新建项目结构

SpringCloud04：SpringCloud Rest学习环境搭建 - 图6.

6.3 配置类ConfigBean

  1. package com.godfrey.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.  * 配置类
  9.  *
  10.  * @author godfrey
  11.  * @since 2020-11-18
  12.  */
  13. @Configuration
  14. public class ConfigBean {
  16.     @Bean
  17.     public RestTemplate getRestTemplate() {
  18.         return new RestTemplate();
  19.     }
  20. }

6.4 DeptConsumerController

  1. package com.godfrey.springcloud.controller;
  3. import com.godfrey.springcloud.pojo.Dept;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.web.bind.annotation.PathVariable;
  6. import org.springframework.web.bind.annotation.PostMapping;
  7. import org.springframework.web.bind.annotation.RequestMapping;
  8. import org.springframework.web.bind.annotation.RestController;
  9. import org.springframework.web.client.RestTemplate;
  11. import java.util.List;
  12. import java.util.concurrent.atomic.AtomicInteger;
  14. /**
  15.  * @author godfrey
  16.  * @since 2020-11-18
  17.  */
  18. @RestController
  19. public class DeptConsumerController {
  21.     private RestTemplate restTemplate;
  23.     private static final String REST_URL_PREFIX = "http://localhost:800";
  25.     @Autowired
  26.     DeptConsumerController(RestTemplate restTemplate) {
  27.         this.restTemplate = restTemplate;
  28.     }
  30.     @PostMapping("/consumer/dept/add")
  31.     public boolean addDept(Dept dept) {
  32.         return restTemplate.postForObject(REST_URL_PREFIX + "/dept/add/", dept, Boolean.class);
  33.     }
  35.     @RequestMapping("/consumer/dept/get/{id}")
  36.     public Dept queryById(@PathVariable("id") Long id) {
  37.         return restTemplate.getForObject(REST_URL_PREFIX + "/dept/get/" + id, Dept.class);
  38.     }
  40.     @RequestMapping("/consumer/dept/list")
  41.     public List<Dept> queryAll() {
  42.         return restTemplate.getForObject(REST_URL_PREFIX + "/dept/list", List.class);
  43.     }
  44. }

6.5 启动类

  1. package com.godfrey.springcloud;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. @SpringBootApplication
  7. public class DeptConsumer_80 {
  8.     public static void main(String[] args) {
  9.         SpringApplication.run(DeptConsumer_80.class, args);
  10.     }
  11. }

7、测试

服务提供者：

SpringCloud04：SpringCloud Rest学习环境搭建 - 图7

服务消费者

SpringCloud04：SpringCloud Rest学习环境搭建 - 图8

8、集群

根据springcloud-provider-dept-8001模块，新建两个模块springcloud-provider-dept-8002和springcloud-provider-dept-8003即可，随后修改相应的配置文件和接口即可

为了使消费者轮询访问8001~3，springcloud-consumer-dept-80模块下controller修改为如下：

  1. package com.godfrey.springcloud.controller;
  3. import com.godfrey.springcloud.pojo.Dept;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.web.bind.annotation.PathVariable;
  6. import org.springframework.web.bind.annotation.PostMapping;
  7. import org.springframework.web.bind.annotation.RequestMapping;
  8. import org.springframework.web.bind.annotation.RestController;
  9. import org.springframework.web.client.RestTemplate;
  11. import java.util.List;
  12. import java.util.concurrent.atomic.AtomicInteger;
  14. /**
  15.  * @author godfrey
  16.  * @since 2020-11-18
  17.  */
  18. @RestController
  19. public class DeptConsumerController {
  21.     private RestTemplate restTemplate;
  23.     private static final String REST_URL_PREFIX = "http://localhost:800";
  25.     private AtomicInteger num = new AtomicInteger(3);
  27.     @Autowired
  28.     DeptConsumerController(RestTemplate restTemplate) {
  29.         this.restTemplate = restTemplate;
  30.     }
  32.     @PostMapping("/consumer/dept/add")
  33.     public boolean addDept(Dept dept) {
  34.         return restTemplate.postForObject(REST_URL_PREFIX + (num.getAndIncrement() % 3 + 1) + "/dept/add/", dept, Boolean.class);
  35.     }
  37.     @RequestMapping("/consumer/dept/get/{id}")
  38.     public Dept queryById(@PathVariable("id") Long id) {
  39.         return restTemplate.getForObject(REST_URL_PREFIX + (num.getAndIncrement() % 3 + 1) + "/dept/get/" + id, Dept.class);
  40.     }
  42.     @RequestMapping("/consumer/dept/list")
  43.     public List<Dept> queryAll() {
  44.         return restTemplate.getForObject(REST_URL_PREFIX + (num.getAndIncrement() % 3 + 1) + "/dept/list", List.class);
  45.     }
  46. }

启动测试刷新浏览器，得到如下即环境搭建成功

SpringCloud04：SpringCloud Rest学习环境搭建 - 图9

SpringCloud04：SpringCloud Rest学习环境搭建 - 图10

SpringCloud04：SpringCloud Rest学习环境搭建 - 图11