搭建微服务基础环境023.创建使用会员微服务模块-service consumer3.1需求分析
浏览器向service consumer请求某个数据,service consumer会去向service provider请求数据,然后将service provider返回的数据返回给浏览器。
添加数据同理。
3.2思路分析
- 创建Module(member-service-consumer-80) & 完成配置
- 创建controller
- 完成测试
3.3实现步骤3.3.1创建Module&完成配置
步骤同上一篇的2.3.1
(1)创建Module:member-service-consumer-80
(2)在子模块的pom.xml文件中加入相关的依赖:
因为这个模块不需要直接操作数据库,相比于之间的子模块,减少了和数据库相关的依赖。
E-Commerce-Center com.li.springcloud 1.0-SNAPSHOT 4.0.0 member-service-consumer-80 8 8 org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-actuator org.projectlombok lombok
(3)创建resources/application.yml
server: port: 80spring: application: name: member-service-consumer-80
(4)创建启动类
package com.li.springcloud;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;/** * @author 李 * @version 1.0 */@SpringBootApplicationpublic class MemberConsumerApplication { public static void main(String[] args) { SpringApplication.run(MemberConsumerApplication.class,args); }}
测试,启动成功:
3.3.1业务实现3.3.1.1utils层
创建工具类Result.java(略,见2.3.3.1)
3.3.1.2Entity层
Member.java
package com.li.springcloud.entity;import lombok.AllArgsConstructor;import lombok.Data;import lombok.NoArgsConstructor;/** * @author 李 * @version 1.0 */@Data@AllArgsConstructor@NoArgsConstructor//因为对象在网络中以流的形式传递,这里最好实现Serializable接口public class Member implements Serializable{ private Long id; private String name; private String pwd; private String mobile; private String email; private Integer gender;}
3.3.1.3注入RestTemplate
RestTemplate 基本介绍:RestTemplate 是 Spring 提供的用于访问Rest服务的模板类,它提供来了许多便捷访问远程 Http 服务的方法。
通过 RestTemplate,我们可以向另一个微服务模块发出 Http 请求(支持 Restful 风格),去调用该模块的 Controller 提供的 API 接口,就像浏览器发出请求调用该 API 接口一样。
RestTemplate 官网:RestTemplate (Spring Framework 5.2.2.RELEASE API)
创建配置类,注入RestTemplate对象:
package com.li.springcloud.config;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.web.client.RestTemplate;/** * @author 李 * @version 1.0 * 注入RestTemplate Bean */@Configurationpublic class CustomInitBean { @Bean public RestTemplate getRestTemplate() { return new RestTemplate(); }}
3.3.1.4Controller层
MemberConsumerController.java:
package com.li.springcloud.controller;import com.li.springcloud.entity.Member;import com.li.springcloud.utils.Result;import lombok.extern.slf4j.Slf4j;import org.springframework.stereotype.Controller;import org.springframework.validation.annotation.Validated;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 org.springframework.web.client.RestTemplate;import javax.annotation.Resource;/** * @author 李 * @version 1.0 */@RestController@Slf4jpublic class MemberConsumerController { @Resource private RestTemplate restTemplate; //定义一个基础的url public static final String MEMBER_SERVICE_PROVIDER_URL = "http://localhost:10000"; //添加对象到数据库表中 @PostMapping("/member/consumer/save") public Result save(Member member) { log.info("service-consumer member={}", member); /** * MEMBER_SERVICE_PROVIDER_URL + "/member/save":就是向对应子模块发出的完整url请求 * member:就是通过 restTemplate 发出的 post 请求携带的数据(对象) * Result.class:就是返回的对象类型 */ return restTemplate.postForObject (MEMBER_SERVICE_PROVIDER_URL + "/member/save", member, Result.class); } //根据id调用服务接口,返回member对象信息 @GetMapping("/member/consumer/get/{id}") public Result getMemberById(@PathVariable("id") Integer id) { return restTemplate.getForObject (MEMBER_SERVICE_PROVIDER_URL + "/member/get/" + id, Result.class); }}
3.3.1完成测试
分别启动两个子模块(service consumer、service provider)
(1)测试save方法:postman以表单形式发出数据:
结果显示添加成功,但是我们在数据库中看到的确是空值:
原因是因为使用RestTemplate,它会将数据以json格式发送。解决方法是在服务模块对应方法参数中使用@RequestBody注解,将接收的json格式数据转换成对象。
最好实体类实现Serializable,支持可序列化
重新启动模块,使用postman发送数据:数据库添加成功。
(2)浏览器测试getMemberById方法:
测试通过。
3.4注意事项和使用细节
当SpringCloud的服务有多个时,管理多个服务的启动使用右上角的run会不好管理,我们可以使用Run Dashboard:idea中如何开启Dashboard
4.创建共用模块-供其他模块使用4.1需求分析
我们在 consumer 和 provider 模块都使用到了 Member 和 Result 类,我们可以将它们抽取到共用模块(e_commerce_center_common-api),使用Maven 打包成 jar包,其他模块需要使用直接引入依赖即可。
4.2思路分析
- 创建Module & 完成配置
- 创建Entity,把共用的实体类放到对应的包下
- 完成测试
4.3实现步骤4.3.1创建Module&完成配置
(1)创建Module–e_commerce_center_common-api
(2)在本模块的pom.xml引入公共的依赖
org.projectlombok lombok <!--true:防止将该依赖传递到其他模块中 1. true 表示两个项目之间依赖不传递 比如 a 模块依赖了本项目,那么本项目不会把 lombok 的jar包给 a 模块 意义在于继承依赖时,防止jar发生版本冲突(如,a模块可以自定义需要的Lombok版本) 2. 不设置optional或optional=默认值false,都表示传递依赖 --> true
4.3.2抽取共用的API/类
创建多个子模块都要使用的公共类,注意路径要和其他模块的路径相同。
4.3.3使用Maven打包成jar
(1)按如下步骤进行打包:
(2)成功后会在target目录下生成对应的jar包:
并且maven-archiver下的pom.properties中生成了项目对应的坐标:
#Generated by Maven#Tue Apr 04 19:38:29 CST 2023version=1.0-SNAPSHOTgroupId=com.li.springcloudartifactId=e_commerce_center_common-api
4.3.4工程重构
(1)在 member-service-provider-10000 模块删除当前模块的 entity 包和 utils 包
(2)在 member-service-provider-10000 的 pom.xml 引入公共模块:
com.li.springcloud e_commerce_center_common-api 1.0-SNAPSHOT
然后点击刷新Maven,这样就可以引入之前打包好的jar包代码了。
(3)同理,在 member-service-consumer-80 模块中也删除 entity 和 utils 包,然后在本模块的 pom.xml 文件中也引入公共模块,然后刷新。
4.3.5完成测试
分别启动 member-service-provider-10000 和 member-service-consumer-80 两个子模块,在浏览器中发送请求进行测试:
如下,测试成功,工程进行重构之后没有问题,公共模块引入各个模块之后依然可以工作。
之后如果多个模块还有公共的类,依然可以通过这种方式来抽取共用的API/类,然后通过引入公共模块的方式来简化代码。