Soul网关中的@SoulSpringMvcClient注解

最新推荐文章于 2023-10-30 16:54:58 发布

子夜2104

最新推荐文章于 2023-10-30 16:54:58 发布

阅读量561

点赞数

分类专栏： Soul

本文链接：https://blog.csdn.net/yangwangyunduan/article/details/113194541

版权

本文深入探讨了Soul网关中的@SoulSpringMvcClient注解，该注解用于标记服务接口并在系统启动时自动注册到后台。注解可应用于类或方法，指定接口路径、规则名、描述信息和传输类型等。在启动过程中，通过配置文件和后置处理器完成接口注册，将信息发送到后台进行处理。理解这一注解的工作流程对于掌握Soul网关的配置和代理机制至关重要。

摘要由CSDN通过智能技术生成

本篇文章分析的是@SoulSpringMvcClient注解，它的作用是：用于标记SpringMvc服务中的接口，被标记的接口在系统启动的是时候，将当前接口注册到soul-admin后台中。使用方式如下：

@RestController
@RequestMapping("/order")
@SoulSpringMvcClient(path = "/order")
public class OrderController {
   
	//省略了其他代码

    @GetMapping("/findById")
    @SoulSpringMvcClient(path = "/findById", desc = "Find by id")
    public OrderDTO findById(@RequestParam("id") final String id) {
   
        OrderDTO orderDTO = new OrderDTO();
        orderDTO.setId(id);
        orderDTO.setName("hello world findById");
        return orderDTO;
    }
}

它的定义如下：

注解可以使用在类上，也可以使用在方法上；
path:表示接口的路径；
ruleName：表示规则名称；
desc：接口描述信息；
rpcType：传输类型，默认是http，在soul网关中，还有SpringCloud，Dubbo，Sofa等类型；
enabled：是否开启（是否被网关代理），默认是true:
registerMetaData：是否注册元数据信息，默认是false。

@Retention(RetentionPolicy.RUNTIME)
@Target({
   ElementType.TYPE, ElementType.METHOD})
public @interface SoulSpringMvcClient {
   
    
    /**
     * Path string.
     *
     * @return the string
     */
    String path();
    
    /**
     * Rule name string.
     *
     * @return the string
     */
    String ruleName() default <