OpenGitLink
/
yudao-cloud
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

增加 yudao-spring-boot-starter-env 组件，完成 tag 请求头的读取到上下文

This commit is contained in:
YunaiV 2022-06-25 17:18:47 +08:00
parent fcfa66100c
commit f879c4aa2b
20 changed files with 232 additions and 156 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
pom.xml
View File

@ -16,7 +16,8 @@
<!-- <module>yudao-module-bpm</module>-->
<module>yudao-module-system</module>
<module>yudao-module-infra</module>
<!-- <module>yudao-module-pay</module>-->
<module>yudao-spring-boot-starter-env</module>
<!-- <module>yudao-module-pay</module>-->
</modules>
<name>${project.artifactId}</name>

6
yudao-dependencies/pom.xml
View File

@ -157,6 +157,12 @@
<version>${spring.boot.version}</version>
</dependency>
<dependency>
<groupId>cn.iocoder.cloud</groupId>
<artifactId>yudao-spring-boot-starter-env</artifactId>
<version>${revision}</version>
</dependency>
<!-- Web 相关 -->
<dependency>
<groupId>cn.iocoder.cloud</groupId>

2
yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/enums/WebFilterOrderEnum.java
View File

@ -13,6 +13,8 @@ public interface WebFilterOrderEnum {
int TRACE_FILTER = CORS_FILTER + 1;
int ENV_TAG_FILTER = TRACE_FILTER + 1;
int REQUEST_BODY_CACHE_FILTER = Integer.MIN_VALUE + 500;
// OrderedRequestContextFilter 默认为 -105，用于国际化上下文等等

51
yudao-framework/yudao-spring-boot-starter-env/pom.xml Normal file
View File

@ -0,0 +1,51 @@
<?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>
<groupId>cn.iocoder.cloud</groupId>
<artifactId>yudao-framework</artifactId>
<version>${revision}</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>yudao-spring-boot-starter-env</artifactId>
<packaging>jar</packaging>
<name>${project.artifactId}</name>
<description>
开发环境拓展，实现类似阿里的特性环境的能力
1. https://segmentfault.com/a/1190000018022987
</description>
<url>https://github.com/YunaiV/ruoyi-vue-pro</url>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>cn.iocoder.cloud</groupId>
<artifactId>yudao-common</artifactId>
</dependency>
<!-- Spring 核心 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!-- Web 相关 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
</dependency>
<dependency>
<groupId>jakarta.servlet</groupId>
<artifactId>jakarta.servlet-api</artifactId>
</dependency>
</dependencies>
</project>

18
yudao-framework/yudao-spring-boot-starter-env/src/main/java/cn/iocoder/yudao/framework/env/config/EnvProperties.java vendored Normal file
View File

@ -0,0 +1,18 @@
package cn.iocoder.yudao.framework.env.config;
import lombok.Data;
/**
* 环境
*
* @author 芋道源码
*/
@Data
public class EnvProperties {
/**
* 环境标签
*/
private String tag;
}

25
yudao-framework/yudao-spring-boot-starter-env/src/main/java/cn/iocoder/yudao/framework/env/config/YudaoEnvWebAutoConfiguration.java vendored Normal file
View File

@ -0,0 +1,25 @@
package cn.iocoder.yudao.framework.env.config;
import cn.iocoder.yudao.framework.common.enums.WebFilterOrderEnum;
import cn.iocoder.yudao.framework.env.core.web.EnvWebFilter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
public class YudaoEnvWebAutoConfiguration {
/**
* 创建 {@link EnvWebFilter} Bean
*/
@Bean
public FilterRegistrationBean<EnvWebFilter> envWebFilterFilter() {
EnvWebFilter filter = new EnvWebFilter();
FilterRegistrationBean<EnvWebFilter> bean = new FilterRegistrationBean<>(filter);
bean.setOrder(WebFilterOrderEnum.ENV_TAG_FILTER);
return bean;
}
}

39
yudao-framework/yudao-spring-boot-starter-env/src/main/java/cn/iocoder/yudao/framework/env/core/context/EnvContextHolder.java vendored Normal file
View File

@ -0,0 +1,39 @@
package cn.iocoder.yudao.framework.env.core.context;
import cn.hutool.core.collection.CollUtil;
import com.alibaba.ttl.TransmittableThreadLocal;
import java.util.ArrayList;
import java.util.List;
/**
* 开发环境上下文
*
* @author 芋道源码
*/
public class EnvContextHolder {
/**
* 标签的上下文
*
* 使用 {@link List} 的原因，可能存在多层设置或者清理
*/
private static final ThreadLocal<List<String>> tagContext = TransmittableThreadLocal.withInitial(ArrayList::new);
public static void setTag(String tag) {
tagContext.get().add(tag);
}
public static String getTag() {
return CollUtil.getLast(tagContext.get());
}
public static void removeTag() {
List<String> tags = tagContext.get();
if (CollUtil.isEmpty(tags)) {
return;
}
tags.remove(tags.size() - 1);
}
}

1
yudao-framework/yudao-spring-boot-starter-env/src/main/java/cn/iocoder/yudao/framework/env/core/package-info.java vendored Normal file
View File

@ -0,0 +1 @@
package cn.iocoder.yudao.framework.env.core;

26
yudao-framework/yudao-spring-boot-starter-env/src/main/java/cn/iocoder/yudao/framework/env/core/util/EnvUtils.java vendored Normal file
View File

@ -0,0 +1,26 @@
package cn.iocoder.yudao.framework.env.core.util;
import cn.hutool.core.net.NetUtil;
import javax.servlet.http.HttpServletRequest;
import java.util.Objects;
/**
* 环境 Utils
*
* @author 芋道源码
*/
public class EnvUtils {
private static final String HEADER_DUBBO_TAG = "tag";
private static final String HOST_NAME_VALUE = "${HOSTNAME}";
public static String getTag(HttpServletRequest request) {
String tag = request.getHeader(HEADER_DUBBO_TAG);
// 如果请求的是 "${HOSTNAME}"，则解析成对应的本地主机名
// 目的：特殊逻辑，解决 IDEA Rest Client 不支持环境变量的读取，所以就服务器来做
return Objects.equals(tag, HOST_NAME_VALUE) ? NetUtil.getLocalHostName() : tag;
}
}

41
yudao-framework/yudao-spring-boot-starter-env/src/main/java/cn/iocoder/yudao/framework/env/core/web/EnvWebFilter.java vendored Normal file
View File

@ -0,0 +1,41 @@
package cn.iocoder.yudao.framework.env.core.web;
import cn.hutool.core.util.StrUtil;
import cn.iocoder.yudao.framework.env.core.context.EnvContextHolder;
import cn.iocoder.yudao.framework.env.core.util.EnvUtils;
import org.springframework.web.filter.OncePerRequestFilter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* 环境的 {@link javax.servlet.Filter} 实现类
* 当有 tag 请求头时，设置到 {@link EnvContextHolder} 的标签上下文
*
* @author 芋道源码
*/
public class EnvWebFilter extends OncePerRequestFilter {
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
throws ServletException, IOException {
// 如果没有 tag，则走默认的流程
String tag = EnvUtils.getTag(request);
if (StrUtil.isEmpty(tag)) {
chain.doFilter(request, response);
return;
}
// 如果有 tag，则设置到上下文
EnvContextHolder.setTag(tag);
try {
chain.doFilter(request, response);
} finally {
EnvContextHolder.removeTag();
}
}
}

7
yudao-framework/yudao-spring-boot-starter-env/src/main/java/cn/iocoder/yudao/framework/env/package-info.java vendored Normal file
View File

@ -0,0 +1,7 @@
/**
* 开发环境拓展，实现类似阿里的特性环境的能力
* 1. https://segmentfault.com/a/1190000018022987
*
* @author 芋道源码
*/
package cn.iocoder.yudao.framework.env;

2
yudao-framework/yudao-spring-boot-starter-env/src/main/resources/META-INF/spring.factories Normal file
View File

@ -0,0 +1,2 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.iocoder.yudao.framework.env.config.YudaoEnvWebAutoConfiguration

2
yudao-framework/yudao-spring-boot-starter-rpc/pom.xml
View File

@ -38,7 +38,7 @@
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-common</artifactId> <!-- 兜底，保证在不引入 spring-cloud-starter-dubbo 时，注解等不报错 -->
</dependency>
<!-- -->
<!-- -->
<!-- <dependency>-->
<!-- <groupId>com.alibaba.cloud</groupId>-->
<!-- <artifactId>spring-cloud-starter-dubbo</artifactId>-->

15
yudao-module-system/yudao-module-system-biz/pom.xml
View File

@ -24,6 +24,11 @@
<artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>
<dependency>
<groupId>cn.iocoder.cloud</groupId>
<artifactId>yudao-spring-boot-starter-env</artifactId>
</dependency>
<!-- 依赖服务 -->
<dependency>
<groupId>cn.iocoder.cloud</groupId>
@ -105,11 +110,11 @@
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<!-- Job 定时任务相关 TODO 芋艿：暂时去掉 -->
<!-- <dependency>-->
<!-- <groupId>cn.iocoder.cloud</groupId>-->
<!-- <artifactId>yudao-spring-boot-starter-job</artifactId>-->
<!-- </dependency>-->
<!-- Job 定时任务相关 -->
<dependency>
<groupId>cn.iocoder.cloud</groupId>
<artifactId>yudao-spring-boot-starter-job</artifactId>
</dependency>
<!-- 消息队列相关 -->
<dependency>

1
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/AuthController.http
View File

@ -2,6 +2,7 @@
POST {{systemBaseUrl}}/system/auth/login
Content-Type: application/json
tenant-id: {{adminTenentId}}
tag: 123
{
"username": "admin",

31
归档/common/mall-spring-boot-starter-dubbo/src/main/java/cn/iocoder/mall/dubbo/config/DubboWebAutoConfiguration.java
View File

@ -1,31 +0,0 @@
package cn.iocoder.mall.dubbo.config;
import cn.iocoder.mall.dubbo.core.web.DubboRouterTagWebInterceptor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
public class DubboWebAutoConfiguration implements WebMvcConfigurer {
private Logger logger = LoggerFactory.getLogger(DubboWebAutoConfiguration.class);
// ========== 拦截器相关 ==========
@Override
public void addInterceptors(InterceptorRegistry registry) {
try {
// 设置为 -1000 的原因，保证在比较前面就处理该逻辑。例如说，认证拦截器；
registry.addInterceptor(new DubboRouterTagWebInterceptor()).order(-1000);
logger.info("[addInterceptors][加载 DubboRouterTagWebInterceptor 拦截器完成]");
} catch (NoSuchBeanDefinitionException e) {
logger.warn("[addInterceptors][无法获取 DubboRouterTagWebInterceptor 拦截器，无法使用基于 dubbo-tag 请求头进行 Dubbo 标签路由]");
}
}
}

27
归档/common/mall-spring-boot-starter-dubbo/src/main/java/cn/iocoder/mall/dubbo/core/router/DubboRouterTagContextHolder.java
View File

@ -1,27 +0,0 @@
package cn.iocoder.mall.dubbo.core.router;
import cn.iocoder.mall.dubbo.core.filter.DubboProviderRouterTagFilter;
/**
* Dubbo 路由 Tag 的上下文
*
* @see DubboProviderRouterTagFilter
* @see cn.iocoder.mall.dubbo.core.web.DubboRouterTagWebInterceptor
*/
public class DubboRouterTagContextHolder {
private static ThreadLocal<String> tagContext = new ThreadLocal<>();
public static void setTag(String tag) {
tagContext.set(tag);
}
public static String getTag() {
return tagContext.get();
}
public static void clear() {
tagContext.remove();
}
}

45
归档/common/mall-spring-boot-starter-dubbo/src/main/java/cn/iocoder/mall/dubbo/core/web/DubboRouterTagWebInterceptor.java
View File

@ -1,45 +0,0 @@
package cn.iocoder.mall.dubbo.core.web;
import cn.iocoder.common.framework.util.OSUtils;
import cn.iocoder.common.framework.util.StringUtils;
import cn.iocoder.mall.dubbo.core.cluster.interceptor.DubboConsumerRouterTagClusterInterceptor;
import cn.iocoder.mall.dubbo.core.filter.DubboProviderRouterTagFilter;
import cn.iocoder.mall.dubbo.core.router.DubboRouterTagContextHolder;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* Dubbo 路由标签的 Web 拦截器，将请求 Header 中的 {@link #HEADER_DUBBO_TAG} 设置到 {@link DubboRouterTagContextHolder} 中。
*
* @see DubboProviderRouterTagFilter
* @see DubboConsumerRouterTagClusterInterceptor
*/
public class DubboRouterTagWebInterceptor implements HandlerInterceptor {
private static final String HEADER_DUBBO_TAG = "dubbo-tag";
private static final String HOST_NAME_VALUE = "${HOSTNAME}";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
String tag = request.getHeader(HEADER_DUBBO_TAG);
if (StringUtils.hasText(tag)) {
// 特殊逻辑，解决 IDEA Rest Client 不支持环境变量的读取，所以就服务器来做
if (HOST_NAME_VALUE.equals(tag)) {
tag = OSUtils.getHostName();
}
// 设置到 DubboRouterTagContextHolder 上下文
DubboRouterTagContextHolder.setTag(tag);
}
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
DubboRouterTagContextHolder.clear();
}
}

3
归档/common/mall-spring-boot-starter-dubbo/src/main/resources/META-INF/spring.factories
View File

@ -1,5 +1,2 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.iocoder.mall.dubbo.config.DubboWebAutoConfiguration
org.springframework.boot.env.EnvironmentPostProcessor=\
cn.iocoder.mall.dubbo.config.DubboEnvironmentPostProcessor

43
归档/common/pom.xml
View File

@ -1,43 +0,0 @@
<?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>onemall</artifactId>
<groupId>cn.iocoder.mall</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>common</artifactId>
<packaging>pom</packaging>
<modules>
<module>common-framework</module>
<module>mall-spring-boot</module>
<module>mall-spring-boot-starter-swagger</module>
<module>mall-spring-boot-starter-web</module>
<module>mall-security-annotations</module>
<module>mall-spring-boot-starter-security-admin</module>
<module>mall-spring-boot-starter-security-user</module>
<module>mall-spring-boot-starter-sentry</module>
<module>mall-spring-boot-starter-mybatis</module>
<module>mall-spring-boot-starter-dubbo</module>
<module>mall-spring-boot-starter-system-error-code</module>
<module>mall-spring-boot-starter-rocketmq</module>
<module>mall-spring-boot-starter-xxl-job</module>
<module>mall-spring-boot-starter-redis</module>
</modules>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>cn.iocoder.mall</groupId>
<artifactId>mall-dependencies</artifactId>
<version>1.0-SNAPSHOT</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
</project>