SpringCloud——REST微服务案例之微服务搭建

2023-10-18 17:32
文章标签 java 服务 spring 搭建 案例 springcloud rest 之微

本文主要是介绍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微服务案例之微服务搭建的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/234112。

相关文章

Java 实用工具类Spring 的 AnnotationUtils详解

Java 实用工具类Spring 的 AnnotationUtils详解

《Java实用工具类Spring的AnnotationUtils详解》Spring框架提供了一个强大的注解工具类org.springframework.core.annotation.Annot... 目录前言一、AnnotationUtils 的常用方法二、常见应用场景三、与 JDK 原生注解 API 的
阅读更多...
Java controller接口出入参时间序列化转换操作方法(两种)

Java controller接口出入参时间序列化转换操作方法(两种)

《Javacontroller接口出入参时间序列化转换操作方法(两种)》：本文主要介绍Javacontroller接口出入参时间序列化转换操作方法,本文给大家列举两种简单方法,感兴趣的朋友一起看... 目录方式一、使用注解方式二、统一配置场景：在controller编写的接口，在前后端交互过程中一般都会涉及
阅读更多...
Java中的StringBuilder之如何高效构建字符串

Java中的StringBuilder之如何高效构建字符串

《Java中的StringBuilder之如何高效构建字符串》本文将深入浅出地介绍StringBuilder的使用方法、性能优势以及相关字符串处理技术,结合代码示例帮助读者更好地理解和应用,希望对大家... 目录关键点什么是 StringBuilder？为什么需要 StringBuilder？如何使用 St
阅读更多...
使用Java将各种数据写入Excel表格的操作示例

使用Java将各种数据写入Excel表格的操作示例

《使用Java将各种数据写入Excel表格的操作示例》在数据处理与管理领域,Excel凭借其强大的功能和广泛的应用,成为了数据存储与展示的重要工具,在Java开发过程中,常常需要将不同类型的数据,本文... 目录前言安装免费Java库1. 写入文本、或数值到 Excel单元格2. 写入数组到 Excel表格
阅读更多...
Java并发编程之如何优雅关闭钩子Shutdown Hook

Java并发编程之如何优雅关闭钩子Shutdown Hook

《Java并发编程之如何优雅关闭钩子ShutdownHook》这篇文章主要为大家详细介绍了Java如何实现优雅关闭钩子ShutdownHook,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起... 目录关闭钩子简介关闭钩子应用场景数据库连接实战演示使用关闭钩子的注意事项开源框架中的关闭钩子机制1.
阅读更多...
Maven中引入 springboot 相关依赖的方式(最新推荐)

Maven中引入 springboot 相关依赖的方式(最新推荐)

《Maven中引入springboot相关依赖的方式(最新推荐)》：本文主要介绍Maven中引入springboot相关依赖的方式(最新推荐),本文给大家介绍的非常详细,对大家的学习或工作具有... 目录Maven中引入 springboot 相关依赖的方式1. 不使用版本管理（不推荐）2、使用版本管理（推
阅读更多...
Java 中的 @SneakyThrows 注解使用方法(简化异常处理的利与弊)

Java 中的 @SneakyThrows 注解使用方法(简化异常处理的利与弊)

《Java中的@SneakyThrows注解使用方法(简化异常处理的利与弊)》为了简化异常处理,Lombok提供了一个强大的注解@SneakyThrows,本文将详细介绍@SneakyThro... 目录1. @SneakyThrows 简介 1.1 什么是 Lombok？2. @SneakyThrows
阅读更多...
在 Spring Boot 中实现异常处理最佳实践

在 Spring Boot 中实现异常处理最佳实践

《在SpringBoot中实现异常处理最佳实践》本文介绍如何在SpringBoot中实现异常处理,涵盖核心概念、实现方法、与先前查询的集成、性能分析、常见问题和最佳实践,感兴趣的朋友一起看看吧... 目录一、Spring Boot 异常处理的背景与核心概念1.1 为什么需要异常处理？1.2 Spring B
阅读更多...
如何在 Spring Boot 中实现 FreeMarker 模板

如何在 Spring Boot 中实现 FreeMarker 模板

《如何在SpringBoot中实现FreeMarker模板》FreeMarker是一种功能强大、轻量级的模板引擎,用于在Java应用中生成动态文本输出（如HTML、XML、邮件内容等）,本文... 目录什么是 FreeMarker 模板？在 Spring Boot 中实现 FreeMarker 模板1. 环
阅读更多...
SpringMVC 通过ajax 前后端数据交互的实现方法

SpringMVC 通过ajax 前后端数据交互的实现方法

《SpringMVC通过ajax前后端数据交互的实现方法》：本文主要介绍SpringMVC通过ajax前后端数据交互的实现方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价... 在前端的开发过程中，经常在html页面通过AJAX进行前后端数据的交互，SpringMVC的controll
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2