Spring 메시지, 국제화 기능

메시지와 국제화 기능은 스프링 MVC만 사용해서 [MessageSource 스프링 빈]을 직접 구현해도 되지만, 스프링과 티임리프에서 제공하는 국제화와 메시지 기능을 사용하면 상당히 편리하다.

/* messageSource 인터페이스를 이용해서 스프링의 메시지 기능을 사용할 수 있다. */

@Bean // 스프링부트를 사용하면 따로 등록하지 않아도 자동으로 등록되어있다.
public MessageSource messageSource() {
	ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
	messageSource.setBasenames("messages", "errors");
	messageSource.setDefaultEncoding("utf-8");
	return messageSource;
}

MessageSource 객체 설정 방법, 스프링부트를 사용하면 알아서 해준다.

// application.properties
spring.messages.basename=messages // messageSource 객체의 빈 이름. 기본값임

 

application.properties 옵션값 알아보기 (Spring Boot 2.5.4)

Common Application Properties

 

---

# 메시지 기능이란

HTML 뷰에 적혀있는 '상품명' 이라는 글자를 전부 '상품이름'으로 바꾸려고 하면 어떻게 해야할까?

이런 이름들을 Message라고 부르고, 다양한 Message들을 하나로 관리하는 기능을 메시지 기능이라고 한다.

 

예를 들어 message.properteis라는 파일을 만들고 아래와 같이 메시지를 관리할 수 있다.

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

 

---

# 국제화 기능이란

HTTP의 accpet=language 헤더값등으로 사용자의 언어 지역(Locale)을 알아내서 언어별로 메시지 파일(.properteis)을 다르게 적용시키는 기능이다.

사용자의 언어를 파악해서 메시지 설정파일을 적절하게 변경하는 기능

 

---

# 스프링, 타임리프에 메시지 적용하기

스프링은 아래와 같은 기본으로 메시지 이름(messages) 설정 값을 가지고 있다.

• resources/ 안에 있는 messages.properties, messages_ko.properties 등을 자동으로 인식한다.

// application.properties
spring.messages.basename=messages // messageSource 객체의 빈 이름. 기본값임

messages 라는 빈을 등록했다면 아래와 같은 파일을 자동으로 인식한다.

- messages_en.properties
- messages_ko.properties
- messages_국가코드.properties
- messages.properties (default 메시지 설정값)

 

• message.properties를 아래와 같이 수정해보자.

# message.properties
hello=안녕
hello.name=안녕 {0}

 

• 스프링에서는 MessageSource 인터페이스에 스프링 빈을 주입받아 사용할 수 있다.

@SpringBootTest
public class MessageSourceTest {

  @Autowired
  MessageSource ms;

  @Test
  @DisplayName("hello 프로퍼티에는 [안녕] 값이 들어있다.")
  void helloMessage() {
    String result = ms.getMessage("hello", null, null);
    assertThat(result).isEqualTo("안녕");
  }

  @Test
  @DisplayName("프로퍼티가 없는 경우 NoSuchMessageException을 발생시킨다.")
  void notFoundMessageCode() {
    assertThatThrownBy(() -> ms.getMessage("no_code", null, null))
        .isInstanceOf(NoSuchMessageException.class);
  }

  @Test
  @DisplayName("ms.getMessage()를 사용하면 프로퍼티가 없는 경우 기본값을 지정해줄 수 있다.")
  void notFoundMessageCodeDefaultMessage() {
    String result = ms.getMessage("no_code", null, "기본 메시지", null);
    assertThat(result).isEqualTo("기본 메시지");
  }

  @Test
  @DisplayName("메시지 파라메타는 Object[]로 줄 수 있다.")
  void argumentMessage() {
    String message = ms.getMessage("hello.name", new Object[]{"Spring"}, null);
    assertThat(message).isEqualTo("안녕 Spring");
  }
  
  @Test
  @DisplayName("지역(Locale)값에 따라 다른 메시지 프로퍼티를 사용한다.")
  void enLang() {
    assertThat(ms.getMessage("hello", null, Locale.ENGLISH)).isEqualTo("hello");
  }


  @Test
  @DisplayName("해당 지역(Locale)이 없거나 null을 주면 기본 메시지 프로퍼티를 사용한다.")
  void defaultLang() {
    assertThat(ms.getMessage("hello", null, null)).isEqualTo("안녕");
    assertThat(ms.getMessage("hello", null, Locale.KOREA)).isEqualTo("안녕");
  }
}

 

• 타임리프에서는 #{hello} #{hello.name('파라메타')} #{ hello.name(${name}) } 으로 사용한다.

실제 타임리프에서 메시지 사용 예제 살펴보기

# resources/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=상품 수정

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

  <div>
    <label for="itemId" th:text="#{label.item.id}">상품 ID</label>
    <input class="form-control" id="itemId" name="itemId" readonly th:value="${item.id}"
           type="text" value="1">
  </div>
  <div>
    <label for="itemName" th:text="#{label.item.itemName}">상품명</label>
    <input class="form-control" id="itemName" name="itemName" readonly th:value="${item.itemName}"
           type="text" value="상품A">
  </div>
  <div>
    <label for="price" th:text="#{label.item.price}">가격</label>
    <input class="form-control" id="price" name="price" readonly th:value="${item.price}"
           type="text" value="10000">
  </div>
  <div>
    <label for="quantity" th:text="#{label.item.quantity}">수량</label>
    <input class="form-control" id="quantity" name="quantity" readonly th:value="${item.quantity}"
           type="text" value="10">
  </div>

 

 

---

# 스프링, 타임리프에 국제화 적용하기

스프링을 사용하면 그냥 message_en.properties를 추가로 작성해주면 영어 국제화가 적용된다. 👍

 

• 이는 스프링에 LocaleResolver라는 인터페이스가 존재하기 때문이다.
• 스프링 부트에서는 LocaleResolver = new AcceptHeaderLocaleResolver() 를 기본으로 사용한다.
   이는 HTTP의 Accept-Language 헤더값을 읽어서 Locale을 설정하는 객체이다.

즉, 다른방식으로 사용자의 언어를 파악하고 싶다면 LocaleResolver를 변경해주면 된다. 웹브라우저의 헤더를 사용하지 않고 사용자의 Locale 정보를 쿠키, 세션에 보관해서 사용하기도 한다.

물론 쿠키, 세션을 이용하는 LocaleResolver 구현체도 이미 스프링에서 제공해주고 있다.

여담으로 스프링에서는 Internationalization 를 [i ~18글자 ~n] 이라는 의미로 i18n 패키지를 사용한다.