Spring Cloud与微服务之服务网关微服务

本是古典何须时尚 2022-04-08 12:43 260阅读 0赞

### 文章目录 ###

*  为什么要使用服务网关微服务
 *  springcloud-api-gateway
 *   *  springcloud-api-gateway项目结构
     *  springcloud-api-gateway源码
 *  springcloud-api-gateway的使用
 *   *  springcloud-api-gateway

# 为什么要使用服务网关微服务 #

在分布式的微服务中，很多情况下，我们不需要让外网访问我们全部的微服务，而只是选择将用户可能直接使用到的微服务暴漏出来，比如说我们这里同时搭建了商品微服务与订单微服务，而订单微服务可以用来方便用户对于自身订单的查询，而商品微服务就完全没有必要暴漏在外网中，因为商品微服务是直接被订单微服务所调用的，而不是被用户所调用的，而用户是通过订单微服务来间接使用商品微服务中的信息的，因而这里就需要我们使用相应的网关来拦截掉未经授权的访问。而这里我们采用的是使用SpringCloud的Zuul来实现服务网关微服务。

# springcloud-api-gateway #

## springcloud-api-gateway项目结构 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1paWTEwNzg2ODkyNzY_size_16_color_FFFFFF_t_70]

## springcloud-api-gateway源码 ##

UserLoginZuulFilter源码：

package com.lyc.filters;
    
    import com.netflix.zuul.ZuulFilter;
    import com.netflix.zuul.context.RequestContext;
    import org.apache.commons.lang.StringUtils;
    import org.springframework.stereotype.Component;
    
    import javax.servlet.http.HttpServletRequest;
    
    @Component  //加入到Spring容器
    public class UserLoginZuulFilter extends ZuulFilter { 
    
        @Override
        public String filterType() { 
            return "pre";    //设置过滤器类型为pre
        }
    
        @Override
        public int filterOrder() { 
            return 0;   //设置执行顺序
        }
    
        @Override
        public boolean shouldFilter() { 
            return true;   //该过滤需要执行
        }
    
        @Override
        public Object run() {   //编写业务逻辑
            RequestContext requestContext = RequestContext.getCurrentContext();
            HttpServletRequest request = requestContext.getRequest();
            String token = request.getParameter("token");
            if(StringUtils.isEmpty(token)){ 
                requestContext.setSendZuulResponse(false);   //过滤该请求，不对其进行路由
                requestContext.setResponseStatusCode(401);
                return null;
            }
            return null;
        }
    }

ApiGatewayApplication源码：

package com.lyc;
    
    import com.lyc.filters.UserLoginZuulFilter;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.SpringBootConfiguration;
    import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
    import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
    import org.springframework.context.annotation.Bean;
    
    @EnableZuulProxy
    @EnableAutoConfiguration
    @SpringBootConfiguration
    public class ApiGatewayApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(ApiGatewayApplication.class,args);
        }
    
        /** * 即便是所有的配置都写好了，如果不添加这个Bean方法，那还是不会执行任何的过滤方法 * @return */
        @Bean
        public UserLoginZuulFilter userLoginZuulFilter(){ 
            return new UserLoginZuulFilter();
        }
    }

application.yml源码：

server:
      port: 6677  #服务端口
    
    spring:
      application:
        name: springcloud-api-gateway #指定服务名
    
    zuul:
      routes:
        item-service:   #item-service 这个名字是任意写的
          path: /item-service/** #配置请求URL的请求规则
          #url: http://127.0.0.1:8081 #真正的微服务地址
          serviceId: springcloud-goods-item #指定Eureka注册中心的服务id
    
    eureka:
      client:
        registerWithEureka: true #是否将自己注册到Eureka服务中，本身就是所有无需注册
        fetchRegistry: true #是否从Eureka中获取注册信息
        serviceUrl: #Eureka客户端与Eureka服务端进行交互的地址
          defaultZone: http://root:root123@127.0.0.1:6868/eureka/
      instance:
        prefer-ip-address: true #将自己的ip地址注册到Eureka服务中

pom.xml源码：

<?xml version="1.0" encoding="UTF-8"?>
    
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>springcloud-parent</artifactId>
            <groupId>com.lyc</groupId>
            <version>1.0-RELEASE</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>springcloud-api-gateway</artifactId>
        <packaging>jar</packaging>
    
        <name>SpringCloud微服务：：网关服务器</name>
    
        <url>http://www.example.com</url>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        </properties>
    
        
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>Dalston.SR3</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-zuul</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka-server</artifactId>
            </dependency>
        </dependencies>
    
        <build>
            <finalName>${project.artifactId}</finalName>
        </build>
    
    </project>

# springcloud-api-gateway的使用 #

## springcloud-api-gateway ##

访问方式：

http://127.0.0.1:6677/item-service/item/1?token=123

其展示的结果：

这里我们访问的是商品微服务中的信息，以前我们访问商品微服务时是通过下面的路径：

http://127.0.0.1:8081/item/1

但是此时由于网关的存在，此时我们可以直接访问网关，然后由网关帮我们转向商品微服务，由于我们的网关接口号定义为6677，而我们在网关配置文件application.yml中的配置方式如下：

zuul:
      routes:
        item-service:   #item-service 这个名字是任意写的
          path: /item-service/** #配置请求URL的请求规则
          #url: http://127.0.0.1:8081 #真正的微服务地址
          serviceId: springcloud-goods-item #指定Eureka注册中心的服务id

上面中的path指的是拦截的url路径，而serviceId指的是Eureka注册中心的服务id，因而当我们访问/item-service/时，其就会去配置中心Eureka中查找相应的服务springcloud-goods-item，然后实现对商品微服务的访问拦截操作。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1paWTEwNzg2ODkyNzY_size_16_color_FFFFFF_t_70]: /images/20220405/f54e82815c8048bc80f4171305fd4616.png