메시지, 국제화 기능

메시지 기능

 

예를들어 이전 포스팅에서 만든 상품관리 프로젝트에서 상품명 이라는 단어를 모두 상품이름으로 고치고 싶을 때 어떻게 해야할까요?

상품 등록 폼, 편집 폼, 상세 폼 등 여러 템플릿에 하드코딩된 "상품명"을 "상품이름"으로 바꾸는 것은 상당히 귀찮은 작업입니다.

 

스프링에서는 다양한 메시지를 한 곳에서 관리할 수 있도록 하는 메시지 기능을 제공합니다.

 

예를 들어 messages.properties라는 메시지 관리용 파일을 만들고

item = 상품

item.id = 상품 ID

item.itemName = 상품명

item.price = 가격

item.quantity = 수량

 

각 HTML 들에 하드코딩된 데이터들을 th:text="#{item.itemName}"으로 바꾸면 됩니다.

---

국제화 기능

메시지에서 확장된 기능으로 메시지에서 설명한 메시지 파일 (message.properties) 을 각 나라별로 별도로 관리하면 서비스를 국제화 할수 있습니다.

 

예를 들어 영미권에서 사용할 messages_en.properties라는 메시지 파일을 만들고

item=Item

item.id=Item ID

item.itemName=Item Name

item.price=price

item.quantity=quantity

한국에서 사용할 messages_ko.properties라는 메시지 파일을 만드는 것이죠.

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

 

이렇게 하면 사이트를 국제화 할 수 있습니다.

 

한국에서 접근한지 영미권에서 접근한 것인지 인식하는 방법은 HTTP Accept-language 헤더 값을 사용하거나 사용자가 직접 언어를 선택하도록 하고, 쿠키 등을 사용해서 처리하는 방법이 있습니다.

 

메시지, 국제화 기능은 직접 구현도 가능하지만 스프링에서는 이런 기능들을 간편하게 사용할 수 있도록 제공하고 있습니다.

 

---

Spring Boot의 메시지 관리 기능 

메시지 관리 기능을 사용하기 위한 방법은 두 가지 방법이 있습니다.

1) 스프링이 제공하는 MessageSource를 스프링 빈으로 직접 등록하거나

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

MessageSource(interface)의 구현체 ResourceBundleMessageSource(implement)을 스프링 빈으로 등록.

• basename : 설정 파일의 이름 지정. 
  • "messages"로 지정하면 "messages.properties"파일을 읽어서 사용합니다.
  • 추가로 국제와 기능을 사용하려면 "파일이름"뒤에 "_en", "_ko"와 같이 파일명 마지막에 언어 정보를 주면 됩니다.
  • 파일의 위치는 /resources 하위
  • 만약 찾을 수 있는 국제화된 파일이 없으면 언어정보가 없는 파일이름을 사용하게 됩니다.
• defaultEncoding : 인코딩 정보 지정

 

2) 이렇게 수동으로 빈 등록을 하지 않아도 사실 스프링 부트를 사용하면 알아서 MessageSource를 자동으로 스프링 빈으로 등록합니다.

스프링 부트를 사용해서 메시지 기능을 사용하게 될 경우에는 application.properties에 메시지 소스를 설정하면 됩니다.

spring.messages.basename=messages

 

이렇게 별도의 설정을 하지 않으면 messages라는 이름으로 기본 등록됩니다. 따라서 messages_en, messages_ko와 같은 파일만 등록하면 자동으로 인식합니다.

 

 

자 이제 메시지 파일을 만들고 테스트 해보겠습니다.

 

messages.properties

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

 

messages_en.properties

hello=hello
hello.name=hello {0}

 

TestCode

@SpringBootTest
public class MessageSourceTest {
    @Autowired
    MessageSource ms;

    @Test
    void helloMessage()
    {
        String result = ms.getMessage("hello", null, null);
        Assertions.assertThat(result).isEqualTo("안녕");
    }

    @Test
    void notFoundMessageCode()
    {
        Assertions.assertThatThrownBy(
                ()-> ms.getMessage("no_code",null,null)
        ).isInstanceOf(NoSuchMessageException.class);
    }

    @Test
    void notFoundMessageCodeFeDefaultMessage()
    {
        String result = ms.getMessage("no_code", null, "기본 메시지", null);
        Assertions.assertThat(result).isEqualTo("기본 메시지");
    }

    @Test
    void argumentMessage()
    {
        String result = ms.getMessage("hello.name", new Object[]{"Spring"}, null);
        Assertions.assertThat(result).isEqualTo("안녕 Spring");
    }

    @Test
    void defaultLang()
    {
        Assertions.assertThat(ms.getMessage("hello", null, null)).isEqualTo("안녕");
        Assertions.assertThat(ms.getMessage("hello", null, Locale.KOREA)).isEqualTo("안녕");
    }

    @Test
    void enLang() {
        Assertions.assertThat(ms.getMessage("hello", null,
                Locale.ENGLISH)).isEqualTo("hello");
    }

}

 

@Autowired MessageSource ms;

스프링 부트로 자동 빈 등록된 MessageSource ms 에 의존관계 주입

자동 빈 등록 방식 사용 시 ResourceBundleMessageSource를 사용

 

String getMessage(String code, @Nullable Object[] args, @Nullable String defaultMessage, Locale locale);

/**
 * Try to resolve the message. Treat as an error if the message can't be found.
 * @param code the message code to look up, e.g. 'calculator.noRateSet'.
 * MessageSource users are encouraged to base message names on qualified class
 * or package names, avoiding potential conflicts and ensuring maximum clarity.
 * @param args an array of arguments that will be filled in for params within
 * the message (params look like "{0}", "{1,date}", "{2,time}" within a message),
 * or {@code null} if none
 * @param locale the locale in which to do the lookup
 * @return the resolved message (never {@code null})
 * @throws NoSuchMessageException if no corresponding message was found
 * @see #getMessage(MessageSourceResolvable, Locale)
 * @see java.text.MessageFormat
 */
String getMessage(String code, @Nullable Object[] args, Locale locale) throws NoSuchMessageException;

MessageSource 인터페이스는 코드를 포함한 일부 파라미터로 메시지를 읽어오는 기능 제공합니다.

 

getMessage(code, argument, defaultMessage, locale) 

• code : 지정할 메시지 
• argument ( Object로 설정 , Nullable ) : 지정할 메시지 뒤에 합칠 수 있음 

  • 다음 메시지의 {0} 부분은 매개변수를 전달해서 치환할 수 있습니다.

    hello.name=안녕 {0} ▶︎ Spring 단어를 매개변수로 전달 ▶︎ 안녕 Spring

• defaultMessage : code 에서 지정한 메시지가 존재하지 않으면 사용할 기본 값 메시지 설정 
• locale : 지정한 locale이 없으면 기본 설정파일(basename)에서 설정한 기본 이름 메시지 파일 조회

---

애플리케이션에 적용

messages.properties

label.item=상품!
label.item.id=상품 ID!
label.item.itemName=상품명!
label.item.price=가격!
label.item.quantity=개수!

page.items=상품 목록!
page.item=상품 상세!
page.addItem=상품 등록!
page.updateItem=상품 수정!
page.save = 저장 완료!

button.save=저장!
button.cancel=취소!

 

messages_en.properties

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

page.items=Item List
page.item=Item Detail
page.addItem=Item Add
page.updateItem=Item Update
page.save = Item Saved.

button.save=Save
button.cancel=Cancel

 

 

<form action="item.html" th:action th:object="${item}" method="post">

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

<div class="col">
    <button class="w-100 btn btn-primary btn-lg"
            th:text="#{page.updateItem}"
            onclick="location.href='editForm.html'"
            th:onclick="|location.href='@{/message/items/{itemId}/edit(itemId=${item.id})}'|"
            type="button">상품 수정</button>
</div>

• th:text를 #{...}로 지정하면 됩니다.

뷰 템플릿에 적용

messages.properties 사용

 

messages_en.properties 사용

영미권으로 Accept-locale 설정하는 방법 (Chrome 기준)

설정 - 언어에서 다음과 같이 변경하면 됩니다.

 

스프링은 언어 선택시 기본으로 Accept-Language 헤더의 값을 사용합니다. 

설정에서 기본언어 우선순위를 영어를 최우선으로 지정하면 Accept-Language 헤더가 자동으로 변경됩니다.

 

참고로 스프링은 Locale 선택 방식을 변경할 수 있도록 LocaleResolver라는 인터페이스를 제공, 변경하고 싶으면 LocaleResolver의 구현체를 변경해서 쿠키나 세션 기반의 Locale 선택 기능으로 변경 할 수 있습니다.

 

<참고자료>

 

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의