一、什麼是RestTemplate
RestTemplate是Spring提供的用於訪問Rest服務的客戶端,RestTemplate提供了多種便捷訪問遠程Http服務的方法,能夠大大提高客戶端的編寫效率。所以從本質上來說,RestTemplate並不屬於SpringCloud中的內容,而是屬於Spring中的一個生態。而SpringCloud,並不是一個框架,而是一堆框架的集合體,包含了多種技術棧。在SpringCloud中使用RestTemplate,可以更加方便地實現消費者與提供者之間的服務調用。
二、搭建工程
由於是SpringCloud項目,自然是要搭建一個總工程,下面擴展子工程,也就是將項目拆分開來,“專業的人做專業的事”。
1.使用maven創建一個簡單的工程,導入所需要的依賴
<?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.chen</groupId>
<artifactId>SpringCloud</artifactId>
<version>1.0-SNAPSHOT</version>
<!--打包方式-->
<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>
<log4j.version>1.2.17</log4j.version>
<lombok.version>1.16.18</lombok.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啓動依賴-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</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>
<!--日誌依賴-->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.2.3</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>${log4j.version}</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
個人建議:因爲總工程下的src目錄沒什麼用,所以可以把它刪掉。
2.新建api工程
在總工程下新建Module,第一個Module爲api工程,可以把它理解爲pojo類的集合,並導入依賴
<?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.chen</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>SpringCloud-api</artifactId>
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
</project>
提示:可以看到,我引入的lombok依賴在父工程中也導入了,爲什麼在子過程中引入跟父工程同樣的依賴呢?我用的是IDEA工具,可以明顯看到,我引入的lombok依賴指向了父工程的lombok依賴,並且版本號保持一致。
這裏呢我就用一個Dept(部門類)進行測試
package com.chen.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 {
private long deptno;
private String dname;
//這個數據存在哪個數據庫
private String db_source;
/**
* 鏈式寫法
* dept.setDeptNo(11).setDname('sss').setDb_source()
*/
}
3.新建服務提供者工程
該工程就是普通的SpringBoot工程了,負責數據庫的增刪改查。
導入該工程的依賴
<?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.chen</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>SpringCloud-provider-8002</artifactId>
<dependencies>
<!--我們需要拿到實體類,從api項目的pojo拿-->
<dependency>
<groupId>com.chen</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啓動依賴-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
</dependency>
<!--springboot測試依賴-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-test</artifactId>
</dependency>
<!--springboot的web依賴-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--jetty依賴相當於tomcat(springboot自帶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>
提示:我這裏引入了熱部署插件devtools,作用就是可以不重新啓動工程就可以在代碼修改後自動部署項目,但需要在IDEA工具裏面自己進行設置。所以說沒有此依賴也沒有影響,就是要自己重啓項目而已。
在application.yml中編寫配置信息
Server:
port: 8001
#mybatis配置
mybatis:
type-aliases-package: com.chen.pojo
mapper-locations: classpath:mybatis/mapper/*.xml
config-location: classpath:mybatis/mybatis-config.xml
#spring配置
spring:
application:
name: SpringCloud-provider
datasource:
type: com.alibaba.druid.pool.DruidDataSource
url: jdbc:mysql://localhost:3306/db01?useUnicode=true&serverTimezone=GMT%2B8&characterEncoding=UTF-8&useSSL=false
username: root
password: 123456
driver-class-name: org.gjt.mm.mysql.Driver
druid:
# 指明是否在從池中取出連接前進行檢驗,如果檢驗失敗, 則從池中去除連接並嘗試取出另一個,
#注意: 設置爲true後如果要生效,validationQuery參數必須設置爲非空字符串
test-on-borrow: false
# 指明連接是否被空閒連接回收器(如果有)進行檢驗.如果檢測失敗,則連接將被從池中去除.
#注意: 設置爲true後如果要生效,validationQuery參數必須設置爲非空字符串
test-while-idle: true
# 指明是否在歸還到池中前進行檢驗,注意: 設置爲true後如果要生效,
#validationQuery參數必須設置爲非空字符串
test-on-return: false
# SQL查詢,用來驗證從連接池取出的連接,在將連接返回給調用者之前.
#如果指定,則查詢必須是一個SQL SELECT並且必須返回至少一行記錄
validation-query: select 1
提示:我將端口號改成8001,目的是使用消費者來調這個服務提供者端口不衝突。
接下來就是常規操作了,寫SQL-->寫dao-->寫service-->寫service實現-->寫控制器
以下是我用到的數據庫信息
編寫Mybatis的配置信息
<?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>
編寫Mapper文件(SQL語句)
<?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="com.mapper.DeptDao">
<insert id="addDept" parameterType="Dept">
insert into dept (dname, db_source)
values (#{dname}, DATABASE());
</insert>
<select id="queryId" resultType="Dept" parameterType="java.lang.Long">
select * from dept where deptno = #{deptno};
</select>
<select id="queryAll" resultType="Dept">
select * from dept;
</select>
</mapper>
編寫dao層
package com.mapper;
import com.chen.pojo.Dept;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;
import java.util.List;
@Mapper
@Repository
public interface DeptDao {
boolean addDept(Dept dept);
Dept queryId(Long id);
List<Dept> queryAll();
}
編寫service層
package com.service;
import com.chen.pojo.Dept;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public interface DeptService {
public boolean addDept(Dept dept);
public Dept queryId(Long id);
public List<Dept> queryAll();
}
編寫service實現類
package com.service.serviceImpl;
import com.chen.pojo.Dept;
import com.mapper.DeptDao;
import com.service.DeptService;
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 queryId(Long id) {
return deptDao.queryId(id);
}
@Override
public List<Dept> queryAll() {
return deptDao.queryAll();
}
}
編寫啓動類
package com;
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);
}
}
以上都是一些常規的套路和操作,接下來就是使用RestTemplate進行服務調用。
4.新建消費者工程
所謂消費者,我的理解是前端向消費者發送請求,而消費者向服務提供者發送請求(在這過程使用RestTempate實現),而服務提供者進行數據庫的查詢及數據的處理,做一些耗時耗資源的操作。可能到這裏就會有疑惑了,爲什麼搞這麼麻煩,那就直接調服務提供者不就行了。哈哈哈,這就是分佈式的東西了,我這裏只是寫了一個服務提供者,到時候可以寫成多個服務提供者,而每個服務提供者可以說是除了端口號其他東西幾乎一模一樣,再利用負載均衡,維持系統的穩定性。
新建Module,導入依賴
<?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.chen</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>SpringCloud-consumer-80</artifactId>
<dependencies>
<!--實體類依賴,從api中導-->
<dependency>
<groupId>com.chen</groupId>
<artifactId>SpringCloud-api</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<!--spirngboot的web依賴-->
<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>
在application.yml中編寫配置信息
server:
port: 80
將 RestTemplate 的實例加載到Spring容器中
package com.chen.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
@Configuration
public class ConfigBean {
@Bean
public RestTemplate getRestTemplate() {
return new RestTemplate();
}
}
編寫控制器,供前端調用
package com.chen.controller;
import com.chen.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 {
@Autowired
private RestTemplate restTemplate;
private static final String REST_URL_PREFIX = "http://localhost:8001";
@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/add")
public boolean add(Dept dept) {
return restTemplate.postForObject(REST_URL_PREFIX +"/dept/add", dept, boolean.class);
}
@RequestMapping("/consumer/dept/list")
public List<Dept> list() {
return restTemplate.getForObject(REST_URL_PREFIX + "/dept/list", List.class);
}
}
編寫啓動類
package com.chen;
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);
}
}
至此,一個簡單的SpringCloud基於http的rest風格調用已經完成了,首先當然是要先啓動服務提供者工程,然後再啓動消費者工程,前端只需要調消費者的接口實現數據的增刪改查。