1.服务提供者与服务消费者简介
使用微服务构建的是分布式系统,微服务之间通过网络进行通信。使用服务提供者和服务消费者来描述微服务之间的调用关系,其中服务提供者是提供服务的服务,服务消费者是依赖其它服务的服务。
本小节以电影售票系统中的用户购票场景为例,来演示服务之间是如何调用的,在这个场景中需要编写一个服务提供者(用户微服务)和一个服务消费者(电影微服务)。在进行购票业务操作之前,电影微服务需要调用用户微服务的接口查询当前用户余额,来校验该账户否满足购票条件。
2.数据准备
新建一个名为mydb的数据库,在mydb中新建一个名为user的数据表,然后往数据表里插入3条数据,具体SQL语句如下。
create database if not exists mydb character set = utf8;
create table user (
id int(11) not null auto_increment,
username varchar(30) default null,
name varchar(30) default null,
age int(3) default null,
balance decimal(10,2) default null,
primary key (id)
);
insert into user values (1, 'account1', 'cherry', 20 ,300.00);
insert into user values (2, 'account2', 'owen', 28, 500.00);
insert into user values (3, 'account3', 'steven', 25, 800.00);
服务提供者
1.引入依赖
新建一个SpringBoot工程,并在pom.xml文件中添加所需要的dependency。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.1.1</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.2</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<exclusions>
<exclusion>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
</dependency>
2.添加配置
在application.properties文件中添加如下配置信息。
############################################################
#
# MySQL配置
#
############################################################
### 连接信息
spring.datasource.url = jdbc:mysql://localhost:3306/mydb?characterEncoding=utf-8&useSSL=false
### 用户名
spring.datasource.username = root
### 密码
spring.datasource.password = admin123
### 驱动
spring.datasource.driver-class-name = com.mysql.cj.jdbc.Driver
############################################################
#
# MyBatis配置
#
############################################################
### po类存放目录
mybatis.type-aliases-package = com.leichuangkj.provideruser.dao.po
### mapper(.xml)资源文件存放路径
mybatis.mapper-locations = classpath:mybatis/mapper/*.xml
3.开发服务端通用返回对象
在项目目录“/src/main/java/com/leichuangkj/provideruser”下新建common目录,并在common目录下新建ResponseCode枚举类和ServerResponse类,具体代码如下。
public enum ResponseCode {
//1.定义枚举值
ERROR(0,"ERROR"),
SUCCESS(1,"SUCCESS");
//2.定义枚举属性
private final int code;
private final String desc;
//3.定义构造函数
ResponseCode(int code, String desc){
this.code = code;
this.desc = desc;
}
//4.定义get方法
public int getCode(){
return code;
}
public String getDesc(){
return desc;
}
}
@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
//保证序列化json的时候,如果是null的对象,key也会消失
public class ServerResponse<T> implements Serializable {
//1.定义属性
private int status;
private String message;
private T data;
//2.定义构造函数
private ServerResponse(int status) {
this.status = status;
}
private ServerResponse(int status, T data) {
this.status = status;
this.data = data;
}
private ServerResponse(int status, String message, T data) {
this.status = status;
this.message = message;
this.data = data;
}
private ServerResponse(int status, String message) {
this.status = status;
this.message = message;
}
//3.getter方法
public int getStatus() {
return status;
}
public T getData() {
return data;
}
public String getMessage() {
return message;
}
@JsonIgnore
//使之不在json序列化结果当中
//4.判断这个响应是不是一个正确的响应
public boolean isSuccess() {
return this.status == ResponseCode.SUCCESS.getCode();
}
//5.定义返回对象的方法
public static <T> ServerResponse<T> createBySuccess() {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode());
}
public static <T> ServerResponse<T> createBySuccessMessage(String message) {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), message);
}
public static <T> ServerResponse<T> createBySuccess(T data) {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), data);
}
public static <T> ServerResponse<T> createBySuccess(String message, T data) {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), message, data);
}
public static <T> ServerResponse<T> createByError() {
return new ServerResponse<T>(ResponseCode.ERROR.getCode(), ResponseCode.ERROR.getDesc());
}
public static <T> ServerResponse<T> createByErrorMessage(String errorMessage) {
return new ServerResponse<T>(ResponseCode.ERROR.getCode(), errorMessage);
}
public static <T> ServerResponse<T> createByErrorCodeMessage(int errorCode, String errorMessage) {
return new ServerResponse<T>(errorCode, errorMessage);
}
public static <T> ServerResponse<T> createByErrorCodeMessageData(int errorCode, String errorMessage,T data) {
return new ServerResponse<T>(errorCode, errorMessage,data);
}
}
4.dao层开发
首先在项目目录“/src/main/java/com/leichuangkj/provideruser”下新建“/dao/po”目录,并在po目录下新建User实体类,具体代码如下。
@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class User {
private Integer id;
private String username;
private String name;
private Integer age;
private BigDecimal balance;
}
然后在dao目录下新建mapper目录,并在mapper目录下新建UserMapper接口,具体代码如下。
@Repository
public interface UserMapper {
User findByName(String id);
}
最后在resource目录下新建“mybatis/mapper”目录,并在mapper目录下新建UserMapper.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.leichuangkj.provideruser.dao.mapper.UserMapper" >
<resultMap id="BaseResultMap" type="com.leichuangkj.provideruser.dao.po.User">
<constructor>
<idArg column="id" javaType="java.lang.Integer" jdbcType="INTEGER" />
<arg column="username" javaType="java.lang.String" jdbcType="VARCHAR" />
<arg column="name" javaType="java.lang.String" jdbcType="VARCHAR" />
<arg column="age" javaType="java.lang.Integer" jdbcType="INTEGER" />
<arg column="balance" javaType="java.math.BigDecimal" jdbcType="DECIMAL" />
</constructor>
</resultMap>
<select id="findByName" parameterType="java.lang.String" resultMap="BaseResultMap">
select id, username, name, age, balance
from user
where name = #{name,jdbcType=VARCHAR}
</select>
</mapper>
5.service层开发
在项目目录“/src/main/java/com/leichuangkj/provideruser”下新建service目录,并在service目录下新建IUser接口,具体代码如下。
public interface IUser {
ServerResponse findByName(String name);
}
然后在service目录下新建impl目录,并在impl目录下新建UserImpl实现类,具体代码如下。
@Service
public class UserImpl implements IUser {
@Autowired
UserMapper userMapper;
@Override
public ServerResponse findByName(String name) {
User user = userMapper.findByName(name);
if (user == null) {
return ServerResponse.createByErrorMessage("没有查询到用户");
}
return ServerResponse.createBySuccess(user);
}
}
6.controller层开发
在项目目录“/src/main/java/com/leichuangkj/provideruser”下新建controller目录,并在controller目录下新建UserController类,具体代码如下。
@RestController
public class UserController {
@Autowired
UserImpl userImpl;
@GetMapping(value = "/user/{name}")
public ServerResponse findByName(@PathVariable String name) {
return userImpl.findByName(name);
}
}
7.启动项目
在启动类ProviderUserApplication上添加注解“@MapperScan(basePackages = “com.leichuangkj.provideruser.dao.mapper”)”,然后启动项目。
@MapperScan(basePackages = "com.leichuangkj.provideruser.dao.mapper")
@SpringBootApplication
public class ProviderUserApplication {
public static void main(String[] args) {
SpringApplication.run(ProviderUserApplication.class, args);
}
}
8.测试
启动项目,然后在postman中请求“localhost:8080/user/steven”,可以查询到相应的信息,测试结果如下所示。
{
"status": 1,
"data": {
"id": 3,
"username": "account3",
"name": "steven",
"age": 25,
"balance": 800.00
}
}
服务提供者
1.引入依赖
新建一个SpringBoot工程,并在pom.xml文件中添加所需要的dependency。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.2</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.47</version>
</dependency>
2.添加配置
在application.properties文件中添加如下配置信息。
############################################################
#
# 端口配置
#
############################################################
server.port = 8081
3.开发服务端通用返回对象
在项目目录“/src/main/java/com/leichuangkj/consumermovie”下新建common目录,并在common目录下新建ResponseCode枚举类和ServerResponse类,具体代码如下。
public enum ResponseCode {
//1.定义枚举值
ERROR(0,"ERROR"),
SUCCESS(1,"SUCCESS");
//2.定义枚举属性
private final int code;
private final String desc;
//3.定义构造函数
ResponseCode(int code, String desc){
this.code = code;
this.desc = desc;
}
//4.定义get方法
public int getCode(){
return code;
}
public String getDesc(){
return desc;
}
}
@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
//保证序列化json的时候,如果是null的对象,key也会消失
public class ServerResponse<T> implements Serializable {
//1.定义属性
private int status;
private String message;
private T data;
//2.定义构造函数
private ServerResponse(int status) {
this.status = status;
}
private ServerResponse(int status, T data) {
this.status = status;
this.data = data;
}
private ServerResponse(int status, String message, T data) {
this.status = status;
this.message = message;
this.data = data;
}
private ServerResponse(int status, String message) {
this.status = status;
this.message = message;
}
//3.getter方法
public int getStatus() {
return status;
}
public T getData() {
return data;
}
public String getMessage() {
return message;
}
@JsonIgnore
//使之不在json序列化结果当中
//4.判断这个响应是不是一个正确的响应
public boolean isSuccess() {
return this.status == ResponseCode.SUCCESS.getCode();
}
//5.定义返回对象的方法
public static <T> ServerResponse<T> createBySuccess() {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode());
}
public static <T> ServerResponse<T> createBySuccessMessage(String message) {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), message);
}
public static <T> ServerResponse<T> createBySuccess(T data) {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), data);
}
public static <T> ServerResponse<T> createBySuccess(String message, T data) {
return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), message, data);
}
public static <T> ServerResponse<T> createByError() {
return new ServerResponse<T>(ResponseCode.ERROR.getCode(), ResponseCode.ERROR.getDesc());
}
public static <T> ServerResponse<T> createByErrorMessage(String errorMessage) {
return new ServerResponse<T>(ResponseCode.ERROR.getCode(), errorMessage);
}
public static <T> ServerResponse<T> createByErrorCodeMessage(int errorCode, String errorMessage) {
return new ServerResponse<T>(errorCode, errorMessage);
}
public static <T> ServerResponse<T> createByErrorCodeMessageData(int errorCode, String errorMessage,T data) {
return new ServerResponse<T>(errorCode, errorMessage,data);
}
}
4.dao层开发
在项目目录“/src/main/java/com/leichuangkj/consumermovie”下新建“/dao/po”目录,并在po目录下新建User实体类,具体代码如下。
@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class User {
private Integer id;
private String username;
private String name;
private Integer age;
private BigDemical balance;
}
5.controller层开发
在项目目录“/src/main/java/com/leichuangkj/consumermovie”下新建controller目录,并在controller目录下新建MovieController类,具体代码如下。
@RestController
public class MovieController {
@Autowired
private RestTemplate restTemplate;
@GetMapping(value = "/user/{name}")
public ServerResponse findByName(@PathVariable String name) {
String rs = this.restTemplate.getForObject("http://localhost:8080/user/" + name, String.class);
JSONObject jsonObject = JSON.parseObject(rs);
//业务逻辑处理,这里直接返回json体的数据内容
return ServerResponse.createBySuccess(jsonObject.get("data"));
}
}
6.启动项目
在启动类ConsumerMovieApplication中注入RestTemplate ,代码如下所示,然后启动项目。
@SpringBootApplication
public class ConsumerMovieApplication {
@Bean
public RestTemplate restTemplate() {
return new RestTemplate();
}
public static void main(String[] args) {
SpringApplication.run(ConsumerMovieApplication.class, args);
}
}
7.测试
启动项目,然后在postman中请求“localhost:8081/user/steven”,可以查询到相应的信息,测试结果如下所示。
{
"status": 1,
"data": {
"id": 3,
"username": "account3",
"name": "steven",
"age": 25,
"balance": 800.00
}
}
3.硬编码存在的问题
上面已经实现一个用户微服务和电影微服务,并在电影微服务中使用RestTemplate调用用户微服务中的API。但是,我们看到MovieController中的代码,是把服务提供者的网络地址(http://localhost:8080/user/" + name)硬编码在程序中的,当然也可以提取到配置文件中去,但是这种方式仍然会有很多问题,主要有以下两点。
- 适用场景有局限:如果服务提供者的网络地址发生变化,将会影响到服务消费者。如用户微服务的网络地址发生变化,就需要修改电影为服务的配置并重新发布。
- 无法动态伸缩:在生成环境中,每一个微服务一般都会部署多个实例,从而实现容灾和负载均衡。在微服务架构的系统中,还需要具备自动伸缩能力,如动态增减节点等。