SpringCloud笔记之Rest环境搭建

1. REST

1.1 REST的概念

---

• Spring Cloud是基于HTTP的REST方式调用的
• REST不是“rest”这个单词，而是Resource Representational State Transfer的缩写，通俗来讲就是：资源在网络中以某种表现形式进行状态转移。
  1. Resource：资源，即数据（网络的核心）
  2. Representational：某种表现形式，比如用JSON、XML、JPEG等；
  3. State Transfer：状态变化，通过HTTP动词实现
• REST描述的是在网络中 client 和 server 的一种交互形式，REST本身不实用，实用的是如何设计RestFul API（REST风格的网络接口）
• Server提供的RestFul API中，URL中只使用名词来指定资源，原则上不使用动词。“资源”是REST架构或者说整个网络处理的核心。
• 用HTTP协议里的动词来实现资源的添加，修改。
• Server和Clien之间传递某资源的一种表现形式，比如用JSON、XML传输文本，或者用JPG，WebP传输图片等
• 用HTTP Status Code传递Server 的状态信息。比如最常用的200表示成功，500表示Server内部错误等

1.2 HTTP动词

---

1. GET（SELECT）：从服务器获取资源（一项或多项）
2. POST（CREATE）：在服务器新建一个资源
3. PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）
4. PATCH（UPDATE）：在服务器更新资源（客户端提提供改变的属性）
5. DELETE（DELETE）：从服务器删除资源

比如：

GET /zoos：列出所有动物园
POST /zoos：新建一个动物园
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

1.3 REST的优点

1. 提高用户界面的便捷性（操作简单）
2. 通过简化服务器提高可伸缩性（高性能，低成本）
3. 允许组件分别优化（可以让服务端和客户端分别进行改进和优化）
4. 提高可见性（可以单独考虑每个请求）
5. 提高可靠性（更容易从局部故障中修复）
6. 提高可扩展性（降低了服务器资源使用）
7. 减少交互次数，减少交互的平均延迟

2. Rest环境搭建

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

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

2.1 创建父工程

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

---

pom.xml

<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.0modelVersion>

    <groupId>com.haustgroupId>
    <artifactId>springcloudartifactId>
    <version>1.0-SNAPSHOTversion>
    <modules>
        <module>springcloud-apimodule>
        <module>springcloud-provider-dept-8001module>
        <module>springcloud-consumer-dept-80module>
    modules>

    
    <packaging>pompackaging>

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

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloudgroupId>
                <artifactId>spring-cloud-alibaba-dependenciesartifactId>
                <version>0.2.0.RELEASEversion>
                <type>pomtype>
                <scope>importscope>
            dependency>
            
            <dependency>
                <groupId>org.springframework.cloudgroupId>
                <artifactId>spring-cloud-dependenciesartifactId>
                <version>Greenwich.SR1version>
                <type>pomtype>
                <scope>importscope>
            dependency>
            
            <dependency>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-dependenciesartifactId>
                <version>2.1.4.RELEASEversion>
                <type>pomtype>
                <scope>importscope>
            dependency>
            
            <dependency>
                <groupId>mysqlgroupId>
                <artifactId>mysql-connector-javaartifactId>
                <version>5.1.47version>
            dependency>
            <dependency>
                <groupId>com.alibabagroupId>
                <artifactId>druidartifactId>
                <version>1.1.10version>
            dependency>
            
            <dependency>
                <groupId>org.mybatis.spring.bootgroupId>
                <artifactId>mybatis-spring-boot-starterartifactId>
                <version>1.3.2version>
            dependency>
            
            <dependency>
                <groupId>ch.qos.logbackgroupId>
                <artifactId>logback-coreartifactId>
                <version>1.2.3version>
            dependency>
            <dependency>
                <groupId>junitgroupId>
                <artifactId>junitartifactId>
                <version>${junit.version}version>
            dependency>
            <dependency>
                <groupId>log4jgroupId>
                <artifactId>log4jartifactId>
                <version>${log4j.version}version>
            dependency>
            <dependency>
                <groupId>org.projectlombokgroupId>
                <artifactId>lombokartifactId>
                <version>${lombok.version}version>
            dependency>
        dependencies>
    dependencyManagement>

project>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

2.2 创建子模块

---

父工程为springcloud，其下有多个子module

• springcloud-api : 只放实体类（Dept）
• springcloud-provider-dept-8001：提供者，负责给消费者提供接口
• springcloud-consumer-dept-80 ： 消费者，负责从提供者中调用接口

2.3 api接口

---

springcloud-api

Dept.java

/**
 * @author qin jin
 * @date 2022/9/18 18:36
 */
@Data
@NoArgsConstructor
@Accessors( chain = true ) // 链式写法
public class Dept implements Serializable {
    private Long deptno;
    private String dname;
    private String db_source;

    public Dept(String dname){
        this.dname = dname;
    }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

2.4 提供者

---

springcloud-provider-dept-8001

DeptController.java

/**
 * @author qin jin
 * @date 2022/9/18 19:56
 */

//提供Restful 服务!
@RestController
public class DeptController {

    @Autowired
    private DeptService deptService;

    @PostMapping("/dept/add")
    public boolean addDept(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();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

2.5 消费者

---

springcloud-consumerdept-80

springcloud-consumerdept-80访问springcloud-provider-dept-8001下的controller使用REST方式

DeptConSumerController.java

/**
 * @author qin jin
 * @date 2022/9/18 21:54
 */
@RestController
public class DeptConsumerController {
    //消费者 不应该有service层 ，应该调用提供者的接口
    //RestTemplate

    @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);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

使用RestTemplete先需要放入Spring容器中

---

ConfigBean .java

@Configuration
public class ConfigBean {//@Configuration -- spring  applicationContext.xml

    //配置负载均衡实现RestTemplate
    // IRule
    // RoundRobinRule 轮询
    // RandomRule 随机
    // AvailabilityFilteringRule ： 会先过滤掉，跳闸，访问故障的服务~，对剩下的进行轮询~
    // RetryRule ： 会先按照轮询获取服务~，如果服务获取失败，则会在指定的时间内进行，重试
    @Bean
    public RestTemplate getRestTemplate(){
        return new RestTemplate();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

springcloud-provider-dept-8001的dao接口调用springcloud-api模块下的pojo，可使用在springcloud-provider-dept-8001的pom文件导入springcloud-api模块依赖的方式：

<dependency>
    <groupId>com.xawlgroupId>
    <artifactId>springcloud-apiartifactId>
    <version>1.0-SNAPSHOTversion>
dependency>
1
2
3
4
5
6

springcloud-consumer-dept-80和springcloud-provider-dept-8001的pom.xml和父工程下的依赖基本一样