Soul网关接入与验证

简介: 本章节在前两章基础上集成Soul网关,讲解Provider与Consumer应用如何通过添加依赖、注解及配置文件接入Soul,实现服务注册与网关路由,并通过实际请求验证网关调用流程。

此章节将基于上一章节基础之上,引入Soul网关,至于Soul网关是干什么的,怎么做的,我们会在后续章节讲解,1-3章节侧重于搭建应用。

本章节的Soul网关接入,如果你1,2章节都是和我保持一致,那么只需要直接启动Soul网关即可,但是对应的provider,consumer应用是需要额外的代码接入的。

开发环境和第二章保持一致。

3.1 提供者接入Soul

3.1.1 pom

<dependency>
  <groupId>org.dromara</groupId>
  <artifactId>soul-spring-boot-starter-client-alibaba-dubbo</artifactId>
  <version>2.2.0</version>
</dependency>
<dependency>
  <groupId>org.dromara</groupId>
  <artifactId>soul-spring-boot-starter-client-springmvc</artifactId>
  <version>2.2.0</version>
</dependency>
<dependency>
  <groupId>org.dromara</groupId>
  <artifactId>soul-client-springmvc</artifactId>
  <version>2.2.0</version>
</dependency>

3.1.2 Controller


与之前不同的是,这里我们会在Controller增加一个注解,@SoulSpringMvcClient,标注其注册成为一个SoulSpringMvcClient对象。这里有两种方式,一种是全局,一种是下面示例文件的局部,我会在 3.1.3 配置文件具体讲解二者实现上的差异性。

其中@SoulSpringMvcClient(path = "/consumer/** "), ** 标识允许访问:consumer路径下全部,如果在当前Controller中,你只想部分暴露,那么更正为:

  • 删除Controller上的:SoulSpringMvcClient(path = "/consumer/** ")
  • 在对应需要暴露的接口上,加上全路径,如:  @SoulSpringMvcClien(path = "/consumer/getUserById")
package com.youzha.dubbo.Controller;
import com.youzha.dubbo.dto.ResultDTO;
import com.youzha.dubbo.entity.User;
import com.youzha.dubbo.service.RemoteUserService;
import lombok.extern.slf4j.Slf4j;
import org.dromara.soul.client.springmvc.annotation.SoulSpringMvcClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;
/**
 * @author youzhaxiaobo
 * @version 1.0
 * @date 2020/7/1 19:30
 * @Desc
 */
@Slf4j
@RestController
@RequestMapping("/consumer")
@SoulSpringMvcClient(path = "/consumer/**")
public class ConsumerController {
    @Autowired
    private RemoteUserService userService;
    @GetMapping(value = "/getUserById", produces = MediaType.APPLICATION_JSON_VALUE)
    public ResultDTO getUserById(@RequestParam("id") int id) {
        log.info("id=" + id);
        User user = userService.findById(id);
        log.info("消费者获取用户,信息为:{}", user);
        if(null == user) {
           return new ResultDTO(-1, "获取失败");
        }
        return new ResultDTO(200, "获取成功", user);
    }
    @GetMapping(value = "/helloWorld", produces = MediaType.APPLICATION_JSON_VALUE)
    public ResultDTO helloWorld() {
        log.info("id=" + 1);
        User user = userService.findById(1);
        log.info("消费者获取用户,信息为:{}", user);
        if(null == user) {
            return new ResultDTO(-1, "获取失败");
        }
        return new ResultDTO(200, "获取成功", user);
    }
}

3.1.3 配置文件

soul:
  # 网关http配置
  http:
    adminUrl: http://127.0.0.1:9093
    contextPath: /consumer
    appName: consumer
    full: false
    port: 9092

说明:

  • http:标注这里协议是Http,同样还有(dubbo等)
  • adminUrl:对应soul-admin启动的应用地址,端口
  • contextPath:对应注册进Soul的路由前缀(即我们后续通过网关访问的限制名,多个应用应不同)
  • appName:对应的应用名称,不配置的话,会默认取 dubbo配置中application 中的名称
  • full:true则表示代理全部,全局允许访问,权限很大;false表示非全局,只访问有注解的地方(推荐)
  • port:当前应用的启动端口,并非soul-admin或网关,需保持一直


另外,如果你在 application.yaml(properties) 中配置了context-path,请删除,这个配置对于Soul而言是无感知的,即你的配置文件中不应出现下面的servlet配置:

server:
  port: 9092
  servlet:
    context-path: **

如果你在这里配置的:full是false,那么对应3.1.2章节就无需调整,如果是true,直接3.1.2关于SoulPringMvcClient相关注解即可。

3.2 消费者接入Soul

消费者相关配置,和提供者是一致的,这里不再赘述,直接贴出相关代码。

3.2.1 pom

<dependency>
  <groupId>org.dromara</groupId>
  <artifactId>soul-spring-boot-starter-client-alibaba-dubbo</artifactId>
  <version>2.2.0</version>
</dependency>
<dependency>
  <groupId>org.dromara</groupId>
  <artifactId>soul-spring-boot-starter-client-springmvc</artifactId>
  <version>2.2.0</version>
</dependency>
<dependency>
  <groupId>org.dromara</groupId>
  <artifactId>soul-client-springmvc</artifactId>
  <version>2.2.0</version>
</dependency>

3.2.2 Controller

package com.youzha.dubbo.controller;
import com.youzha.dubbo.dto.ResultDTO;
import lombok.extern.slf4j.Slf4j;
import org.dromara.soul.client.springmvc.annotation.SoulSpringMvcClient;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author youzhaxiaobo
 * @version 1.0
 * @date 2020/7/4 0004 13:52
 * @Desc
 */
@Slf4j
@RestController
@RequestMapping("/provider")
@SoulSpringMvcClient(path = "/provider/**")
public class ProviderController {
    @GetMapping(value = "/hello", produces = MediaType.APPLICATION_JSON_VALUE)
    public ResultDTO getUserById(@RequestParam("id") int id) {
        log.info("id=" + id);
        if (id > 0) {
            return new ResultDTO(-1, "获取失败");
        }
        return new ResultDTO(200, "获取成功");
    }
}

3.2.3 配置文件

soul:
  # 网关dubbo配置
  dubbo:
    adminUrl: http://127.0.0.1:9093
    contextPath: /provider-youzha
    appName: provider-youzha
  # 网关http配置
  http:
    adminUrl: http://127.0.0.1:9093
    contextPath: /provider
    appName: provider
    full: false
    port: 9091

说明:

  • 这里同时暴露出去了dubbo,http两套协议,dubbo对应的就是我们提供在Service层的代码,其变更很小,如下,只是增加了一个注解:@SoulDubboClient

  • dubbo,http提供的contextPath的路由前缀,需要保持不同,同时全局唯一(即不能和其他应用一致)

3.3 验证

前提:启动了zookeeper,启动了MySQL。

3.3.1 启动soul-admin

直接启动相关Application即可,登陆控制台查看:localhost:9093,用户名/密码:admin/123456。

成功之后,查看插件,注意这里确保二者开启,且配置项和我吻合:

其中:divide

zk:

{"register":"zookeeper://127.0.0.1:2181"}

3.3.2 启动soul-boostrap

直接启动相关Application即可。

3.3.3 启动soul-provider

直接启动相关Application即可,出现下面的日志则表示注册成功:

3.3.4 启动soul-consumer

直接启动相关Application即可,出现下面的日志则表示注册成功:

注意:

3.3.3,3.3.4启动完成之后,查看soul-admin的网页管理端,应该出现下图:

3.3.5 验证

此时直接通过自身IP访问消费者,地址:http://localhost:9092/consumer/getUserById?id=1,查看日志:

消费者:

提供者:

通过网关访问消费者,地址:http://localhost:9094/consumer/consumer/getUserById?id=1,查看日志:

消费者:

提供者:

直接通过自身IP访问提供者,地址:http://localhost:9091/provider/hello?id=-1

通过网关访问提供者,地址:http://localhost:9094/provider/provider/hello?id=-1

Chrome POST验证provider的dubbo接口

fetch(new Request('http://localhost:9094/provider/provider-youzha/findById',{
    method:'POST', 
    headers: {'Content-Type': 'application/x-www-form-urlencoded'},
    body:"id=1"
})).then((resp)=>{console.log(resp)})

注意:

  • 通过网关访问,其地址为boostrap对应的:ip+端口
  • 访问地址需要加上路由前缀,即配置文件中 soul 模块中的contextPath
  • 如果你的项目和soul不部署在同一服务器,请在你的配置文件中追加上该配置(以你实际部署机器IP为准),保证Soul能管理你的服务
  • soul.http.host=168.10.54.115


3.4 完整代码

📎Dubbo_Soul.rar

📎zookeeper.rar

📎redis.rar

📎Soul.rar

相关文章
|
3月前
|
canal 缓存 关系型数据库
微服务原理篇(Canal-Redis)
本文介绍了ES索引同步的常见方案,重点讲解Canal+MQ数据同步机制。通过解析MySQL的binlog日志,Canal模拟slave伪装接入主库,实现增量数据捕获,并结合RabbitMQ保证消息顺序性地同步至Elasticsearch。同时探讨了缓存一致性问题,提出使用分布式锁(如Redis)控制并发写操作,避免双写不一致。还涵盖Redis持久化、集群模式、过期淘汰策略及缓存三剑客(穿透、雪崩、击穿)的解决方案,系统梳理了高并发场景下的数据同步与缓存保障技术体系。
173 0
 微服务原理篇(Canal-Redis)
|
1月前
|
人工智能 安全 机器人
🔥🔥🔥阿里云无影云电脑一键部署OpenClaw(Clawdbot)图文教程
阿里云无影云电脑一键部署OpenClaw(Clawdbot)教程:3分钟极速启动,内置镜像预装OpenClaw及多款应用,支持钉钉、QQ、飞书等IM平台机器人快速集成,无需开发,配置API Key与通道密钥即可运行。
555 0
|
3月前
|
Arthas Java 测试技术
基础指令
Arthas 是一款Java诊断工具,支持查看线程信息(dashboard、thread)、反编译类(jad)、观测方法调用(watch)等。可通过命令查看最忙线程、阻塞线程、指定状态线程及方法入参出参,支持采样间隔设置,帮助快速定位性能问题。
基础指令
|
3月前
|
Arthas 监控 Java
下载安装
Arthas 是一款Java诊断工具,使用前需确保服务器已启动Java应用、安装JDK并可访问公网。通过下载 arthas-boot.jar 并启动,可连接目标Java进程进行实时监控与问题排查,支持多进程选择,操作简单高效。
下载安装
|
3月前
|
SQL Java 数据库连接
持久层框架MyBatisPlus
MyBatisPlus是MyBatis的增强框架,简化单表CRUD操作,通过继承BaseMapper即可实现增删改查,支持条件构造器、分页插件、代码生成等功能,提升开发效率,广泛应用于企业项目中。
 持久层框架MyBatisPlus
|
3月前
|
Arthas 存储 运维
记Arthas实现一次CPU排查与代码热更新
本文介绍如何使用Arthas排查Java应用CPU占用过高问题,通过thread、watch、jad等指令定位线程阻塞与异常代码,并实现无需重启的热更新修复,结合profile生成火焰图进行性能分析,提升线上问题处理效率。
记Arthas实现一次CPU排查与代码热更新
|
9月前
|
NoSQL 网络安全 Redis
RedisDesktopManager免费软件下载,Redis桌面管理器(又名RDM),redis管理器
Redis桌面管理器(RDM)是一款支持Windows、Linux和MacOS的开源Redis数据库管理工具,提供易于使用的GUI界面,支持SSL/TLS加密、SSH隧道及云服务集成。本文档介绍了RDM的安装方法,并详细列出了Redis常用命令分类教程,包括键操作、字符串、哈希、列表、集合、有序集合、发布/订阅、事务及服务器管理等核心功能,帮助用户快速上手Redis开发与管理。
3308 1
|
Java Maven 开发者
maven项目中官方setting.xml文件
`settings.xml` 是 Maven 的配置文件,用于定义用户或全局级别的构建行为。它包含本地仓库路径、网络代理、服务器认证、仓库镜像及构建配置文件等设置,帮助开发者根据环境定制 Maven 行为,提升构建效率与灵活性。
1474 0
|
9月前
|
人工智能 JSON 测试技术
AI 驱动 API 研发提效:解析 Apipost 在 API 文档生成场景的全流程能力
随着AI和大模型技术发展,软件开发步入智能化时代。API研发作为核心环节,高效调试与文档编写至关重要。Apipost是国内领先的API协同工具,提供从API设计到性能测试的完整闭环,支持AI驱动的文档生成、Markdown润色及OpenAPI生成等功能,显著提升团队效率。其AI功能可一键补全参数描述、生成示例代码与响应样例,减少重复劳动,助力开发者专注于业务逻辑优化。无论是快速迭代还是大规模接口设计,Apipost都为高效协作提供了强大支持。
612 0
|
网络协议 Java Nacos
SpringCloudAlibaba-Seata2.0.0与Nacos2.2.1
检查 Nacos 控制台,确认 Seata 服务器和 Spring Boot 应用已成功注册。 - 通过执行全局事务验证 Seata 的分布式事务管理功能。
1523 31

热门文章

最新文章