메시지 & 국제화 (Message & Internationalization)

📂 스프링/기본 개념

메시지 & 국제화 (Message & Internationalization)

Amenable 2023. 4. 25. 00:22

1. 개념 🍓

1. 메시지 (Message)

화면에 보이는 '상품명'이라는 단어를 '상품이름'으로 바꾸고 싶을 경우 어떻게 해야 할까? 간단하게는 item.html에서 해당 단어를 바꾸면 된다.

하지만 상품명이라는 단어가 item.html, addItem.html, updateItem.html, deleteItem.html, ... 에서 사용되고 있다면 모든 파일을 고쳐야 한다는 문제가 있다.

이렇게 HTML 파일에 메시지를 하드코딩되어 있도록 하는 게 아니라, 메시지를 한 곳에서 관리하도록 할 수 있는데 이것이 바로 메시지 기능이다.

2. 국제화 (Internationalization)

한국어를 사용하는 사람에게는 '상품명', 영어를 사용하는 사람에게는 'Item Name'으로 보여주고자 한다. 이를 가능하게 하는 것이 국제화 기능이다.

2. 메시지 소스 설정 🍉

메시지와 국제화는 /resources/messages.properties에 있는 내용을 읽음으로써 동작한다. (물론 messsages.properties가 아닌 다른 파일을 읽을 수도 있다.) messages.properties를 읽을 수 있도록 설정하는 방법으로는 직접 등록(스프링 빈)과 자동 등록(스프링 부트)이 있다.

1. 직접 등록 (스프링 빈)

스프링이 제공하는 MessageSource를 스프링 빈으로 등록하여 메시지 기능을 사용할 수 있다.

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

MessageSourc는 인터페이스이므로 ResourceBundleMessageSource라는 구현체를 이용해야 한다.

basename
값으로 messages로 지정하면 messages.properties, messages_ko.properties, messages_en.properties 등을 읽을 수 있다.
이때 주의할 점은 이름에 '.'을 넣지 않도록 하자. '.'을 path구분자로 변환하기 때문이다. (ex. error.message)
defaultEncoding
인코딩 정보를 저장한다.

파일의 위치는 /resources/messages.properties이다.

2. 자동 등록 (스프링 부트)

스프링 부트를 사용하면 스프링 부트가 MessageSource를 자동으로 스프링 빈으로 등록한다. 메시지 소스를 application.properties에 아래와 같이 설정할 수 있다.

spring.messages.basename=messages

기본 값이 spring.messages.basename=messages 라서 별도로 설정을 하지 않아도 되긴 한다. 그러나 추가로 메시지 값을 관리하고 싶을 경우에는 다음과 같이 설정을 할 수 있다.

#예시
spring.messages.basename=messages, config.i18n.messages

3. 메시지 파일 설정 🥝

아래와 같이 /resources에 'messages.properties', 'messages_en.properties'을 설정할 수 있다.

# /resources/messages.properties
label.item=상품
label.item.id=상품 ID
label.item.itemName=상품명

page.addItem=상품 등록
page.updateItem=상품 수정

hello.name=안녕 {0}

# /resources/messages_en.properties
label.item=Item
label.item.id=Item ID
label.item.itemName=Item Name

page.addItem=Item Registration
page.updateItem=Item Modification

hello.name=hello {0}

4. 웹 애플리케이션에서 사용하기 (타임리프) 🍇

그리고 'xxx.html'파일을 다음과 같이 설정할 수 있다.

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="utf-8">
    <title>Title</title>
</head>
<body>
    <div th:text="#{label.item}"></div>
    <div th:text="#{label.item.id}"></div>
    <div th:text="#{label.item.itemName}"></div>
    <br>
    <div th:text="#{page.addItem}"></div>
    <div th:text="#{page.updateItem}"></div>
    <br>
    <div th:text="#{hello.name(${userName})}"></div> // 파라미터 사용
</body>
</html>

1. 메시지

위의 HTML을 이용하면 화면에는 메시지 파일(messages.properties)에 있는 값들이 출력된다. (한글이 물음표로 나올 때에는 '[Settings] - [File Encodings] - Default encoding for properties files : UTF-8'로 설정하도록 하자. 이렇게 설정하면 messages.properties가 다시 물음표로 바꾸어 있을 수 있는데 그것도 확인하자.)

맨 처음에 고려했던 것처럼 '상품명'을 '상품이름'이라고 메시지 파일에서 수정해 보자.

# /resources/messages.properties
# '상품명'을 '상품이름'으로 수정
label.item=상품
label.item.id=상품 ID
label.item.itemName=상품이름 #여기를 수정

page.addItem=상품 등록
page.updateItem=상품 수정

hello.name=안녕 {0}

그러면 다음과 같이 '상품명'이 '상품이름'이라고 보이게 된다. 하나씩 바꿔줄 필요가 없다!

2. 국제화

국제화는 Locale 정보를 기반으로 이루어진다. Locale에 맞추어 구체적인 것이 있으면 구체적인 것을 찾고, 없으면 디폴트(messages.properties)를 찾는다.

현재에는 Locale이 ko인데 messages_ko.properties가 없으므로 messages.properties가 사용되고 있다. 그래서 다음과 같이 한글 화면이 출력되는 것이다. (Locale은 개발자도구(F12) → Network → Request Headers → Accept-Language에서 확인이 가능하다.)

만약 Locale이 영어로 들어온다면 messages_en.properties가 사용되어 아래와 같은 영어 화면이 나올 것이다.

영어로 설정하는 방법은 'Chrome 맞춤설정 및 제어 → 언어 → 영어 → 가장 위로 이동'으로 설정하면 된다. 그러면 Accept-Language가 en이 된다.

5. 스프링에서 사용하기 🍍

@SpringBootTest
public class MessageSourceTest {

    @Autowired
    MessageSource ms;

    @Test
    void itemMessage() {
        String result = ms.getMessage("label.item", null, null);
        Assertions.assertThat(result).isEqualTo("상품");
    }
    
    // 파라미터 사용
    @Test
    void argumentMessage() {
        String result = ms.getMessage("hello.name", new Object[]{"Amenable"}, null);
        Assertions.assertThat(result).isEqualTo("안녕 Amenable");
    }
}

해당 글은
김영한 님의 '스프링 MVC 2편 - 백엔드 웹 개발 활용 기술',
H.Kwon 님의 'Spring Boot(Spring) i18n 설정 시 주의사항',
hanker 님의 'Spring boot - 다국어 처리 시 한글 물음표(?)로 나올때'
을 참고하였습니다.