Spring Cloud服务接入
接入前,请正确启动 shenyu-admin
,并开启springCloud
插件,在网关端和springCloud
服务端引入相关依赖。可以参考前面的 Spring Cloud快速开始。
应用客户端接入的相关配置请参考:。
数据同步的相关配置请参考:数据同步配置。
- 在网关的
pom.xml
文件中引入如下依赖。
如果你使用
eureka
作为springCloud
的注册中心- 在网关的
pom.xml
文件中,新增如下依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
<version>2.2.0.RELEASE</version>
</dependency>
- 在网关的
在网关的
yml
文件中,新增如下配置:eureka:
client:
serviceUrl:
defaultZone: http://localhost:8761/eureka/ # 你的eureka地址
instance:
prefer-ip-address: true
如果你使用
nacos
作为springCloud
的注册中心- 在网关的
pom.xml
文件中,新增如下依赖:
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<version>2.1.0.RELEASE</version>
</dependency>
- 在网关的
特别提示:请确保spring Cloud注册中心服务发现配置开启
- 配置方式
spring:
cloud:
discovery:
enabled: true
- 代码方式
@SpringBootApplication
@EnableDiscoveryClient
public class ShenyuBootstrapApplication {
/**
* Main Entrance.
* @param args startup arguments
public static void main(final String[] args) {
SpringApplication.run(ShenyuBootstrapApplication.class, args);
}
}
- 重启你的网关服务。
可以参考:
- 在由
SpringCloud
构建的微服务中,引入如下依赖:
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-client-springcloud</artifactId>
<version>${shenyu.version}</version>
</dependency>
在
controller
接口上加上@ShenyuSpringCloudClient
注解。 注解可以加到类或方法上面,path
属性为前缀,如果含有/**
代表你的整个接口需要被网关代理。示例一: 代表
/test/payment
,/test/findByUserId
都会被网关代理。``` @RestController @RequestMapping(“/test”) @ShenyuSpringCloudClient(path = “/test/**”) public class HttpTestController {
* 示例二:
代表 `/order/save`,会被网关代理,而`/order/findById` 则不会。
```java
@RestController
@RequestMapping("/order")
@ShenyuSpringCloudClient(path = "/order")
public class OrderController {
@PostMapping("/save")
@ShenyuSpringMvcClient(path = "/save")
public OrderDTO save(@RequestBody final OrderDTO orderDTO) {
orderDTO.setName("hello world save order");
return orderDTO;
}
@GetMapping("/findById")
public OrderDTO findById(@RequestParam("id") final String id) {
OrderDTO orderDTO = new OrderDTO();
orderDTO.setId(id);
return orderDTO;
}
}
- 示例三:
isFull
: 代表整个服务都会被网关代理。
shenyu:
client:
registerType: http
serverLists: http://localhost:9095
props:
contextPath: /http
appName: http
isFull: true
# registerType : 服务注册类型,请参考应用客户端接入文档
# serverList: 服务列表,请参考应用客户端接入文档
# contextPath: 为你的项目在shenyu网关的路由前缀。 比如/order ,/product 等等,网关会根据你的这个前缀来进行路由。
# appName:你的应用名称,不配置的话,会默认取application 中的名称
# isFull: 设置true 代表代理你的整个服务,false表示代理你其中某几个controller
@RestController
@RequestMapping("/order")
public class OrderController {
@PostMapping("/save")
@ShenyuSpringMvcClient(path = "/save")
public OrderDTO save(@RequestBody final OrderDTO orderDTO) {
orderDTO.setName("hello world save order");
return orderDTO;
}
@GetMapping("/findById")
public OrderDTO findById(@RequestParam("id") final String id) {
OrderDTO orderDTO = new OrderDTO();
orderDTO.setId(id);
orderDTO.setName("hello world findById");
return orderDTO;
}
}
示例四:这是一种简化的使用方式,只需要一个简单的注解,使用元数据注册到网关。 特别说明:目前只支持@RequestMapping、@GetMapping、@PostMapping、@DeleteMapping、@PutMapping
注解,并且只对@XXXMapping
中的第一个路径有效。
- 启动你的服务成功注册后,进入后台管理系统的
插件列表 -> rpc proxy -> springCloud
,会看到自动注册的选择器和规则信息。
你之前请求的域名是你自己的服务,现在要换成网关的域名。