SpringCloud Rest学习环境搭建:服务提供者和消费者
介绍
我们要使用一个Dept部门模块做一个微服务通用案例Consumer消费者(Client)通过REST调用Provider提供者(Server)提供的服务。
一个父工程带着多个Moudule子模块
MicroServiceCloud父工程(Project)下初次带着3个子模块(Module)
- microservicecloud-api 【封装的整体entity/接口/公共配置等】
- microservicecloud-consumer-dept-80 【服务提供者】
- microservicecloud-provider-dept-8001 【服务消费者】
SpringCloud版本选择
SpringCloud版本是要和SpringBoot的版本对应起来的,比如说我用的SpringBoot版本是2.2.5.RELEASE,对应的SpringCloud版本就是Hoxton.SR3
创建项目
新建父工程项目SpringCloud,Packageing是pom模式
类似一个抽象父类,将后续各个子模块公用的jar包等统一提取出来。
建立数据库cloud。
create table dept(
deptno bigint primary key not null auto_increment,
dname varchar(60),
db_sourse varchar(60)
);
insert into dept(dname,db_sourse) values('开发部',database());
insert into dept(dname,db_sourse) values('人事部',database());
insert into dept(dname,db_sourse) values('财务部',database());
insert into dept(dname,db_sourse) values('市场部',database());
insert into dept(dname,db_sourse) values('运营部',database());
配置父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.example</groupId>
<artifactId>SpringCloud</artifactId>
<version>1.0-SNAPSHOT</version>
<!--这里放的是子模块-->
<modules>
<module>SpringCloud-api</module>
<module>SpringCloud-provider-dept-8001</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>
<mysql.version>5.1.47</mysql.version>
<spring-cloud.vesion>Hoxton.SR3</spring-cloud.vesion>
<spring-boot.version>2.2.5.RELEASE</spring-boot.version>
<druid.version>1.1.14</druid.version>
<mybatis-spring-boot-starter.version>1.1.1</mybatis-spring-boot-starter.version>
<lombok.version>1.18.8</lombok.version>
<log4j.version>1.2.17</log4j.version>
<logback-core.version>1.2.7</logback-core.version>
</properties>
<dependencyManagement>
<dependencies>
<!-- springcloud的依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.vesion}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!--springboot依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-actuator</artifactId>
<version>${spring-boot.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!--数据库 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
<!--数据源 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>${druid.version}</version>
</dependency>
<!-- SpringBoot启动器-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>${mybatis-spring-boot-starter.version}</version>
</dependency>
<!-- 日志测试-->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>${logback-core.version}</version>
</dependency>
<!-- junit-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</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>
创建子模块-服务提供者
子模块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.example</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>
创建实体类
Dept.java
package com.springcloud.entity;
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;
}
public void setDb_source(String db_source) {
this.db_source = db_source;
}
/*
链式写法:
Dept dept = new Dept();
dept.setDeptNo(11).setDname('ssss').setDb_source('001');
*/
}
子模块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.example</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>SpringCloud-provider-dept-8001</artifactId>
<dependencies>
<!-- 我们要拿到实体类,所以要配置api module-->
<dependency>
<groupId>com.example</groupId>
<artifactId>SpringCloud-api</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<!-- junit -->
<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>
<!--test-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-test</artifactId>
</dependency>
<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>
接口层mapper
DeptMapper.java
package com.springcloud.mapper;
import com.springcloud.entity.Dept;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;
import java.util.List;
@Mapper
@Repository
public interface DeptMapper {
public boolean addDept(Dept dept);
public Dept queryById(Long id);
public List<Dept> queryAll();
}
服务层service
DeptService.java
package com.springcloud.service;
import com.springcloud.entity.Dept;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;
public interface DeptService {
public boolean addDept(Dept dept);
public Dept queryById(Long id);
public List<Dept> queryAll();
}
DeptServiceImpl.java
package com.springcloud.service;
import com.springcloud.entity.Dept;
import com.springcloud.mapper.DeptMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class DeptServiceImpl implements DeptService{
@Autowired
private DeptMapper deptMapper;
@Override
public boolean addDept(Dept dept){
return deptMapper.addDept(dept);
}
@Override
public Dept queryById(Long id){
return deptMapper.queryById(id);
}
@Override
public List<Dept> queryAll(){
return deptMapper.queryAll();
}
}
controller层
DeptController.java
package com.springcloud.controller;
import com.springcloud.entity.Dept;
import com.springcloud.service.DeptService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
//提供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();
}
}
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="com.springcloud.mapper.DeptMapper">
<insert id="addDept" parameterType="Dept">
insert into cloud.dept (dname,db_source)
value (#{dname},DATABASE())
</insert>
<select id="queryById" parameterType="Long" resultType="Dept">
select * from cloud.dept where deptno = #{deptno};
</select>
<select id="queryAll" resultType="Dept">
select * from cloud.dept;
</select>
</mapper>
application.yml配置文件。
server:
port: 8001
#mybatis的配置
mybatis:
type-aliases-package: com.springcloud
# config-location: classpath:mybatis-config.xml
mapper-locations: classpath:mapper/*Mapper.xml
#Spring的配置
spring:
# application:
# name: SpringCloud-provider-dept
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/cloud?useUnicode=true&characterEncoding=utf-8&useSSL=false
username: root
password: 123456
调用接口
创建子模块-服务消费者
子模块SpringCloud-consumer-dept-800
消费者比较方便的一点就是拿到远程url地址就行,直接从地址发送请求就行。
消费者是不需要service层的只访问就可以了,端口默认是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.example</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>SpringCloud-consumer-dept-800</artifactId>
<!--消费者和前端挂钩,不连接数据库-->
<!--实体类+web-->
<dependencies>
<dependency>
<groupId>com.example</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>
springcloud-consumer-dept-80访问springcloud-provider-dept-8001下的controller使用REST方式.
DeptConsumerController.java
package com.springcloud.controller;
import com.springcloud.entity.Dept;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
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)
//提供多种便捷访问远程http服务的方法,简单的Restful服务模板
@Autowired
private RestTemplate restTemplate;
//服务提供方地址前缀
//Ribbon:我们这里的地址,应该是一个变量,通过服务名来访问
private static final String REST_URL_PREFIX="http://localhost:8001";
/**
* 消费方添加部门信息
* @param dept
* @return
*/
@RequestMapping("/consumer/dept/add")
public boolean add(Dept dept) {
// postForObject(服务提供方地址(接口),参数实体,返回类型.class)
return restTemplate.postForObject(REST_URL_PREFIX + "/dept/add", dept, Boolean.class);
}
/**
*
* @param id
* @return
*/
//消费方根据id查询部门信息
@RequestMapping("/consumer/dept/get/{id}")
public Dept get(@PathVariable("id")Long id){
return restTemplate.getForObject(REST_URL_PREFIX+"/dept/get"+id,Dept.class);
}
/**
* 消费方查询部门信息列表
* @return
*/
@RequestMapping ("/consumer/dept/list")
public List<Dept> list() {
return restTemplate.getForObject(REST_URL_PREFIX + "/dept/list", List.class);
}
}
使用RestTemplete先需要放入Spring容器中
ConfigBean.java
package com.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
//配置负载均衡实现RestTemplate
// IRule
// RoundRobinRule 轮询
// RandomRule 随机
// AvailabilityFilteringRule : 会先过滤掉,跳闸,访问故障的服务~,对剩下的进行轮询~
// RetryRule : 会先按照轮询获取服务~,如果服务获取失败,则会在指定的时间内进行,重试
@Bean
public RestTemplate getRestTemplate(){
return new RestTemplate();
}
}
配置文件只写个端口就行
启动类也要加上
调用
可以看到消费者和服务提供者的url不一样。