[Spring] MessageSource를 이용한 국제화 exception 적용하기

 

 

프로젝트를 하면서 예외처리를 할 때 국제화 적용을 해보았다.

 

🌱 i18n 개념

i18n이란 internationalization(i와 n사이 18글자)을 줄인 것으로 한국어로 번역하면 '국제화'라는 뜻이다. 
국제화는 문화, 지역, 언어가 다양한 대상 고객을 위해 쉽게 현지화될 수 있는 제품, 애플리케이션 또는 문서 콘텐츠를 설계하고 개발하는 것이다!

 

 

⚙️ build.gradle 에 의존성 추가

나는 yml파일을 통해 메시지를 관리할 것이기 때문에 의존성을 추가해줬다! properties로 할 거면 추가 안 해도 될 것 같다!

implementation 'net.rakugakibox.util:yaml-resource-bundle:1.1'

 

 

⚙️ application.yml에 메시지 경로 설정 및 설정 파일

spring:
  messages:
    basename: i18n/messages
    encoding: UTF-8

 

 

해당 예외 메시지 경로는 이렇게 지정했다! 현재는 한국어와 영어만 관리할 것이기 때문에 messages_ko.yml , messages_en.yml 두 개만 정의했다!

 

 

안에 내부는 아래와 같은 형식으로 정의했다.

successResult:
  code: "200"
  msg: "Success."


successResult:
    code: "200"
    msg: "성공하였습니다."

 

 

⚙️ MessageConfiguration 설정

@Configuration
public class MessageConfiguration implements WebMvcConfigurer {

    @Bean //세션에 지역 설정. default는 KOREAN = 'ko'
    public SessionLocaleResolver localResolver() {
        SessionLocaleResolver slr = new SessionLocaleResolver();
        slr.setDefaultLocale(Locale.KOREAN);
        return slr;
    }

    @Bean //지역 설정을 변경하는 인터셉터. 요청시 파라미터 Lang 정보를 저장하면 언어가 변경됨
    public LocaleChangeInterceptor localeChangeInterceptor() {
        LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
        lci.setParamName("lang");
        return lci;
    }

    @Override //인터셉터를 시스템 레지스트리에 등록
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(localeChangeInterceptor());
    }

    @Bean // yml 파일을 참조하는 MessageSource 선언
    public MessageSource messageSource(
            @Value("${spring.messages.basename}") String basename,
            @Value("${spring.messages.encoding}") String encoding
    ) {
        YamlMessageSource ms = new YamlMessageSource();
        ms.setBasename(basename);
        ms.setDefaultEncoding(encoding);
        ms.setAlwaysUseMessageFormat(true);
        ms.setUseCodeAsDefaultMessage(true);
        ms.setFallbackToSystemLocale(true);
        return ms;
    }

    // locale 정보에 따라 다른 yml 파일을 읽도록 처리
    private static class YamlMessageSource extends ResourceBundleMessageSource {
        @Override
        protected ResourceBundle doGetBundle(String basename, Locale locale) throws MissingResourceException {
            return ResourceBundle.getBundle(basename, locale, YamlResourceBundle.Control.INSTANCE);
        }
    }

}

 

 

위의 파일을 생성하고 해당 메시지를 사용할 때 나는 아래와 같이 사용했다!!

    private void setSuccessResult(CommonResult result) {
        result.setCode(Integer.parseInt(messageSource.getMessage("successResult.code", null, LocaleContextHolder.getLocale())));
        result.setMsg(messageSource.getMessage("successResult.msg", null, LocaleContextHolder.getLocale()));
    }

 

messageSource를 이용해서 값을 세팅해 주면 된다 :)

 

🫧 결과

 

포스트맨으로 테스트해 봤는데 성공적으로 잘 나오는 것 같다 ㅎㅎ 

 

 

reference

https://javaengine.tistory.com/entry/SpringBoot2%EB%A1%9C-Rest-api-%EB%A7%8C%EB%93%A4%EA%B8%B07-%E2%80%93-MessageSource%EB%A5%BC-%EC%9D%B4%EC%9A%A9%ED%95%9C-Exception-%EC%B2%98%EB%A6%AC