目录
项目介绍
整体结构
功能介绍
远程调用
添加远程调用的依赖
yml配置文件内容
设计远程调用接口
业务层注入远程调用对象
启动类添加注解
重要注解
@EnableFeignClients注解
@FeignClient注解
zuul网关设计
添加网关设计依赖
启动类添加注解
yml文件设计
项目介绍
整体结构
功能介绍
- sp01-commons服务:公有服务,主要定义了用户和商品等对象,以及对应的接口(包含了需要实现的一些方法),还设计了响应请求的一些工具。该服务为其它服务所依赖,所以后续需要使用该服务的工程应当添加此公有服务的依赖。
- sp02-itemservice服务:商品服务,实现了公有服务的ItemService接口,并定义了控制层用于接收请求。
- sp03-userservice服务:用户服务,功能与商品服务类似。
- sp04-orderservice服务:订单服务,实现了订单服务接口,设计了feign远程调用的接口,用于实现远程调用用户服务和商品服务的功能。
- sp05-eureka服务:注册服务,用于对所有的服务进行注册,可以根据服务的注册列表进行访问相关服务。(设置了两个注册服务,防止服务宕机)
- sp06-zuul服务:网关服务,为所有的服务添加一个网关,所有的请求经过网关进行转发。
远程调用
添加远程调用的依赖
添加远程服务调用依赖openfeign.
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>cn.tedu</groupId>
<artifactId>sp04-orderservice</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>sp04-orderservice</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<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>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>cn.tedu</groupId>
<artifactId>sp01-commons</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<--添加远程服务调用依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Hoxton.SR9</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
yml配置文件内容
向两个服务注册中心注册了自己的服务。
spring:
application:
name: order-service
server:
port: 8201
# 客户端应用请求地址: /eureka 子路径
# 用浏览器查看 eureka 控制台地址: /
# defaultZone: 如果使用云服务,可以购买不同地点的服务器,自己的服务器则必须是defaultZone
eureka:
client:
service-url:
defaultZone: http://eureka1:2001/eureka,http://eureka2:2002/eureka
# 配置 Ribbon 重试次数
#ribbon:
# MaxAutoRetries: 1
# MaxAutoRetriesNextServer: 2
设计远程调用接口
设计远程服务调用的接口,用于实现远程服务的调用。接口只需定义请求规则,不进行具体的请求处理。下面是远程调用商品服务的接口设计,用户服务的设计类似。
package cn.tedu.sp04.feign;
import cn.tedu.sp01.entity.Item;
import cn.tedu.web.util.JsonResult;
import org.springframework.cloud.openfeign.FeignClient;
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.RequestBody;
import java.util.List;
/**
* @Author 作者:小龙猿
* @Project 项目:springcloud1
* @Time 时间:2021/9/10 14:21
*/
/*
三个配置:
1.调用哪个服务
2.调用这个服务的哪个路径
3.向这个路径提交什么参数
*/
@FeignClient(name = "item-service")
public interface ItemClient {
@GetMapping("/{orderId}")
JsonResult<List<Item>> getItem(@PathVariable String orderId);
@PostMapping("/decreaseNumber")
JsonResult decreaseNumber(@RequestBody List<Item> items);
}
业务层注入远程调用对象
有了远程服务调用的接口,就可以在业务层注入相关对象,进行远程服务的调用。
package cn.tedu.sp04.order.service;
import cn.tedu.sp01.entity.Item;
import cn.tedu.sp01.entity.Order;
import cn.tedu.sp01.entity.User;
import cn.tedu.sp01.service.OrderService;
import cn.tedu.sp04.feign.ItemClient;
import cn.tedu.sp04.feign.UserClient;
import cn.tedu.web.util.JsonResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
/**
* @Author 作者:小龙猿
* @Project 项目:springcloud1
* @Time 时间:2021/9/9 15:41
*/
@Service
@Slf4j
public class OrderServiceImpl implements OrderService {
@Autowired
private UserClient userClient;//注入远程调用服务的对象(代理对象)
@Autowired
private ItemClient itemClient;
@Override
public Order getOrder(String orderId) {
//TODO: 远程调用user-service获取用户信息
JsonResult<User> user = userClient.getUser(8);//这儿是自己设定的值,真实项目中应该根据登录的用户id查询
//浏览器-->OrderController-->OrderServiceImpl-->ItemClient-->ItemController-->ItemServiceImpl
//TODO: 远程调用item-service获取商品信息
JsonResult<List<Item>> items = itemClient.getItem(orderId);
Order order = new Order();
order.setId(orderId);
order.setUser(user.getData());
order.setItems(items.getData());
return order;
}
@Override
public void addOrder(Order order) {
//TODO: 调用item-service减少商品库存
itemClient.decreaseNumber(order.getItems());
//TODO: 调用user-service增加用户积分
userClient.addScore(order.getUser().getId(), 100);
log.info("保存订单: "+order);
}
}
启动类添加注解
启动类添加 @EnableFeignClients 注解。
package cn.tedu.sp04;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;
@EnableFeignClients
@SpringBootApplication
public class Sp04OrderserviceApplication {
public static void main(String[] args) {
SpringApplication.run(Sp04OrderserviceApplication.class, args);
}
}
重要注解
@EnableFeignClients注解
@EnableFeignClients注解描述启动类时,用于告诉springboot在启动时,扫描启动类所在包或子包中的类,假如接口上有@FeignClient注解描述,则对这样的接口创建其实现类,在实现类内部帮我们进行远程服务调用。
@FeignClient注解
@FeignClient注解用于描述远程调用接口,这个接口不需要你写实现类,你只需要定义访问规则即可(例如请求方式,请求URL,请求参数)。
@FeignClient 注解描述的接口的实现类对象会默认交给spring管理,这个bean对象的名字默认就是name属性指定的值,这个name还有一个层面的含义,就是你远程调用的服务名。
假如@FeignClient注解中添加了contextId属性,则这个属性值默认会作为当前bean对象的名字,此时name的值仅仅作为要调用的服务名对待,一般推荐contextId的值默认为@FeignClient注解描述的接口的名字(首字母小写)。
zuul网关设计
添加网关设计依赖
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>cn.tedu</groupId>
<artifactId>sp06-zuul</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>sp06-zuul</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Hoxton.SR12</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<--添加网关设计的依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>
<dependency>
<groupId>cn.tedu</groupId>
<artifactId>sp01-commons</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
启动类添加注解
在启动类上添加两个注解@EnableZuulProxy和@EnableDiscoveryClient。
package cn.tedu.sp06;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
@EnableZuulProxy
@EnableDiscoveryClient//Eureka注册中心扫描该服务并进行注册
@SpringBootApplication
public class Sp06ZuulApplication {
public static void main(String[] args) {
SpringApplication.run(Sp06ZuulApplication.class, args);
}
}
yml文件设计
主要进行网关路由的设计。
spring:
application:
name: zuul
server:
port: 3001
eureka:
client:
service-url:
defaultZone: http://eureka1:2001/eureka, http://eureka2:2002/eureka
zuul:
routes:
item-service: /item-service/**
user-service: /user-service/**
order-service: /order-service/**
可以结合下篇文章加深理解 Nacos-消费者服务调用生产者服务(负载均衡实现调用多个服务器)