springcloud-Rest学习环境搭建

1 准备阶段

1.1 介绍

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

1.2 SpringCloud版本选择

大版本说明

SpringBoot	SpringCloud	关系
1.2.x	Angel版本(天使)	兼容SpringBoot1.2x
1.3.x	Brixton版本(布里克斯顿)	兼容SpringBoot1.3x，也兼容SpringBoot1.4x
1.4.x	Camden版本(卡姆登)	兼容SpringBoot1.4x，也兼容SpringBoot1.5x
1.5.x	Dalston版本(多尔斯顿)	兼容SpringBoot1.5x，不兼容SpringBoot2.0x
1.5.x	Edgware版本(埃奇韦尔)	兼容SpringBoot1.5x，不兼容SpringBoot2.0x
2.0.x	Finchley版本(芬奇利)	兼容SpringBoot2.0x，不兼容SpringBoot1.5x
2.1.x	Greenwich版本(格林威治)

实际开发版本关系

spring-boot-starter-parent		spring-cloud-dependencles
版本号	发布日期	版本号	发布日期
1.5.2.RELEASE	2017-03	Dalston.RC1	2017-x
1.5.9.RELEASE	2017-11	Edgware.RELEASE	2017-11
1.5.16.RELEASE	2018-04	Edgware.SR5	2018-10
1.5.20.RELEASE	2018-09	Edgware.SR5	2018-10
2.0.2.RELEASE	2018-05	Fomchiey.BULD-SNAPSHOT	2018-x
2.0.6.RELEASE	2018-10	Fomchiey-SR2	2018-10
2.1.4.RELEASE	2019-04	Greenwich.SR1	2019-03

本次项目使用表中最新的版本

1.3 创建数据库

新建一个数据库 db01 并添加dept表

1.4 项目结构

一个父工程下携带三个子模块

MicroServiceCloud-父工程
MicroServiceCloud-api 【封装的整体pojo/接口/公共配置等】-子模块
MicroServiceCloud-provider-dept-8001 【服务提供者】-子模块
MicroServiceCloud-consumer-dept-80 【服务消费者】-子模块

2 创建父工程

2.1 搭建目录结构

新建一个普通的maven项目-springcloud,删除src目录并新建三个子模块,三个子模块也是普通maven项目

2.2 导入父工程需要的依赖

springcloud : pom.xml

 <?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>
 
    <groupId>com.lv</groupId>
    <artifactId>springcloud</artifactId>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>springcloud-api</module>
        <module>springcloud-provider-dept-8001</module>
        <module>springcloud-consumer-dept-80</module>
    </modules>
 
    <!--打包方式 pom-->
    <packaging>pom</packaging>
 
    <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>
        <lombok.version>1.16.18</lombok.version>
        <log4j.version>1.2.17</log4j.version>
    </properties>
 
    <dependencyManagement>
        <dependencies>
            <!--SpringCloud的依赖-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.SR1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--SpringBoot的依赖-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.1.4.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--数据库-->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.47</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.10</version>
            </dependency>
            <!--SpringBoot mybatis启动器-->
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.2</version>
            </dependency>
            <!--日志测试-->
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-core</artifactId>
                <version>1.2.3</version>
            </dependency>
            <!--junit-->
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
            </dependency>
            <!--lombok-->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </dependency>
            <!--Log4j-->
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>${log4j.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

3 公共模块

编写springcloud-api模块

3.1 导入依赖

springcloud-api : pom.xml

 <?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>springcloud</artifactId>
        <groupId>com.lv</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
 
    <artifactId>springcloud-api</artifactId>
 
    <!--当前Module自己需要的依赖,如果父依赖中已经配置了版本,这里就不用写了-->
    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
 
</project>

3.2 编写实体类

创建包结构 com.lv.springcloud.pojo ,并在该包下编写实体类Dept

springcloud-api : src/main/java/com/lv/springcloud/pojo/Dept.java

 package com.lv.springcloud.pojo;
 
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
 
import java.io.Serializable;
 
@Data
@NoArgsConstructor
@Accessors(chain = true) //支持链式写法
public class Dept implements Serializable { //Dept 实体类,orm 类表关系映射
    private Long deptno;//主键
    private String dname;
 
    //这个数据存在哪个数据库的字段~微服务,一个服务对应一个数据库,同一个信息可能存在不同的数据库
    private String db_source;
    public Dept(String dname) {
        this.dname = dname;
    }
    /*
    链式写法:
        Dept dept = new Dept();
        dept.setDeptno(11).setDname('ssss').setDb_source('011');
     */
}

4 服务提供者

编写springcloud-provider-dept-8001模块

4.1 导入依赖

springcloud-provider-dept-8001 : pom.xml

 <?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>springcloud</artifactId>
        <groupId>com.lv</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
 
    <artifactId>springcloud-provider-dept-8001</artifactId>
 
    <dependencies>
        <!--我们需要拿到实体类,所以要配置api module-->
        <dependency>
            <groupId>com.lv</groupId>
            <artifactId>springcloud-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--junit-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--druid数据源-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
        </dependency>
        <!--日志测试-->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
        </dependency>
        <!--SpringBoot mybatis启动器-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <!--test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-test</artifactId>
        </dependency>
        <!--web启动器-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--jetty:和tomcat差不多-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jetty</artifactId>
        </dependency>
        <!--热部署工具-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>
</project>

4.2 编写目录结构

4.3 编写配置文件

编写mybatis配置文件 mybatis-config.xml

springcloud-provider-dept-8001 : src/main/resources/mybatis/mybatis-config.xml

 <?xml version="1.0" encoding="UTF8" ?>
<!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>

编写核心配置文件 application.yaml

springcloud-provider-dept-8001 : src/main/resources/application.yaml

 server:
  port: 8001
#mybatis配置
mybatis:
  type-aliases-package: com.lv.springcloud.pojo
  config-location: classpath:mybatis/mybatis-config.xml
  mapper-locations: classpath:mybatis/mapper/*.xml
#spring的配置
spring:
  application:
    name: springcloud-provider-dept
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource #数据源
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/db01?useSSL=false&useUnicode=true&characterEncoding=utf-8
    username: root
    password: 123456

4.4 编写dao层

在dao包下新建一个DeptDao接口

springcloud-provider-dept-8001 : src/main/java/com/lv/springcloud/dao/DeptDao.java

 package com.lv.springcloud.dao;
 
import com.lv.springcloud.pojo.Dept;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;
 
import java.util.List;
 
@Mapper
@Repository
public interface DeptDao {
    public boolean addDept(Dept dept);
    public Dept queryById(Long id);
    public List<Dept> queryAll();
}

在mapper文件夹下新建一个DeptMapper.xml文件

springcloud-provider-dept-8001 : src/main/resources/mybatis/mapper/DeptMapper.xml

 <?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.lv.springcloud.dao.DeptDao">
    <insert id="addDept" parameterType="Dept">
        insert into dept(dname,db_source)
        values (#{dname},DATABASE())
    </insert>
    <select id="queryById" resultType="Dept" parameterType="Long">
        select * from dept
        where deptno = #{deptno}
    </select>
    <select id="queryAll" resultType="Dept">
        select * from dept
    </select>
</mapper>

4.5 编写service层

在service包下新建一个DeptService接口

springcloud-provider-dept-8001 : src/main/java/com/lv/springcloud/service/DeptService.java

 package com.lv.springcloud.service;
 
import com.lv.springcloud.pojo.Dept;
 
import java.util.List;
 
public interface DeptService {
    public boolean addDept(Dept dept);
    public Dept queryById(Long id);
    public List<Dept> queryAll();
}

在service包下新建一个DeptService接口对应的实现类DeptServiceImpl.java

springcloud-provider-dept-8001 : src/main/java/com/lv/springcloud/service/DeptServiceImpl.java

 package com.lv.springcloud.service;
 
import com.lv.springcloud.dao.DeptDao;
import com.lv.springcloud.pojo.Dept;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
 
import java.util.List;
 
@Service
public class DeptServiceImpl implements DeptService{
 
    @Autowired
    private DeptDao deptDao;
 
    @Override
    public boolean addDept(Dept dept) {
        return deptDao.addDept(dept);
    }
 
    @Override
    public Dept queryById(Long id) {
        return deptDao.queryById(id);
    }
 
    @Override
    public List<Dept> queryAll() {
        return deptDao.queryAll();
    }
}

4.6 编写controller层

在controller包下新建一个DeptController

springcloud-provider-dept-8001 : src/main/java/com/lv/springcloud/controller/DeptController.java

 package com.lv.springcloud.controller;
 
import com.lv.springcloud.pojo.Dept;
import com.lv.springcloud.service.DeptService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
 
import java.util.List;
 
//提供Restful服务!
@RestController
public class DeptController {
 
    @Autowired
    private DeptService deptService;
 
    @PostMapping("/dept/add")
    public boolean add(@RequestBody Dept dept){
        return deptService.addDept(dept);
    }
 
    @GetMapping("/dept/get/{id}")
    public Dept get(@PathVariable("id") Long id){
        return deptService.queryById(id);
    }
 
    @GetMapping("/dept/list")
    public List<Dept> queryAll(){
        return deptService.queryAll();
    }
}

4.7 编写主启动类

在springcloud包下新建一个DeptProvider_8001.java

springcloud-provider-dept-8001 : src/main/java/com/lv/springcloud/DeptProvider_8001.java

 package com.lv.springcloud;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
//启动类
@SpringBootApplication
public class DeptProvider_8001 {
    public static void main(String[] args) {
        SpringApplication.run(DeptProvider_8001.class,args);
    }
}

4.8 本地测试

启动主启动类,依次访问控制层中的三个请求

@GetMapping("/dept/get/{id}")请求

@GetMapping("/dept/list")请求

@PostMapping("/dept/add")请求

我们部门增加的请求是post方式,现在是以get方式请求的,所以不支持这个请求方式.

5 服务消费者

编写springcloud-consumer-dept-80模块

5.1 导入依赖

springcloud-consumer-dept-80 : pom.xml

 <?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>springcloud</artifactId>
        <groupId>com.lv</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
 
    <artifactId>springcloud-consumer-dept-80</artifactId>
 
    <!--实体类+web-->
    <dependencies>
        <dependency>
            <groupId>com.lv</groupId>
            <artifactId>springcloud-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--热部署工具-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>
 
</project>

5.2 编写目录结构

5.3 编写配置文件

编写核心配置文件 application.yaml

springcloud-consumer-dept-80 : src/main/resources/application.yaml

 server:
  port: 80

5.4 注册RestTemplate

在config包下新建一个ConfigBean.java

springcloud-consumer-dept-80 : src/main/java/com/lv/springcloud/config/ConfigBean.java

 package com.lv.springcloud.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
 
@Configuration
public class ConfigBean {//添加了@Configuration注解后这个类就相当于spring中的applicationContext.xml
    @Bean
        public RestTemplate getRestTemplate(){
        return new RestTemplate();
    }
}

5.5 编写controller层

在controller包下新建一个DeptConsumerController.java

springcloud-consumer-dept-80 : src/main/java/com/lv/springcloud/controller/DeptConsumerController.java

 package com.lv.springcloud.controller;
 
import com.lv.springcloud.pojo.Dept;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
 
import java.util.List;
 
@RestController
public class DeptConsumerController {
    //理解:消费者,不应该有service层~
    //RestTemplate .... 供我们直接调用就可以了! 注册到spring中
    //三个参数:(url,实体:Map,Class<T> responseType)
 
    @Autowired
    private RestTemplate restTemplate;//提供多种便捷访问远程http服务的方法,简单的Restful服务模板~
 
    private static final String REST_URL_PREFIX = "http://localhost:8001";
 
    @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/dept/list")
    public List<Dept> list(){
        return restTemplate.getForObject(REST_URL_PREFIX+"/dept/list",List.class);
    }
}

5.6 编写主启动类

在springcloud包下新建一个DeptConsumer_80.java

springcloud-consumer-dept-80 : src/main/java/com/lv/springcloud/DeptConsumer_80.java

 package com.lv.springcloud;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
public class DeptConsumer_80 {
    public static void main(String[] args) {
        SpringApplication.run(DeptConsumer_80.class,args);
    }
}

5.7 测试

在springcloud-provider-dept-8001运行的状态下,启动springcloud-consumer-dept-80的主启动类,保证两个模块都是运行状态.访问服务消费者控制层中的三个请求

@RequestMapping("/consumer/dept/add")

@GetMapping("/dept/get/{id}")

@GetMapping("/dept/list")

测试完成,基本环境搭建成功

刷新页面返回顶部

登录后才能查看或发表评论，立即登录或者逛逛博客园首页

相关博文：

· springcloud-学习前言

· springcloud-学习总结

· I-第一章：（3）REST 微服务案例

· 【springcloud】环境搭建与Rest使快速上手

· 【Spring】SpringCloudの環境構築（一般）

阅读排行：
· 阿里最新开源QwQ-32B，效果媲美deepseek-r1满血版，部署成本又又又降低了！
· 单线程的Redis速度为什么快？
· SQL Server 2025 AI相关能力初探
· AI编程工具终极对决：字节Trae VS Cursor，谁才是开发者新宠？
· 展开说说关于C#中ORM框架的用法！

从零开始的博客世界

大多数人都以为是才智成就了科学家，他们错了，是品格。 ——爱因斯坦