한 번에 끝내는 Spring 완.전.판 초격차 패키지 Online.

Part 3. Spring Web MVC

카테고리 : 한 번에 끝내는 Spring 완.전.판 초격차 패키지 Online.

Part 3. Spring Web MVC

API 설계

어노테이션 기반 설계 - @Controller, @RestController

  • 컨트롤러 클래스
    • MVC 패턴 중 핸들러 메소드를 포함하는 컨트롤러 빈을 만드는 과정
    • @Controller
    • @RestController = @ResponseBody + @Controller
  • 핸들러 메소드 (Handler Method)
    • 스프링 웹서비스가 받는 URI 요청을 컨트롤러 클래스의 특정 메소드에 매핑하는 과정
    • @RequestMapping
    • @GetMapping
    • @PostMapping
    • @PutMapping
    • @DeleteMapping
    • @PatchMapping
  • 자동 에러페이지 제거: server.error.whitelabel.enabled=false
  • 에러 컨트롤러 구현시 implements ErrorController

@Controller
public class BaseController implements ErrorController {

    @GetMapping("/")
    public String root() {
        return "index";
    }

    @RequestMapping("/error")
    public String error() {
        return "error";
    }

}
  • management.endpoints.web.exposure.include=* 같은 경우에는 실제 배포시 성능과 보안 때문에 정리 해주어야 한다.

함수 기반 설계

함수형 프로그래밍

  • 함수형 프로그래밍?
    • 함수형 프로그래밍(函數型 프로그래밍, 영어: functional programming)은 자료 처리를 수학적 함수의 계산으로 취급하고 상태와 가변 데이터를 멀리하는 프로그래밍 패러다임의 하나이다.
    • Functional programming is programming without assignment statements.
      • 함수형 프로그래밍은 대입문 없이 프로그래밍하는 것입니다.
    • 특징
      • 상태가 없다.
      • 대입문이 없다.
      • 부작용(side effect)이 없는 순수 함수
      • 불변성(immutability)
    • 역사: 오래되었다
      • 1930 람다 대수
      • 1954 IPL
      • 1958 LISP
      • 1990 Haskell

함수 기반 설계

  • 함수형 엔드포인트
    • Spring Web 의 엔드포인트를 함수형 스타일로 작성하는 방법 제공
    • WebMvc.fn
    • routing, request handling
    • 불변성을 고려하여 설계되었다.
    • 기존의 DispatcherServlet 위에서 동작
    • 애노테이션 스타일과 함께 사용 가능
  • 주요 키워드
    • HandlerFunction == @RequestMapping
      • 입력: ServerRequest
      • 출력: ServerResponse
    • RouterFunction == @RequestMapping
      • 입력: ServerRequest
      • 출력: Optional
    • HandlerFunction VS RouterFunction
      • HandlerFunction의 결과: data
      • RouterFunction의 결과: data + behavior (ex: url mapping)
    • 기타 세부 키워드
      • RequestPredicates
      • RouterFunctions.route().nest()
      • RouterFunctions.route().before()
      • RouterFunctions.route().after()
      • RouterFunctions.Builder.onError()
      • RouterFunctions.Builder.filter()

Reference

요청, 응답 설계

Handler Methods

  • 핸들러 메소드란
    • Spring Web 에서 사용자의 요청(request)을 받아 응답(response)을 리턴하는 메소드
  • 매핑 정보
    • @RequestMapping
      • name: 뷰 템플릿에서 식별할 때 쓰는 이름
      • value, path: URI
      • method: HTTP method(ex: GET, POST, …)
      • params: 파라미터 검사
      • headers: 헤더 검사
      • consumes: 헤더의 Content-Type 검사
      • produces: 헤더의 Accept 검사
      • img.png
    • @RequestMapping shortcuts
      • @GetMapping
      • @PostMapping
      • @PutMapping
      • @DeleteMapping
      • @PatchMapping
  • 요청
    • 핸들러 메소드가 받을 수 있는 요청들
      • 메소드 파라미터로 적어 넣을 수 있는 타입들
      • ServletRequest, ServletResponse, HttpSession
      • WebRequest, NativeWebRequest
      • @RequestParam, @PathVariable
      • @RequestBody, HttpEntity
      • @ModelAttribute, @SessionAttribute, Model, ModelMap
      • @RequestHeader, @CookieValue
      • Principal, Locale, TimeZone, InputStream, OutputStream, Reader, Writer, ….
      • 많이 있다.
  • 응답
    • 핸들러 메소드가 내보낼 수 있는 응답들
      • 메소드가 리턴할 수 있는 타입들
      • ModelAndView
      • String, View
      • @ModelAttribute, Map, Model
      • @ResponseBody
      • HttpEntity, ResponseEntity
      • HttpHeaders
      • void
      • 등등

Reference

@ControllerAdvice

스프링 부트 기본 에러 응답의 응용

BasicErrorController

  • 스프링 부트의 기본 응답이 마음에 든다면
  • BasicErrorController 를 상속 받아서
    • 특정 메소드만 오버라이드 하거나
    • 특정 핸들러 메소드를 추가하는 식으로 응용
  • BasicErrorController 의 핸들러 메소드
    • BasicErrorController.errorHtml() -> 뷰 응답
    • BasicErrorController.error() -> json body 응답

커스텀 에러 페이지: 기본

  • 간단히 static html 이나 template 파일을 추가해서 커스텀 페이지를 등록하는 법
  • 단일 기본 페이지
    • /resources/static/error.html
    • /resources/public/error.html
    • /resources/template/error.템플릿 확장자
  • html status 별 기본 페이지
    • /resources/static,public,template/error/{http status 번호}.html,템플릿확장자
    • /resources/static,public,template/error/4xx.html,템플릿확장자
    • /resources/static,public,template/error/5xx.html,템플릿확장자

@ExceptionHandler

@ControllerAdvice

  • @ExceptionHandler 를 모아서 글로벌하게 적용할 때 쓰는 애노테이션
  • 종류
    • @ControllerAdvice
    • @RestControllerAdvice
  • 속성
    • value == basePackages
    • basePackages: 적용 범위를 문자열을 이용해 특정 패키지로 지정
    • basePackagesClasses: 적용 범위를 대표 클래스 한개를 이용해 특정 패키지로 지정
      • basePackages 를 type-safe 하게 사용하기 위해 제공하는 옵션
    • assignableTypes: 적용 범위를 특정 클래스에 할당할 수 있는 컨트롤러로 지정
    • annotations: 적용 범위를 특정 애노테이션을 사용한 컨트롤러로 지정
  • ResponseEntityExceptionHandler
    • Spring MVC 에서 내부적으로 발생하는 예외들을 처리하는 클래스
    • API 예외 처리를 담당하는 @ControllerAdvice 클래스에서 상속 받아 사용
    • 커스트마이징을 원하는 특정 메소드 오버라이드

Reference

컨트롤러 테스트

  • @TestConstructor(autowireMode = TestConstructor.AutowireMode.ALL)
    • 어노테션을 붙이면 생성자의 모든 의존성 주입

스프링 부트 테스트

  • @SpringBootTest 기본 구성
    • 일딴 스프링 컨테이너와 스프링 부트 환경을 포함하는 테스트는 이것으로 다 작성가능
    • 통합 테스트를 할 때 적절한 선택
    • 애플리케이션 컨텍스트를 로드하는데 시간이 걸리므로 테스트가 다소 무거운 편
    • @SpringBootTest
      • 포함한 애노테이션: @BootstrapWith + @ExtendWith
        • 흔한 실수: JUnit 5 쓸 때 @ExtendWith(SpringExtension.class) 쓰지 않기
    • @Test
      • JUnit 5 애노테이션
      • 단위 테스트 메소드를 지정
  • @SpringBootTest
    • img.png
    • value, properties: 프로퍼티 설정
    • args: 애플리케이션 실행 시 커맨드라인으로 입력하는 인자(옵션) 설정
    • classes: ApplicationContext 로딩을 위한 설정 클래스를 직접 지정
    • webEnvironment: ApplicationContext 의 웹 환경 설정
      • WebEnvironment.MOCK: mock servlet, embedded server 동작 x
        • @AutoConfigureMockMvc, @AutoConfigureWebTestClient 와 함께 써서 mock test 가능
      • WebEnvironment.RANDOM_PORT: 랜덤 포트, embedded server 동작
      • WebEnvironment.DEFINED_PORT: 포트 지정(server.port), embedded server 동작
      • WebEnvironment.NONE: 웹 환경 구성 안 함, embedded server 동작 x

스프링 부트 테스트: Slice Test

Auto-configured Test (Slice Test)

  • 스프링 애플리케이션에서 내가 필요한 일부분(slice)의 자동 설정만 불러오는 방법
  • @DataCassandraTest
  • @DataJdbcTest
  • @DataJpaTest
  • @DataLdapTest
  • @DataMongoTest
  • @DataNeo4jTest
  • @DataR2dbcTest
  • @DataRedisTest
  • @JdbcTest
  • @JooqTest
  • @JsonTest
  • @RestClientTest
  • @WebFluxTest
  • @WebMvcTest
  • @WebServiceClientTes

스프링 부트 테스트: @WebMvcTest

Spring MVC 컨트롤러 레이어를 슬라이스 테스트할 때 사용

  • MockMvc 빈을 자동 설정하고 테스트에 사용
  • 로드할 컨트롤러 클래스를 지정 가능 (기본 동작: 전체 컨트롤러 로드)

Reference

TDD 방식으로 복습하기

TDD

Test Driven Development (TDD)

  • 테스트 주고 개발 기법
  • 프로그램의 설계와 구현, 사고의 흐름을 테스트 중심으로 생각하는 개발 방법
  • 개발 순서의 변화
    • as-is: 구현한다 -> 테스트한다
    • to-be: 테스트를 만든다 -> 구현한다
  • 주요 키워드: 익스트림 프로그래밍 (XP), 애자일, 폭포수 모델, Test-First Programming

RED - GREEN- REFACTOR

TDD 개발 사이클

  1. RED: (실패하는) 테스트를 짠다. (요구 사항의 명세)
  2. GREEN: 테스트를 성공시킨다.(구현)
  3. REFACTOR: 구현 코드를 고도화(리팩토링)한다.

Given - When - Then

테스트의 구조를 표현하는 방법(a.k.a. 3A, Arrange - Act - Assert)

  • Given (Arrange): 상태(state)의 정의 - 테스트를 수행할 때 전제 조건
  • When (Act): 동작 - 테스트 실행
  • Then (Assert): 검증 - 동작의 결과(actual) vs 예상값(expected)

Reference

비즈니스 로직 구현

@Service 이해

비즈니스 로직을 담당하는 컴포넌트

  • 도메인 모델(데이터)과 컨트롤러 사이에 위치
  • 클래스 네이빙을 반드시 ‘-Service’로 할 필요 없다
    • 하지만 관례적으로 실무에서 즐겨 사용되는 네이밍
  • 구현방식
    • 인터페이스 + 클래스: 정석
      • 인터페이스를 요구사항에 따른 기능 문서(ex: javadoc)로 작성
      • 같은 기능을 하는 다양한 구현체를 작성할 니즈가 예상될 때 적합
    • 클래스
      • 실무에서는 즐겨 사용되기도 하는 방식
      • 인터페이스를 추가로 작성하는 수고를 덜게 된다
      • 컨트롤러 레이어와 결합도는 증가한다

Reference

Validation

  • 사용자 입력값에 있을지 모르는 오류를 처리하려면?
    • 모든 입력단 앞에 방어 코드가 추가된다.
    • 방어 코드는 복잡하고 반복적인 대표적인 boilerplate code(상용구 코드)
  • 애노테이션 기반으로 데이터 검증을 돕는 JSR-303, JSR-380 표준이 도입
    • 검즉 구현과 비즈니스 로직을 분리하고, 비즈니스 로직에 더 집중 가능
    • 간결한 코드 표현, 더 나은 가독성

Validation in Boot

build.gradle 에 spring-boot-starter-validation 의존성 추가

  • Spring Boot 2.3 이전: spring-boot-starter-web 에 기본 포함
  • Spring Boot 2.3 이후: 직접 넣어줘야 한다
  • 사용 패턴
    • @Validated + 메소드 파라미터 검증
      • 메소드 파라미터에 validation annotation 을 직접 사용해서 검증하는 방법
      • 클래스에 @Validated 필요
      • 발생 예외: ConstraintViolationException, 직접 처리해 줘야 하는 예외
      • ConfigurationProperties 클래스에도 적용 가능
    • @Valid + Data Object
      • 검증하려는 데이터 오브젝트에만 검증 로직을 적용할 때
      • @Validated 필요하지 않다
      • 발생 예외: MethodArgumentNotValidException
        • ResponseEntityExceptionHandler 지원을 받을 수 있다

Reference

Spring Boot Properties

  • logging
    • debug
    • trace
    • logging.level.원하는.패키지.이름
    • img.png
  • banner
    • img.png
  • config
    • spring.config.activate.on-profile
    • spring.profiles 가 deprecated 되었으니 주의
    • spring.config.import
    • spring.config.use-legacy-processing
  • main
    • spring.main.banner-mode
    • spring.main.lazy-initialization
  • json
    • img.png
    • img.png
  • web
    • spring.hateoas.use-hal-as-default-json-media-type
    • spring.mvc.converters.preferred-json-mapper
    • spring.mvc.format.date
    • spring.mvc.format.date-time
    • spring.mvc.format.time
    • spring.mvc.view.prefix
    • spring.mvc.view.suffix
  • web (servlet.multipart)
    • img.png
  • server
    • server.error.whitelabel.enabled
    • server.port
    • http encoding, session, ssl, tomcat …
  • 그 밖에
    • security
    • actuator
    • devtools

Reference

비즈니스 로직의 테스트

비즈니스 로직을 테스트하는 방법

  • unit test, solitary test -> 필요로 하는 것들만 사용하거나 mocking, slice test
    • 컨트롤러 입출력의 확인
    • 에러의 검증
    • 비즈니스 로직의 동작
  • integration test, sociable test -> @SpringBootTest
    • 인증 + api 호출
    • api 호출 -> 비즈니스 -> 데이터 접근 -> 응답 까지

Reference

뷰, 뷰 템플릿

타임리프

Thymeleaf 만의 특징, 강점

HTML5 웹 표준을 준수하는 템플릿

  • 전체적인 문법이 HTML5 마크업 표준을 최대한 해치지 않게끔 설계
  • Decoupled logic: 템플릿 문법을 아예 템플릿에서 분리 가능
    • 순수한 마크업만 남음 -> 템플릿 엔진이 작동하지 않아도 렌더링되는 정적 목업 페이지
    • 디자이너가 이해하기 쉬운 코드

Reference

프리마커

FreeMarker

Apache FreeMarker

  • 아파치 재단에서 만든 오픈소스 자바 템플릿 엔진
  • 2000년 릴리즈 발표
  • 2015년 아파치 인큐베이터 등록, 2018년 완전한 아파치 프로젝트가 됨
  • FreeMarker Template Language (FTL) 을 사용

Apache FreeMarker 장점

오랫동안 실무에서 보편적으로 널리 사용된 템플릿 엔진

  • 강력한 템플릿 문법을 지원: 복잡한 동작을 수행 가능
  • 경량: 외부 의존성을 갖지 않는다
  • 국제화 대응 가능
  • XML 처리 가능

FreeMarker + Spring Boot

스프링 부트에서 프리마커 사용하기

  • 스프링 부트 프리마커 의존성 추가
  • 템플릿 파일 작성
    • .ftlh: html 베이스의 템플릿
    • .ftlx: xml 베이스의 템플릿

FreeMarker: 기능

  • Type
    • Scalars: String, Number, Boolean, Date-like
    • Containers: Hash, Sequence, Collection
    • Subroutines: Methods, Functions, User-defined directives
    • Miscellaneous: Node, Markup output
  • Structure
    • text
    • interpolation
    • FTL tag
    • comment
  • Template Syntax
    • Directives: <#directivename parameters>
      • <#list>
      • <#if>
      • <#assign>
    • Expressions
      • built-ins: ${string?builtin}
        • upper_case, html, c, size, cap_first, join(), …
        • default value operator: ${value!”default”}
    • Interpolations: ${expression}

Reference

머스타쉬

Mustache

logic-less templates.

  • 2009년 최초 릴리즈
  • 제어 흐름을 표현하는 문법이 없는 점이 특징
  • list 태그와 람다식을 이용해 조건문이나 반복문을 표현
  • 엄청나게 다양한 언어 지원: ActionScript, C++, Clojure, CoffeeScript, ColdFusion, Common Lisp, Crystal, D, Dart, Delphi, Elixir, Erlang, …..
  • 콧수염을 닮은 중괄호를 많이 사용해서 이름이 이렇게 붙음
  • 모바일과 웹 애플리케이션에서 주로 사용됨

Mustache + Spring Boot

스프링 부트에서 머스타쉬 사용하기

  • 머스타쉬 부트 프리마커 의존성 추가
  • 템플릿 파일 작성

Reference

그루비 템플릿

Groovy Template

그루비 언어로도 템플릿 뷰를 작성할 수 있다

  • 템플릿 언어가 마크업과 완전히 동떨어진 그루비로 작성됨
  • 파일 확장자: .tpl
  • 공식 문서와 스프링 블로그, 유명 사이트 튜토리얼 일부 외에는 참고할 만한 의견이나 글이 별로 없음

Reference

설정과 생산성을 향상시키는 주요 도구들

Rest Repositories

Repository 로부터 REST API 를 자동으로 만들어주는 기술

  • Spring Data REST 를 사용
  • 페이징, 정렬, 리미트 사용 가능
  • QueryDSL Extension 을 함께 사용하면 큰 노력 없이 컬럼별 검색 기능까지 사용 가능

Rest Repositories 와 실무

  • 편리해 보이는데, 실무에서 많이 사용하나요?
    • 많이 사용하지는 않는다.
    • 도메인을 직접 api 에 노출하는 것을 꺼린다.
    • 복잡한 요구사항에 맞춰 api 설계를 하고 싶은 경우 부적합하다.
    • 설정을 잘 하지 않으면 불필요한 API가 노출될 수도 있다.
    • 실무에서 API는 필요에 따라 직접 만드는 편이다.
  • 이럴 땐 사용을 고려
    • 내부에서 사용하는 애플리케이션을 만들 때
    • 도메인이 복잡하지 않울 때
    • 요구사항이 복잡하지 않고 심플한 CRUD로 구성되어 있을 때
    • 빠르게 만들어야 할 때

Reference

Rest Repositories HAL Explorer

이제 API 테스트도 스프링 부트에서

  • 심플하고 편리한 UI 제공

Reference

Devtools

Spring Boot Devtools

스프링 부트 개발의 절친

  • 스프링 부트 모듈들의 세부 설정을 개발에 적합한 형태로 자동으로 바꿔준다. (ex: 캐시 끄기)
  • Automatic restart - 자바 코드가 바뀌면 자동으로 애플리케이션을 재시작
  • Live reload - 정적 페이지가 바뀌면 자동으로 브라우저 웹페이지 refresh

Devtools: Automatic Restart

  • Restart vs Cold start
    • 자동 재시작은 생각보다 빠르다
    • devtools classloader: base classloader + restart classloader
      • restart (triggered devtools): restart classloader 만 갱신한다 (개발에서 자주 바뀌는 부분)
      • cold start(부트 직접 재시작): 전체 classloader 갱신
    • Restart triggering condition: classpath 안의 소스코드가 업데이트 되었을 때
      • build project
        • “build project automatically”: 소스코드 변경할 때 마다 자동으로 빌드 시작 -> 수시로 restart
      • maven: mvn compile
      • gradle: gradle build
  • Restart vs Reload
    • 소스코드 변경의 더 빠른 반영을 원한다면
      • JRebel을 살펴보기
      • 매우 빠름 (거의 즉시, 늦어도 3초 내외면 소스코드 변경이 애플리케이션에 반영됨)
      • 생산성 향상
      • 유료

Devtools: Live Reload

  • Live Reload
    • 웹페이지에 변경점이 발생하면 바로 refresh
    • embedded Live Reload server
    • browser extension 설치 필요: chrome, firefox, safari 지원
    • 리소스에 변경이 일어나면 브라우저 리프레쉬를 트리거

Reference

Actuator

Spring Boot Actuator

스프링 부트의 다양한 설정과 지표를 모니터링할 수 있는 도구

  • 내가 만든 빈이 잘 등록되었을까?
  • 내가 만든 빈이 다른 빈들과 어떤 연관 관계를 맺고 있을까?
  • 내가 설정한 환경변수, 프로퍼티가 잘 등록되었을까?
  • 내가 의도한 엔드포인트가 잘 노출되고 있을까?
  • 내가 의도한 로깅이 잘 일어나고 있을까?
  • 헬스 체크: 시스템이 정상 동작하고 있을까?
  • 캐시가 잘 동작하고 있을까?

Actuator: Endpoints

  • 기본 엔드포인트
    • auditevents, beans, caches, conditions, configprops, env, ….
  • 웹애플리케이션에서 추가로 활성화되는 엔드포인트
    • heapdump, jolokia, logfile, prometheus

Actuator

© 2020. All rights reserved.

SIKSIK