1. 概述
在本教程中，我们将研究将包含文本的资源内容作为String注入到我们的Spring bean中的各种方法。
我们将介绍如何查找资源并读取其内容。
此外，我们还将演示如何跨多个bean共享加载的资源。我们将通过使用与依赖注入相关的注解来展示这一点，尽管同样可以通过使用基于XML的注入并在XML属性文件中声明bean来实现相同的目的。
2. 使用Resource
我们可以使用Resource接口来简化定位资源文件的过程。Spring帮助我们使用资源加载器查找和读取资源，资源加载器根据提供的路径决定选择哪个资源实现。Resource实际上是一种访问资源内容的方式，而不是内容本身。
让我们看看为类路径上的资源获取Resource实例的一些方法。
2.1 使用ResourceLoader
如果我们更喜欢使用延迟加载，我们可以使用ResourceLoader类：
ResourceLoader resourceLoader = new DefaultResourceLoader();
Resource resource = resourceLoader.getResource("classpath:resource.txt");
我们还可以使用@Autowired将ResourceLoader注入到我们的bean中：
@Autowired
private ResourceLoader resourceLoader;
2.2 使用@Value
我们可以使用@Value将Resource直接注入到Spring bean中：
@Value("classpath:resource.txt")
private Resource resource;
3. 从资源到字符串的转换
一旦我们有权访问资源，我们就需要能够将其读入String。让我们创建一个带有静态方法asString的ResourceReader实用程序类来为我们执行此操作。
首先，我们必须获取一个InputStream：
InputStream inputStream = resource.getInputStream();
我们的下一步是获取此InputStream并将其转换为String。我们可以使用Spring自带的FileCopyUtils#copyToString方法：
public class ResourceReader {
public static String asString(Resource resource) {
try (Reader reader = new InputStreamReader(resource.getInputStream(), UTF_8)) {
return FileCopyUtils.copyToString(reader);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
// more utility methods
}
还有许多其他方法可以实现这一点，例如使用Spring的StreamUtils类的copyToString。
我们还创建另一个实用程序方法readFileToString，它将检索路径的Resource，并调用asString方法将其转换为String。
public static String readFileToString(String path) {
ResourceLoader resourceLoader = new DefaultResourceLoader();
Resource resource = resourceLoader.getResource(path);
return asString(resource);
}
4. 添加配置类
如果每个bean都必须单独注入资源String，那么有可能会出现代码重复和bean拥有自己的String副本而更多地使用内存。
我们可以通过在加载应用程序上下文时将资源的内容注入一个或多个Spring bean来实现更简洁的解决方案。通过这种方式，我们可以隐藏从需要使用此内容的各种bean读取资源的实现细节。
@Configuration
public class LoadResourceConfig {
// Bean Declarations
}
4.1 使用持有资源字符串的Bean
让我们声明bean以在@Configuration类中保存资源内容：
@Bean
public String resourceString() {
return ResourceReader.readFileToString("resource.txt");
}
现在让我们通过添加@Autowired注解将注册的bean注入到字段中：
public class LoadResourceAsStringIntegrationTest {
private static final String EXPECTED_RESOURCE_VALUE = "..."; // The string value of the file content
@Autowired
@Qualifier("resourceString")
private String resourceString;
@Test
public void givenUsingResourceStringBean_whenConvertingAResourceToAString_thenCorrect() {
assertEquals(EXPECTED_RESOURCE_VALUE, resourceString);
}
}
在这种情况下，我们使用@Qualifier注解和bean的名称，因为我们可能需要注入相同类型的多个字段-String。
我们应该注意，@Qualifier中使用的bean名称派生自配置类中创建bean的方法的名称。
5. 使用SpEL
最后，让我们看看如何使用Spring表达式语言来描述将资源文件直接加载到我们类中的字段中所需的代码。
让我们使用@Value注解将文件内容注入到字段resourceStringUsingSpel中：
public class LoadResourceAsStringIntegrationTest {
private static final String EXPECTED_RESOURCE_VALUE = "..."; // The string value of the file content
@Value("#{T(cn.tuyucheng.taketoday.loadresourceasstring.ResourceReader).readFileToString('classpath:resource.txt')}")
private String resourceStringUsingSpel;
@Test
public void givenUsingSpel_whenConvertingAResourceToAString_thenCorrect() {
assertEquals(EXPECTED_RESOURCE_VALUE, resourceStringUsingSpel);
}
}
在这里，我们调用了ResourceReader#readFileToString，通过使用“classpath:”来描述文件的位置-@Value注解中的前缀路径。
为了减少SpEL中的代码量，我们在ResourceReader类中创建了一个辅助方法，该方法使用Apache Commons FileUtils从提供的路径访问文件：
public class ResourceReader {
public static String readFileToString(String path) throws IOException {
return FileUtils.readFileToString(ResourceUtils.getFile(path), StandardCharsets.UTF_8);
}
}
6. 总结
在本教程中，我们回顾了一些将资源转换为字符串的方法。
首先，我们看到了如何生成一个Resource来访问文件，以及如何将Resource读取成String。
接下来，我们还展示了如何隐藏资源加载实现，并通过在@Configuration中创建限定的beans允许字符串内容在beans之间共享，从而允许字符串自动装配。
最后，我们使用了SpEL，它提供了一个紧凑而直接的解决方案，尽管它需要一个自定义的辅助函数来阻止它变得过于复杂。
与往常一样，本教程的完整源代码可在GitHub上获得。
Post Directory
