Spring Cloud_Rest 微服务通用案例（二-基本环境搭建）

本文链接：https://blog.csdn.net/fujuacm/article/details/105708489

文章目录

1、整体父工程 microservicecloud
2、公共子模块 microservicecloud - api
2.1、在该公共子模块新建部门 Entity 实体类
2.2、执行 mvn clean & mvn install

3、微服务提供者 microservicecloud-provider-dept-8001
3.1、创建 application.yml 配置文件
3.2、新建mybatis.cfg.xml文件
3.3、运行数据库脚本
3.4、创建 DeptDao 部门接口
3.5、新建 mapper 文件夹后再建 DeptMapper.xml
3.6、新建 Service 接口和实现类
3.7、编写 DeptController 部门微服务提供者 REST
3.8、编写主启动类

4、部门服务消费者 microservicecloud-consumer-dept-80
4.1、创建 application.yml 配置文件
4.2、往 IoC 容器注入 RestTemplate 类
4.3、编写消费者类
4.4、编写启动类，浏览器测试

服务以操作部门表 Dept 为例，分如下模块：

整体父工程 microservicecloud
公共子模块 microservicecloud-api
部门微服务提供者 microservicecloud-provider-dept 8001
部门微服务消费者 microservicecloud-consumer-dept 80

1、整体父工程 microservicecloud

新建父工程microservicecloud，切记是 Packaging 是选择 pom 模式。父工程主要是定义 POM 文件和各依赖的版本号，将后续各个子模块公用的 jar 包等统一提出来，类似一个抽象父类

在 pom 工程导入如下约定属性管理：

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <junit.version>4.12</junit.version>
        <log4j.version>1.2.17</log4j.version>
        <lombok.version>1.16.18</lombok.version>
    </properties>

在 pom 工程导入如下依赖管理：

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Dalston.SR1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>1.5.9.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.0.4</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.0.31</version>
            </dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.0</version>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-core</artifactId>
                <version>1.2.3</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>${log4j.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

2、公共子模块 microservicecloud - api

右键点击父工程项目，New -> Module 创建一个模块。

在新建模块中的 pom 文件内部，粘贴如下信息：

<?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>
    <parent>
        <artifactId>microServiceCloud</artifactId>
        <groupId>per.cjh</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>per.cjh</groupId>
    <artifactId>microservicecloud-api</artifactId>
    <packaging>jar</packaging>

    <!-- 当前 Module 需要用到的 jar 包，按自己需求添加，如果父类已经包含了，可以不用写版本 -->
    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

</project>

2.1、在该公共子模块新建部门 Entity 实体类

package per.cjh.springcloud.entities;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

import java.io.Serializable;

@Data
@AllArgsConstructor // lombok 全参构造函数
@NoArgsConstructor // lombok 空参构造函数
@Accessors(chain = true) // 产生的setter返回的this而不是void，用于实现链式编程
public class Dept implements Serializable{
    private Long deptno; // 主键
    private String dname; // 部门名称
    private String db_source; // 来自哪个数据库，因为微服务架构可以一个服务对应一个数据库，同一个信息被存储到不同数据库
}

2.2、执行 mvn clean & mvn install

执行 mvn clean & mvn install 后在本地仓库生成 jar 包，供其它模块引用，达到通用目的。也即需要用到部门实体的话，不用每个工程都定义一份，直接引用本模块即可。

3、微服务提供者 microservicecloud-provider-dept-8001

实现目录：
在这里插入图片描述
右键父工程，新建子模块
在子模块的 pom 文件中，粘贴下面信息：

<?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>microServiceCloud</artifactId>
        <groupId>per.cjh</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <groupId>per.cjh</groupId>
    <artifactId>microservicecloud-provider-dept-8001</artifactId>

    <dependencies>
        <dependency>
            <groupId>per.cjh</groupId>
            <artifactId>microservicecloud-api</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jetty</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>springloaded</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>
</project>

3.1、创建 application.yml 配置文件

在 resources 根路径下面创建 application.yml 配置文件，并粘贴如下配置：

server:
  port: 8001
# 整合 Mybatis
mybatis:
  config-location: classpath:mybatis/mybatis.cfg.xml        # mybatis配置文件所在路径
  type-aliases-package: per.cjh.springcloud.entities    # 所有Entity别名类所在包
  mapper-locations:
  - classpath:mybatis/mapper/**/*.xml                       # mapper映射文件
# 整合 Spring
spring:
  application:
   name: microservicecloud-dept
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource            # 当前数据源操作类型
    driver-class-name: org.gjt.mm.mysql.Driver              # mysql驱动包
    url: jdbc:mysql://localhost:3306/cloudDB01              # 数据库名称
    username: root
    password: root
    dbcp2:
      min-idle: 5                                           # 数据库连接池的最小维持连接数
      initial-size: 5                                       # 初始化连接数
      max-total: 5                                          # 最大连接数
      max-wait-millis: 200                                  # 等待连接获取的最大超时时间

3.2、新建mybatis.cfg.xml文件

工程 src/main/resources 目录下新建 mybatis 文件夹后新建 mybatis.cfg.xml 文件，并粘贴如下配置：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
    <!-- 开启二级缓存 -->
    <setting name="cacheEnabled" value="true"/>
    </settings>
</configuration>

3.3、运行数据库脚本

DROP DATABASE IF EXISTS cloudDB01;
CREATE DATABASE cloudDB01 CHARACTER SET UTF8;
USE cloudDB01;
CREATE TABLE dept
(
  deptno BIGINT NOT NULL PRIMARY KEY AUTO_INCREMENT,
  dname VARCHAR(60),
  db_source   VARCHAR(60)
);
INSERT INTO dept(dname,db_source) VALUES('开发部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('人事部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('财务部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('市场部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('运维部',DATABASE());
SELECT * FROM dept;

3.4、创建 DeptDao 部门接口

@Mapper
public interface DeptDao {
    public boolean addDept(Dept dept);
    public Dept findById(Long id);
    public List findAll();
}

3.5、新建 mapper 文件夹后再建 DeptMapper.xml

工程 src/main/resources/mybatis 目录下新建 mapper 文件夹后再建 DeptMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="per.cjh.springcloud.dao.DeptDao">
    
    <select id="findById" resultType="Dept" parameterType="Long">
        select deptno,dname,db_source from dept where deptno=#{deptno};
    </select>
    <select id="findAll" resultType="Dept">
        select deptno,dname,db_source from dept;
    </select>
    <insert id="addDept" parameterType="Dept">
        INSERT INTO dept(dname,db_source) VALUES(#{dname},DATABASE());
    </insert>
</mapper>

3.6、新建 Service 接口和实现类

接口：

public interface DeptService {

    public boolean addDept(Dept dept);
    public Dept findById(Long id);
    public List findAll();
}

实现类：

@Service
public class DeptServiceImpl implements DeptService {
    @Autowired
    DeptDao deptDao;

    @Override
    public boolean addDept(Dept dept) {
        return deptDao.addDept(dept);
    }

    @Override
    public Dept findById(Long id) {
        return deptDao.findById(id);
    }

    @Override
    public List findAll() {
        return deptDao.findAll();
    }
}

3.7、编写 DeptController 部门微服务提供者 REST

@RestController
public class DeptController {
    @Autowired
    private DeptService service;

    @RequestMapping(value = "/dept/add", method = RequestMethod.POST)
    public boolean add(@RequestBody Dept dept) {
        return service.addDept(dept);
    }

    @RequestMapping(value = "/dept/get/{id}", method = RequestMethod.GET)
    public Dept get(@PathVariable("id") Long id) {
        return service.findById(id);
    }

    @RequestMapping(value = "/dept/list", method = RequestMethod.GET)
    public List<Dept> add() {
        return service.findAll();
    }
}

3.8、编写主启动类

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

4、部门服务消费者 microservicecloud-consumer-dept-80

右键父工程，新建子模块
在子模块的 pom 文件中，粘贴下面信息：

<?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>microServiceCloud</artifactId>
        <groupId>per.cjh</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <groupId>per.cjh</groupId>
    <artifactId>microservicecloud-consumer-dept-80</artifactId>

    <dependencies>
        <dependency>
            <groupId>per.cjh</groupId>
            <artifactId>microservicecloud-api</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>springloaded</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>
</project>

4.1、创建 application.yml 配置文件

server:
  port: 80

4.2、往 IoC 容器注入 RestTemplate 类

在 per.cjh.springcloud.cfgbeans 包下编写如下 ConfigBean

@Configuration
public class ConfigBean {
    @Bean
    public RestTemplate getRestTemplate() {
        return new RestTemplate();
    }
}

RestTemplate 是什么？
RestTemplate 提供了多种便捷访问远程 Http 服务的方法，是一种简单便捷的访问 restful 服务模板类，是 Spring 提供的用于访问 Rest 服务的客户端模板工具集

4.3、编写消费者类

该类使用 RestTemplate 类，把对该类的请求转换到另外的 IP 地址服务器上（生产者类）。

// 当前类所在的微服务 IP 地址为80，需要将请求转到 8001 的服务器上
@RestController 
public class DeptController_Consumer {

    // 内部地址的访问前缀
    private static final String REST_URL_PREFIX = "http://localhost:8001";

    @Autowired
    private RestTemplate restTemplate;
    /**
     * (url, requestMap, ResponseBean.class)这三个参数分别代表
     * REST请求地址、请求参数、HTTP响应转换被转换成的对象类型。
     * @param dept
     * @return
     */
    @RequestMapping("/consumer/dept/add")
    public boolean add(Dept dept) {

        return restTemplate.postForObject(REST_URL_PREFIX + "/dept/add", dept, Boolean.class);
    }

    @RequestMapping("/consumer/dept/get/{id}")
    public Dept get(@PathVariable("id") Long id) {

        return restTemplate.getForObject(REST_URL_PREFIX + "/dept/get/" + id, Dept.class);
    }

    @RequestMapping("/consumer/list")
    public List<Dept> list() {

        return restTemplate.getForObject(REST_URL_PREFIX + "/dept/list", List.class);
    }
}

4.4、编写启动类，浏览器测试

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