@rdmind/rdmind 0.1.8-alpha.9 → 0.1.9-alpha.0

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,95 +1,114 @@
-<?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>
+         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>
-    <version>${sdk.version}</version>
+  <groupId>com.xiaohongshu.sns</groupId>
+  <artifactId>demo-api</artifactId>
 
-    <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>
-        <spring-boot.version>2.1.6.RELEASE</spring-boot.version>
-    </properties>
+  <!-- 无须动,ci的时候会自动覆盖的   -->
+  <version>${sdk.version}</version>
 
-    <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>
-                <groupId>com.xiaohongshu</groupId>
-                <artifactId>midware-dependencies</artifactId>
-                <version>${midware.version}</version>
-                <type>pom</type>
-                <scope>import</scope>
-            </dependency>
-            <dependency>
-                <groupId>org.springframework.boot</groupId>
-                <artifactId>spring-boot-dependencies</artifactId>
-                <version>${spring-boot.version}</version>
-                <type>pom</type>
-                <scope>import</scope>
-            </dependency>
-        </dependencies>
-    </dependencyManagement>
+  <properties>
+    <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>
 
+  <dependencyManagement>
     <dependencies>
+      <dependency>
+        <groupId>com.xiaohongshu</groupId>
+        <artifactId>midware-dependencies</artifactId>
+        <version>${midware.version}</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+      <dependency>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-dependencies</artifactId>
+        <version>${spring-boot.version}</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
 
-        <dependency>
-            <groupId>com.xiaohongshu</groupId>
-            <artifactId>thrift-springboot</artifactId>
-        </dependency>
+    </dependencies>
+  </dependencyManagement>
 
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-autoconfigure</artifactId>
-        </dependency>
+  <dependencies>
+    <dependency>
+      <groupId>com.xiaohongshu</groupId>
+      <artifactId>rpc-context</artifactId>
+    </dependency>
 
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-test</artifactId>
-            <scope>test</scope>
-        </dependency>
+    <dependency>
+      <groupId>com.xiaohongshu</groupId>
+      <artifactId>thrift-springboot</artifactId>
+      <optional>true</optional>
+    </dependency>
 
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-configuration-processor</artifactId>
-            <optional>true</optional>
-        </dependency>
-    </dependencies>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-autoconfigure</artifactId>
+      <optional>true</optional>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.thrift</groupId>
+      <artifactId>libthrift</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-configuration-processor</artifactId>
+      <optional>true</optional>
+    </dependency>
 
-    <distributionManagement>
-        <snapshotRepository>
-            <id>snapshots</id>
-            <name>maven 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>
-        </repository>
-</distributionManagement>
+  </dependencies>
 
-</project>
+  <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>nexus snapshot repository</name>
+      <url>
+        https://artifactory.devops.xiaohongshu.com/artifactory/maven-snapshots/
+      </url>
+    </snapshotRepository>
+    <repository>
+      <id>releases</id>
+      <name>nexus repository</name>
+      <url>
+        https://artifactory.devops.xiaohongshu.com/artifactory/maven-releases/
+      </url>
+    </repository>
+  </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包删除）

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

@@ -0,0 +1,15 @@
+namespace java com.xiaohongshu.sns.demo.api.service
+
+include "../base/base.thrift"
+include "./req.thrift"
+include "./res.thrift"
+include "./common.thrift"
+
+/**
+  *  第一个参数约定传base.Context，请求打点使用。
+  * base.BaseService接口继承ping方法，健康检查使用
+  *
+  */
+
+
+

package/templates/idl-template/wiki/.arcconfig

@@ -1,3 +0,0 @@
-{
-  "phabricator.uri": "http://phab.devops.xiaohongshu.com/"
-}

package/templates/idl-template/wiki/example/.arcconfig

@@ -1,3 +0,0 @@
-{
-  "phabricator.uri": "http://phab.devops.xiaohongshu.com/"
-}

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

@@ -1,29 +0,0 @@
-namespace java com.xiaohongshu.sns.rpc.hello
-
-/*
-   base.thrift 文件路径不要修改，打包过程会默认加入
-   具体文件格式可以参看
-   <groupId>com.xiaohongshu</groupId>
-   <artifactId>thrift-rpc</artifactId>
- */
-include "../base/base.thrift"
-
-struct HelloRequest{
-
-}
-
-struct HelloResponse{
-
-}
-
-/*
-    第一个参数约定传base.Context，请求打点使用。
-    base.BaseService接口继承ping方法，健康检查使用
- */
-service HelloService extends base.BaseService {
-
-    HelloResponse sayHello(
-        1: base.Context context
-        2: HelloRequest request
-    )
-}

package/templates/idl-template/wiki/example/maven_project/src/main/java/com/xiaohongshu/sns/thrift/hello/HelloServiceAutoConfiguration.java

@@ -1,46 +0,0 @@
-package com.xiaohongshu.sns.thrift.hello;
-
-
-import com.xiaohongshu.infra.rpc.core.client.NettyClientProxyFactory;
-import com.xiaohongshu.infra.rpc.core.registry.eds.MultiRegionsEdsThriftAddressSubscriberProvider;
-import com.xiaohongshu.sns.rpc.hello.HelloService;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
-import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.context.annotation.Lazy;
-
-@Configuration
-@ConditionalOnProperty(prefix = "rpc.hello", name = "service-name")
-@ConditionalOnClass(HelloService.class)
-@ConditionalOnBean(MultiRegionsEdsThriftAddressSubscriberProvider.class)
-@EnableConfigurationProperties(com.xiaohongshu.sns.thrift.hello.HelloServiceProperties.class)
-public class HelloServiceAutoConfiguration {
-
-    private MultiRegionsEdsThriftAddressSubscriberProvider thriftServerMultiRegionEdsSubscriber;
-    private com.xiaohongshu.sns.thrift.hello.HelloServiceProperties properties;
-
-    public HelloServiceAutoConfiguration (MultiRegionsEdsThriftAddressSubscriberProvider thriftServerMultiRegionEdsSubscriber,
-            com.xiaohongshu.sns.thrift.hello.HelloServiceProperties properties) {
-        this.thriftServerMultiRegionEdsSubscriber = thriftServerMultiRegionEdsSubscriber;
-        this.properties = properties;
-    }
-
-    @Lazy
-    @Bean
-    @ConditionalOnMissingBean(name = "helloClient")
-    public NettyClientProxyFactory helloClient() {
-        NettyClientProxyFactory factory = new NettyClientProxyFactory();
-        factory.setServerAddressProvider(this.thriftServerMultiRegionEdsSubscriber);
-        factory.setThriftClass(HelloService.class);
-        factory.setServiceName(this.properties.getServiceName());
-        factory.setRpcTimeout(this.properties.getRpcTimeout());
-        factory.setConnectTimeout(this.properties.getConnectionTimeout());
-        factory.setMethodConfigMap(this.properties.getMethodConfig());
-        return factory;
-    }
-
-}

package/templates/idl-template/wiki/example/maven_project/src/main/java/com/xiaohongshu/sns/thrift/hello/HelloServiceProperties.java

@@ -1,18 +0,0 @@
-package com.xiaohongshu.sns.thrift.hello;
-
-import com.xiaohongshu.infra.rpc.core.ThriftMethodConfig;
-import lombok.Data;
-import org.springframework.boot.context.properties.ConfigurationProperties;
-
-import java.util.Map;
-
-@Data
-@ConfigurationProperties("rpc.hello")
-public class HelloServiceProperties {
-
-    private String serviceName;
-    private Integer rpcTimeout = 1000;
-    private Integer connectionTimeout = 100;
-    private Map<String, ThriftMethodConfig> methodConfig;
-
-}

package/templates/idl-template/wiki/example/maven_project/src/main/resources/META-INF/spring.factories

@@ -1,3 +0,0 @@
-# Auto Configure
-org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
-com.xiaohongshu.sns.thrift.hello.HelloServiceAutoConfiguration

package/templates/idl-template/wiki/example/maven_project/src/test/java/com/xiaohongshu/sns/thrift/test/AutoConfigureTest.java

@@ -1,53 +0,0 @@
-package com.xiaohongshu.sns.thrift.test;
-
-import com.xiaohongshu.infra.rpc.core.registry.consul.ThriftServerAddressConsulManager;
-import com.xiaohongshu.sns.rpc.hello.HelloService;
-import com.xiaohongshu.sns.thrift.hello.HelloServiceAutoConfiguration;
-import org.junit.After;
-import org.junit.Assert;
-import org.junit.Before;
-import org.junit.Test;
-import org.springframework.beans.factory.NoSuchBeanDefinitionException;
-import org.springframework.context.annotation.AnnotationConfigApplicationContext;
-import org.springframework.core.env.MutablePropertySources;
-import org.springframework.core.env.StandardEnvironment;
-import org.springframework.mock.env.MockPropertySource;
-
-
-public class AutoConfigureTest {
-
-    private AnnotationConfigApplicationContext context;
-
-    @Before
-    public void setUp() {
-        this.context = new AnnotationConfigApplicationContext();
-        StandardEnvironment environment = new StandardEnvironment();
-        MutablePropertySources propertySources = environment.getPropertySources();
-        MockPropertySource propertySource = new MockPropertySource();
-        propertySource.setProperty("rpc.hello.serviceName", "xxx");
-        propertySources.addFirst(propertySource);
-        context.setEnvironment(environment);
-        context.register(ThriftServerAddressConsulManager.class);
-        context.register(HelloServiceAutoConfiguration.class);
-        context.refresh();
-    }
-
-    @After
-    public void tearDown() {
-        if (this.context != null) {
-            this.context.close();
-        }
-    }
-
-    @Test
-    public void testBeanRegistration() {
-        try {
-            HelloService.Iface client = this.context.getBean("helloClient", HelloService.Iface.class);
-            client.ping();
-        } catch (NoSuchBeanDefinitionException e) {
-            Assert.fail(e.getMessage());
-        } catch (Exception e) {
-            e.printStackTrace();
-        }
-    }
-}