Format Spring Framework XML Configuration Files

Formatting Spring XML Configuration

Spring Framework has historically used XML for bean definitions and application configuration. While Java annotations have become the default, many enterprise projects still maintain extensive Spring XML configurations.

Bean Definition

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

  <context:component-scan base-package="com.example" />

  <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource"
        destroy-method="close">
    <property name="driverClassName" value="com.mysql.cj.jdbc.Driver" />
    <property name="url" value="jdbc:mysql://localhost:3306/mydb" />
    <property name="username" value="root" />
    <property name="password" value="secret" />
  </bean>
</beans>

Schema Location Formatting

Spring XML files often have long xsi:schemaLocation values listing multiple namespace-to-schema mappings. Proper formatting places each namespace/URL pair on its own line for readability.

Constructor and Property Injection

<!-- Constructor injection -->
<bean id="userService" class="com.example.UserService">
  <constructor-arg ref="userRepository" />
  <constructor-arg value="100" />
</bean>

<!-- Property injection -->
<bean id="mailService" class="com.example.MailService">
  <property name="host" value="smtp.example.com" />
  <property name="port" value="587" />
  <property name="templateEngine" ref="templateEngine" />
</bean>

Spring Security XML

<http auto-config="true">
  <intercept-url pattern="/admin/**" access="ROLE_ADMIN" />
  <intercept-url pattern="/user/**" access="ROLE_USER" />
  <form-login login-page="/login" />
  <logout logout-url="/logout" />
</http>

Security configurations benefit greatly from formatting because the URL patterns and access rules form a visual security matrix.

Multiple Configuration Files

Large Spring projects split configuration across multiple XML files. Each file should be self-contained with its own namespace declarations and a clear, focused purpose (data access, security, messaging, etc.).

Import Chains

<import resource="classpath:spring-data.xml" />
<import resource="classpath:spring-security.xml" />
<import resource="classpath:spring-messaging.xml" />

Formatted imports at the top of the file clearly show the configuration dependency chain.