53-微服务技术栈(高级):微服务网关Soul(Soul网关接入与验证)

本文涉及的产品
注册配置 MSE Nacos/ZooKeeper,118元/月
服务治理 MSE Sentinel/OpenSergo,Agent数量 不受限
云原生网关 MSE Higress,422元/月
简介: 此章节将基于上一章节基础之上,引入Soul网关,至于Soul网关是干什么的,怎么做的,我们会在后续章节讲解,1-3章节侧重于搭建应用。本章节的Soul网关接入,如果你1,2章节都是和我保持一致,那么只需要直接启动Soul网关即可,但是对应的provider,consumer应用是需要额外的代码接入的。开发环境和第二章保持一致。

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

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

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

1 提供者接入Soul

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>

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);

   }


}

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相关注解即可。

2 消费者接入Soul

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

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>

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, "获取成功");

   }

}

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 验证

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

3.1 启动soul-admin

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

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

其中:divide

zk:

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

3.2 启动soul-boostrap

直接启动相关Application即可。

3.3 启动soul-provider

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

3.4 启动soul-consumer

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

注意:

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

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

4 完整代码

📎Dubbo_Soul.rar

📎zookeeper.rar

📎redis.rar

📎Soul.rar

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
23天前
|
Cloud Native API
微服务引擎 MSE 及云原生 API 网关 2024 年 9 月产品动态
微服务引擎 MSE 及云原生 API 网关 2024 年 9 月产品动态。
|
30天前
|
缓存 监控 API
探索微服务架构中的API网关模式
【10月更文挑战第5天】随着微服务架构的兴起,企业纷纷采用这一模式构建复杂应用。在这种架构下,应用被拆分成若干小型、独立的服务,每个服务围绕特定业务功能构建并通过HTTP协议协作。随着服务数量增加,统一管理这些服务间的交互变得至关重要。API网关作为微服务架构的关键组件,承担起路由请求、聚合数据、处理认证与授权等功能。本文通过一个在线零售平台的具体案例,探讨API网关的优势及其实现细节,展示其在简化客户端集成、提升安全性和性能方面的关键作用。
70 2
|
1月前
|
存储 缓存 监控
探索微服务架构中的API网关模式
【10月更文挑战第1天】探索微服务架构中的API网关模式
85 2
|
4天前
|
监控 安全 应用服务中间件
微服务架构下的API网关设计策略与实践####
本文深入探讨了在微服务架构下,API网关作为系统统一入口点的设计策略、实现细节及其在实际应用中的最佳实践。不同于传统的摘要概述,本部分将直接以一段精简的代码示例作为引子,展示一个基于NGINX的简单API网关配置片段,随后引出文章的核心内容,旨在通过具体实例激发读者兴趣,快速理解API网关在微服务架构中的关键作用及实现方式。 ```nginx server { listen 80; server_name api.example.com; location / { proxy_pass http://backend_service:5000;
|
2天前
|
Web App开发 Dubbo 关系型数据库
Soul网关接入与验证
Soul网关接入与验证
18 0
Soul网关接入与验证
|
6天前
|
缓存 监控 API
探索微服务架构中的API网关模式
随着微服务架构的兴起,API网关成为管理和服务间交互的关键组件。本文通过在线零售公司的案例,探讨了API网关在路由管理、认证授权、限流缓存、日志监控和协议转换等方面的优势,并详细介绍了使用Kong实现API网关的具体步骤。
22 3
|
6天前
|
存储 缓存 监控
探索微服务架构中的API网关模式
探索微服务架构中的API网关模式
20 2
|
27天前
|
运维 Cloud Native 应用服务中间件
阿里云微服务引擎 MSE 及 云原生 API 网关 2024 年 09 月产品动态
阿里云微服务引擎 MSE 面向业界主流开源微服务项目, 提供注册配置中心和分布式协调(原生支持 Nacos/ZooKeeper/Eureka )、云原生网关(原生支持Higress/Nginx/Envoy,遵循Ingress标准)、微服务治理(原生支持 Spring Cloud/Dubbo/Sentinel,遵循 OpenSergo 服务治理规范)能力。API 网关 (API Gateway),提供 APl 托管服务,覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等 API 生命周期阶段。帮助您快速构建以 API 为核心的系统架构.满足新技术引入、系统集成、业务中台等诸多场景需要
|
1月前
|
API 微服务
Traefik 微服务 API 网关教程(全)
Traefik 微服务 API 网关教程(全)
|
2月前
|
负载均衡 Java 网络架构
实现微服务网关:Zuul与Spring Cloud Gateway的比较分析
实现微服务网关:Zuul与Spring Cloud Gateway的比较分析
89 5