Master Spring Boot Config Management with Enums and @ConfigurationProperties

Background

Spring Boot stores configuration in application.yml or application.properties. Hard‑coded literals reduce readability and increase maintenance effort.

Java enum types group related constant values, eliminating magic numbers. Combining enums with @ConfigurationProperties provides type‑safe, dynamic configuration management.

Why Configuration Management Matters

Poor readability : literals obscure meaning.

High maintenance cost : changes require searching many places.

Magic‑number issues : can cause subtle bugs.

Solution Overview

Define an enum for fixed business concepts (e.g., user roles) and map configuration values to the enum via a Spring @ConfigurationProperties class.

Project Dependencies (pom.xml)

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Thymeleaf template engine -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>

    <!-- Lombok for boilerplate reduction -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <scope>provided</scope>
    </dependency>

    <!-- Validation support -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>

    <!-- DevTools for hot reload -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

Configuration File (application.yml)

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/your_database
    username: your_username
    password: your_password
server:
  port: 8080

app:
  user-type:
    admin: ADMIN
    user: USER
    guest: GUEST
    vip: VIP
    moderator: MODERATOR

Enum Definition (UserTypeEnum.java)

public enum UserTypeEnum {
    ADMIN("管理员"),
    USER("普通用户"),
    GUEST("游客"),
    VIP("VIP用户"),
    MODERATOR("版主");

    private final String description;

    UserTypeEnum(String description) {
        this.description = description;
    }

    public String getDescription() {
        return description;
    }
}

Configuration Class (AppConfig.java)

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import lombok.Data;
import com.icoderoad.enumconfig.enums.UserTypeEnum;

@Data
@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private UserType userType;
    private Database database;
    private Server server;

    @Data
    public static class UserType {
        private UserTypeEnum admin;
        private UserTypeEnum user;
        private UserTypeEnum guest;
        private UserTypeEnum vip;
        private UserTypeEnum moderator;
    }

    @Data
    public static class Database {
        private String url;
        private String username;
        private String password;
    }

    @Data
    public static class Server {
        private int port;
    }
}

Controller (UserController.java)

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class UserController {

    @Autowired
    private AppConfig appConfig;

    @GetMapping("/user-types")
    public String getUserTypes(Model model) {
        model.addAttribute("adminType", appConfig.getUserType().getAdmin().getDescription());
        model.addAttribute("userType", appConfig.getUserType().getUser().getDescription());
        model.addAttribute("guestType", appConfig.getUserType().getGuest().getDescription());
        model.addAttribute("vipType", appConfig.getUserType().getVip().getDescription());
        model.addAttribute("moderatorType", appConfig.getUserType().getModerator().getDescription());
        return "index";
    }
}

Thymeleaf View (index.html)

<!DOCTYPE html>
<html lang="zh-CN" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>用户类型</title>
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css">
</head>
<body>
    <h1 class="mt-5">用户类型</h1>
    <table class="table table-bordered mt-3">
        <thead>
            <tr><th>角色</th><th>描述</th></tr>
        </thead>
        <tbody>
            <tr><td>ADMIN</td><td th:text="${adminType}"></td></tr>
            <tr><td>USER</td><td th:text="${userType}"></td></tr>
            <tr><td>GUEST</td><td th:text="${guestType}"></td></tr>
            <tr><td>VIP</td><td th:text="${vipType}"></td></tr>
            <tr><td>MODERATOR</td><td th:text="${moderatorType}"></td></tr>
        </tbody>
    </table>
</body>
</html>

Result

Running the Spring Boot application and accessing /user-types renders a table that lists each user role together with its human‑readable description, confirming that enum‑based configuration is type‑safe, clear, and easy to maintain.