目录:
架构:
1、父工程构建步骤
1.1、构建项目
1.2、pom.xml
2、API公共模块和部门Entity步骤
2.1、构建项目
2.2、pom.xml
2.3、新建部门Entity且配合Lombok使用
3、SpringCloud Rest微服务案例——部门服务提供者
3.1、构建项目
3.2、pom.xml
3.3、application.yml
3.4、工程src/main/resources目录下新建mybatis文件夹后新建mybatis.cfg.xml文件
3.5、MySQL创建部门数据库脚本
3.6、DeptDao部门接口
3.7、工程src/main/resources/mybatis目录下新建mapper文件夹后再建DeptMapper.xml
3.8、DeptService部门服务接口
3.9、DeptServiceImpl部门服务接口机实现类
3.10、DeptController部门微服务提供者REST
3.11、主启动类DeptProvider8001_App
3.12、测试
4、SpringCloud Rest微服务案例——部门服务消费者
4.1、构建项目
4.2、pom.xml
4.3、application.yml
4.4、新建DeptController_Consumer部门微服务消费者REST
4.5、DeptConsumer80_App主启动类
4.6、注入RestTemplate
4.7、测试
架构:
以Dept部门模块做一个微服务通用案例,Consumer消费者(Client)通过REST调用Provider提供者(Server)提供的服务。
microservice-parent父工程(Project)下初次带着3个子模块(Module)
microservice-parent://父工程
——microservice-api // 封装的整体Entity/接口/公共配置等
——microservice-provider-dept-8001 //微服务落地的服务提供者
——microservice-consumer-dept-80 //微服务调用的客户端使用
1、父工程构建步骤
1.1、构建项目
1.2、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.0</modelVersion>
<groupId>com.myron</groupId>
<artifactId>microservice-parent</artifactId>
<version>0.0.1-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>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Dalston.SR1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>1.5.9.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.0.4</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.0.31</version>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.2.3</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>${log4j.version}</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
主要是定义POM文件,将后续各个子模块公用的jar包等统一提出来,类似一个抽象父类。
2、API公共模块和部门Entity步骤
2.1、构建项目
在microservice-parent项目基础上构建子模块项目。
创建完成后回到父工程查看pom文件的变化:
父工程pom下多了该模块依赖:
<modules>
<module>microservice-api</module>
</modules>
2.2、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.0</modelVersion>
<parent> <!-- 子类里面显示声明才能有明确的继承表现,无意外就是父类的默认版本否则自己定义 -->
<groupId>com.myron</groupId>
<artifactId>microservice-parent</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<artifactId>microservice-api</artifactId> <!-- 当前Module我自己叫什么名字 -->
<dependencies><!-- 当前Module需要用到的jar包,按自己需求添加,如果父类已经包含了,可以不用写版本号 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
</project>
2.3、新建部门Entity且配合Lombok使用
package com.myron.entities;
import java.io.Serializable;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import lombok.experimental.Accessors;
/**
* 部门实体类:
*
*/
@NoArgsConstructor //生成一个无参数的构造方法
@AllArgsConstructor //会生成一个包含所有变量的构造方法
@Data //@Data 注解就可以有下面几个注解的功能: @ToString、@Getter、@Setter、@EqualsAndHashCode、@NoArgsConstructor
//注意的是,同时使用@Data 和 @AllArgsConstructor 后 ,默认的无参构造函数失效,如果需要它,要重新设置 @NoArgsConstructors
@Accessors(chain=true) //用来配置lombok如何产生和显示getters和setters的方法
@ToString
public class Dept implements Serializable{ //Dept(Entity) orm mysql->Dept(table) 类表关系映射
private Long deptno; //主键
private String dname; //部门名称
private String db_source; //来自那个数据库,因为微服务架构可以一个服务对应一个数据库,同一个信息存储到不同数据库
}
mvn clean install后给其他模块引用,达到通用目的。也即需要用到部门实体的话,不用每个工程都定义一份,直接引用本模块 即可。
3、SpringCloud Rest微服务案例——部门服务提供者
3.1、构建项目
New Maven Module:
3.2、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.0</modelVersion>
<parent>
<groupId>com.myron</groupId>
<artifactId>microservice-parent</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<artifactId>microservice-provider-dept-8001</artifactId>
<dependencies>
<!-- 引入自己定义的api通用包,可以使用Dept部门Entity -->
<dependency>
<groupId>com.myron</groupId>
<artifactId>microservice-api</artifactId>
<version>${project.version}</version>
</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>
<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>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jetty</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>
<!-- 修改后立即生效,热部署 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>springloaded</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
</dependency>
</dependencies>
</project>
3.3、application.yml
server:
port: 8001
mybatis:
config-location: classpath:mybatis/mybatis.cfg.xml # mybatis配置文件所在路径
type-aliases-package: com.myron.entities # 所有Entity别名类所在包
mapper-locations:
- classpath:mybatis/mapper/**/*.xml # mapper映射文件
spring:
application:
name: dept-provider
datasource:
type: com.alibaba.druid.pool.DruidDataSource # 当前数据源操作类型
driver-class-name: org.gjt.mm.mysql.Driver # mysql驱动包
url: jdbc:mysql://localhost:3306/cloudDB01 # 数据库名称
username: root
password: root
dbcp2:
min-idle: 5 # 数据库连接池的最小维持连接数
initial-size: 5 # 初始化连接数
max-total: 5 # 最大连接数
max-wait-millis: 200 # 等待连接获取的最大超时时间
3.4、工程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="cacheEnabled" value="true" /><!-- 二级缓存开启 -->
</settings>
</configuration>
3.5、MySQL创建部门数据库脚本
DROP DATABASE IF EXISTS cloudDB01;
CREATE DATABASE cloudDB01 CHARACTER SET UTF8;
USE cloudDB01;
CREATE TABLE dept
(
deptno BIGINT NOT NULL PRIMARY KEY AUTO_INCREMENT,
dname VARCHAR(60),
db_source VARCHAR(60)
);
INSERT INTO dept(dname,db_source) VALUES('开发部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('人事部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('财务部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('市场部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('运维部',DATABASE());
SELECT * FROM dept;
3.6、DeptDao部门接口
package com.myron.dao;
import java.util.List;
import org.apache.ibatis.annotations.Mapper;
import com.myron.entities.Dept;
@Mapper
public interface DeptDao
{
public boolean addDept(Dept dept);
public Dept findById(Long id);
public List<Dept> findAll();
}
3.7、工程src/main/resources/mybatis目录下新建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.myron.dao.DeptDao">
<select id="findById" resultType="Dept" parameterType="Long">
select deptno,dname,db_source from dept where deptno=#{deptno};
</select>
<select id="findAll" resultType="Dept">
select deptno,dname,db_source from dept;
</select>
<insert id="addDept" parameterType="Dept">
INSERT INTO dept(dname,db_source) VALUES(#{dname},DATABASE());
</insert>
</mapper>
3.8、DeptService部门服务接口
package com.myron.service;
import java.util.List;
import com.nari.entities.Dept;
public interface DeptService
{
public boolean add(Dept dept);
public Dept get(Long id);
public List<Dept> list();
}
3.9、DeptServiceImpl部门服务接口机实现类
package com.myron.service.impl;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.myron.dao.DeptDao;
import com.myron.entities.Dept;
import com.myron.service.DeptService;
@Service
public class DeptServiceImpl implements DeptService
{
@Autowired
private DeptDao dao;
//添加部门
@Override
public boolean add(Dept dept)
{
return dao.addDept(dept);
}
//根据id获取部门信息
@Override
public Dept get(Long id)
{
return dao.findById(id);
}
//获取所有部门信息
@Override
public List<Dept> list()
{
return dao.findAll();
}
}
3.10、DeptController部门微服务提供者REST
package com.myron.controller;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import com.myron.entities.Dept;
import com.myron.service.DeptService;
@RestController
@RequestMapping("/provider/dept")
public class DeptController
{
@Autowired
private DeptService service;
@Autowired
private DiscoveryClient client;
@RequestMapping(value = "/add", method = RequestMethod.POST)
public boolean add(@RequestBody Dept dept)
{
return service.add(dept);
}
@RequestMapping(value = "/get/{id}", method = RequestMethod.GET)
public Dept get(@PathVariable("id") Long id)
{
return service.get(id);
}
@RequestMapping(value = "/list", method = RequestMethod.GET)
public List<Dept> list()
{
return service.list();
}
}
3.11、主启动类DeptProvider8001_App
package com.myron;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class DeptProvider8001_App
{
public static void main(String[] args)
{
SpringApplication.run(DeptProvider8001_App.class, args);
}
}
3.12、测试
4、SpringCloud Rest微服务案例——部门服务消费者
4.1、构建项目
在microservice-parent上构建消费端模块项目。
4.2、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.0</modelVersion>
<parent>
<groupId>com.myron</groupId>
<artifactId>microservicecloud</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<artifactId>microservice-consumer-dept-80</artifactId>
<description>部门微服务消费者</description>
<dependencies>
<dependency><!-- 自己定义的api -->
<groupId>com.myron.springcloud</groupId>
<artifactId>microservicecloud-api</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 修改后立即生效,热部署 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>springloaded</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
</dependency>
</dependencies>
</project>
4.3、application.yml
server:
port: 80
4.4、新建DeptController_Consumer部门微服务消费者REST
package com.myron.controller;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
import com.myron.entities.Dept;
/**
* 服务消费者:
*
*/
@RestController
@RequestMapping("/consumer/dept")
public class DeptController_Consumer {
private static final String REST_URL_PREFIX = "http://localhost:8001/provider/dept"; //http://注意一定要加上,否则会报异常
/**
* 使用 使用restTemplate访问restful接口非常的简单粗暴。 (url, requestMap,
* ResponseBean.class)这三个参数分别代表 REST请求地址、请求参数、HTTP响应转换被转换成的对象类型。
*/
@Autowired
private RestTemplate restTemplate;
@RequestMapping(value = "/add", method = RequestMethod.POST)
public boolean add(Dept dept) {
String url = REST_URL_PREFIX + "/add";
return restTemplate.postForObject(url, dept, Boolean.class);
}
@RequestMapping(value = "/get/{id}", method = RequestMethod.GET)
public Dept get(@PathVariable("id") Long id) {
String url = REST_URL_PREFIX + "/get/" + id;
return restTemplate.getForObject(url, Dept.class);
}
@SuppressWarnings("unchecked")
@RequestMapping(value = "/list" , method = RequestMethod.GET)
public List<Dept> list() {
String url = REST_URL_PREFIX + "/list";
return restTemplate.getForObject(url, List.class);
}
}
4.5、DeptConsumer80_App主启动类
package com.myron;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
/**
* 部门消费者启动类:
*
*/
@SpringBootApplication
public class DeptConsumer80_App {
public static void main(String[] args) {
SpringApplication.run(DeptConsumer80_App.class, args);
}
}
4.6、注入RestTemplate
package com.myron.cfgbeans;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
@Configuration
public class ConfigBean { //boot -->spring applicationContext.xml --- @Configuration配置 ConfigBean = applicationContext.xml
@Bean
public RestTemplate getRestTemplate() {
return new RestTemplate();
}
}
4.7、测试
首先启动DeptProvider8001_App服务提供者,然后启动DeptConsumer80_App服务消费者,即可调用服务。