本文主要是介绍SpringCloud——REST微服务案例之微服务搭建,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
一、案例概述
以Dept部门模块做一个微服务通用案例Consumer消费者(Client)通过REST调用Provider提供者(Server)提供的服务
二、案例模块
microservicecloud父工程带着3个子模块(Module)
microservicecloud-api(封装的整体Entity/接口/公共配置等)
microservicecloud-provider-dept-8001(微服务落地的服务提供者)
microservicecloud-consumer-dept-80(微服务调用的客户端)
三、示例
1、父工程(microservicecloud):主要是定义POM文件,将后续各个子模块公用的jar包等统一提出来,类似一个抽象父类
①创建工程:maven的pom(打包方式为pom)工程
②引入依赖,完整的pom如下:
<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.atguigu.springcloud</groupId><artifactId>microservicecloud</artifactId><version>0.0.1-SNAPSHOT</version><packaging>pom</packaging><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><!-- jdk版本使用1.8 --><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>
2、公共接口API模块
①在父工程下新建一个maven模块子工程:打包方式为jar,每创建一个模块,父工程的pom文件都会添加一个子工程的module
②引入该模块自己的依赖:如lombok
<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.atguigu.springcloud</groupId><artifactId>microservicecloud</artifactId><version>0.0.1-SNAPSHOT</version></parent><!-- 当前Module名字 --><artifactId>microservicecloud-api</artifactId><!-- 当前Module需要用到的jar包,按自己需求添加,如果父类已经包含了,可以不用写 --><dependencies><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency></dependencies>
</project>
③新建部门Entity实体:
@SuppressWarnings("serial")
@NoArgsConstructor
@Data
@Accessors(chain = true)
public class Dept implements Serializable // 必须序列化
{private Long deptno; // 主键private String dname; // 部门名称private String db_source;// 来自哪个数据库,因为微服务架构可以一个服务对应一个数据库,同一个信息被存储到不同数据库public Dept(String dname) {super();this.dname = dname;}
}
④在microservicecloud-api上执行maven clean和maven install,生成相应的jar包,给其他模块引用
3、部门微服务提供者Module(microservicecloud-provider-dept-8001):
a、在父工程下新建模块microservicecloud-provider-dept-8001
b、引入依赖:
<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.atguigu.springcloud</groupId><artifactId>microservicecloud</artifactId><version>0.0.1-SNAPSHOT</version></parent><artifactId>microservicecloud-provider-dept-8001</artifactId><dependencies><dependency><!-- 引入自己定义的api通用包,可以使用Dept部门Entity --><groupId>com.atguigu.springcloud</groupId><artifactId>microservicecloud-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>
c、主配置文件配置(端口、数据源等):
server:port: 8001mybatis:config-location: classpath:mybatis/mybatis.cfg.xmltype-aliases-package: com.atguigu.springcloud.entitiesmapper-locations:- classpath:mybatis/mapper/**/*.xmlspring:application:name: microservicecloud-dept #暴露服务时的应用名datasource:type: com.alibaba.druid.pool.DruidDataSourcedriver-class-name: org.gjt.mm.mysql.Driverurl: jdbc:mysql://localhost:3306/cloudDB01username: rootpassword: 123456dbcp2:min-idle: 5initial-size: 5max-total: 5max-wait-millis: 200
d、mybatis.cfg.xml文件配置:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd"><configuration><settings><setting name="cacheEnabled" value="true" /><!-- 开启二级缓存 --></settings>
</configuration>
e、建库建表,初始化数据:
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());
f、定义DeptDao部门接口:注意使用@Mapper注解
@Mapper
public interface DeptDao {public boolean addDept(Dept dept);public Dept findById(Long id);public List<Dept> findAll();
}
g、编写Dao对应的mapper文件DeptMapper.xml:相当于是DeptDao接口的实现类
<?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.atguigu.springcloud.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>
h、定义部门服务接口DeptService:
public interface DeptService {public boolean add(Dept dept);public Dept get(Long id);public List<Dept> list();
}
i、编写部门服务接口实现类DeptServiceImpl:
@Service
public class DeptServiceImpl implements DeptService {@Autowiredprivate DeptDao dao;@Overridepublic boolean add(Dept dept) {return dao.addDept(dept);}@Overridepublic Dept get(Long id) {return dao.findById(id);}@Overridepublic List<Dept> list() {return dao.findAll();}}
j、编写部门微服务提供者的REST接口DeptController:
@RestController
public class DeptController {@Autowiredprivate DeptService service;@RequestMapping(value = "/dept/add", method = RequestMethod.POST)public boolean add(@RequestBody Dept dept) {return service.add(dept);}@RequestMapping(value = "/dept/get/{id}", method = RequestMethod.GET)public Dept get(@PathVariable("id") Long id) {return service.get(id);}@RequestMapping(value = "/dept/list", method = RequestMethod.GET)public List<Dept> list() {return service.list();}}
k、编写主启动类DeptProvider8001_App:
@SpringBootApplication
public class DeptProvider8001_App {public static void main(String args[]) {SpringApplication.run(DeptProvider8001_App.class, args);}
}
l、启动测试:
4、部门微服务消费者Module(microservicecloud-consumer-dept-80)
①在父工程下添加模块microservicecloud-consumer-dept-80
②引入依赖:
<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.atguigu.springcloud</groupId><artifactId>microservicecloud</artifactId><version>0.0.1-SNAPSHOT</version></parent><artifactId>microservicecloud-consumer-dept-80</artifactId><description>部门微服务消费者</description><dependencies><dependency><!-- 自己定义的api --><groupId>com.atguigu.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>
③主配置文件中配置端口:
server:port: 8080
④编写配置类ConfigBean:该配置类主要是为了将RestTemplate注册到IOC容器,以便于在其他组件中注入使用
@Configuration
public class ConfigBean
{@Beanpublic RestTemplate getRestTemplate(){return new RestTemplate();}
}
RestTemplate提供了多种便捷访问远程Http服务的方法,是一种简单便捷的访问restful服务模板类,是Spring提供的用于访问Rest服务的客户端模板工具集。使用restTemplate访问restful接口非常的简单粗暴无脑。(url, requestMap, ResponseBean.class)这三个参数分别代表REST请求地址、请求参数、HTTP响应被转换成的对象类型。使用方式参见文档。类似于HttpClient。
⑤编写部门微服务消费者的REST接口DeptController_Consumer:
@RestController
public class DeptController_Consumer {private static final String REST_URL_PREFIX = "http://localhost:8001";@Autowiredprivate RestTemplate restTemplate;@RequestMapping(value = "/consumer/dept/add")public boolean add(Dept dept) {return restTemplate.postForObject(REST_URL_PREFIX + "/dept/add", dept, Boolean.class);}@RequestMapping(value = "/consumer/dept/get/{id}")public Dept get(@PathVariable("id") Long id) {return restTemplate.getForObject(REST_URL_PREFIX + "/dept/get/" + id, Dept.class);}@SuppressWarnings("unchecked")@RequestMapping(value = "/consumer/dept/list")public List<Dept> list() {return restTemplate.getForObject(REST_URL_PREFIX + "/dept/list", List.class);}
}
⑥编写DeptConsumer80_App主启动类:
@SpringBootApplication
public class DeptConsumer80_App {public static void main(String[] args) {SpringApplication.run(DeptConsumer80_App.class, args);}
}
⑦测试:
这篇关于SpringCloud——REST微服务案例之微服务搭建的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!