@rdmind/rdmind 0.1.8 → 0.1.9-alpha.1

package/template/sns-demo-common/src/main/java/com/xiaohongshu/sns/demo/common/utils/WrappedContextHelper.java

@@ -0,0 +1,182 @@
+package com.xiaohongshu.sns.demo.common.utils;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.xiaohongshu.infra.apm.utils.ContextHelper;
+import com.xiaohongshu.infra.rpc.base.Context;
+
+import com.xiaohongshu.sns.demo.common.constants.AppPlatform;
+import lombok.Data;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.ObjectUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.math.NumberUtils;
+import org.springframework.stereotype.Component;
+import org.springframework.util.CollectionUtils;
+
+import java.net.URLDecoder;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Optional;
+
+/**
+ * 对中间件 ContextHelper 的封装，便于拿到当前的请求信息。
+ * 整合了 ContextUtils 现有功能及增强的上下文解析能力。
+ *
+ * @author RDMind
+ */
+@Component
+@Slf4j
+public class WrappedContextHelper {
+
+    public static final String APP_CONTEXT_PREFIX = "__app_context:";
+    public static final String HTTP_HEADER = "httpHeader";
+
+    /**
+     * 获取原始 Context
+     */
+    public static Context get() {
+        return ContextHelper.getContext();
+    }
+
+    /**
+     * 获取当前用户 ID
+     */
+    public static String getUserId() {
+        Context context = get();
+        if (context == null) {
+            return StringUtils.EMPTY;
+        }
+        String userId = context.getUserID();
+        if (StringUtils.isBlank(userId)) {
+            Map<String, String> baggageMap = context.getBaggage();
+            if (!CollectionUtils.isEmpty(baggageMap)) {
+                userId = baggageMap.get("viewerUserId");
+            }
+        }
+        return StringUtils.isBlank(userId) ? StringUtils.EMPTY : userId;
+    }
+
+    /**
+     * 获取当前操作者邮箱
+     */
+    public static String getUserEmail() {
+        Context context = get();
+        return context == null ? StringUtils.EMPTY : context.getBaggage().getOrDefault("__app_context:operatorEmail", StringUtils.EMPTY);
+    }
+
+    /**
+     * 获取当前操作者展示名称
+     */
+    public static String getUserDisplayName() {
+        Context context = get();
+        return context == null ? StringUtils.EMPTY : context.getBaggage().getOrDefault("__app_context:displayName", StringUtils.EMPTY);
+    }
+
+    /**
+     * 获取当前操作者真实姓名
+     */
+    public static String getUserRealName() {
+        Context context = get();
+        return context == null ? StringUtils.EMPTY : context.getBaggage().getOrDefault("__app_context:operatorName", StringUtils.EMPTY);
+    }
+
+    /**
+     * 获取当前用户IP
+     */
+    public static String getUserIp() {
+        Context context = get();
+        if (context == null) {
+            return StringUtils.EMPTY;
+        }
+        return StringUtils.isBlank(context.getUserIP()) ? StringUtils.EMPTY : context.getUserIP();
+    }
+
+    /**
+     * 获取 requestId
+     */
+    public static String getRequestId() {
+        Context context = get();
+        if (context == null || CollectionUtils.isEmpty(context.getBaggage())) {
+            return StringUtils.EMPTY;
+        }
+        return context.getBaggage().getOrDefault(APP_CONTEXT_PREFIX + "requestId", StringUtils.EMPTY);
+    }
+
+    /**
+     * 获取当前客户端平台
+     */
+    public static String getPlatform() {
+        Context context = get();
+        if (context == null) {
+            return AppPlatform.UNKNOWN.value();
+        }
+        String platform = context.getAppPlatform();
+        return StringUtils.isBlank(platform) ? AppPlatform.UNKNOWN.value() : AppPlatform.findBy(platform).value();
+    }
+
+    /**
+     * 获取 networkType
+     */
+    public static int getNetworkType() {
+        String cAppNetworkType = ContextHelper.getAppContext("c_app_network_type");
+        return NumberUtils.toInt(cAppNetworkType);
+    }
+
+    public static String getHttpHeaderStr() {
+        Context context = get();
+        if (context == null) {
+            return StringUtils.EMPTY;
+        }
+        Map<String, String> baggage = Optional.ofNullable(context.getBaggage()).orElse(Collections.emptyMap());
+        return baggage.getOrDefault(APP_CONTEXT_PREFIX + HTTP_HEADER, "");
+    }
+
+    private HttpHeader getParsedHttpHeader() {
+        Context context = get();
+        if (context != null && context.getBaggage().containsKey(APP_CONTEXT_PREFIX + HTTP_HEADER)) {
+            String headerJson = ContextHelper.getAppContext(HTTP_HEADER);
+            HttpHeader header = JsonHelper.fromJson(headerJson, HttpHeader.class, false);
+            return ObjectUtils.defaultIfNull(header, new HttpHeader());
+        }
+        return new HttpHeader();
+    }
+
+    /**
+     * 内部封装的 Http Header 对象 (使用 Jackson 注解)
+     */
+    @Data
+    static class HttpHeader {
+        @JsonProperty("User-Agent")
+        private String userAgent;
+        @JsonProperty("xy-common-params")
+        private String commonParams;
+        @JsonProperty("X-Network-Source")
+        private String xNetworkSource;
+        @JsonProperty("Xy-Platform-Info")
+        private String platformInfo;
+    }
+
+    private Map<String, String> parseCommonParams() {
+        String paramStr = this.getParsedHttpHeader().getCommonParams();
+        if (StringUtils.isEmpty(paramStr)) {
+            return Collections.emptyMap();
+        }
+        Map<String, String> params = new HashMap<>();
+        for (String kv : paramStr.split("&")) {
+            String[] arr = kv.split("=");
+            if (arr.length == 2) {
+                try {
+                    params.put(arr[0], URLDecoder.decode(arr[1], "UTF-8"));
+                } catch (Exception e) {
+                    // ignore
+                }
+            }
+        }
+        return params;
+    }
+
+    public String getDeviceId() {
+        return StringUtils.trimToEmpty(parseCommonParams().get("deviceId"));
+    }
+}

package/template/sns-demo-domain/pom.xml

@@ -26,11 +26,6 @@
             <groupId>com.xiaohongshu</groupId>
             <artifactId>infra-framework-context</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-test</artifactId>
-            <scope>test</scope>
-        </dependency>
     </dependencies>
 
 </project>

package/template/sns-demo-infrastructure/pom.xml

@@ -47,11 +47,6 @@
             <groupId>com.xiaohongshu</groupId>
             <artifactId>infra-framework-rpc-core</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-test</artifactId>
-            <scope>test</scope>
-        </dependency>
     </dependencies>
 
 </project>

package/template/sns-demo-start/pom.xml

@@ -24,11 +24,6 @@
             <groupId>com.xiaohongshu.xray</groupId>
             <artifactId>xray-logging</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-test</artifactId>
-            <scope>test</scope>
-        </dependency>
     </dependencies>
 
     <build>

package/template/sns-demo-start/src/main/resources/logback-spring.xml

@@ -3,12 +3,6 @@
     <property name="LOG_LEVEL" value="INFO"/>
     <include resource="logback-xray-base.xml"/>
 
-    <root level="${LOG_LEVEL}">
-        <appender-ref ref="ASYNC-CONSOLE-APPENDER"/>
-        <!--        <appender-ref ref="Sentry"/>-->
-    </root>
-
-    <logger name="com.xiaohongshu.sns" level="debug"></logger>
     <logger name="org.apache.ibatis" level="INFO"></logger>
     <logger name="org.apache.catalina" level="ERROR"></logger>
     <logger name="org.apache.zookeeper" level="INFO"></logger>
@@ -17,6 +11,9 @@
     <logger name="com.xiaohongshu.racing" level="WARN"></logger>
     <logger name="com.dianping.cat" level="INFO"></logger>
     <logger name="red.midware.shaded" level="INFO"></logger>
+    <logger name="com.xiaohongshu.infra.xds.cds.CDSSharedStubWrapper" level="ERROR"></logger>
     <logger name="events" level="INFO"></logger>
-
-</configuration>
+    <logger name="com.zaxxer.hikari.HikariConfig" level="WARN"></logger>
+    <logger name="com.zaxxer.hikari.HikariDataSource" level="WARN"></logger>
+    <logger name="com.xiaohongshu.infra.rpc.core.registry.eds.MultiRegionsEdsThriftAddressSubscriberProvider" level="off"/>
+</configuration>

package/templates/idl-template/wiki/.idea/codeStyles/Project.xml

@@ -0,0 +1,7 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <ScalaCodeStyleSettings>
+      <option name="MULTILINE_STRING_CLOSING_QUOTES_ON_NEW_LINE" value="true" />
+    </ScalaCodeStyleSettings>
+  </code_scheme>
+</component>

package/templates/idl-template/wiki/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
+  </state>
+</component>

package/templates/idl-template/wiki/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,5 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+  </profile>
+</component>

package/templates/idl-template/wiki/.idea/misc.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AnalysisProjectProfileManager">
+    <option name="PROJECT_PROFILE" />
+    <option name="USE_PROJECT_LEVEL_SETTINGS" value="false" />
+    <list size="0" />
+  </component>
+  <component name="ProjectRootManager">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+  <component name="SuppressionsComponent">
+    <option name="suppComments" value="[]" />
+  </component>
+</project>

package/templates/idl-template/wiki/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/wiki.iml" filepath="$PROJECT_DIR$/.idea/wiki.iml" />
+    </modules>
+  </component>
+</project>

package/templates/idl-template/wiki/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$/../../../../.." vcs="Git" />
+  </component>
+</project>

package/templates/idl-template/wiki/.idea/wiki.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/templates/idl-template/wiki/SDK-Dev-Guide.md

@@ -49,8 +49,6 @@ thrift idl开发参考[Thrift IDL开发规范](./README.md)
 
 Java sdk会以`maven_project`目录作为打包的基础目录，因此可以在目录中添加代码来定制sdk的功能。
 
-例如，使用[SpringBoot AutoConfiguration](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-developing-auto-configuration.html)为sdk开发自动配置功能，参考[例子](example)。
-
 ## 常见问题
 
 1. Invalid remote: origin

package/templates/idl-template/wiki/example/.gitlab-ci.yml

@@ -1,26 +1,12 @@
+image: docker-reg.devops.xiaohongshu.com/shequ/sns-sdk-ci:latest
+
 stages:
   - build
-# 根据项目类型保留需要build的stage 并删掉其他stage
-build:java:
-  stage: build
-  image: docker-reg.devops.xiaohongshu.com/shequ/sns-sdk-ci:latest
-  script:
-    - skr -p ${CI_PROJECT_NAME} -c ${CI_COMMIT_REF_NAME}
-  only:
-    - branches
-    - /^\d+\.\d+\.\d+$/
 
-build:go:
+build:java:
   stage: build
-  image: docker-reg.devops.xiaohongshu.com/shequ/sns-gosdk-ci:latest
   script:
     - skr -p ${CI_PROJECT_NAME} -c ${CI_COMMIT_REF_NAME}
   only:
     - branches
     - /^\d+\.\d+\.\d+$/
-
-build:node:
-  stage: build
-  image: docker-reg.devops.xiaohongshu.com/fe/ts-generator:latest
-  script:
-    - DEBUG=common-bin tsGen build --branch ${CI_COMMIT_REF_NAME} --userEmail ${GITLAB_USER_EMAIL} --ciId ${CI_COMMIT_SHA:0:8} --pId ${CI_PROJECT_ID}

package/templates/idl-template/wiki/example/base.thrift

@@ -0,0 +1,94 @@
+namespace java com.xiaohongshu.infra.rpc.base
+
+/**
+* rpc context that contains:
+* 1: open tracing infomation
+* 2: userID for log coloring
+* 3: an expandable map for custom loads
+*/
+struct Context {
+    /**
+    * open tracing trace id
+    **/
+    1: string traceID;
+    /**
+    * the caller's host (IP or hostname)
+    **/
+    2: string clientHost;
+    /**
+    * open tracing baggae, can be used to carry custom loads
+    **/
+    3: map<string, string> baggage;
+    /**
+    * open tracing span id
+    **/
+    4: string spanID;
+    /**
+    * whether the very request is sampled
+    **/
+    5: bool sampled;
+    /**
+    * open tracing parent span ID
+    **/
+    6: string parentSpanID;
+    /**
+    * userID for log coloring
+    **/
+    7: string userID;
+    /**
+    * appID for multi-app
+    **/
+    8: string appID;
+    /**
+    * projectID for multi-app
+    **/
+    9: string projectID;
+    /**
+    * app build number
+    **/
+    10: i32 appBuild;
+    /**
+    * app platform
+    **/
+    11: string appPlatform;
+    /**
+    * user ip address
+    **/
+    12: string userIP;
+    /**
+    * session locale
+    **/
+    13: string locale;
+}
+
+/**
+* multi-app 枚举类型
+**/
+enum ProjectType {
+    XHS = 0
+    TOP = 1
+}
+
+/**
+* common result
+*/
+struct Result {
+    1: required bool success,
+    2: optional i32 code,
+    3: optional string message
+}
+
+/**
+* typedefs
+*/
+typedef i64 Timestamp
+
+/**
+* the BaseService is defined for management purpose, such as check alive.
+**/
+service BaseService {
+    /**
+    * for checking alive
+    **/
+    void ping()
+}

package/templates/idl-template/wiki/example/common.thrift

@@ -0,0 +1,39 @@
+namespace java com.xiaohongshu.sns.demo.api.common
+
+include "../base/base.thrift"
+
+/**
+* 分页-请求对象
+**/
+struct PageParam {
+    /**
+    * 页码
+    **/
+    1:optional i32 pageNo;
+    /**
+    * 分页大小
+    **/
+    2:optional i32 pageSize;
+}
+
+/**
+* 分页-返回对象
+**/
+struct PageResp {
+    /**
+    * 当前页
+    **/
+    1:optional i32 currentPage;
+    /**
+    * 分页大小
+    **/
+    2:optional i32 pageSize;
+    /**
+    * 总页数
+    **/
+    3:optional i32 totalPages;
+    /**
+    * 总条数
+    **/
+    4:optional i32 totalCount;
+}

package/templates/idl-template/wiki/example/dto.thrift

@@ -0,0 +1,3 @@
+namespace java com.xiaohongshu.sns.demo.api.dto
+
+include "enum.thrift"

package/templates/idl-template/wiki/example/enum.thrift

@@ -0,0 +1 @@
+namespace java com.xiaohongshu.sns.demo.api.enum

package/templates/idl-template/wiki/example/gen-java.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
 
-filename="./hello.thrift"
-thrift --gen java:generated_annotations=undated -out maven_project/src/main/java/ $filename
+# 这里每一行就是一个thrift文件路径,直接遍历来快速构建
+filename="./service.thrift"
+for file in $filename; do
+    thrift --gen java:generated_annotations=undated -out maven_project/src/main/java/ $file
+done

package/templates/idl-template/wiki/example/maven_project/pom.xml

@@ -1,40 +1,23 @@
-<?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">
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
-    <groupId>com.xiaohongshu.sns.thrift</groupId>
-    <artifactId>hello-sdk</artifactId>
+    <groupId>com.xiaohongshu.sns</groupId>
+    <artifactId>demo-api</artifactId>
+
+    <!-- 无须动,ci的时候会自动覆盖的   -->
     <version>${sdk.version}</version>
 
     <properties>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <sdk.version>1.0.0-SNAPSHOT</sdk.version>
-        <midware.version>2.2.31-RELEASE</midware.version>
+        <midware.version>3.3.11-RELEASE</midware.version>
         <spring-boot.version>2.1.6.RELEASE</spring-boot.version>
+        <!--这里换成jdk11 david解析不了，不支持-->
+        <maven.compiler.source>8</maven.compiler.source>
+        <maven.compiler.target>8</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
-                </configuration>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-surefire-plugin</artifactId>
-                <configuration>
-                    <skip>true</skip>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
-
     <dependencyManagement>
         <dependencies>
             <dependency>
@@ -51,25 +34,31 @@
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
+
         </dependencies>
     </dependencyManagement>
 
     <dependencies>
+        <dependency>
+            <groupId>com.xiaohongshu</groupId>
+            <artifactId>rpc-context</artifactId>
+        </dependency>
 
         <dependency>
             <groupId>com.xiaohongshu</groupId>
             <artifactId>thrift-springboot</artifactId>
+            <optional>true</optional>
         </dependency>
 
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-autoconfigure</artifactId>
+            <optional>true</optional>
         </dependency>
 
         <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-test</artifactId>
-            <scope>test</scope>
+            <groupId>org.apache.thrift</groupId>
+            <artifactId>libthrift</artifactId>
         </dependency>
 
         <dependency>
@@ -77,19 +66,49 @@
             <artifactId>spring-boot-configuration-processor</artifactId>
             <optional>true</optional>
         </dependency>
+
     </dependencies>
 
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.1</version>
+                <configuration>
+                    <source>1.8</source>
+                    <target>1.8</target>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>2.1.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
     <distributionManagement>
         <snapshotRepository>
             <id>snapshots</id>
-            <name>maven snapshot repository</name>
-            <url>https://artifactory.devops.xiaohongshu.com/artifactory/maven-snapshots/</url>
+            <name>nexus snapshot repository</name>
+            <url>
+                https://artifactory.devops.xiaohongshu.com/artifactory/maven-snapshots/
+            </url>
         </snapshotRepository>
         <repository>
             <id>releases</id>
-            <name>maven releases repository</name>
-            <url>https://artifactory.devops.xiaohongshu.com/artifactory/maven-releases/</url>
+            <name>nexus repository</name>
+            <url>
+                https://artifactory.devops.xiaohongshu.com/artifactory/maven-releases/
+            </url>
         </repository>
-</distributionManagement>
-
-</project>
+    </distributionManagement>
+</project>

package/templates/idl-template/wiki/example/req.thrift

@@ -0,0 +1,4 @@
+namespace java com.xiaohongshu.sns.demo.api.req
+
+include "./dto.thrift"
+include "./common.thrift"

package/templates/idl-template/wiki/example/res.thrift

@@ -0,0 +1,5 @@
+namespace java com.xiaohongshu.sns.demo.api.res
+
+include "../base/base.thrift"
+include "./dto.thrift"
+include "./common.thrift"

package/templates/idl-template/wiki/example/sdk-spec.yml

@@ -1,5 +1,6 @@
 dependencies:
-  sns-idls/base: 1.0.1
+  sns-idls/base: 1.1.7      # 依赖sns-idls/base项目，tag为1.1.7
 build:
-  node:
-    enabled: false
+  go:
+    enabled: false           # 是否开启go编译 [gosdk](https://wiki.xiaohongshu.com/pages/viewpage.action?pageId=43487207)
+  recurse: true    # 是否递归编译引用的thrift文件（默认会将com.xiaohongshu.infra.rpc.base包删除）