spring路径通配符

朱雀 2022-09-30 13:53 169阅读 0赞

在应用[spring][]的工程中，使用class path的方式加载配置文件应该是最常用的做法，然而对大部分人来说，刚开始使用Spring时，几乎都碰到过加载配置文件失败的情况，除了配置上的错误外，很多时候是因为配置文件的路径和程序中指定的加载路径不一致，从而导致配置文件找不到，或是加载了错误地方的配置文件。本文将就Spring如何从class path中加载配置文件做一些简要的分析。

classpath:与classpath\*:的区别在于，前者只会从第一个classpath中加载，而后者会从所有的classpath中加载  
  
如果要加载的资源，不在当前ClassLoader的路径里，那么用classpath:前缀是找不到的，这种情况下就需要使用classpath\*:前缀  
  
另一种情况下，在多个classpath中存在同名资源，都需要加载，那么用classpath:只会加载第一个，这种情况下也需要用classpath\*:前缀  
  
可想而知，用classpath\*:需要遍历所有的classpath，所以加载速度是很慢的，因此，在规划的时候，应该尽可能规划好资源文件所在的路径，尽量避免使用classpath\*

情形一：使用classpath加载且不含通配符

这是最简单的情形，Spring默认会使用当前线程的ClassLoader的`getResource``方法获取资源的``URL``，如果无法获得当前线程的``ClassLoader``，``Spring``将使用加载类`org.springframework.util.ClassUtils的ClassLoader。

1.当工程目录结构如图所示:

[![hi.baidu.com_162e8a01091243d3277fb5b6.jpg][]][hi.baidu.com_162e8a01091243d3277fb5b6.jpg]

即配置文件放在bin目录中的conf文件夹里，这时使用

ApplicationContext context =

new ClassPathXmlApplicationContext("conf/application-context.xml");来创建ApplicationContext对象的话，Spring将加载bin/conf目录下的application-context.xml文件。Spring启动时的输出显示为：

Loading XML bean definitions from

class path resource \[conf/application-context.xml\]

2. 当工程目录结构如图所示：

[![hi.baidu.com_2883c6137efac826dd540182.jpg][]][hi.baidu.com_2883c6137efac826dd540182.jpg]

即 bin 目录下只有 .class 文件，没有配置文件，同时在工程属性的 Java Build Path->Libraries 里导入 conf.jar 文件， jar 文件结构如图所示：

[![hi.baidu.com_6e214454318d1c51564e0082.jpg][]][hi.baidu.com_6e214454318d1c51564e0082.jpg]

这时使用

ApplicationContext context =

new ClassPathXmlApplicationContext("conf/application-context.xml");来创建ApplicationContext对象的话，Spring将加载conf.jar文件中conf目录下的application-context.xml文件。Spring启动时的输出显示为：

Loading XML bean definitions from

class path resource \[conf/application-context.xml\]

3.  当工程目录结构如图所示 :

[![hi.baidu.com_162e8a01091243d3277fb5b6_000.jpg][]][hi.baidu.com_162e8a01091243d3277fb5b6_000.jpg]

即配置文件放在 bin 目录中的 conf 文件夹里，同时在工程属性的 Java Build Path->Libraries 里导入 conf.jar 文件， jar 文件结构如图所示：

[![hi.baidu.com_6e214454318d1c51564e0082_000.jpg][]][hi.baidu.com_6e214454318d1c51564e0082_000.jpg]

这时使用

ApplicationContext context =

new ClassPathXmlApplicationContext("conf/application-context.xml");来创建ApplicationContext对象的话，由于没有使用classpath\*前缀，Spring只会加载一个application-context.xml文件。在eclipse中将会加载bin/conf目录下的application-context.xml文件，而jar包中的conf/application-context.xml并不会被加载，Spring启动时的输出显示为：

Loading XML bean definitions from

class path resource \[conf/application-context.xml\]

情形二：使用classpath加载，包含通配符

碰到通配符的情况时，Spring会通过使用路径中的非通配符部分先确定资源的大致位置，然后根据这个位置在确定具体的资源位置，结合下面给出的几种情况可以更好地理解Spring的这种工作方式

1. 当工程目录结构如图所示:

[![hi.baidu.com_acc59d524d8cb30b0cf3e383.jpg][]][hi.baidu.com_acc59d524d8cb30b0cf3e383.jpg]

即配置文件放在bin目录中的conf文件夹里，这时使用

ApplicationContext context = new

ClassPathXmlApplicationContext("conf/\*\*/\*application-context.xml");

来创建ApplicationContext对象的话，Spring首先会通过路径中的非通配符部分即conf，先确定conf的路径，即bin/conf目录，然后从该目录下加载配置文件，由于使用了/\*\*/的方式，表明要加载conf目录下包括各级子目录中的所有配置文件，因此bin/conf/application-context.xml文件和

bin/conf/admin/admin-application-context.xml都会被加载，Spring启动时的输出显示为：

Loading XML bean definitions from file

\[D:\\myworkspace\\spring-study\\bin\\conf\\admin\\admin-application-context.xml\]

Loading XML bean definitions from file

\[D:\\myworkspace\\spring-study\\bin\\conf\\application-context.xml\]

2 ．当工程目录结构如图所示：

[![hi.baidu.com_2883c6137efac826dd540182_000.jpg][]][hi.baidu.com_2883c6137efac826dd540182_000.jpg]

即 bin 目录下只有 .class 文件，没有配置文件，同时在工程属性的 Java Build Path->Libraries 里导入 conf.jar 文件， jar 文件结构如图所示：

[![hi.baidu.com_1b3b6663288aaa650c33fa83.jpg][]][hi.baidu.com_1b3b6663288aaa650c33fa83.jpg]

这时使用

ApplicationContext context = new

ClassPathXmlApplicationContext("conf/\*\*/\*application-context.xml");来创建ApplicationContext对象的话，Spring首先会通过路径中的非通配符部分即conf，先确定conf的路径，即conf.jar中的conf目录，然后从该目录下加载配置文件，由于使用了/\*\*/的方式，表明要加载conf目录下包括各级子目录中的所有配置文件，因此conf/application-context.xml文件和

conf/admin/admin-application-context.xml都会被加载，Spring启动时的输出显示为：

Loading XML bean definitions from class path resource

\[conf/admin/admin-application-context.xml\]

Loading XML bean definitions from class path resource

\[conf/application-context.xml\]

3 ．当工程目录结构如图所示：

[![hi.baidu.com_acc59d524d8cb30b0cf3e383_000.jpg][]][hi.baidu.com_acc59d524d8cb30b0cf3e383_000.jpg]

即配置文件放在 bin 目录中的 conf 文件夹里，同时在工程属性的 Java Build Path->Libraries 里导入 conf.jar 文件， jar 文件结构如图所示：

[![hi.baidu.com_1b3b6663288aaa650c33fa83_000.jpg][]][hi.baidu.com_1b3b6663288aaa650c33fa83_000.jpg]

这时使用

ApplicationContext context = new

ClassPathXmlApplicationContext("conf/\*\*/\*application-context.xml");来创建ApplicationContext对象的话，Spring首先会通过路径中的非通配符部分即conf，先确定conf的路径，在eclipse中是bin/conf目录，然后从该目录下加载配置文件，由于使用了/\*\*/的方式，表明要加载conf目录下包括各级子目录中的所有配置文件，因此bin/conf/application-context.xml文件和

bin/conf/admin/admin-application-context.xml都会被加载，但conf.jar文件中的配置文件并不会被加载，Spring启动时的输出显示为：

Loading XML bean definitions from file

\[D:\\myworkspace\\spring-study\\bin\\conf\\admin\\admin-application-context.xml\]

Loading XML bean definitions from file

\[D:\\myworkspace\\spring-study\\bin\\conf\\application-context.xml\]

情形三：使用classpath\*前缀且不包含通配符

使用classpath\*前缀可以获取所有与给定路径匹配的classpath资源，从而避免出现两个不同位置有相同名字的文件，Spring只加载其中一个的情况。

当工程目录结构如图所示 :

[![hi.baidu.com_162e8a01091243d3277fb5b6_000.jpg][]][hi.baidu.com_162e8a01091243d3277fb5b6_000.jpg]

即配置文件放在 bin 目录中的 conf 文件夹里，同时在工程属性的 Java Build Path->Libraries 里导入 conf.jar 文件， jar 文件结构如图所示：

[![hi.baidu.com_6e214454318d1c51564e0082_001.jpg][]][hi.baidu.com_6e214454318d1c51564e0082_001.jpg]

这时使用

ApplicationContext context = new

ClassPathXmlApplicationContext("classpath\*:conf/application-context.xml");来创建ApplicationContext对象的话， Spring将会加载bin目录下的application-context.xml文件和jar包里的application-context.xml文件，Spring启动时的输出显示为：

Loading XML bean definitions from URL

\[file:/D:/myworkspace/spring-study/bin/conf/application-context.xml\]

Loading XML bean definitions from URL

\[jar:file:/D:/myworkspace/conf1.jar!/conf/application-context.xml\]

情形四：使用classpath\*前缀，包含通配符

当工程目录结构如图所示：

[![hi.baidu.com_acc59d524d8cb30b0cf3e383_001.jpg][]][hi.baidu.com_acc59d524d8cb30b0cf3e383_001.jpg]

即配置文件放在 bin 目录中的 conf 文件夹里，同时在工程属性的 Java Build Path->Libraries 里导入 conf.jar 文件， jar 文件结构如图所示：

[![hi.baidu.com_1b3b6663288aaa650c33fa83_001.jpg][]][hi.baidu.com_1b3b6663288aaa650c33fa83_001.jpg]

这时使用

ApplicationContext context = new

ClassPathXmlApplicationContext("classpath\*:conf/\*\*/\*application-context.xml");来创建ApplicationContext对象的话，Spring首先会通过路径中的非通配符部分即conf，先确定conf的路径，由于使用了classpaht\*前缀，因此bin目录下的conf和jar包里的conf都会被加载，同时由于使用了/\*\*/的方式，表明要加载conf目录下包括各级子目录中的所有配置文件，因此bin/conf/application-context.xml和

bin/conf/admin/admin-application-context.xml以及jar包中的

conf/application-context.xml和

conf/admin/admin-application-context.xml都会被加载，Spring启动时的输出显示为：

Loading XML bean definitions from file

\[D:\\myworkspace\\spring-study\\bin\\conf\\admin\\admin-application-context.xml\]

Loading XML bean definitions from file

\[D:\\myworkspace\\spring-study\\bin\\conf\\application-context.xml\]

Loading XML bean definitions from URL

\[jar:file:/D:/myworkspace/conf1.jar!/conf/admin/admin-application-context.xml\]

Loading XML bean definitions from URL

\[jar:file:/D:/myworkspace/conf1.jar!/conf/application-context.xml\]

特别注意：

如果工程目录如图所示：

[![hi.baidu.com_53166660ec9d4641ebf8f883.jpg][]][hi.baidu.com_53166660ec9d4641ebf8f883.jpg]

即配置文件直接放在 bin 目录中，同时在工程属性的 Java Build Path->Libraries 里导入 conf.jar 文件， jar

[spring]: http://lib.csdn.net/base/javaee
[hi.baidu.com_162e8a01091243d3277fb5b6.jpg]: /images/20220705/a92cd5e87f5b4e75853a8761af4d05eb.png
[hi.baidu.com_2883c6137efac826dd540182.jpg]: /images/20220705/4cce6f2891a44e9a87e2220719ca9380.png
[hi.baidu.com_6e214454318d1c51564e0082.jpg]: /images/20220705/d4b9e6539ba44f3a8177571be4518b90.png
[hi.baidu.com_162e8a01091243d3277fb5b6_000.jpg]: /images/20220705/49fcc7efe04a47fe82323add9c1d9f43.png
[hi.baidu.com_6e214454318d1c51564e0082_000.jpg]: /images/20220705/da7a8d15a32d400ba63f5e30c5cacf57.png
[hi.baidu.com_acc59d524d8cb30b0cf3e383.jpg]: /images/20220705/00ed198cab124232b8eba645f419ae48.png
[hi.baidu.com_2883c6137efac826dd540182_000.jpg]: /images/20220705/e856e39b562a4e8aa079e836a483fc97.png
[hi.baidu.com_1b3b6663288aaa650c33fa83.jpg]: /images/20220705/d37e80dcb04e482a89ebf4efefd41042.png
[hi.baidu.com_acc59d524d8cb30b0cf3e383_000.jpg]: /images/20220705/cb5ca63c659e417a86a64e99dcde2786.png
[hi.baidu.com_1b3b6663288aaa650c33fa83_000.jpg]: /images/20220705/1d37032dc48441a39c1bcbcded03d41c.png
[hi.baidu.com_6e214454318d1c51564e0082_001.jpg]: /images/20220705/be3cb407ae8f4a2e9b461c4929c4de02.png
[hi.baidu.com_acc59d524d8cb30b0cf3e383_001.jpg]: /images/20220705/d321aa16bda84c79b461a613139a2f66.png
[hi.baidu.com_1b3b6663288aaa650c33fa83_001.jpg]: /images/20220705/cd6fc8cab246408998a0093602400da6.png
[hi.baidu.com_53166660ec9d4641ebf8f883.jpg]: /images/20220705/c91cf3bdf5ff4cb79ed8d176402d19be.png