Spring 简明教程

Spring - Injecting Collection

您已经看到如何使用 Bean 配置文件中的 <property> 标记的 value 属性配置原始数据类型，以及使用 ref 属性配置对象引用。这两种情况都涉及将奇异值传递给 Bean。

现在，如果您想传递复数值，如 Java 集合类型（例如列表、集合、映射和属性），该怎么办。为了处理这种情况，Spring 提供了四种类型的集合配置元素，如下所示−

Sr.No	Element & Description
1	<list> 这有助于进行接线，即注入一个值列表，同时允许重复。
2	<set> 这有助于接线一组值，但没有任何重复。
3	<map> 这可用于注入名称-值对的集合，其中名称和值可以是任何类型。
4	<props> 这可用于注入名称-值对的集合，其中名称和值都是字符串。

您可以使用 <list> 或 <set> 来接线任何 java.util.Collection 的实现或 array 。

您将遇到两种情况：(a) 传递集合的直接值和 (b) 传递 Bean 引用作为集合元素之一。

Example

让我们准备一个可用的 Eclipse IDE，然后执行以下步骤来创建一个 Spring 应用程序−

Steps	Description
1	使用 SpringExample 创建一个项目，并在创建的项目 src 文件夹下创建 com.tutorialspoint 包。
2	使用 Add External JARs 选项添加必需的 Spring 库，如 Spring Hello World Example 章节中所述。
3	在 com.tutorialspoint 包下创建 Java 类 JavaCollection 和 MainApp。
4	在 src 文件夹下创建 Beans 配置文件 Beans.xml。
5	最后一步是创建所有 Java 文件和 Bean 配置文件的内容，并按如下所述运行应用程序。

以下是 JavaCollection.java 文件的内容−

package com.tutorialspoint;
import java.util.*;

public class JavaCollection {
   List addressList;
   Set  addressSet;
   Map  addressMap;
   Properties addressProp;

   // a setter method to set List
   public void setAddressList(List addressList) {
      this.addressList = addressList;
   }

   // prints and returns all the elements of the list.
   public List getAddressList() {
      System.out.println("List Elements :"  + addressList);
      return addressList;
   }

   // a setter method to set Set
   public void setAddressSet(Set addressSet) {
      this.addressSet = addressSet;
   }

   // prints and returns all the elements of the Set.
   public Set getAddressSet() {
      System.out.println("Set Elements :"  + addressSet);
      return addressSet;
   }

   // a setter method to set Map
   public void setAddressMap(Map addressMap) {
      this.addressMap = addressMap;
   }

   // prints and returns all the elements of the Map.
   public Map getAddressMap() {
      System.out.println("Map Elements :"  + addressMap);
      return addressMap;
   }

   // a setter method to set Property
   public void setAddressProp(Properties addressProp) {
      this.addressProp = addressProp;
   }

   // prints and returns all the elements of the Property.
   public Properties getAddressProp() {
      System.out.println("Property Elements :"  + addressProp);
      return addressProp;
   }
}

以下是 MainApp.java 文件的内容−

package com.tutorialspoint;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class MainApp {
   public static void main(String[] args) {
      ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml");
      JavaCollection jc=(JavaCollection)context.getBean("javaCollection");

      jc.getAddressList();
      jc.getAddressSet();
      jc.getAddressMap();
      jc.getAddressProp();
   }
}

以下是配置文件 Beans.xml ，其中包含对所有类型集合的配置−

<?xml version = "1.0" encoding = "UTF-8"?>

<beans xmlns = "http://www.springframework.org/schema/beans"
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://www.springframework.org/schema/beans
   http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

   <!-- Definition for javaCollection -->
   <bean id = "javaCollection" class = "com.tutorialspoint.JavaCollection">

      <!-- results in a setAddressList(java.util.List) call -->
      <property name = "addressList">
         <list>
            <value>INDIA</value>
            <value>Pakistan</value>
            <value>USA</value>
            <value>USA</value>
         </list>
      </property>

      <!-- results in a setAddressSet(java.util.Set) call -->
      <property name = "addressSet">
         <set>
            <value>INDIA</value>
            <value>Pakistan</value>
            <value>USA</value>
            <value>USA</value>
         </set>
      </property>

      <!-- results in a setAddressMap(java.util.Map) call -->
      <property name = "addressMap">
         <map>
            <entry key = "1" value = "INDIA"/>
            <entry key = "2" value = "Pakistan"/>
            <entry key = "3" value = "USA"/>
            <entry key = "4" value = "USA"/>
         </map>
      </property>

      <!-- results in a setAddressProp(java.util.Properties) call -->
      <property name = "addressProp">
         <props>
            <prop key = "one">INDIA</prop>
            <prop key = "one">INDIA</prop>
            <prop key = "two">Pakistan</prop>
            <prop key = "three">USA</prop>
            <prop key = "four">USA</prop>
         </props>
      </property>
   </bean>

</beans>

完成源文件和 Bean 配置文件创建后，我们运行该应用程序。如果您的应用程序一切正常，它将打印以下消息−

List Elements :[INDIA, Pakistan, USA, USA]
Set Elements :[INDIA, Pakistan, USA]
ap Elements :{1 = INDIA, 2 = Pakistan, 3 = USA, 4 = USA}
Property Elements :{two = Pakistan, one = INDIA, three = USA, four = USA}

Injecting Bean References

以下 Bean 定义将帮助您了解如何将 Bean 引用注入为集合的元素之一。您甚至可以将引用和值混合在一起，如下面的代码片段所示−

<?xml version = "1.0" encoding = "UTF-8"?>

<beans xmlns = "http://www.springframework.org/schema/beans"
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://www.springframework.org/schema/beans
   http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

   <!-- Bean Definition to handle references and values -->
   <bean id = "..." class = "...">

      <!-- Passing bean reference  for java.util.List -->
      <property name = "addressList">
         <list>
            <ref bean = "address1"/>
            <ref bean = "address2"/>
            <value>Pakistan</value>
         </list>
      </property>

      <!-- Passing bean reference  for java.util.Set -->
      <property name = "addressSet">
         <set>
            <ref bean = "address1"/>
            <ref bean = "address2"/>
            <value>Pakistan</value>
         </set>
      </property>

      <!-- Passing bean reference  for java.util.Map -->
      <property name = "addressMap">
         <map>
            <entry key = "one" value = "INDIA"/>
            <entry key = "two" value-ref = "address1"/>
            <entry key = "three" value-ref = "address2"/>
         </map>
      </property>
   </bean>

</beans>

要使用上述 Bean 定义，您需要以能够处理引用的方式定义您的 setter 方法。

Injecting null and empty string values

如果您需要传递一个空字符串作为值，那么您可以按如下方式传递−

<bean id = "..." class = "exampleBean">
   <property name = "email" value = ""/>
</bean>

前面的示例等效于 Java 代码：exampleBean.setEmail("")

如果您需要传递一个 NULL 值，那么您可以按如下方式传递−

<bean id = "..." class = "exampleBean">
   <property name = "email"><null/></property>
</bean>

前面的示例等价于 Java 代码：exampleBean.setEmail(null)