Merge pull request #854 from simple-robot/pref-resources-load

ForteScarlet · web-flow · commit f4fe9ea35efe · 2024-06-17T00:56:47.000+08:00
简单优化spring中加载resources时资源不存在的错误提示
diff --git a/.github/workflows/kdoc.yml.bk b/.github/workflows/kdoc.yml.bk
@@ -22,7 +22,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 21
           cache: 'gradle'
 
       # setup Gradle
diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -30,7 +30,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 21
           #cache: 'gradle'
 
       - name: Run All Tests
@@ -74,7 +74,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 21
           cache: 'gradle'
 
       # setup Gradle
@@ -113,7 +113,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 21
           cache: 'gradle'
 
       # setup Gradle
diff --git a/.github/workflows/publish-snapshot.yml b/.github/workflows/publish-snapshot.yml
@@ -41,7 +41,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 21
           cache: 'gradle'
 
       - name: Run All Tests
@@ -82,7 +82,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 21
           cache: 'gradle'
 
       # setup Gradle
diff --git a/.github/workflows/test-branch.yml b/.github/workflows/test-branch.yml
@@ -20,7 +20,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 21
           cache: 'gradle'
 
       - name: Run All Tests
@@ -50,7 +50,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 21
           cache: 'gradle'
       - name: Run Detekt
         uses: gradle/gradle-build-action@v3
diff --git a/.github/workflows/test-v4-branch.yml b/.github/workflows/test-v4-branch.yml
@@ -54,7 +54,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 21
           cache: 'gradle'
       - name: Run Detekt
         uses: gradle/gradle-build-action@v3
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -102,6 +102,8 @@ detekt {
 tasks.withType<Detekt>().configureEach {
     // internal 处理器不管
     exclude("internal-processors/**")
+    // tests 不管
+    exclude("tests/**")
 
     include("**/src/*Main/kotlin/**/*.kt")
     include("**/src/*Main/kotlin/**/*.java")
@@ -142,6 +144,8 @@ apiValidation {
         listOf(
             "interface-uml-processor",
             "simbot-test",
+            "tests",
+            "spring-boot-starter-test",
         )
     )
 
diff --git a/qodana.yaml b/qodana.yaml
@@ -18,7 +18,7 @@ profile:
 #    paths:
 #      - <path/where/not/run/inspection>
 
-projectJDK: azul-11 #(Applied in CI/CD pipeline)
+projectJDK: azul-21 #(Applied in CI/CD pipeline)
 
 #Execute shell command before Qodana execution (Applied in CI/CD pipeline)
 #bootstrap: sh ./prepare-qodana.sh
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -67,6 +67,9 @@ include(":simbot-cores:simbot-core-spring-boot-starter-v2")
 // extensions
 include(":simbot-extensions:simbot-extension-continuous-session")
 
+// local tests
+include(":tests:spring-boot-starter-test")
+
 // local
 // if (!(System.getProperty("IS_CI") ?: System.getenv("IS_CI")).toBoolean()) {
 //     include(":tests:native-impl-test")
diff --git a/simbot-cores/simbot-core-spring-boot-starter-common/api/simbot-core-spring-boot-starter-common.api b/simbot-cores/simbot-core-spring-boot-starter-common/api/simbot-core-spring-boot-starter-common.api
@@ -109,12 +109,14 @@ public final class love/forte/simbot/spring/common/application/SpringApplication
 	public final fun getAutoStartBots ()Z
 	public final fun getAutoStartMode ()Llove/forte/simbot/spring/common/application/BotAutoStartMode;
 	public final fun getConfigurationJsonResources ()Ljava/util/Set;
+	public final fun getIgnoreIOExceptionForResourcesLoad ()Z
 	public final fun setAutoRegistrationFailurePolicy (Llove/forte/simbot/spring/common/application/BotRegistrationFailurePolicy;)V
 	public final fun setAutoRegistrationMismatchConfigurableBotManagerPolicy (Llove/forte/simbot/spring/common/application/MismatchConfigurableBotManagerPolicy;)V
 	public final fun setAutoRegistrationResourceLoadFailurePolicy (Llove/forte/simbot/spring/common/application/BotConfigResourceLoadFailurePolicy;)V
 	public final fun setAutoStartBots (Z)V
 	public final fun setAutoStartMode (Llove/forte/simbot/spring/common/application/BotAutoStartMode;)V
 	public final fun setConfigurationJsonResources (Ljava/util/Set;)V
+	public final fun setIgnoreIOExceptionForResourcesLoad (Z)V
 }
 
 public final class love/forte/simbot/spring/common/application/SpringApplicationConfigurationProperties$BotProperties$Companion {
diff --git a/simbot-cores/simbot-core-spring-boot-starter-common/src/main/kotlin/love/forte/simbot/spring/common/application/SpringApplicationConfigurationProperties.kt b/simbot-cores/simbot-core-spring-boot-starter-common/src/main/kotlin/love/forte/simbot/spring/common/application/SpringApplicationConfigurationProperties.kt
@@ -48,6 +48,13 @@ public class SpringApplicationConfigurationProperties {
             internal const val DEFAULT_JSON_RESOURCE_PATTERN: String = "classpath:simbot-bots/*.bot.json"
         }
 
+        /**
+         * 是否忽略读取 [configurationJsonResources] 过程中产生的 `IOException`。
+         *
+         * @since 4.0.1
+         */
+        public var ignoreIOExceptionForResourcesLoad: Boolean = true
+
         /**
          * 需要加载的所有组件下它们对应的所有 JSON 格式 的 bot 配置文件。
          * 默认为 [`classpath:simbot-bots/\*.bot.json`][DEFAULT_JSON_RESOURCE_PATTERN]
diff --git a/simbot-cores/simbot-core-spring-boot-starter-v2/src/main/kotlin/love/forte/simbot/spring2/configuration/application/DefaultSimbotApplicationProcessor.kt b/simbot-cores/simbot-core-spring-boot-starter-v2/src/main/kotlin/love/forte/simbot/spring2/configuration/application/DefaultSimbotApplicationProcessor.kt
@@ -47,6 +47,7 @@ import org.springframework.context.annotation.Configuration
 import org.springframework.core.io.Resource
 import org.springframework.core.io.support.PathMatchingResourcePatternResolver
 import java.io.FileNotFoundException
+import java.io.IOException
 
 /**
  * [SimbotApplicationProcessor] 的默认实现
@@ -150,6 +151,7 @@ private class BotAutoLoader(
 
     fun load() {
         val resolver = PathMatchingResourcePatternResolver()
+        val ignoreIO = properties.ignoreIOExceptionForResourcesLoad
 
         val botList =
             properties.configurationJsonResources
@@ -172,6 +174,25 @@ private class BotAutoLoader(
                             fne
                         )
 
+                        emptySequence()
+                    } catch (ie: IOException) {
+                        if (!ignoreIO) {
+                            throw ie
+                        }
+                        logger.warn(
+                            "Bot configuration resource path [{}] could not be resolved " +
+                                "because of IOException(message={}), will be skipped.",
+                            it,
+                            ie.localizedMessage,
+                        )
+                        logger.debug(
+                            "Bot configuration resource path [{}] could not be resolved " +
+                                "because of IOException(message={}), will be skipped.",
+                            it,
+                            ie.localizedMessage,
+                            ie
+                        )
+
                         emptySequence()
                     }
                 }
diff --git a/simbot-cores/simbot-core-spring-boot-starter/src/main/kotlin/love/forte/simbot/spring/configuration/application/DefaultSimbotApplicationProcessor.kt b/simbot-cores/simbot-core-spring-boot-starter/src/main/kotlin/love/forte/simbot/spring/configuration/application/DefaultSimbotApplicationProcessor.kt
@@ -47,6 +47,7 @@ import org.springframework.context.annotation.Configuration
 import org.springframework.core.io.Resource
 import org.springframework.core.io.support.PathMatchingResourcePatternResolver
 import java.io.FileNotFoundException
+import java.io.IOException
 
 /**
  * [SimbotApplicationProcessor] 的默认实现
@@ -150,6 +151,7 @@ private class BotAutoLoader(
 
     fun load() {
         val resolver = PathMatchingResourcePatternResolver()
+        val ignoreIO = properties.ignoreIOExceptionForResourcesLoad
 
         val botList =
             properties.configurationJsonResources
@@ -160,18 +162,37 @@ private class BotAutoLoader(
                     } catch (fne: FileNotFoundException) {
                         logger.warn(
                             "Bot configuration resource path [{}] could not be resolved " +
-                                "because of FileNotFoundException(message={}), will be skip.",
+                                "because of FileNotFoundException(message={}), will be skipped.",
                             it,
                             fne.localizedMessage,
                         )
                         logger.debug(
                             "Bot configuration resource path [{}] could not be resolved " +
-                                "because of FileNotFoundException(message={}), will be skip.",
+                                "because of FileNotFoundException(message={}), will be skipped.",
                             it,
                             fne.localizedMessage,
                             fne
                         )
 
+                        emptySequence()
+                    } catch (ie: IOException) {
+                        if (!ignoreIO) {
+                            throw ie
+                        }
+                        logger.warn(
+                            "Bot configuration resource path [{}] could not be resolved " +
+                                "because of IOException(message={}), will be skipped.",
+                            it,
+                            ie.localizedMessage,
+                        )
+                        logger.debug(
+                            "Bot configuration resource path [{}] could not be resolved " +
+                                "because of IOException(message={}), will be skipped.",
+                            it,
+                            ie.localizedMessage,
+                            ie
+                        )
+
                         emptySequence()
                     }
                 }
diff --git a/tests/spring-boot-starter-test/build.gradle.kts b/tests/spring-boot-starter-test/build.gradle.kts
@@ -0,0 +1,58 @@
+/*
+ *     Copyright (c) 2024. ForteScarlet.
+ *
+ *     Project    https://github.com/simple-robot/simpler-robot
+ *     Email      ForteScarlet@163.com
+ *
+ *     This file is part of the Simple Robot Library (Alias: simple-robot, simbot, etc.).
+ *
+ *     This program is free software: you can redistribute it and/or modify
+ *     it under the terms of the GNU Lesser General Public License as published by
+ *     the Free Software Foundation, either version 3 of the License, or
+ *     (at your option) any later version.
+ *
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     Lesser GNU General Public License for more details.
+ *
+ *     You should have received a copy of the Lesser GNU General Public License
+ *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+plugins {
+    kotlin("jvm")
+    id("org.springframework.boot") version "3.3.0"
+    id("io.spring.dependency-management") version "1.1.5"
+    kotlin("plugin.spring") version "2.0.0"
+}
+
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(17)
+    }
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation(project(":simbot-cores:simbot-core-spring-boot-starter"))
+    implementation("org.springframework.boot:spring-boot-starter")
+    implementation("org.jetbrains.kotlin:kotlin-reflect")
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+}
+
+kotlin {
+    compilerOptions {
+        freeCompilerArgs.addAll("-Xjsr305=strict")
+    }
+}
+
+tasks.withType<Test> {
+    useJUnitPlatform()
+}
diff --git a/tests/spring-boot-starter-test/src/main/kotlin/love/forte/spring/test/Main.kt b/tests/spring-boot-starter-test/src/main/kotlin/love/forte/spring/test/Main.kt
@@ -0,0 +1,38 @@
+/*
+ *     Copyright (c) 2024. ForteScarlet.
+ *
+ *     Project    https://github.com/simple-robot/simpler-robot
+ *     Email      ForteScarlet@163.com
+ *
+ *     This file is part of the Simple Robot Library (Alias: simple-robot, simbot, etc.).
+ *
+ *     This program is free software: you can redistribute it and/or modify
+ *     it under the terms of the GNU Lesser General Public License as published by
+ *     the Free Software Foundation, either version 3 of the License, or
+ *     (at your option) any later version.
+ *
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     Lesser GNU General Public License for more details.
+ *
+ *     You should have received a copy of the Lesser GNU General Public License
+ *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+package love.forte.spring.test
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.boot.runApplication
+
+/**
+ *
+ * @author ForteScarlet
+ */
+@SpringBootApplication
+class Main
+
+fun main(args: Array<String>) {
+    runApplication<Main>(*args)
+}
diff --git a/tests/spring-boot-starter-test/src/test/kotlin/love/forte/spring/test/Main.kt b/tests/spring-boot-starter-test/src/test/kotlin/love/forte/spring/test/Main.kt
@@ -0,0 +1,46 @@
+/*
+ *     Copyright (c) 2024. ForteScarlet.
+ *
+ *     Project    https://github.com/simple-robot/simpler-robot
+ *     Email      ForteScarlet@163.com
+ *
+ *     This file is part of the Simple Robot Library (Alias: simple-robot, simbot, etc.).
+ *
+ *     This program is free software: you can redistribute it and/or modify
+ *     it under the terms of the GNU Lesser General Public License as published by
+ *     the Free Software Foundation, either version 3 of the License, or
+ *     (at your option) any later version.
+ *
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     Lesser GNU General Public License for more details.
+ *
+ *     You should have received a copy of the Lesser GNU General Public License
+ *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+package love.forte.spring.test
+
+import kotlinx.coroutines.runBlocking
+import love.forte.simbot.application.Application
+import love.forte.simbot.spring.EnableSimbot
+import org.springframework.beans.factory.getBean
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.boot.runApplication
+
+
+/**
+ *
+ * @author ForteScarlet
+ */
+@SpringBootApplication
+@EnableSimbot
+class Main
+
+fun main(args: Array<String>) {
+    val context = runApplication<Main>(*args)
+    val app = context.getBean<Application>()
+    runBlocking { app.join() }
+}
