Spring boot 入门之Zuul

旧城等待， 2021-09-23 04:02 116阅读 0赞

# 1.创建spring boot基础工程，名称为service-gateway。 #

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">
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.hand</groupId>
        <artifactId>service-gateway</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
        <name>service-gateway</name>
        <description>Demo project for Spring Boot</description>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.7.RELEASE</version>
            <relativePath/> 
        </parent>
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka-server</artifactId>
            </dependency>
        </dependencies>
        <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>
        <build>
            <plugins>
                <plugin>
                <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>

## 其中有一些配置是自带的生成的，没有的就加进去。 ##

src目录下找到启动项：ServiceGatewayApplication，加入注解

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
    @EnableEurekaServer
    @SpringBootApplication
    public class ServiceGatewayApplication {
        public static void main(String[] args) {
        SpringApplication.run(ServiceGatewayApplication.class, args);
        }
    }

application.properties配置文件改为：

server.port=1111
    eureka.client.register-with-eureka=false
    eureka.client.fetch-registry=false
    eureka.client.serviceUrl.defaultZone=http://localhost:${server.port}/eureka/

# 2.在基础的boot工程里面加入service-A服务 #

![这里写图片描述][SouthEast]  
先选中boot工程，在点击File。  
![这里写图片描述][SouthEast 1]  
点击 new –> module 创建boot.名称为 service-a  
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">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.hand</groupId>
        <artifactId>service-a</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
        <name>service-a</name>
        <description>Demo project for Spring Boot</description>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.7.RELEASE</version>
            <relativePath/> 
        </parent>
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka</artifactId>
            </dependency>
        </dependencies>
        <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>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>

## src目录下ServiceAApplication加入注解： ##

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    @EnableDiscoveryClient
    @SpringBootApplication
    public class ServiceAApplication { 
        public static void main(String[] args) {
            SpringApplication.run(ServiceAApplication.class, args);
        }
    }

## 加入controller提供服务； ##

import com.hand.dto.Test;
    import com.hand.service.ITestService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.cloud.client.ServiceInstance;
    import org.springframework.cloud.client.discovery.DiscoveryClient;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    import java.util.List;
    import java.util.logging.Logger;
    /** * Created by qqg on 2017/9/15. */
    @RestController
    public class ComputeController {
        private final Logger logger = Logger.getLogger(String.valueOf(getClass()));
        @Autowired
        private DiscoveryClient client;
        @RequestMapping(value = "/add" ,method = RequestMethod.GET)
        public Integer add(@RequestParam Integer a, @RequestParam Integer b) {
            ServiceInstance instance = client.getLocalServiceInstance();
    
            Integer r = a + b;
            logger.info("/add, host:" + instance.getHost() + ", service_id:" + instance.getServiceId() + ", result:" + r);
            return r;
        }
    }

## application.properties配置文件 ##

spring.application.name=service-A
    server.port=2222
    eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

# 3.在基础boot中加入Zuul服务，名称为zuul-gateway。同上，创建spring boot 应用。 #

## 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">
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.hand</groupId>
        <artifactId>zuul-gateway</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
        <name>zuul-gateway</name>
        <description>Demo project for Spring Boot</description>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.7.RELEASE</version>
            <relativePath/> 
        </parent>
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-zuul</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka</artifactId>
            </dependency>
        </dependencies>
        <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>
        <build>
            <plugins>
                <plugin>
                <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>

## Application的编写 ##

import com.hand.filter.AccessFilter;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.SpringCloudApplication;
    import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
    import org.springframework.context.annotation.Bean;
    @EnableZuulProxy
    @SpringCloudApplication
    public class ZuulGatewayApplication {
        public static void main(String[] args) {
        SpringApplication.run(ZuulGatewayApplication.class, args);
        }
        @Bean
        public AccessFilter accessFilter() {
            return new AccessFilter();
        }
    }

## 过滤器的编写 ##

import com.netflix.zuul.ZuulFilter;
    import com.netflix.zuul.context.RequestContext;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import javax.servlet.http.HttpServletRequest;
    /** * Created by qqg on 2017/9/19. */
    public class AccessFilter extends ZuulFilter { 
        private static Logger log = LoggerFactory.getLogger(AccessFilter.class);
        @Override
        public String filterType() {
            return "pre";
        }
        @Override
        public int filterOrder() {
            return 0;
        }
        @Override
        public boolean shouldFilter() {
            return true;
        }
        @Override
        public Object run() {
            RequestContext ctx = RequestContext.getCurrentContext();
            HttpServletRequest request = ctx.getRequest();
            log.info(String.format("%s request to %s", request.getMethod(), request.getRequestURL().toString()));
            Object accessToken = request.getParameter("accessToken");
            if(accessToken == null) {
                log.warn("access token is empty");
                ctx.setSendZuulResponse(false);
                ctx.setResponseStatusCode(401);
                return null;
            }
            log.info("access token ok");
            return null;
        }
    }

## application.properties配置文件 ##

spring.application.name=api-gateway
    server.port=5555
    # routes to url
    zuul.routes.api-a.path=/api-a/** zuul.routes.api-a.serviceId=service-A eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

## zuul.routes.api-a.serviceId=service-A表示服务名称，zuul.routes.api-a.path=/api-a/\*\*该服务名称对应过滤的链接。 ##

# 4。启动3个服务。访问[http://localhost:1111][http_localhost_1111] #

![这里写图片描述][SouthEast 2]

## 说明你创建没有问题。 ##

访问：[http://localhost:5555/api-a/add?a=1&b=2&accessToken=token][http_localhost_5555_api-a_add_a_1_b_2_accessToken_token]  
![这里写图片描述][SouthEast 3]  
访问：[http://localhost:5555/api-a/add?a=1&b=2][http_localhost_5555_api-a_add_a_1_b_2]  
![这里写图片描述][SouthEast 4]

## 返回空，不知道为什么不是401页面，都设置了。 ##

## 不过过滤器起作用了。 ##

# 5.下篇在说说在这个的基础上连接数据库。 #

[SouthEast]: /images/20210923/bf892ee08261475a8b759492f8a5947e.png
[SouthEast 1]: /images/20210923/e3944dced5e84f35b3280b03cb0a10cd.png
[http_localhost_1111]: http://localhost:1111
[SouthEast 2]: /images/20210923/9e8bd2575889440baaecb6a0306bdf2d.png
[http_localhost_5555_api-a_add_a_1_b_2_accessToken_token]: http://localhost:5555/api-a/add?a=1&b=2&accessToken=token
[SouthEast 3]: /images/20210923/ea0fe295cf514b1f9857214086d25c82.png
[http_localhost_5555_api-a_add_a_1_b_2]: http://localhost:5555/api-a/add?a=1&b=2
[SouthEast 4]: /images/20210923/b9e18378186d4711bebc9ec5b60303f7.png