Spring 메시지, 국제화

다양한 메시지를 한 곳에서 관리하도록 하는 기능

목적

메시지

item=상품
item.id=상품 ID
item.itemName=상품명
item.price=가격
item.quantity=수량

<label for="itemName" th:text="#{item.itemName}"></label>

국제화

item=상품
item.id=상품 ID
item.itemName=상품명
item.price=가격
item.quantity=수량

item=Item
item.id=Item ID
item.itemName=Item Name
item.price=price
item.quantity=quantity

Spring 메시지 소스 설정

직접 등록

@Bean
public MessageSource messageSource() {
    ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
    messageSource.setBasenames("messages", "errors");
    messageSource.setDefaultEncoding("utf-8");
    return messageSource;
}

• basenames : 설정 파일의 이름을 지정한다.
• messages 로 지정하면 messages.properties 파일을 읽어서 사용한다.
• 추가로 국제화 기능을 적용하려면 messages_en.properties, messages_ko.properties와 같이 파일명 마지막에 언어 정보를 주면된다.
• 만약 찾을 수 있는 국제화 파일이 없으면 messages.properties(언어정보가 없는 파일명)를 기본으로 사용한다.
• 파일의 위치는 /resources/messages.properties
• 여러 파일을 한번에 지정할 수 있다. 여기서는 messages, errors 둘을 지정했다.

• defaultEncoding : 인코딩 정보를 지정한다. utf-8 을 사용하면 된다.

Spring Boot

spring.messages.basename=messages,config.i18n.messages

메시지 소스 기본 값

spring.messages.basename=messages

메시지 파일 만들기

• messages.properties :기본 값으로 사용(한글)

• messages_en.properties : 영어 국제화 사용

hello=안녕
hello.name=안녕 {0}

hello=hello
hello.name=hello {0}

스프링 메시지 소스 사용

MessageSource 인터페이스

public interface MessageSource {
    String getMessage(String code, @Nullable Object[] args, @Nullable String defaultMessage, Locale locale);
    String getMessage(String code, @Nullable Object[] args, Locale locale) throws NoSuchMessageException;

메시지 사용

ms.getMessage("hello", null, null);

• code: hello

• args: null

• locale: null

• locale 정보가 없으면 basename 에서 설정한 기본 이름 메시지 파일을 조회

• basename 으로 messages 를 지정 했으므로 messages.properties 파일에서 데이터 조회

기본 메시지

• 메시지가 없는 경우에는 NoSuchMessageException 이 발생한다.

• 메시지가 없어도 기본 메시지( defaultMessage )를 사용하면 기본 메시지가 반환된다.

매개변수 사용

ms.getMessage("hello.name", new Object[]{"Spring"}, null);

국제화 파일 선택

• locale 정보를 기반으로 국제화 파일을 선택

• Locale이 en_US 의 경우 messages_en_US → messages_en messages → messages 순서로 찾는다.

• Locale 에 맞추어 구체적인 것이 있으면 구체적인 것을 찾고, 없으면 디폴트를 찾는다고 이해하면 된다.

국제화 사용

• ms.getMessage("hello", null, null); : locale 정보가 없는 경우 Locale.getDefault() 을 호출해서 시스템의 기본 로케일을 사용 예) locale = null 인 경우 시스템 기본 locale 이 ko_KR 이므로 messages_ko.properties 조회 시도 → 조회 실패 → messages.properties 조회

• ms.getMessage("hello", null, Locale.KOREA); : locale 정보가 있지만, message_ko 가 없으므로 messages 를 사용

• ms.getMessage("hello", null, Locale.ENGLISH); : locale 정보가 Locale.ENGLISH 이므로 messages_en 을 찾아서 사용

Thymeleaf

메시지 적용

• 타임리프의 메시지 표현식 #{...} 를 사용하면 스프링의 메시지를 편리하게 조회

• 등록한 상품이라는 이름을 조회하려면 #{label.item}

국제화 선택

LocaleResolver

public interface LocaleResolver {
    Locale resolveLocale(HttpServletRequest request);
    void setLocale(HttpServletRequest request, @Nullable HttpServletResponse response, @Nullable Locale locale);
}

LocaleResolver 변경