ZetCode

Spring c-namespace 教程

最后修改于 2023 年 10 月 18 日

Spring 构造函数命名空间教程展示了如何在 Spring 应用程序的基于构造函数的注入中使用 c-namespace。

Spring 是一个流行的 Java 应用程序框架,用于创建企业级应用程序。

Spring c-namespace

Spring c-namespace 是 <bean/> 标签的 <constructor-arg/> 子元素的 XML 快捷方式和替代。要启用 c-namespace 功能,我们需要在 XML 文件中添加 xmlns:c="http://www.springframework.org/schema/c"。请注意,此命名空间没有单独的 XSD 文件;因此,IntelliJ 等 IDE 无法识别它。

Spring c-namespace 示例

该应用程序包含两个 User bean。一个使用旧的 <constructor-arg/> 注入,另一个使用新的 c-namespace 属性注入。

src
├───main
│   ├───java
│   │   └───com
│   │       └───zetcode
│   │           │   Application.java
│   │           └───bean
│   │                   User.java
│   └───resources
│           logback.xml
│           my-beans.xml
└───test
    └───java

这是项目结构。

pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
            http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.zetcode</groupId>
    <artifactId>cnamespace</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <spring-version>5.3.23</spring-version>

    </properties>

    <dependencies>

        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.4.0</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring-version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring-version}</version>
        </dependency>
        
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <version>3.1.0</version>
                <configuration>
                    <mainClass>com.zetcode.Application</mainClass>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

pom.xml 文件中,我们有基本的 Spring 依赖 spring-corespring-context,以及日志 logback-classic 依赖。

exec-maven-plugin 用于从 Maven 命令行执行 Spring 应用程序。

resources/logback.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <logger name="org.springframework" level="ERROR"/>
    <logger name="com.zetcode" level="INFO"/>

    <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <Pattern>%d{HH:mm:ss.SSS} %blue(%-5level) %magenta(%logger{36}) - %msg %n
            </Pattern>
        </encoder>
    </appender>

    <root>
        <level value="INFO" />
        <appender-ref ref="consoleAppender" />
    </root>
</configuration>

logback.xml 是 Logback 日志库的配置文件。

resources/my-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"
        xmlns:c="http://www.springframework.org/schema/c"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean name="user1" class="com.zetcode.bean.User">
        <constructor-arg name="name" value="John Doe"/>
        <constructor-arg name="occupation" value="gardener"/>
    </bean>

    <bean name="user2" class="com.zetcode.bean.User"
            c:name="Peter Smith" c:occupation="teacher"/>

</beans>

my-beans.xml 文件声明了两个 bean:user1user2user1 使用 <constructor-arg/> 注入其值,而 user2 使用 c:namec:occupation 属性。

com/zetcode/bean/User.java
package com.zetcode.bean;

public class User {

    private String name;
    private String occupation;

    public User(String name, String occupation) {
        this.name = name;
        this.occupation = occupation;
    }

    @Override
    public String toString() {

        final var sb = new StringBuilder("User{");
        sb.append("name='").append(name).append('\'');
        sb.append(", occupation='").append(occupation).append('\'');
        sb.append('}');
        return sb.toString();
    }
}

这是由 Spring 容器管理的 User 类。由于我们在应用程序中使用了基于构造函数的注入,因此它必须包含一个构造函数。

com/zetcode/Application.java
package com.zetcode;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.support.GenericXmlApplicationContext;

public class Application {

    private static final Logger logger = LoggerFactory.getLogger(Application.class);

    public static void main(String[] args) {

        var ctx = new GenericXmlApplicationContext("my-beans.xml");

        var u1 = ctx.getBean("user1");
        var u2 = ctx.getBean("user2");

        logger.info("{}", u1);
        logger.info("{}", u2);

        ctx.close();
    }
}

这是主要的应用程序类。它检索两个 bean 并将它们打印到控制台。

$ mvn -q exec:java
16:40:39.632 INFO  com.zetcode.Application - User{name='John Doe', occupation='gardener'} 
16:40:39.632 INFO  com.zetcode.Application - User{name='Peter Smith', occupation='teacher'} 

我们运行应用程序。

在本文中,我们展示了如何将基于构造函数的注入与 c-namespace 结合使用。

作者

我的名字是 Jan Bodnar,我是一名充满热情的程序员,拥有丰富的编程经验。我从 2007 年开始撰写编程文章。迄今为止,我已撰写了 1,400 多篇文章和 8 本电子书。我在编程教学方面拥有十多年的经验。

列出 所有 Spring 教程