<div id="readability-page-1" class="page"><div>
                                
                <div id="SE-e9954d2f-72cc-4774-8559-bea68dd41265">
                                    <p id="SE-cd96f49b-d30e-4170-8979-504427e8d52f"><span id="SE-b6c09f7f-834d-4464-827b-e9dc6b70ab9b">​</span></p><p id="SE-2dbae16a-5bc0-41fa-927e-8d48310a9b74"><span id="SE-c7e5d38f-6968-41d7-a0ca-9c010e3720b4">평소에 별 생각없이 썼던 springboot 의 @ConfigurationProperties 에 대해 정리한다.</span></p><p id="SE-8e8972e8-dc01-49e6-8810-cab3b55b0d74"><span id="SE-1cc6e40e-c25a-49af-ada2-2ae5d7d9101d">아래와 같이 prefix 에 "customProperties" 를 적으면 에러가 발생한다.</span></p>
                            </div>                <div id="SE-a42d7190-0492-4afb-9ae9-300b3eb80cb7">
                                    <p>@Configuration
@ConfigurationProperties(prefix = "customProperties")
public class MainConfiguration {
    String name;
 
    // getters and setters
}</p>
                                </div>                                <div id="SE-205fdfb3-3f32-4232-8973-5e146ef39163">
                                    <p>$ mvn spring-boot:run
...
...
***************************
APPLICATION FAILED TO START
***************************

Description:

Configuration property name 'customProperties' is not valid:

    Invalid characters: 'P'
    Bean: mainConfiguration
    Reason: Canonical names should be kebab-case ('-' separated), lowercase alpha-numeric characters and must start with a letter

Action:

Modify 'customProperties' so that it conforms to the canonical names requirements.</p>
                                </div>                <div id="SE-ee151467-4c0e-435c-b521-9c2fe2dc9be2">
                                    <p id="SE-73c827d0-59f5-40e3-b210-e2ef806fe0a6"><span id="SE-cb88489c-db40-4c2b-8249-a4f71032ea87">​</span></p><p id="SE-b8335060-d6ec-4385-a9de-a098e8093f26"><span id="SE-61d0396f-4888-427b-81f6-3586a7abfc0b">이유는 prefix 에는 kebab-case 형태로 적어주는게 룰이기 때문이다.</span></p><p id="SE-8c87380c-10dc-469a-912c-a868846eddad"><span id="SE-ecd15db1-01e8-4a14-a6d0-b819d897665b">에러를 해결하기 위해서는 prefix 를 아래와 같이 수정해줘야 한다.</span></p>
                            </div>                <div id="SE-8ff9973e-47d0-48fb-9de6-58bd6dedb9de">
                                    <p>@ConfigurationProperties(prefix = "custom-properties")</p>
                                </div>                <div id="SE-2c2081d9-7815-4294-bef5-da843f11ea86">
                            <p id="SE-8a7f2136-90ab-4565-973d-779e0a13a6cb"><span id="SE-9d30c025-87e9-489b-a27e-01bd68cabb37">@ConfigurationProperties 의 prefix 에 kebab-case 형태로 적으면 아래 모든 케이스에 대해 알아서 처리를 한다.</span></p>
                        </div>                <div id="SE-2f4516d8-96c2-4c5a-8d88-f26c661b60f5">
                                    <p>customProperties.name="Baeldung"
CustomProperties.name="Baeldung"
custom_properties.name="Baeldung"
custom-properties.name="Baeldung"</p>
                                </div>                <div id="SE-8f6eff6f-9827-4e0e-8f73-56277c8a1b62">
                            <p id="SE-69ff95d7-03fa-4dc0-9c08-12ef66ffbe5e"><span id="SE-89c61d16-c950-4621-b198-ff6bd3397fd0">즉, properties 나 yaml 파일에 어떤형태로 작성하든 상관 없지만 @ConfigurationProperties 의 prefix 에는 kebab-case 형태로 적어야 한다는걸 기억하자.</span></p>
                        </div>    </div></div>

나만의공간。

KIM JUNGHWAN

평소에 별 생각없이 썼던 springboot 의 @ConfigurationProperties 에 대해 정리한다. 아래와 같이 prefix 에 "customProperties" 를 적으면 에러가 발생한다. 아래는 에러 내용 이유는 prefix 에는 kebab-case 형태로 적어주는게 룰이기 때문이다. 에러를 해결하기 위해서는 prefix 를 아래와 같이 수정해줘야 한다. @ConfigurationProperties 의 prefix 에 kebab-case 형태로 적으면 아래 모든 케이스에 대해 알아서 처리를 한다. 즉, properties 나 yaml 파일에 어떤형태로 작성하든 상관 없지만 @ConfigurationProperties 의 prefix 에는 kebab-case 형태로 적어야 한다는걸 기억하자.

[Springboot] @ConfigurationProperties prefix 룰

댓글