微服務網關實戰02-網關搭建

在本文中，將會帶着大家一步一步進行網關的搭建，主要涉及到日誌、鑑權、全局異常、限流、斷路、斷路看板等

 

這裏比較簡單，直接新建一個springboot項目即可，整個項目的目錄結構如下：

 

網關項目目錄結構

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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>platform</groupId>
    <artifactId>gateway</artifactId>
    <version>1.0.0.RELEASE</version>
    <name>platform-gateway</name>
    <description>微服務網關實戰</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Hoxton.SR1</spring-cloud.version>
        <maven-jar-plugin.version>3.1.1</maven-jar-plugin.version>
    </properties>

    <dependencies>

        <!-- zuul核心 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        
        <!-- 註冊中心客戶端 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

        <!-- springboot熱部署 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional>
        </dependency>

        <!-- 單元測試 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</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>
     

main函數如下：

package com.platform.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

// 網關注解
@EnableZuulProxy
// 註冊中心註解
@EnableDiscoveryClient
@SpringBootApplication
public class PlatformGatewayApplication {

    public static void main(String[] args) {
        SpringApplication.run(PlatformGatewayApplication.class, args);
    }

}

application.yml代碼如下：

######配置基本信息###################################
##配置應用名稱,強制,需要註冊到註冊中心
spring.application.name: platform-gateway
##配置時間格式,爲了避免精度丟失,全部換成字符串
spring.jackson.timeZone: GMT+8
spring.jackson.dateFormat: yyyy-MM-dd HH:mm:ss
spring.jackson.generator.writeNumbersAsStrings: true
##配置環境+熱部署###################################
##代表這需要加載哪個環境，dev代表着會加載application-dev.yml文件中的屬性
spring.profiles.active: dev
##熱部署啓動
spring.devtools.restart.enabled: true
######日誌配置###################################
logging.level.com.platform: debug
#######配置路由信息###################################
#數據服務路由前綴配置
zuul.routes.atomic-datas.path: /datas/**
#數據服務對應的原子服務名,此名字與註冊中心上的名字一致，不過小寫也行
zuul.routes.atomic-datas.serviceId: atomic-datas

application-dev.yml代碼如下：

#####配置服務器基礎信息#######
#網關的端口
server.port: 8012
#####配置註冊中心#######
#將IP註冊到註冊中心上
eureka.instance.prefer-ip-address: true
#IP名稱
eureka.instance.instance-id: ${spring.cloud.client.ip-address}:${server.port}
#註冊中心地址
eureka.client.service-url.defaultZone: http://127.0.0.1:8761/eureka/

logback-spring.xml代碼如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設置爲WARN，則低於WARN的信息都不會輸出 -->
<!-- scan:當此屬性設置爲true時，配置文檔如果發生改變，將會被重新加載，默認值爲true -->
<!-- scanPeriod:設置監測配置文檔是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。 -->
<!-- debug:當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
	<contextName>logback</contextName>

	<!-- name的值是變量的名稱，value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義後，可以使“${}”來使用變量。 -->
	<property name="log.path" value="applog" />

	<!-- 日誌格式和顏色渲染 -->
	<!-- 彩色日誌依賴的渲染類 -->
	<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
	<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
	<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
	<!-- 彩色日誌格式 -->
	<property name="console_log_pattern"
		value="${console_log_pattern:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />

	<!--1. 輸出到控制檯 -->
	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
		<!--此日誌appender是爲開發使用，只配置最底級別，控制檯輸出的日誌級別是大於或等於此級別的日誌信息 -->
		<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
			<level>debug</level>
		</filter>
		<encoder>
			<Pattern>${console_log_pattern}</Pattern>
			<!-- 設置字符集 -->
			<charset>UTF-8</charset>
		</encoder>
	</appender>

	<!--2. 輸出到文檔 -->
	<!-- 2.1 level爲 DEBUG 日誌，時間滾動輸出 -->
	<appender name="debug_file" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<!-- 正在記錄的日誌文檔的路徑及文檔名 -->
		<file>${log.path}/appDebug.log</file>
		<!--日誌文檔輸出格式 -->
		<encoder>
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
			<charset>UTF-8</charset> <!-- 設置字符集 -->
		</encoder>
		<!-- 日誌記錄器的滾動策略，按日期，按大小記錄 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<!-- 日誌歸檔 -->
			<fileNamePattern>${log.path}/appDebug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
				<maxFileSize>100MB</maxFileSize>
			</timeBasedFileNamingAndTriggeringPolicy>
			<!--日誌文檔保留天數 -->
			<maxHistory>15</maxHistory>
		</rollingPolicy>
		<!-- 此日誌文檔只記錄debug級別的 -->
		<filter class="ch.qos.logback.classic.filter.LevelFilter">
			<level>debug</level>
			<onMatch>ACCEPT</onMatch>
			<onMismatch>DENY</onMismatch>
		</filter>
	</appender>

	<!-- 2.2 level爲 INFO 日誌，時間滾動輸出 -->
	<appender name="info_file" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<!-- 正在記錄的日誌文檔的路徑及文檔名 -->
		<file>${log.path}/appInfo.log</file>
		<!--日誌文檔輸出格式 -->
		<encoder>
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
			<charset>UTF-8</charset>
		</encoder>
		<!-- 日誌記錄器的滾動策略，按日期，按大小記錄 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<!-- 每天日誌歸檔路徑以及格式 -->
			<fileNamePattern>${log.path}/appInfo-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
				<maxFileSize>100MB</maxFileSize>
			</timeBasedFileNamingAndTriggeringPolicy>
			<!--日誌文檔保留天數 -->
			<maxHistory>15</maxHistory>
		</rollingPolicy>
		<!-- 此日誌文檔只記錄info級別的 -->
		<filter class="ch.qos.logback.classic.filter.LevelFilter">
			<level>info</level>
			<onMatch>ACCEPT</onMatch>
			<onMismatch>DENY</onMismatch>
		</filter>
	</appender>

	<!-- 2.3 level爲 WARN 日誌，時間滾動輸出 -->
	<appender name="warn_file" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<!-- 正在記錄的日誌文檔的路徑及文檔名 -->
		<file>${log.path}/appWarn.log</file>
		<!--日誌文檔輸出格式 -->
		<encoder>
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
			<charset>UTF-8</charset> <!-- 此處設置字符集 -->
		</encoder>
		<!-- 日誌記錄器的滾動策略，按日期，按大小記錄 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<fileNamePattern>${log.path}/appWarn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
				<maxFileSize>100MB</maxFileSize>
			</timeBasedFileNamingAndTriggeringPolicy>
			<!--日誌文檔保留天數 -->
			<maxHistory>15</maxHistory>
		</rollingPolicy>
		<!-- 此日誌文檔只記錄warn級別的 -->
		<filter class="ch.qos.logback.classic.filter.LevelFilter">
			<level>warn</level>
			<onMatch>ACCEPT</onMatch>
			<onMismatch>DENY</onMismatch>
		</filter>
	</appender>

	<!-- 2.4 level爲 ERROR 日誌，時間滾動輸出 -->
	<appender name="error_file" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<!-- 正在記錄的日誌文檔的路徑及文檔名 -->
		<file>${log.path}/appError.log</file>
		<!--日誌文檔輸出格式 -->
		<encoder>
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
			<charset>UTF-8</charset> <!-- 此處設置字符集 -->
		</encoder>
		<!-- 日誌記錄器的滾動策略，按日期，按大小記錄 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<fileNamePattern>${log.path}/appError-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
				<maxFileSize>100MB</maxFileSize>
			</timeBasedFileNamingAndTriggeringPolicy>
			<!--日誌文檔保留天數 -->
			<maxHistory>15</maxHistory>
		</rollingPolicy>
		<!-- 此日誌文檔只記錄ERROR級別的 -->
		<filter class="ch.qos.logback.classic.filter.LevelFilter">
			<level>ERROR</level>
			<onMatch>ACCEPT</onMatch>
			<onMismatch>DENY</onMismatch>
		</filter>
	</appender>

	<!--當爲開發配置的時候，輸出到控制檯 -->
	<springProfile name="dev">
		<root level="info">
			<appender-ref ref="console" />
			<appender-ref ref="info_file" />
			<appender-ref ref="warn_file" />
			<appender-ref ref="error_file" />
		</root>
	</springProfile>

	<!--當爲測試配置的時候，輸出到文件 -->
	<springProfile name="test">
		<root level="info">
			<appender-ref ref="console" />
			<appender-ref ref="info_file" />
			<appender-ref ref="warn_file" />
			<appender-ref ref="error_file" />
		</root>
	</springProfile>

	<!--當爲生產配置的時候，輸出到阿里平臺 -->
	<springProfile name="pro">
		<root level="info">
			<appender-ref ref="console" />
			<appender-ref ref="info_file" />
			<appender-ref ref="warn_file" />
			<appender-ref ref="error_file" />
		</root>
	</springProfile>

</configuration>

運行main函數，然後通過網關調用接口

後端接口：
http://localhost:8013/web/demo/user/test

網關接口：
http://localhost:8012/datas/web/demo/user/test

注意對比：網關調用接口的時候，加了datas，這個屬性就在我們的application.yml裏面進行配置，最後得到結果如下：

 

至此網關項目搭建成功。

下面將會做網關的全局異常攔截