Spring Cloud服务接入

    接入前,请正确启动 shenyu-admin,并开启springCloud插件,在网关端和springCloud服务端引入相关依赖。可以参考前面的 Spring Cloud快速开始

    应用客户端接入的相关配置请参考:。

    数据同步的相关配置请参考:数据同步配置

    • 在网关的 pom.xml 文件中引入如下依赖。
    • 如果你使用 eureka 作为 springCloud的注册中心

      • 在网关的pom.xml文件中,新增如下依赖:
      1. <dependency>
      2. <groupId>org.springframework.cloud</groupId>
      3. <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
      4. <version>2.2.0.RELEASE</version>
      5. </dependency>
    • 在网关的yml文件中,新增如下配置:

      1. eureka:
      2. client:
      3. serviceUrl:
      4. defaultZone: http://localhost:8761/eureka/ # 你的eureka地址
      5. instance:
      6. prefer-ip-address: true
    • 如果你使用 nacos 作为 springCloud的注册中心

      • 在网关的pom.xml文件中,新增如下依赖:
      1. <dependency>
      2. <groupId>com.alibaba.cloud</groupId>
      3. <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
      4. <version>2.1.0.RELEASE</version>
      5. </dependency>

    特别提示:请确保spring Cloud注册中心服务发现配置开启

    • 配置方式
    1. spring:
    2. cloud:
    3. discovery:
    4. enabled: true
    • 代码方式
    1. @SpringBootApplication
    2. @EnableDiscoveryClient
    3. public class ShenyuBootstrapApplication {
    4. /**
    5. * Main Entrance.
    6. * @param args startup arguments
    7. public static void main(final String[] args) {
    8. SpringApplication.run(ShenyuBootstrapApplication.class, args);
    9. }
    10. }
    • 重启你的网关服务。

    可以参考:

    • 在由SpringCloud构建的微服务中,引入如下依赖:
    1. <dependency>
    2. <groupId>org.apache.shenyu</groupId>
    3. <artifactId>shenyu-spring-boot-starter-client-springcloud</artifactId>
    4. <version>${shenyu.version}</version>
    5. </dependency>
    • controller接口上加上 @ShenyuSpringCloudClient 注解。 注解可以加到类或方法上面,path属性为前缀,如果含有 /** 代表你的整个接口需要被网关代理。

    • 示例一: 代表 /test/payment, /test/findByUserId 都会被网关代理。

      ``` @RestController @RequestMapping(“/test”) @ShenyuSpringCloudClient(path = “/test/**”) public class HttpTestController {

    1. * 示例二:
    2. 代表 `/order/save`,会被网关代理,而`/order/findById` 则不会。
    3. ```java
    4. @RestController
    5. @RequestMapping("/order")
    6. @ShenyuSpringCloudClient(path = "/order")
    7. public class OrderController {
    8. @PostMapping("/save")
    9. @ShenyuSpringMvcClient(path = "/save")
    10. public OrderDTO save(@RequestBody final OrderDTO orderDTO) {
    11. orderDTO.setName("hello world save order");
    12. return orderDTO;
    13. }
    14. @GetMapping("/findById")
    15. public OrderDTO findById(@RequestParam("id") final String id) {
    16. OrderDTO orderDTO = new OrderDTO();
    17. orderDTO.setId(id);
    18. return orderDTO;
    19. }
    20. }
    • 示例三: isFull: 代表整个服务都会被网关代理。
    1. shenyu:
    2. client:
    3. registerType: http
    4. serverLists: http://localhost:9095
    5. props:
    6. contextPath: /http
    7. appName: http
    8. isFull: true
    9. # registerType : 服务注册类型,请参考应用客户端接入文档
    10. # serverList: 服务列表,请参考应用客户端接入文档
    11. # contextPath: 为你的项目在shenyu网关的路由前缀。 比如/order ,/product 等等,网关会根据你的这个前缀来进行路由。
    12. # appName:你的应用名称,不配置的话,会默认取application 中的名称
    13. # isFull: 设置true 代表代理你的整个服务,false表示代理你其中某几个controller
    1. @RestController
    2. @RequestMapping("/order")
    3. public class OrderController {
    4. @PostMapping("/save")
    5. @ShenyuSpringMvcClient(path = "/save")
    6. public OrderDTO save(@RequestBody final OrderDTO orderDTO) {
    7. orderDTO.setName("hello world save order");
    8. return orderDTO;
    9. }
    10. @GetMapping("/findById")
    11. public OrderDTO findById(@RequestParam("id") final String id) {
    12. OrderDTO orderDTO = new OrderDTO();
    13. orderDTO.setId(id);
    14. orderDTO.setName("hello world findById");
    15. return orderDTO;
    16. }
    17. }

    示例四:这是一种简化的使用方式,只需要一个简单的注解,使用元数据注册到网关。 特别说明:目前只支持@RequestMapping、@GetMapping、@PostMapping、@DeleteMapping、@PutMapping注解,并且只对@XXXMapping中的第一个路径有效。

    • 启动你的服务成功注册后,进入后台管理系统的插件列表 -> rpc proxy -> springCloud,会看到自动注册的选择器和规则信息。
    • 你之前请求的域名是你自己的服务,现在要换成网关的域名。