02.ETC

ETC

메시지, 국제화

메시지 기능: 다양한 메시지를 한 곳에서 관리하는 기능

messages.properteis

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

국제화 기능: 메시지 파일을 각 나라별로 별도로 관리하는 국제화 기능

• messages_en.properties 와 같이 파일명 마지막에 언어 정보 추가

• 찾을 수 있는 국제화 파일이 없으면 messages.properties 를 기본으로 사용

messages_en.propertis

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

messages_ko.propertis

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

Spring Message Source

SpringBoot 는 MessageSource 를 자동으로 스프링 빈으로 등록

• Spring 사용 시 구현체인 ResourceBundleMessageSource 를 빈으로 등록

  @Bean
  public MessageSource messageSource() {
      ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
      // messages 지정 시 messages.properties 파일을 읽어서 사용
      messageSource.setBasenames("messages", "errors");
      messageSource.setDefaultEncoding("utf-8");
      return messageSource;
  }

SpringBoot Message Source 설정

application.properties

spring.messages.basename=messages,config.i18n.messages

• 스프링 부트 메시지 소스 기본 값: spring.messages.basename=messages

• MessageSource 를 스프링 빈 등록하지 않고, 스프링 부트 관련 설정을 하지 않으면 messages 라는 이름으로 기본 등록

• 따라서 messages.properties, messages_en.properties .. 파일만 등록하면 자동으로 인식

• 추가 옵션은 Spring-Boot Docs 참고
• /resources/messages.properties 경로에 Message 파일 저장

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

Message Source 사용

• SpringBoot 는 MessageSource 를 자동으로 Spring Bean 으로 등록하므로 바로 사용 가능

• MessageSource 는 message.properties 파일 정보를 가지고 있음

@Autowired
MessageSource ms;

@Test
void helloMessage() {
    // locale 정보가 없으면 basename 에서 설정한 기본 이름 메시지 파일(messages.properties) 조회
    String result = ms.getMessage("hello", null, null);
    assertThat(result).isEqualTo("안녕");
}

@Test
void notFoundMessageCode() {
    // 메시지가 없는 경우 NoSuchMessageException 발생
    assertThatThrownBy(() -> ms.getMessage("no_code", null, null))
            .isInstanceOf(NoSuchMessageException.class);
}
@Test
void notFoundMessageCodeDefaultMessage() {
    // 메시지가 없어도 defaultMessage 를 사용하면 기본 메시지 반환
    String result = ms.getMessage("no_code", null, "기본 메시지", null);
    assertThat(result).isEqualTo("기본 메시지");
}

@Test
void argumentMessage() {
    // 메시지의 {0} 부분은 매개변수를 전달해서 치환
    String result = ms.getMessage("hello.name", new Object[]{"Aaron"}, null);
    assertThat(result).isEqualTo("안녕 Aaron");
}

Message Source 국제화 사용

• locale 정보 기반으로 국제화 파일 선택

• Locale 이 en_US 일 경우 messages_en_US ➜ messages_en ➜ messages(default) 순서 탐색

@Test
void defaultLang() {
    // locale 정보가 없으므로 messages 사용
    assertThat(ms.getMessage("hello", null, null)).isEqualTo("안녕");
    // locale 정보가 있지만, message_ko 가 없으므로 messages 사용
    assertThat(ms.getMessage("hello", null, Locale.KOREA)).isEqualTo("안녕");
}

@Test
void enLang() {
    // locale 정보가 Locale.ENGLISH 이므로 messages_en 사용
    assertThat(ms.getMessage("hello", null, Locale.ENGLISH)).isEqualTo("hello");
}

Web Application Message

메시지 적용

• 타임리프의 메시지 표현식 #{...} 를 사용하면 스프링 메시지를 편리하게 조회 가능

  • messages.properties

    label.item=상품
    hello.name=안녕 {0}

  • Thymeleaf

    <div th:text="#{label.item}"></h2>
    <p th:text="#{hello.name(${item.itemName})}"></p>

국제화 적용

• 웹 브라우저의 언어 설정 값이 변하면 요청시 Accept-Language 의 값이 변경되고, 이 정보를 Spring 은 Locale 로 인식해 자동으로 국제화 처리

• LocaleResolver

  • Spring 은 Locale 선택 방식을 변경할 수 있도록 LocaleResolver 인터페이스 제공

  • Spring Boot 는 언어 선택 시 기본적으로 Accept-Language 헤더값을 활용하는 AcceptHeaderLocaleResolver 사용

  • Locale 선택 방식을 변경하려면 LocaleResolver 구현체를 변경해서 쿠키나 세션 기반의 Locale 선택 기능 사용

---

Spring Type Converter

스프링 타입 변환 적용 예

• HTTP Query String 으로 전달되는 데이터는 모두 String Type 이지만, 스프링은 타입을 변환해 제공

  • @RequestParam

  • @ModelAttribute

  • @PathVariable

  • @Value

  • XML Spring Bean 정보 변환

  • View Rendering

  • ...

  // @RequestParam
  @GetMapping("/hello")
  public String hello(@RequestParam Integer data) {}
  
  // @ModelAttribute
  @GetMapping("/hello")
  public String hello(@ModelAttribute UserData data) {}
  
  class UserData {
      Integer data;
  }
  
  // @PathVariable
  @GetMapping("/users/{userId}")
  public String hello(@PathVariable("data") Integer data) {}
  
  // @Value
  @Value("${api.key}")
  private String key;

Type Converter

Converter Interface

스프링에 사용자 정의 타입 변환이 필요하면 컨버터 인터페이스를 구현해서 등록해 보자.

package org.springframework.core.convert.converter;

public interface Converter<S, T> {
    T convert(S source);
}

ex. 컨버터 인터페이스 구현

public class StringToIntegerConverter implements Converter<String, Integer> {
    @Override
    public Integer convert(String source) {
        return Integer.valueOf(source);
    }
}

...

@Test
void stringToInteger() {
    StringToIntegerConverter converter = new StringToIntegerConverter();
    Integer result = converter.convert("10");
    assertThat(result).isEqualTo(10);
}

• 스프링은 용도에 따라 다양한 방식의 타입 컨버터 제공

  • Converter : 기본 타입 컨버터

  • ConverterFactory : 전체 클래스 계층 구조가 필요할 경우

  • GenericConverter : 정교한 구현, 대상 필드의 애노테이션 정보 사용 가능

  • ConditionalGenericConverter : 특정 조건이 참인 경우에만 실행

  • 그밖에 문자, 숫자, boolean, Enum 등 일반적인 타입에 대한 대부분의 컨버터를 기본으로 제공

Spring Type Conversion

ConversionService

개별 컨버터를 모아두고, 그것들을 묶어서 편리하게 사용할 수 있는 기능

• 스프링은 @RequestParam 같은 곳 내부에서 ConversionService 를 사용해서 타입을 변환

ConversionService interface

• Converting 가능 여부와 기능 제공

package org.springframework.core.convert;

import org.springframework.lang.Nullable;

public interface ConversionService {

    boolean canConvert(@Nullable Class<?> sourceType, Class<?> targetType);

    boolean canConvert(@Nullable TypeDescriptor sourceType, TypeDescriptor targetType);

    @Nullable
    <T> T convert(@Nullable Object source, Class<T> targetType);

    @Nullable
    Object convert(@Nullable Object source, @Nullable TypeDescriptor sourceType, TypeDescriptor targetType);

}

DefaultConversionService

• ConversionService 인터페이스의 구현체(컨버터를 등록하는 기능도 제공)

• 사용 초점의 ConversionService 와 등록 초점의 ConverterRegistry 로 분리되어 구현

  • 인터페이스 분리 원칙 적용(ISP-Interface Segregation Principal)

  • 인터페이스 분리를 통해 컨버터를 사용하는 클라이언트와 컨버터를 등록하고 관리하는 클라이언트의 관심사를 명확하게 분리

.

• 타입 컨버터들은 컨버전 서비스 내부에 숨어서 제공되므로, 클라이언트는 타입 컨버터를 몰라도 무관

• 타입 변환을 원하는 클라이언트의 경우 컨버전 서비스 인터페이스에만 의존

  • 컨버전 서비스를 등록하는 부분과 사용하는 부분을 분리하고 의존관계 주입을 사용

@Test
void conversionService() {
    // Converter 등록
    DefaultConversionService conversionService = new DefaultConversionService();
    conversionService.addConverter(new StringToIntegerConverter());
    conversionService.addConverter(new IntegerToStringConverter());

    // ConverterService 사용
    assertThat(conversionService.convert("10", Integer.class)).isEqualTo(10);
    assertThat(conversionService.convert(10, String.class)).isEqualTo("10");
}

Apply Converter in Spring 🌞

• 스프링은 내부에서 ConversionService 제공

• WebMvcConfigurer 가 제공하는 addFormatters() 를 사용해서 컨버터 등록

• @RequestParam 의 경우 RequestParamMethodArgumentResolver 에서 ConversionService 를 사용해서 타입을 변환

WebConfig.java

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new StringToIntegerConverter());
        registry.addConverter(new IntegerToStringConverter());
    }
}

...

@GetMapping("/hello-v2")
public String helloV2(@RequestParam Integer data) {
    return "ok";
}

Apply Converter in View Template

타임리프는 렌더링 시 컨버터를 적용해서 렌더링 하는 방법을 편리하게 지원

View Template

Controller.java

@GetMapping("/view")
public String converterView(Model model) {
    model.addAttribute("number", 10000);
    return "view";
}

view.html

• 변수 표현식 : ${...}

• 컨버전 서비스 적용 : ${{...}}

<li>${number}: <span th:text="${number}" ></span></li>
<li>${{number}}: <span th:text="${{number}}" ></span></li>

Form

Controller.java

• @ModelAttribute 내부에서 ConversionService 동작

@GetMapping("/converter/edit")
public String converterForm(Model model) {
    IpPort ipPort = new IpPort("127.0.0.1", 8080);
    Form form = new Form(ipPort);
    model.addAttribute("form", form);
    return "form";
}

@PostMapping("/converter/edit")
public String converterEdit(@ModelAttribute Form form, Model model) {
    IpPort ipPort = form.getIpPort();
    model.addAttribute("ipPort", ipPort);
    return "view";
}

form.html

• th:field 는 Converter 까지 자동 적용

• th:value 는 보여주는 용도

<form th:object="${form}" th:method="post">
  th:field <input type="text" th:field="*{ipPort}" /><br />
  th:value <input type="text" th:value="*{ipPort}" /><br />
  <input type="submit" />
</form>

Formatter

객체를 특정한 포멧에 맞추어 문자로 출력하거나, 그 반대의 역할을 하는 것에 특화된 기능

• Converter: 범용(객체 ➜ 객체)에 사용

• Formatter: 문자(객체 ➜ 문자, 문자 ➜ 객체, 현지화)에 특화

  • 특별한 Converter..

Formatter Interface

public interface Printer<T> { // 객체 ➜ 문자
    String print(T object, Locale locale);
}

public interface Parser<T> { // 문자 ➜ 객체
    T parse(String text, Locale locale) throws ParseException;
}

public interface Formatter<T> extends Printer<T>, Parser<T> {
}

implements Formatter

public class NumberFormatter implements Formatter<Number> {

    @Override
    public Number parse(String text, Locale locale) throws ParseException {
        NumberFormat format = NumberFormat.getInstance(locale);
        return format.parse(text);
    }

    @Override
    public String print(Number object, Locale locale) {
        return NumberFormat.getInstance(locale).format(object);
    }
}

...

class MyNumberFormatterTest {

    MyNumberFormatter formatter = new MyNumberFormatter();

    @Test
    void parse() throws ParseException {
        Number result = formatter.parse("1,000", Locale.KOREA);
        assertThat(result).isEqualTo(1000L);
    }

    @Test
    void print() {
        String result = formatter.print(1000, Locale.KOREA);
        assertThat(result).isEqualTo("1,000");
    }
}

스프링은 용도에 따라 다양한 방식의 포맷터 제공

• AnnotationFormatterFactory: 필드의 타입이나 애노테이션 정보를 활용할 수 있는 포맷터

• Spring Field Formatting

FormattingConversionService

• ConverstionService 에는 컨버터만 등록 가능하고, 포맷터는 등록 불가

• 포맷터 등록을 지원하는 FormattingConversionService 를 사용하여 포맷터를 추가해 보자.

  • 내부에서 어댑터 패턴을 사용해서 Formatter 가 Converter 처럼 동작하도록 지원

• DefaultFormattingConversionService 는 FormattingConversionService 를 상속받아 기본적인 통화, 숫자 관련 기본 포맷터를 추가 제공

  • ConversionService 관련 기능을 상속받으므로 Converter, Formatter 모두 등록 가능

• 스프링 부트는 DefaultFormattingConversionService 를 상속 받은 WebConversionService 를 내부에서 사용

DefaultFormattingConversionService conversionService = new DefaultFormattingConversionService();

// 컨버터 등록
conversionService.addConverter(new StringToIpPortConverter());
conversionService.addConverter(new IpPortToStringConverter());

// 포맷터 등록
conversionService.addFormatter(new MyNumberFormatter());

// 컨버터 사용
IpPort ipPort = conversionService.convert("127.0.0.1:8080", IpPort.class);
assertThat(ipPort).isEqualTo(new IpPort("127.0.0.1", 8080));

// 포맷터 사용
assertThat(conversionService.convert(1000, String.class)).isEqualTo("1,000");
assertThat(conversionService.convert("1,000", Long.class)).isEqualTo(1000L);

Apply Formatter in Spring 🌞

• 기능이 겹칠 경우(Source-type, Target-type 동일) Converter 우선

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new StringToIpPortConverter());
        registry.addConverter(new IpPortToStringConverter());

        registry.addFormatter(new MyNumberFormatter());
    }
}

Annotation driven Formatting

• 스프링은 자바에서 기본으로 제공하는 타입들에 대해 수많은 포맷터를 기본으로 제공

• 객체의 각 필드마다 다른 형식의 포맷을 지정하는 어려움을 해결하기 위해 애노테이션 기반 형식 지정 포맷터 제공

  • @NumberFormat : 숫자 관련 형식 지정 포맷터 사용

    • NumberFormatAnnotationFormatterFactory

  • @DateTimeFormat : 날짜 관련 형식 지정 포맷터 사용

    • Jsr310DateTimeFormatAnnotationFormatterFactory

  @Getter
  @Setter
  static class Form {
      @NumberFormat(pattern = "###,###")
      private Integer number;
  
      @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
      private LocalDateTime localDateTime;
  }

Annotation-driven Formatting

참고,

HttpMessageConverter 에는 Convetion Service 가 적용되지 않음

JSON 을 객체로 변환하는 HttpMessageConverter 는 내부에서 Jackson 같은 라이브러리를 사용

따라서, JSON 결과로 만들어지는 숫자나 날짜 포맷을 변경하고 싶으면 해당 라이브러리가 제공하는 설정을 통해서 포맷을 지정

File Upload

전송 방식

기본적인 HTML Form 전송 방식

• application/x-www-form-urlencoded

• HTML Form

  <form action="/save" method="post">
    <inpout type="text" name="username" />
    <inpout type="text" name="age" />
    <button type="submit">전송</button>
  </form>

• HTTP Message

  HTTP/1.1 200 OK
  
  POST /save HTTP/1.1
  Host: localhost:8080
  Content-Type: application/x-www-form-urlencoded
  
  username=kim&age=20

Form 내용과 여러 파일을 함께 전송하는 HTML Form 전송 방식

• multipart/form-data

• HTML Form

  • form tag 에 enctype="multipart/form-data" 지정

  <form action="/save" method="post" enctype="multipart/form-data">
    <inpout type="text" name="username" />
    <inpout type="text" name="age" />
    <inpout type="file" name="file1" />
    <button type="submit">전송</button>
  </form>

• HTTP Message

  • 각각의 전송 항목이 구분

  • Content-Disposition 라는 항목별 헤더와 부가 정보가 분리

  HTTP/1.1 200 OK
  
  POST /save HTTP/1.1
  Host: localhost:8080
  Content-Type: multipart/form-data; boundary=----XXX
  Content-Length: 10457
  
  ----XXX
  Content-Disposition: form-data; name="username"
  
  Kim
  ----XXX
  Content-Disposition: form-data; name="age"
  
  20
  ----XXX
  Content-Disposition: form-data; name="file1"; filename="sample.jpg"
  Content-Type: image/png
  
  102941as9d86f7aa9807sd6fas987df6...
  ----XXX--

HTTP 메시지 참고

Servlet File Upload

Multipart 관련 설정

# HTTP 요청 메시지 확인
logging.level.org.apache.coyote.http11=debug

# 파일 업로드 경로 설정
file.dir=C:/Users/Aaron/file/

# 업로드 사이즈 제한 (사이즈 초과 시 SizeLimitExceededException 예외 발생)
# max-file-size : 파일 하나 사이즈 (default > 1MB)
# max-request-size : 여러 파일 요청의 경우 전체 사이즈 (default > 10MB)
spring.servlet.multipart.max-file-size=1MB
spring.servlet.multipart.max-request-size=10MB

# Multipart 데이처 처리 여부 (default > true)
spring.servlet.multipart.enabled=true

• multipart.enabled 옵션이 켜져 있다면, Spring DispatcherServlet 에서 MultipartResolver 실행

• multipart 요청인 경우 Servlet Container 가 전달하는 HttpServletRequest 를 MultipartHttpServletRequest 로 변환해서 반환

• Spring 이 제공하는 기본 MultipartResolver 는 MultipartHttpServletRequest Interface 를 구현한 StandardMultipartHttpServletRequest 를 반환

ServletUploadController.java

@Slf4j
@Controller
@RequestMapping("/servlet/")
public class ServletUploadControllerV2 {

    /**
     * properties 설정 값 주입
     */
    @Value("${file.dir}")
    private String fileDir;

    @GetMapping("/upload")
    public String newFile() {
        return "upload-form";
    }

    @PostMapping("/upload")
    public String saveFile(HttpServletRequest request) throws ServletException, IOException {
        log.info("request={}", request);

        String itemName = request.getParameter("itemName");
        log.info("itemName={}", itemName);

        /**
         * Multipart 형식은 전송 데이터를 각 Part 로 나누어 전송
         */
        Collection<Part> parts = request.getParts();
        log.info("parts={}", parts);

        for (Part part : parts) {
            log.info("==== PART ====");
            log.info("name={}", part.getName());
            Collection<String> headerNames = part.getHeaderNames();
            for (String headerName : headerNames) {
                log.info("header {}: {}", headerName, part.getHeader(headerName));
            }

            /*
             *편의 메서드
             */
            //Content-Disposition: form-data; name="file"; filename="image.png"
            //Content-Type: image/png
            log.info("submittedFileName={}", part.getSubmittedFileName()); // 클라이언트가 전달한 파일명
            log.info("size={}", part.getSize()); //part body size

            //데이터 읽기
            InputStream inputStream = part.getInputStream(); // Part의 전송 데이터 읽기
            String body = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
            log.info("body={}", body);

            //파일에 저장하기
            if (StringUtils.hasText(part.getSubmittedFileName())) {
                String fullPath = fileDir + part.getSubmittedFileName();
                log.info("파일 저장 fullPath={}", fullPath);
                part.write(fullPath); // Part를 통해 전송된 데이터를 저장
            }
        }

        return "upload-form";
    }
}

request=org.springframework.web.multipart.support.StandardMultipartHttpServletRequest@2b82974a
itemName=Spring
parts=[org.apache.catalina.core.ApplicationPart@367a8c9f, org.apache.catalina.core.ApplicationPart@33180a33]
==== PART ====
name=itemName
header content-disposition: form-data; name="itemName"
submittedFileName=null
size=6
body=Spring
==== PART ====
name=file
header content-disposition: form-data; name="file"; filename="image.png"
header content-type: image/png
submittedFileName=image.png
size=191492
body=�PNG
...
...

Spring File Upload 🌞

• 스프링은 MultipartFile Interface 로 Multipart File 을 매우 편리하게 지원

@PostMapping("/upload")
public String saveFile(@RequestParam String itemName,
                        @RequestParam MultipartFile file, HttpServletRequest request) throws IOException {

    if (!file.isEmpty()) {
        String fullPath = fileDir + file.getOriginalFilename(); //업로드 파일 명
        log.info("파일 저장 fullPath={}", fullPath);
        file.transferTo(new File(fullPath)); //파일 저장
    }

    return "upload-form";
}

File Upload And Download

예제로 구현하는 파일 업로드, 다운로드 (1)

예제로 구현하는 파일 업로드, 다운로드 (2)