全链路上下文demo

Author: lyb-geek

.gitignore

@@ -623,3 +623,5 @@
 /springboot-code-authorization/springboot-code-authorization.iml
 /springboot-mybatis-autoId/target/
 /springboot-mybatis-autoId/springboot-mybatis-autoId.iml
+/springboot-chaincontext/target/classes/com/github/lybgeek/chaincontext/
+/springboot-chaincontext/springboot-chaincontext.iml

README.md

@@ -106,3 +106,5 @@ springboot实战系列暂时先更新到这边，下边是对之前springboot实
 
 [springboot之优雅处理返回值](https://mp.weixin.qq.com/s?__biz=MzI1MTY1Njk4NQ==&mid=2247492409&idx=1&sn=e18d0511d71cec0a122d8ea950a81243&chksm=e9ed0d4fde9a8459183519ce711c71dce719d2382b8b9e33bd8adeadc0d6c1bee067b692a02a&token=2137971283&lang=zh_CN#rd)
 
+[如何使用自定义类加载器防止代码被反编译破解](https://mp.weixin.qq.com/s?__biz=MzI1MTY1Njk4NQ==&mid=2247493416&idx=1&sn=2c4cc888793e88df15396ff6fb3dbda0&chksm=e9ed095ede9a8048522c77d9a01d0675ccfd134d2db2f4adccc2eb9c5e85d998edc3c9da2097&token=1482534083&lang=zh_CN#rd)
+

pom.xml

@@ -33,6 +33,7 @@
         <module>springboot-unit-resp</module>
         <module>springboot-mybatis-autoId</module>
         <module>springboot-code-authorization</module>
+        <module>springboot-chaincontext</module>
     </modules>
     <parent>
         <groupId>org.springframework.boot</groupId>
@@ -95,10 +96,18 @@
         <hytrix.version>1.5.18</hytrix.version>
         <spring-kafka.version>2.2.6.RELEASE</spring-kafka.version>
         <hutool.version>5.4.1</hutool.version>
+        <spring-cloud.version>Greenwich.RC2</spring-cloud.version>
     </properties>
 
     <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>
             <dependency>
                 <groupId>org.yaml</groupId>
                 <artifactId>snakeyaml</artifactId>

springboot-chaincontext/ReadME.md

@@ -0,0 +1,6 @@
+该demo主要演示全链路上下文,其功能包括如下
+
+- RestTemplate在调用下游服务时如何将链路上下文数据携带?
+- Feign在调用下游服务时如何将链路上下文数据携带?
+- 服务接收方如何将header或者参数中携带的相关数据设置到链路上下文中?
+- 如何保证hystrix线程池的情况下链路上下文依然有效?

springboot-chaincontext/pom.xml

@@ -0,0 +1,30 @@
+<?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>springboot-learning</artifactId>
+        <groupId>com.github.lybgeek</groupId>
+        <version>0.0.1-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>springboot-chaincontext</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-openfeign</artifactId>
+        </dependency>
+    </dependencies>
+
+
+</project>

springboot-chaincontext/src/main/java/com/github/lybgeek/chaincontext/ChainContextHolder.java

@@ -0,0 +1,70 @@
+package com.github.lybgeek.chaincontext;
+
+import java.util.Optional;
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * The ChainRequestContext holds all key-value config while key is in {@link ChainContextProperties#getKeys()}
+ * <p>
+ * the ChainRequestContext is an extension of a ConcurrentHashMap
+ * 
+ * @author linyb
+ *
+ */
+public class ChainContextHolder extends ConcurrentHashMap<String, Object> {
+
+    private static final long serialVersionUID = -5792996927212791314L;
+
+    protected static Class<? extends ChainContextHolder> contextClass = ChainContextHolder.class;
+
+    protected static final ThreadLocal<? extends ChainContextHolder> THREAD_LOCAL = new InheritableThreadLocal<ChainContextHolder>() {
+        @Override
+        protected ChainContextHolder initialValue() {
+            try {
+                return contextClass.newInstance();
+            } catch (Throwable e) {
+                throw new RuntimeException(e);
+            }
+        }
+    };
+
+    /**
+     * Override the default ChainRequestContext
+     *
+     * @param clazz
+     */
+    public static void setContextClass(Class<? extends ChainContextHolder> clazz) {
+        contextClass = clazz;
+    }
+
+    /**
+     * Get the current ChainRequestContext
+     * 
+     * @return the current ChainRequestContext
+     */
+    public static final ChainContextHolder getCurrentContext() {
+        return THREAD_LOCAL.get();
+    }
+
+    /**
+     * Unsets the threadLocal context. Done at the end of the request.
+     * 
+     * @return
+     */
+    public void unset() {
+        this.clear();
+        THREAD_LOCAL.remove();
+    }
+
+    /**
+     * Returns either passed value of the key, or if the value is {@code null}, the value of {@code defaultValue}.
+     * 
+     * @param key
+     * @param defaultValue
+     * @return
+     */
+    public Object getDefault(String key, Object defaultValue) {
+        return Optional.ofNullable(get(key)).orElse(defaultValue);
+    }
+
+}

springboot-chaincontext/src/main/java/com/github/lybgeek/chaincontext/ChainContextProperties.java

@@ -0,0 +1,42 @@
+package com.github.lybgeek.chaincontext;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+import java.util.List;
+
+/**
+ *
+ * 
+ * @author linyb
+ *
+ */
+@ConfigurationProperties(prefix = "spring.chaincontext")
+public class ChainContextProperties {
+
+    /**
+     * Keys to set in chaincontext, all keys with keyPrefix will add to chaincontext while keys is empty
+     */
+    private List<String> keys;
+
+    /**
+     * The prefix of all keys
+     */
+    private String keyPrefix = "X-CHAIN-";
+
+    public List<String> getKeys() {
+        return keys;
+    }
+
+    public void setKeys(List<String> keys) {
+        this.keys = keys;
+    }
+
+    public String getKeyPrefix() {
+        return keyPrefix;
+    }
+
+    public void setKeyPrefix(String keyPrefix) {
+        this.keyPrefix = keyPrefix;
+    }
+    
+}

springboot-chaincontext/src/main/java/com/github/lybgeek/chaincontext/autoconfig/ChainContextAutoConfiguration.java

@@ -0,0 +1,51 @@
+package com.github.lybgeek.chaincontext.autoconfig;
+
+import com.github.lybgeek.chaincontext.ChainContextProperties;
+import com.github.lybgeek.chaincontext.feign.FeignConfiguration;
+import com.github.lybgeek.chaincontext.hystrix.HystrixChainContextConfiguration;
+import com.github.lybgeek.chaincontext.mvc.ChainContextWebMvcConfigure;
+import com.github.lybgeek.chaincontext.mvc.ChainContexthandlerInterceptor;
+import com.github.lybgeek.chaincontext.parser.DefaultRequestKeyParser;
+import com.github.lybgeek.chaincontext.parser.IRequestKeyParser;
+import com.github.lybgeek.chaincontext.rest.ChainContextBeanPostProcessor;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+
+
+/**
+ *
+ * @author linyb
+ *
+ */
+@Configuration
+@Import({FeignConfiguration.class, HystrixChainContextConfiguration.class})
+@EnableConfigurationProperties(ChainContextProperties.class)
+public class ChainContextAutoConfiguration implements WebMvcConfigurer {
+
+    @Autowired
+    private ChainContextProperties chainContextProperties;
+
+    @ConditionalOnMissingBean
+    @Bean
+    public IRequestKeyParser requestKeyParser() {
+        return new DefaultRequestKeyParser();
+    }
+
+    @Bean
+    public WebMvcConfigurer webMvcConfigurer(IRequestKeyParser requestKeyParser) {
+        ChainContexthandlerInterceptor interceptor = new ChainContexthandlerInterceptor(chainContextProperties, requestKeyParser);
+        return new ChainContextWebMvcConfigure(interceptor);
+    }
+
+    @Bean
+    public ChainContextBeanPostProcessor chainContextBeanPostProcessor() {
+        return new ChainContextBeanPostProcessor();
+    }
+    
+}

springboot-chaincontext/src/main/java/com/github/lybgeek/chaincontext/feign/ChainContextRequestInterceptor.java

@@ -0,0 +1,25 @@
+package com.github.lybgeek.chaincontext.feign;
+
+
+import com.github.lybgeek.chaincontext.ChainContextHolder;
+import feign.RequestInterceptor;
+import feign.RequestTemplate;
+
+/**
+ * RequestInterceptor to add chain context to feign request
+ * 
+ * @author linyb
+ *
+ */
+public class ChainContextRequestInterceptor implements RequestInterceptor {
+
+    @Override
+    public void apply(RequestTemplate template) {
+        if (ChainContextHolder.getCurrentContext() != null) {
+            ChainContextHolder.getCurrentContext().forEach((key, value) -> {
+                template.header(key, value.toString());
+            });
+        }
+    }
+
+}

springboot-chaincontext/src/main/java/com/github/lybgeek/chaincontext/feign/FeignConfiguration.java

@@ -0,0 +1,21 @@
+package com.github.lybgeek.chaincontext.feign;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import com.netflix.loadbalancer.ILoadBalancer;
+
+import feign.Feign;
+import feign.RequestInterceptor;
+
+@ConditionalOnClass(value = { ILoadBalancer.class, Feign.class })
+@Configuration
+public class FeignConfiguration {
+    
+    @Bean
+    public RequestInterceptor requestInterceptor() {
+        return new ChainContextRequestInterceptor();
+    }
+
+}