Merge pull request #447 from sofastack/youji-dev

add tips for import base starter

samples/springboot-samples/cache/ehcache/README.md

@@ -10,9 +10,13 @@ base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加
 ```xml
 
 <!-- 这里添加动态模块相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
     <groupId>com.alipay.sofa.serverless</groupId>
     <artifactId>sofa-serverless-base-starter</artifactId>
+    <version>${sofa.serverless.runtime.version}</version>
+    <type>pom</type>
 </dependency>
 <!-- end 动态模块相关依赖 -->
 

samples/springboot-samples/cache/ehcache/base/pom.xml

@@ -11,6 +11,10 @@
     <artifactId>base-ehcache</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     <dependencies>
+        <!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+        <!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
         <dependency>
             <groupId>com.alipay.sofa.serverless</groupId>
             <artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/cache/redis/README.md

@@ -8,9 +8,13 @@ base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加
 ```xml
 
 <!-- 这里添加动态模块相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
     <groupId>com.alipay.sofa.serverless</groupId>
     <artifactId>sofa-serverless-base-starter</artifactId>
+    <version>${sofa.serverless.runtime.version}</version>
+    <type>pom</type>
 </dependency>
 <!-- end 动态模块相关依赖 -->
 

samples/springboot-samples/cache/redis/sample-redis-base/redis-base-bootstrap/pom.xml

@@ -18,6 +18,10 @@
     </properties>
 
     <dependencies>
+        <!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+        <!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
         <dependency>
             <groupId>com.alipay.sofa.serverless</groupId>
             <artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/config/apollo/base/pom.xml

@@ -11,6 +11,10 @@
     <artifactId>base-apollo</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     <dependencies>
+        <!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+        <!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
         <dependency>
             <groupId>com.alipay.sofa.serverless</groupId>
             <artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/config/nacos/base/pom.xml

@@ -11,6 +11,10 @@
     <artifactId>base-nacos</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     <dependencies>
+        <!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+        <!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
         <dependency>
             <groupId>com.alipay.sofa.serverless</groupId>
             <artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/db/mongo/README.md

@@ -16,9 +16,13 @@ docker run --name mongodb -d -p 27017:27017 -v $(pwd)/data:/data/db ${mongodb_im
 base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加如下依赖
 ```xml
 <!-- 这里添加动态模块相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
     <groupId>com.alipay.sofa.serverless</groupId>
     <artifactId>sofa-serverless-base-starter</artifactId>
+    <version>${sofa.serverless.runtime.version}</version>
+    <type>pom</type>
 </dependency>
 <!-- end 动态模块相关依赖 -->
 
@@ -265,4 +269,4 @@ curl --location --request GET 'localhost:8080/biz2/listCommons'
 ```
 
 ## 注意事项
-这里主要使用简单应用做验证，如果复杂应用，需要注意模块做好瘦身，基座有的依赖，模块尽可能设置成 provided，尽可能使用基座的依赖。
+这里主要使用简单应用做验证，如果复杂应用，需要注意模块做好瘦身，基座有的依赖，模块尽可能设置成 provided，尽可能使用基座的依赖。

samples/springboot-samples/db/mongo/base/bootstrap/pom.xml

@@ -14,6 +14,10 @@
 	<description>mongo base for mongo</description>
 
 	<dependencies>
+		<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+		<!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 		<dependency>
 			<groupId>com.alipay.sofa.serverless</groupId>
 			<artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/db/mybatis/README.md

@@ -5,9 +5,13 @@
 base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加如下依赖
 ```xml
 <!-- 这里添加动态模块相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
     <groupId>com.alipay.sofa.serverless</groupId>
     <artifactId>sofa-serverless-base-starter</artifactId>
+    <version>${sofa.serverless.runtime.version}</version>
+    <type>pom</type>
 </dependency>
 <!-- end 动态模块相关依赖 -->
 

samples/springboot-samples/db/mybatis/base/pom.xml

@@ -15,6 +15,10 @@
 	<description>base for mybatis</description>
 
 	<dependencies>
+		<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+		<!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 		<dependency>
 			<groupId>com.alipay.sofa.serverless</groupId>
 			<artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/logging/log4j2/README.md

@@ -9,9 +9,13 @@ base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加
 
 
 <!-- 这里添加动态模块相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
     <groupId>com.alipay.sofa.serverless</groupId>
     <artifactId>sofa-serverless-base-starter</artifactId>
+    <version>${sofa.serverless.runtime.version}</version>
+    <type>pom</type>
 </dependency>
 <!-- end 动态模块相关依赖 -->
 
@@ -145,4 +149,4 @@ curl http://localhost:8080/biz2
 
 
 ## 注意事项
-这里主要使用简单应用做验证，如果复杂应用，需要注意模块做好瘦身，基座有的依赖，模块尽可能设置成 provided，尽可能使用基座的依赖。
+这里主要使用简单应用做验证，如果复杂应用，需要注意模块做好瘦身，基座有的依赖，模块尽可能设置成 provided，尽可能使用基座的依赖。

samples/springboot-samples/logging/log4j2/base/pom.xml

@@ -16,6 +16,10 @@
 
 	<dependencies>
 		<!-- 这里添加动态模块相关依赖 -->
+		<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+		<!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 		<dependency>
 			<groupId>com.alipay.sofa.serverless</groupId>
 			<artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/logging/logback/README.md

@@ -7,9 +7,13 @@
 base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加如下依赖
 ```xml
 <!-- sofa-serverless 相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
-    <groupId>com.alipay.sofa.serverless</groupId>
-    <artifactId>sofa-serverless-base-starter</artifactId>
+   <groupId>com.alipay.sofa.serverless</groupId>
+   <artifactId>sofa-serverless-base-starter</artifactId>
+   <version>${sofa.serverless.runtime.version}</version>
+   <type>pom</type>
 </dependency>
 <dependency>
     <groupId>com.alipay.sofa</groupId>
@@ -195,4 +199,4 @@ biz1 111 2023-12-27 20:05:55,543  INFO  25790 --- [http-nio-8080-exec-1] [c.a.so
 ```
 
 ## 注意事项
-这里主要使用简单应用做验证，如果复杂应用，需要注意模块做好瘦身，基座有的依赖，模块尽可能设置成 provided，尽可能使用基座的依赖。
+这里主要使用简单应用做验证，如果复杂应用，需要注意模块做好瘦身，基座有的依赖，模块尽可能设置成 provided，尽可能使用基座的依赖。

samples/springboot-samples/logging/logback/base/pom.xml

@@ -15,6 +15,10 @@
 	<description>logging base for logback</description>
 
 	<dependencies>
+		<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+		<!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 		<dependency>
 			<groupId>com.alipay.sofa.serverless</groupId>
 			<artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/msg/kafka/README.md

@@ -7,9 +7,13 @@ base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加
 
 
 <!-- 这里添加动态模块相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
     <groupId>com.alipay.sofa.serverless</groupId>
     <artifactId>sofa-serverless-base-starter</artifactId>
+    <version>${sofa.serverless.runtime.version}</version>
+    <type>pom</type>
 </dependency>
 <!-- end 动态模块相关依赖 -->
 

samples/springboot-samples/msg/kafka/base/pom.xml

@@ -15,6 +15,10 @@
 	<description>logging base for log4j2</description>
 
 	<dependencies>
+		<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+		<!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 		<dependency>
 			<groupId>com.alipay.sofa.serverless</groupId>
 			<artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/msg/rocketmq/README.md

@@ -21,9 +21,13 @@ docker run -d -p 9876:9876 -p 10909:10909 -p 10910:10910 -p 10911:10911 -p 10912
 base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加如下依赖
 ```xml
 <!-- 这里添加动态模块相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
     <groupId>com.alipay.sofa.serverless</groupId>
     <artifactId>sofa-serverless-base-starter</artifactId>
+    <version>${sofa.serverless.runtime.version}</version>
+    <type>pom</type>
 </dependency>
 <!-- end 动态模块相关依赖 -->
 
@@ -154,4 +158,4 @@ INFO  service.SampleConsumer - base receive a message: Greeting(message=biz1 sen
 ```
 
 ## 注意事项
-这里主要使用简单应用做验证，如果复杂应用，需要注意模块做好瘦身，基座有的依赖，模块尽可能设置成 provided，尽可能使用基座的依赖。
+这里主要使用简单应用做验证，如果复杂应用，需要注意模块做好瘦身，基座有的依赖，模块尽可能设置成 provided，尽可能使用基座的依赖。

samples/springboot-samples/msg/rocketmq/base/bootstrap/pom.xml

@@ -12,6 +12,10 @@
 	<version>0.0.1-SNAPSHOT</version>
 
 	<dependencies>
+		<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+		<!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 		<dependency>
 			<groupId>com.alipay.sofa.serverless</groupId>
 			<artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/service/README.md

@@ -6,9 +6,13 @@ base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加
 ```xml
 
 <!-- 这里添加动态模块相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
     <groupId>com.alipay.sofa.serverless</groupId>
     <artifactId>sofa-serverless-base-starter</artifactId>
+    <version>${sofa.serverless.runtime.version}</version>
+    <type>pom</type>
 </dependency>
 <!-- end 动态模块相关依赖 -->
 

samples/springboot-samples/service/sample-service-base/base-bootstrap/pom.xml

@@ -18,6 +18,10 @@
     </properties>
 
     <dependencies>
+        <!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+        <!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
         <dependency>
             <groupId>com.alipay.sofa.serverless</groupId>
             <artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/slimming/README.md

@@ -10,9 +10,13 @@ base 为普通 springboot 改造成的基座，改造内容为在主 pom 里增
 
 
 <!-- 这里添加动态模块相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
     <groupId>com.alipay.sofa.serverless</groupId>
     <artifactId>sofa-serverless-base-starter</artifactId>
+    <version>${sofa.serverless.runtime.version}</version>
+    <type>pom</type>
 </dependency>
 <!-- end 动态模块相关依赖 -->
 

samples/springboot-samples/slimming/log4j2/base/pom.xml

@@ -12,6 +12,10 @@
 	<version>0.0.1-SNAPSHOT</version>
 
 	<dependencies>
+		<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+		<!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 		<dependency>
 			<groupId>com.alipay.sofa.serverless</groupId>
 			<artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/springcloud/gateway/README.md

@@ -3,15 +3,19 @@
 ### base
 base 为普通 springboot cloud改造成的基座，改造内容为在 pom 里增加如下依赖
 ```xml
-	<dependency>
-        <groupId>com.alipay.sofa.serverless</groupId>
-        <artifactId>sofa-serverless-base-starter</artifactId>
-    </dependency>
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+<dependency>
+    <groupId>com.alipay.sofa.serverless</groupId>
+    <artifactId>sofa-serverless-base-starter</artifactId>
+    <version>${sofa.serverless.runtime.version}</version>
+    <type>pom</type>
+</dependency>
 
-    <dependency>
-        <groupId>com.alipay.sofa</groupId>
-        <artifactId>netty-ark-plugin</artifactId>
-    </dependency>
+<dependency>
+    <groupId>com.alipay.sofa</groupId>
+    <artifactId>netty-ark-plugin</artifactId>
+</dependency>
 ```
 
 ### biz

samples/springboot-samples/springcloud/gateway/base/pom.xml

@@ -18,6 +18,10 @@
 	<description>Demo project for Spring Cloud Gateway</description>
 
 	<dependencies>
+		<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+		<!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 		<dependency>
 			<groupId>com.alipay.sofa.serverless</groupId>
 			<artifactId>sofa-serverless-base-starter</artifactId>

samples/springboot-samples/web/tomcat/README.md

@@ -13,13 +13,17 @@ base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加
 
 
 <!-- 这里添加动态模块相关依赖 -->
+<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom, 
+    原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 <dependency>
-    <groupId>com.alipay.sofa.serverless</groupId>
-    <artifactId>sofa-serverless-base-starter</artifactId>
+   <groupId>com.alipay.sofa.serverless</groupId>
+   <artifactId>sofa-serverless-base-starter</artifactId>
+   <version>${sofa.serverless.runtime.version}</version>
+   <type>pom</type>
 </dependency>
-        <!-- end 动态模块相关依赖 -->
+<!-- end 动态模块相关依赖 -->
 
-        <!-- 这里添加 tomcat 单 host 模式部署多web应用的依赖 -->
+<!-- 这里添加 tomcat 单 host 模式部署多web应用的依赖 -->
 <dependency>
 <groupId>com.alipay.sofa</groupId>
 <artifactId>web-ark-plugin</artifactId>
@@ -166,4 +170,4 @@ curl http://localhost:8080/order2
 ```shell
 curl http://localhost:8080/biz1
 curl http://localhost:8080/biz2
-```
+```

samples/springboot-samples/web/tomcat/base/bootstrap/pom.xml

@@ -12,6 +12,10 @@
 	<version>0.0.1-SNAPSHOT</version>
 
 	<dependencies>
+		<!--    务必将次依赖放在构建 pom 的第一个依赖引入, 并且设置 type= pom,
+            原理请参考这里 https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
+		<!--    must add this dependency as the first one in the pom for building jar, and set type=pom,
+            check the reason from here https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/multi-app-padater/ -->
 		<dependency>
 			<groupId>com.alipay.sofa.serverless</groupId>
 			<artifactId>sofa-serverless-base-starter</artifactId>