看该博客之前,建立大家有maven,springboot基础,以及微服务架构概念;如果没有微服务架构思想的话可以看下我发表的一篇博客。
链接如下:
微服务架构描述
以下使用的编辑器是IDEA
开发环境要求:
jdk1.8(springboot推荐jdk1.8及以上)
maven 3.x(maven3.2以上版本)
sringboot:springboot2.0.7
springcloud使用当前最新稳定版本
官网:springcloud官网
现在我们就来搭建Rest分布式微服务架构实战项目
步骤:
- 修改maven配置文件:在maven安装目录下的settings.xml配置文件中,添加以下配置。
<!--开始处更改下载依赖的存放路径, 以下目录需要已经创建-->
<localRepository>D:\javasource\maven-repository</localRepository>
<!--在 mirrors 标签下 添加阿里云maven私服库-->
<mirrors>
<mirror>
<id>alimaven</id>
<mirrorOf>central</mirrorOf>
<name>aliyun maven</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
</mirror>
</mirrors>
<!-- 在 profiles 标签下指定jdk版本 -->
<profile>
<id>jdk-1.8</id>
<activation>
<activeByDefault>true</activeByDefault>
<jdk>1.8</jdk>
</activation>
<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>
</properties>
</profile>
-
IDEA设置
在idea上将maven环境添加进去
微服务架构实战项目介绍:- 项目需求:
本项目采用商品管理模块做一个微服务架构通用案例,消费者通过REST调用提供者提供的商品管理服务。
maven的分包分模块架构 -
一个 Project 父工程下有多个 Module 子模块
-
microservice-cloud-01 父工程(Project)下初始化3个子模块(Module):
- microservice-cloud-02-api 封装的整体Entity/接口/公共配置等
- microservice-cloud-03-provider-product-8001 微服务的服务提供者Provider
- microservice-cloud-04-consumer-product-80 微服务的服务消费者Consumer
浏览器发送URL请求服务默认的端口号都是80,因此只需输入IP或域名即可,可省略 :80
以上设置的微服务提供者端口是8001,消费者端口是80
根据以上描述,我们就可以开始搭建项目工程了
1. 创建一个空工程
工程取名为springcloud,放在d盘ideaProject目录下
2. 创建父工程(pom类型)
注意:父工程必须是pom类型
取名为:microservice-cloud-01
稍等一下,工程模板就下载好了
删除该空工程下src目录及子目录,在pom.xml中手动指定为pom类型
手动指定package为pom类型
3. 在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.mengxuegu.springcloud</groupId>
<artifactId>microservice-cloud-01</artifactId>
<version>1.0-SNAPSHOT</version>
<!--手动指定 pom -->
<packaging>pom</packaging>
<!-- spring boot 采用 2.0.7 版本 -->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.7.RELEASE</version>
<relativePath/>
</parent>
<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>
<!-- spring cloud 采用 Finchley.SR2 版本 -->
<spring-cloud.version>Finchley.SR2</spring-cloud.version>
</properties>
<!--依赖声明-->
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<!--maven不支持多继承,使用import来依赖管理配置-->
<scope>import</scope>
</dependency>
<!--导入 mybatis 启动器-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>
<!--druid数据源-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.12</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.13</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
</dependencyManagement>
</project>
4. 创建公共模块(microservice-cloud-02-api)
鼠标右键上面构建的父工程
创建完成之后,我们可以看一下父工程pom.xml文件的变化
5. 新建商品实体类
package com.mengxuegu.springcloud.entities;
import java.io.Serializable;
/**
* @Auther: xiaomingjun
*/
public class Product implements Serializable {//必须序列化
private Long pid; //主键
private String productName; //产品名称
// 来自那个数据库,因为微服务架构可以一个服务对应一个数据库,同一个信息被存储到不同数据库
private String dbSource;
public Product(String productName) {
this.productName = productName;
}
public Product(Long pid, String productName, String dbSource) {
this.pid = pid;
this.productName = productName;
this.dbSource = dbSource;
}
public Product() {
}
public Long getPid() {
return pid;
}
public void setPid(Long pid) {
this.pid = pid;
}
public String getProductName() {
return productName;
}
public void setProductName(String productName) {
this.productName = productName;
}
public String getDbSource() {
return dbSource;
}
public void setDbSource(String dbSource) {
this.dbSource = dbSource;
}
}
6. 创建服务提供者工程(microservice-cloud-03-provider-product-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>microservice-cloud-01</artifactId>
<groupId>com.mengxuegu.springcloud</groupId>
<version>1.0-SNAPSHOT</version>
<relativePath>../microservice-cloud-01/pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>microservice-cloud-03-provider-product-8001</artifactId>
<dependencies>
<dependency>
<groupId>com.mengxuegu.springcloud</groupId>
<artifactId>microservice-cloud-02-api</artifactId>
<version>${project.version}</version>
</dependency>
<!--springboot web启动器-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mybatis 启动器-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</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>
</dependencies>
</project>
配置application.yml文件
在src/main/resources下新建application.yml文件,配置如下:
server:
port: 8001
mybatis:
config-location: classpath:mybatis/mybatis.cfg.xml # mybatis配置文件所在路径
type-aliases-package: com.mengxuegu.springcloud.entities # 所有Entity别名类所在包
mapper-locations: classpath:mybatis/mapper/**/*.xml # mapper映射文件
spring:
application:
name: microservice-product #这个很重要,这在以后的服务与服务之间相互调用一般都是根据这个name
datasource:
type: com.alibaba.druid.pool.DruidDataSource # 当前数据源操作类型
driver-class-name: com.mysql.cj.jdbc.Driver # mysql驱动包
url: jdbc:mysql://127.0.0.1:3306/springcloud_db01?serverTimezone=GMT%2B8 # 数据库名称
username: root
password: root
dbcp2:
min-idle: 5 # 数据库连接池的最小维持连接数
initial-size: 5 # 初始化连接数
max-total: 5 # 最大连接数
max-wait-millis: 150 # 等待连接获取的最大超时时间
运行mysql数据库
DROP DATABASE IF EXISTS springcloud_db01;
CREATE DATABASE springcloud_db01 CHARACTER SET UTF8;
USE springcloud_db01;
CREATE TABLE product
(
pid BIGINT NOT NULL PRIMARY KEY AUTO_INCREMENT,
product_name VARCHAR(50),
db_source VARCHAR(50)
);
INSERT INTO product(product_name,db_source) VALUES('格力空调',DATABASE());
INSERT INTO product(product_name,db_source) VALUES('海尔冰箱',DATABASE());
INSERT INTO product(product_name,db_source) VALUES('小短裙',DATABASE());
INSERT INTO product(product_name,db_source) VALUES('羽绒服',DATABASE());
INSERT INTO product(product_name,db_source) VALUES('韩版休闲鞋',DATABASE());
INSERT INTO product(product_name,db_source) VALUES('高贵鞋',DATABASE());
SELECT * FROM product;
创建mapper接口
package com.mengxuegu.springcloud.mapper;
import com.mengxuegu.springcloud.entities.Product;
import java.util.List;
/**
* @Auther: xiaomingjun
*/
//@Mapper //或在主启动类上使用@MapperScan注解
public interface ProductMapper {
Product findById(Long pid);
List<Product> findAll();
boolean addProduct(Product product);
}
mybatis相关配置
在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="mapUnderscoreToCamelCase" value="true"/>
</settings>
</configuration>
在src/main/resources/mybatis下新建mapper目录后新建ProductMapper.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.mengxuegu.springcloud.mapper.ProductMapper">
<select id="findById" resultType="Product" parameterType="Long">
select pid, product_name, db_source from product where pid=#{pid};
</select>
<select id="findAll" resultType="Product">
select pid, product_name, db_source from product;
</select>
<insert id="addProduct" parameterType="Product">
INSERT INTO product(product_name, db_source) VALUES(#{productName},
DATABASE());
</insert>
</mapper>
创建服务层
服务接口
package com.mengxuegu.springcloud.service;
import com.mengxuegu.springcloud.entities.Product;
import java.util.List;
/**
* @Auther: xiaomingjun
*/
public interface ProductService {
boolean add(Product product);
Product get(Long id);
List<Product> list();
}
服务接口实现
package com.mengxuegu.springcloud.service.impl;
import com.mengxuegu.springcloud.entities.Product;
import com.mengxuegu.springcloud.mapper.ProductMapper;
import com.mengxuegu.springcloud.service.ProductService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
/**
* @Auther: xiaomingjun
*/
@Service
public class ProductServiceImpl implements ProductService {
@Autowired
private ProductMapper productMapper;
@Override
public boolean add(Product product) {
return productMapper.addProduct(product);
}
@Override
public Product get(Long id) {
return productMapper.findById(id);
}
@Override
public List<Product> list() {
return productMapper.findAll();
}
}
创建控制层-提供者ProductController
package com.mengxuegu.springcloud.controller;
import com.mengxuegu.springcloud.entities.Product;
import com.mengxuegu.springcloud.service.ProductService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/**
* @Auther: xiaomingjun
*/
@RestController
public class ProductController {
@Autowired
private ProductService productService;
@RequestMapping(value = "/product/add", method = RequestMethod.POST)
public boolean add(@RequestBody Product product) {
return productService.add(product);
}
@RequestMapping(value = "/product/get/{id}", method = RequestMethod.GET)
public Product get(@PathVariable("id") Long id) {
return productService.get(id);
}
@RequestMapping(value = "/product/list", method = RequestMethod.GET)
public List<Product> list() {
return productService.list();
}
}
创建主启动类:MicroserviceProductProvider_8001
package com.mengxuegu.springcloud;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @Auther: 梦学谷
*/
@MapperScan("com.mengxuegu.springcloud.mapper") //扫描所有Mapper接口
@SpringBootApplication
public class ProductProvider_8001 {
public static void main(String[] args) {
SpringApplication.run(MicroserviceProductProvider_8001.class, args);
}
}
至此,服务提供者工程已经搭建好了。
测试:
http://localhost:8001/product/get/3
http://localhost:8001/product/list
我们发现服务提供者工程测试成功了。
7. 构建服务消费者工程:microservice-cloud-04-consumer-product-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>microservice-cloud-01</artifactId>
<groupId>com.mengxuegu.springcloud</groupId>
<version>1.0-SNAPSHOT</version>
<relativePath>../microservice-cloud-01/pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>microservice-cloud-04-consumer-product-80</artifactId>
<dependencies>
<dependency>
<groupId>com.mengxuegu.springcloud</groupId>
<artifactId>microservice-cloud-02-api</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
</project>
配置application.yml文件
在src/main/resources下新建application.yml文件,并做如下配置:
server:
port: 80
自定义Rest相关配置类
- 创建配置类:ConfigBean
- 向容器中注入 RestTemplate 组件, 提供了多种简单便捷的访问 Restful服务的方法,是Spring提供的用于访问Rest服务的客户端模板工具集。 (url, requestMap,ResponseBean.class)这三个参数分别代表:REST请求地址、请求参数、HTTP响应转换被转换成的对象类型.
package com.mengxuegu.springcloud.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
/**
* 自定义配置类,
* @Auther: xiaomingjun
*/
@Configuration
public class ConfigBean {
// 向容器中添加 RestTemplate 组件,直接通过此组件可调用 REST 接口
@Bean
public RestTemplate getRestTemplate() {
return new RestTemplate();
}
}
创建控制层-消费者ProductController_Consumer
package com.mengxuegu.springcloud.controller;
import com.mengxuegu.springcloud.entities.Product;
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;
/**
* @Auther: xiaomingjun
*/
@RestController
public class ProductController_Consumer {
private static final String REST_URL_PREFIX = "http://localhost:8001";
@Autowired
private RestTemplate restTemplate;
@RequestMapping(value = "/consumer/product/add")
public boolean add(Product product) {
return restTemplate.postForObject(REST_URL_PREFIX + "/product/add",
product, Boolean.class);
}
@RequestMapping(value = "/consumer/product/get/{id}")
public Product get(@PathVariable("id") Long id) {
return restTemplate.getForObject(REST_URL_PREFIX + "/product/get/" + id,
Product.class);
}
@RequestMapping(value = "/consumer/product/list")
public List<Product> list() {
return restTemplate.getForObject(REST_URL_PREFIX + "/product/list",
List.class);
}
}
创建主启动类
package com.mengxuegu.springcloud;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @Auther: xiaomingjun
*/
@SpringBootApplication
public class ProductConsumer_80 {
public static void main(String[] args) {
SpringApplication.run(MicroserviceProductConsumer_80.class, args);
}
}
至此服务消费者工程就搭建好了,现在我们可以来测试了。来看看服务消费者工程是否能够调用服务提供者提供的服务。
先启动服务提供者工程,再启动服务消费者工程。
http://localhost/consumer/product/get/3
http://localhost/consumer/product/list
http://localhost/consumer/product/add?productName=python
经过以上测试,我们就已经完成了springcloud微服务之间的通信
之后,我将陆续发表springcloud的技术栈,感兴趣的道友们可以关注我,感谢大家的阅读;祝大家快速掌握微服务架构的技术栈。