soul从入门到放弃2--http代理

一、divide插件

进行处理http正向代理的插件，所有http类型的请求，都是由该插件进行负载均衡的调用。

通过浏览器访问http://localhost:9095/#/system/plugin，开启divide插件 ，如图所示：

image

divide插件默认是开启状态，此处只是做个操作示范，开启其他插件以此类推。

二、添加选择器及规则的方式

对于选择器与规则的添加，soul提供了两种方式。对于springmvc体系的项目可以通过注解方式，对于非springmvc体系或者非java项目，可以通过在soul-admin中配置。

一个插件有多个选择器，一个选择器对应多种规则。首先我们先明确选择器、与规则的概念

啥叫选择器？

选择器相当于对流量的第一次筛选，可以用来区分不同项目的contextPath。只有符合选择器的配置的请求，才会被soul捕获。

啥叫规则?

规则就是最终筛选，是对选择器捕获的请求进行最终流量的匹配。如：负载均衡、重试次数等等。

相关数据库设计

数据库UML图如下：

image

plugin：插件表

selector：选择器表

selector_condition:选择器条件表

rule：规则表

rule_condition:规则条件表

一个插件对应多个选择器，一个选择器对应多个规则。一个选择器对应多个匹配的条件，一个规则对应多个匹配条件。每个规则在对应插件下，不同的处理表现为handle字段，handle字段就是一个json字符串。具体的可以在admin使用过程中进行查看。

三、网关引入divide依赖

   
       org.dromara
       soul-spring-boot-starter-plugin-divide
        ${last.version}
   
   
   
       org.dromara
       soul-spring-boot-starter-plugin-httpclient
        ${last.version}
   

记得重启网关，让插件生效

四、Soul-Client方式引入

此方式主要适用用于spring体系下项目，其中springboot和springmvc项目引入依赖包稍有不同，但是在通过注解注册选择器&规则的使用方式上是一致的。

springboot项目

         org.dromara
         soul-spring-boot-starter-client-springmvc
         ${last.version}
     

添加有关于soul-admin的配置，用与同步信息

soul:
     http:
       adminUrl: http://localhost:9095   
       port: 你本项目的启动端口
       contextPath: /httpcontextPath  
       appName: httpappName
       full: false  

adminUrl：soul-admin地址 ，记得加http

port：你本项目的启动端口

contextPath：soul网关的前缀，也是选择器拦截前缀

image

appName:你的应用名称，不配置的话，会默认取 spring.application.name 的值

full:设置true 代表代理你的整个服务，false表示代理你其中某几个controller

可以参考官方例子：以soul/soul-examples/soul-examples-http为例：

比如：

原来访问地址： http://localhost:8188/test/findByUserId?userId=2

添加网关后地址：http://localhost:9195/httpcontextPath/test/findByUserId?userId=2

springmvc项目

           org.dromara
           soul-client-springmvc
           ${last.version}
       

在xml中引入bean，增加配置项

通过注解@SoulSpringMvcClient 注册 选择器&规则

• 使用通配符/**，网关代理整个Controller

只需要在Controller上加@SoulSpringMvcClient(path = "/业务请求标识/**")

@RestController
 @RequestMapping("/test")
 @SoulSpringMvcClient(path = "/test/**")
 public class HttpTestController {

     @PostMapping("/payment")
     public UserDTO post(@RequestBody final UserDTO userDTO) {
         return userDTO;
     }

     @GetMapping("/findByUserId")
     public UserDTO findByUserId(@RequestParam("userId") final String userId) {
         UserDTO userDTO = new UserDTO();
         userDTO.setUserId(userId);
         userDTO.setUserName("hello world");
         return userDTO;
     }      
  }

• 部分api接口被网关代理

Controller类SoulSpringMvcClient(path = "/业务请求标识")，之后在需要代理的方法上追加

@SoulSpringMvcClient(path = "/业务请求标识")即可。

比如：save方法将被网关代理，findById则不会

@RestController
 @RequestMapping("/order")
 @SoulSpringMvcClient(path = "/order")
 public class OrderController {

     @PostMapping("/save")
     @SoulSpringMvcClient(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;
     }
 }

非springMVC体系或者非java

涉及跨语言，可以按照soul的json接口自定义client。 此处先留个坑，预知后事，且听下回分解。

三、心得体会

• 今天仅仅是对divide的spring体系，做了一个开箱体验。大致了解了责任链模式，对plugin-handle有个初步认识，后续详细再调试下代码，分析下如何跳转和url解析
• 按照理解，定义选择器&规则，除了通过注解之外，还可以直接在soul-admin中定义。sping项目尝试成功，跨语言项目尝试直接定义规则代理请求未成功，随着深入的学习，需要调试下源码，一探究竟
• 日拱一卒，每天进步一点点，加油胖子！

参考：

责任链模式：http://c.biancheng.net/view/1383.html