[MVC] 국제화, 메시지 기능 (+ LocaleResolver)

메시지

상황을 하나 가정해서, 게시판 서비스를 만들었다고 생각하자.

모든 게시판에서 게시판에 달린 글을 "댓글"이라고 표시했다고 생각해보자.

그 상황에서 댓글을 "답글"로 고치라는 명령이 떨어졌다고 생각해보자.

우리는 모든 페이지의 댓글을 찾아 답글로 고쳐야 할 것이다.

화면이 많으면 많을수록 해당 작업은 힘들고, 누락할 가능성도 존재할 것이다.

 

이런 다양한 메시지를 한 곳에서 관리하도록 하는 기능을 메시지 기능이라 한다.

 

예를 들면 다음과 같다.

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

comment=답글
comment.writer=작성자
...

위와같이 작성한 후, 각 HTML(타임리프)들은 다음과 같이 해당 데이터를 key값으로 불러서 사용하는 것이다.

(이는 뷰 템플릿 뿐만 아니라, Rest API의 응답으로도 적용하여 사용할 수 있다)

 

 

 

---

국제화

메시지에서 조금만 더 나아가본다면, 해당 메시지들을 국가별로 관리함으로써 서비스를 국제화 할 수 있다.

예를 들어 댓글을, 영어를 쓰는 나라에서는 comment라고 보여주는 것이다.

이는 다음과 같이 국가별 파일을 만들어서 메시지를 관리함으로써 가능해진다.

 

messages_en.properties

comment=comment
comment.writer=Writer
...

 

 

messages_ko.properties

comment=답글
comment.writer=작성자
...

 

그리고 해당 메시지와 국제화 기능은 스프링에서 기본적으로 모두 제공한다. 

스프링에서 제공하는 메시지와 국제화 기능을 사용하는 법을 알아보자.

 

 

---

 

 

스프링에서 제공하는 메시지 기능

스프링에서 메시지 기능을 사용하려면, 스프링이 제공하는 MessageSource를 스프링 빈으로 등록해야 한다. MessageSource는 인터페이스이고, 구현체인 ResourceBundleMessageSource를 스프링 빈으로 등록해주어야 한다.

 

그러나 스프링부트를 사용한다면 자동으로 등록해주기 때문에, 바로 사용할 수 있다.

 

스프링부트에서 메시지 소스 설정은 다음과 같다.

 

application.properties

spring.messages.basename=messages, config.messages

config.messages는 config 폴더 아래에 위치하는 messages라는 뜻이다.

(default값은 messages이다.)

 

 

 

설정

다음 위치에 추가

 

messages.properties

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

{0}은 파라미터이다. (여러개면, 0,1,2, ...)

 

 

국제화 기능도 적용해보자

Resource Bundle 'messages'는 자동으로 생성해준다.

 

messages_en.properties

hello=hello
hello.name=hello {0}

 

 

 

만약 영어권에서 들어온다면 en을 사용하고, 나머지(en이 아닌 곳)에서 들어와 메시지 소스를 찾을 수 없다면 기본적인 messages.properties를 사용한다.

 

 

---

 

사용 (테스트코드)

@Autowired
MessageSource messageSource;

@Test
public void helloMssage() throws Exception {

    String message = messageSource.getMessage("hello", null, null);
    //메시지 소스 파일들 중에서, hello에 해당하는 것을 찾음, 매개변수는 없고, 국가도 null => 따라서 기본값인 messages.properties가 적용
    assertThat(message).isEqualTo("안녕");



    String messageEn = messageSource.getMessage("hello", null, Locale.ENGLISH);
    //메시지 소스 파일들 중에서, hello에 해당하는 것을 찾음, 매개변수는 없고, 국가는 영어권 => 따라서 messages_en.properties가 적용
    assertThat(messageEn).isEqualTo("hello");



    messageEn = messageSource.getMessage("hello", new Object[]{"신동훈","바보"}, Locale.ENGLISH);
    //메시지 소스 파일들 중에서, hello에 해당하는 것을 찾음, 매개변수는 신동훈, 바보, 국가는 영어권
    // => 따라서 messages_en.properties가 적용, 그러나 hello는 매개변수를 사용하지 않기에 신동훈과 바보는 무시
    assertThat(messageEn).isEqualTo("hello");



    messageEn = messageSource.getMessage("hello.name", new Object[]{"신동훈","바보"}, Locale.ENGLISH);
    assertThat(messageEn).isEqualTo("hello 신동훈");
    //메시지 소스 파일들 중에서, hello.name에 해당하는 것을 찾음, 매개변수는 신동훈, 바보, 국가는 영어권
    // => 따라서 messages_en.properties가 적용, 그러나 hello.name은 매개변수를 단 하나만 사용하므로 바보는 무시



    assertThrows(NoSuchMessageException.class, ()-> messageSource.getMessage("no_match",null,Locale.KOREA));
    //메시지 소스 파일들 중에서, no_match에 해당하는 것을 찾음, 그러나 존재하지 않으므로 NoSuchMessageException 발생


    String noSuchMessage = messageSource.getMessage("no_match", null, "기본 메세지", Locale.KOREA);
    //기본 메시지를 줄 수 있음
    assertThat(noSuchMessage).isEqualTo("기본 메세지");

}

 

 

---

 

 

사용 (예외처리 - ControllerAdvice)

@RestControllerAdvice
public class ExceptionAdvice {

    @Autowired
    MessageSource messageSource;

    @ExceptionHandler(Exception.class)
    public ResponseEntity handleBaseEx(Exception exception, Locale locale){

        String message = messageSource.getMessage(exception.getMessage(), null, locale);
		... 생략
    }


}

이런 식으로 Rest API에서 예외 메시지의 국제화 처리도 할 수 있다.

 

 

 

 

---

 

LocaleResolver

스프링은 Locale 선택 방식을 변경할 수 있도록 LocaleResolver라는 인터페이스를 제공하는데, 스프링 부트는 기본 설정으로 Accept-Language를 활용하여 Locale을 결정하는 AcceptHeaderLocalResolver를 사용한다.

 

만약 우리가 임의로 Locale 선택 방식을 바꾸고 싶다면, 해당 LocaleResolver를 상속받아 구현한 구현체를 스프링 빈으로 등록해주면 된다.

 

 

 

📔 Reference

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