17370845950

本文旨在解决spring boot应用在加载`application.yml`配置时抛出的`java.lang.illegalstateexception: snakeyaml was not found on the classpath`错误。核心问题在于缺少yaml解析器`snakeyaml`的运行时依赖。教程将详细分析此异常的根本原因，并提供通过引入正确的`spring-boot-starter`依赖来快速修复，同时优化maven `pom.xml`配置的专业方法。

理解“snakeyaml未找到”异常

当Spring Boot应用尝试加载application.yml或application.yaml配置文件时，如果遇到如下异常信息：

Exception in thread "main" java.lang.IllegalStateException: Attempted to load Config resource 'class path resource [application.yml]' via location 'optional:classpath:/' but snakeyaml was not found on the classpath
    at org.springframework.boot.env.YamlPropertySourceLoader.load(YamlPropertySourceLoader.java:47)
    ...

这个异常明确指出，系统尝试通过YamlPropertySourceLoader加载YAML配置文件，但未能在类路径（classpath）中找到snakeyaml库。snakeyaml是一个Java库，专门用于解析YAML格式的数据。Spring Boot在处理.yml或.yaml格式的配置文件时，内部依赖于snakeyaml来完成解析工作。因此，如果项目中缺少这个关键依赖，就会导致上述IllegalStateException。

根本原因分析

仔细检查项目pom.xml文件是诊断此问题的关键。常见的错误配置是仅引入了Spring Boot的自动配置模块，例如spring-boot-autoconfigure，而没有引入提供核心运行时依赖的spring-boot-starter。

原始pom.xml中可能存在以下依赖：

    org.springframework.boot
    spring-boot-autoconfigure
    2.6.6 
    compile



    org.slf4j
    slf4j-api

spring-boot-autoconfigure模块主要负责提供Spring Boot的自动配置功能，它本身并不直接包含所有必要的运行时依赖，例如YAML解析器（snakeyaml）或日志框架（如slf4j、logback）。这些核心的、通用的运行时依赖通常由spring-boot-starter模块通过传递性依赖引入。

因此，当你的项目只依赖于spring-boot-autoconfigure而没有spring-boot-starter时，Spring Boot在启动并尝试读取application.yml时，会发现缺少snakeyaml这个YAML解析器，从而抛出IllegalStateException。

解决方案

解决此问题最直接且推荐的方法是，将项目中的spring-boot-autoconfigure依赖替换为spring-boot-starter。spring-boot-starter是一个核心的“启动器”依赖，它会负责引入Spring Boot应用所需的一系列基础依赖，包括：

• spring-boot-starter-logging (包含logback和slf4j)
• snakeyaml (用于YAML配置解析)
• Spring Core、Spring Beans、Spring Context等基础Spring框架模块

步骤一：修改pom.xml依赖

将原有的spring-boot-autoconfigure依赖替换为spring-boot-starter。同时，由于spring-boot-starter-parent已经管理了大部分Spring Boot相关依赖的版本，因此通常不需要显式指定spring-boot-starter的版本。

修正后的依赖配置示例：

    4.0.0

    
        org.springframework.boot
        spring-boot-starter-parent
        2.6.6 
    

    com.voicebase.analytics
    test-vbmedia-tokinesis
    0.1.0-SNAPSHOT

    
        
            org.springframework.boot
            spring-boot-starter
            
        
        
        
            org.springframework.retry
            spring-retry
            
        
        
            org.springframework
            spring-tx
            
        
        
            org.projectlombok
            lombok
            provided
        
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
                
                    true
                
                
                    
                        
                            repackage
                        
                    
                
            
            
            
                org.apache.maven.plugins
                maven-compiler-plugin
            
            
            
        
    

关键改动点：

1. 替换依赖: 删除了spring-boot-autoconfigure和slf4j-api等，添加了spring-boot-starter。
2. 版本管理: 移除了spring-retry和spring-tx等依赖的显式版本号。当项目继承spring-boot-starter-parent时，它会提供一个经过测试和兼容性验证的依赖版本集合。这使得pom.xml更加简洁，并减少了版本冲突的风险。
3. 插件优化: 将spring-boot-maven-plugin的executable配置和repackage目标合并到一个插件声明中，避免重复。

步骤二：清理和构建项目

在修改pom.xml后，务必执行Maven的清理和构建操作，以确保新的依赖被正确下载和打包：

mvn clean install

执行此命令后，Maven会下载spring-boot-starter及其所有传递性依赖，其中就包括snakeyaml。重新运行Spring Boot应用，application.yml文件应该能够被正确加载，且不再抛出snakeyaml未找到的异常。

注意事项与最佳实践

• 选择正确的Starter: 对于大多数Spring Boot应用，spring-boot-starter是基础，它提供了Web、数据访问、安全性等常用功能的最小依赖集。根据你的应用类型，可能还需要引入其他特定的Starter，例如spring-boot-starter-web（用于构建Web应用）、spring-boot-starter-data-jpa（用于JPA数据访问）等。
• 依赖管理: 充分利用spring-boot-starter-parent提供的依赖管理功能。它定义了常用库的版本，可以避免手动管理大量依赖的版本号，并确保依赖之间的兼容性。只有当需要覆盖特定依赖的版本或引入parent中未定义的依赖时，才需要显式指定版本。
• 排查依赖冲突: 如果在引入spring-boot-starter后仍然遇到其他类路径相关问题，可以使用mvn dependency:tree命令查看项目的完整依赖树，帮助识别潜在的依赖冲突或重复引入。
• 可执行JAR: spring-boot-maven-plugin是构建可执行JAR文件的关键。它会将所有项目依赖打包到一个“胖JAR”中，使得应用可以独立运行。确保其配置正确，特别是repackage目标和executable配置。

总结

java.lang.IllegalStateException: ... but snakeyaml was not found on the classpath是Spring Boot应用在加载YAML配置文件时常见的依赖缺失问题。其根本原因在于项目pom.xml中未正确引入包含snakeyaml的spring-boot-starter依赖。通过将spring-boot-autoconfigure替换为spring-boot-starter，并利用spring-boot-starter-parent进行依赖版本管理，可以有效且优雅地解决此问题，确保Spring Boot应用能够顺利启动并加载配置。遵循Spring Boot的Starter模式是构建健壮、可维护应用的推荐实践。