banseoksuh / hello-spring

Spring Boot 입문 학습 repository

• Spring Boot를 사용하여 간단한 웹 어플리케이션 개발
• 사용 기술
  • Spring Boot
  • JPA
  • Tomcat
  • Gradle
  • Hibernate
  • Thymeleaf

---

Note

Spring Boot 프로젝트 생성

• https://start.spring.io
• 설정 후 GENERATE 하면 .zip 파일이 다운로드됨
• 해당 파일 압축 풀고 IntelliJ로 해당 폴더 열기
• Project: 라이브러리 관리 툴 선택. 요즘은 Gradle을 많이 사용함
• Project Meta Data
  • Group: 기업명
  • Artifact: 프로젝트명
• Dependencies (중요)
  • 프로젝트 생성 시 어떤 라이브러리를 가져올 것인지 선택
• build.gradle (중요)
  • 버전 설정
  • 라이브러리 다운로드 주소

프로젝트 실행

• src > main > java 디렉토리에 있는 HelloSpringApplication.java에서 main 메서드 실행
• Tomcat started on port(s): 8080 (http)
• main 메서드 실행 시 내장된 tomcat 웹 서버를 띄우면서 Spring Boot가 같이 올라옴
• IntelliJ에서는 서버 구동 시 Java가 Gradle을 통해서 실행되는 것이 기본임. 그러면 실행 속도가 느림.
• preference에서 Java 실행 도구를 Gradle에서 IntelliJ로 변경하면, Gradle을 통하지 않고 IntelliJ에서 바로 java를 실행시켜서 더 빨라짐
• Preferences > Build, Execution, Deployment > Build Tools > Gradle
  • Build and run using: Gradle > IntelliJ IDEA
  • Run tests using: Gradle > IntelliJ IDEA

라이브러리 의존

• 라이브러리A에 대한 의존성을 주입받으면, A가 의존하고 있는 다른 라이브러리들도 주입받게 됨
• Tomcat
  • 웹 서버 라이브러리
  • 이전에는 Tomcat 서버에 자바 소스코드를 밀어넣어서 서버를 띄움
  • 하지만 이제는 Tomcat 서버가 내장되어 있어서 main 메서드 실행 시 서버 띄울 수 있음
• Log
  • 현없에서는 System.out.println() 안 씀
  • logging으로 출력해야 중요 로그가 관리가 됨
  • slf4j, logback을 주로 사용
• Test
  • junit5
  • assertj

View 환경설정

• Welcome Page
  • Spring Boot에서는 static/index.html 파일로 Welcome Page를 제공
• Thymeleaf 템플릿 엔진
  • Controller에서 리턴 값으로 문자을 반환하면, view resolver가 문자에 해당하는 파일을 찾아 반환
  • 파일 위치 : resources:templates/ + {ViewName} + .html

Build

• Terminal을 통해 프로젝트 root 디렉토리로 이동
• ./gradlew build -> 빌드
• build/libs 디렉토리로 이동
• java -jar hello-spring-0.0.1-SNAPSHOT.jar -> jar 파일 실행
• 서버에 jar 파일만 넣고 java -jar jar파일.jar 명령어로 실행시키면 배포됨
• 잘 안 되면 ./gradlew clean build -> 이전 빌드 폴더가 사라지고 새로 빌드됨

정적 컨텐츠

• 웹 브라우저에서 localhost:8080/hello-static.html 요청이 들어오면,
• 컨트롤러에서 먼저 hello-static과 매핑된 메서드가 있는지 확인한다. (컨트롤러가 우선순위를 갖는다)
• 없으면 resources:static/hello-static.html 파일을 찾아 파일 자체를 브라우저로 리턴함

MVC와 템플릿 엔진

• MVC: Model, View, Controller
• 관심사 분리
  • Model은 화면에서 필요한 데이터만을 담는 데에,
  • View는 화면을 그리는 데에,
  • Controller는 비즈니스 로직만을 다루는 데에,
  • 역할과 책임을 분리하기 위해 MVC 모델 발전
• 웹 브라우저에서 요청이 들어오면 Controller를 먼저 찾아와서 매핑된 메서드를 찾아 실행함
• Controller는 ViewResolver에 model을 던짐
• ViewResolver: view를 찾아주고 템플릿 엔진을 연결해줌
• 템플릿 엔진이 model을 변환 후, 변환된 파일을 웹 브라우저로 리턴함

API

• @ResponseBody: 리턴 데이터를 http response의 body부에 그대로 넣어주겠다는 의미
• class A 안에 static class B를 만들면 A.B 방식의 chaining 문법을 사용할 수 있음
• @ResponseBody가 있으면 viewResolver 대신 HttpMessageConverter가 동작함
• 리턴 데이터가 단순 문자열이면 StringHttpMessageConverter가 동작, 객체이면 MappingJackson2HttpMessageConverter가 동작함
• Jackson: 객체를 Json으로 바꿔주는 라이브러리

회원 관리 예제

• 일반적 웹 어플리케이션 계층 구조

  
  • 컨트롤러: 라우팅의 역할
  • 서비스: 핵심 비즈니스 로직
  • 리포지토리: 도메인 객체를 DB로 옮겨줌
  • 도메인: 회원, 주문, 쿠폰 등 주로 DB에 저장 및 관리되는 비즈니스 도메인 객체

• Optional<>: 데이터 조회 시 null일수도 있는 경우 Optional로 감싸서 리턴

• ConcurrentHashMap: 공유되는 변수일 경우에는 동시성 문제가 있어서 실무에서는 HashMap보단 ConcurrentHashMap을 사용

• AtomicLong: 동시성 문제로 long보단 AtomicLong 사용

• null이 반환될 가능성이 있으면 Optional.ofNullable()로 감싸서 리턴

• Assertions.assertEquals(expected, actual)은 테스트 시 실제값과 기대값이 같은지 확인해주는 메서드

• Member result = repository.findByName("spring1").get();

  • .get()을 뒤에 붙이면 Optional을 한꺼풀 벗겨내서 값을 가져올 수 있음

• @AfterEach는 테스트 클래스의 각 테스트 메서드가 끝나면 실행할 함수를 정의

• 테스트는 의존관계 없이 설계되어야 함

회원 서비스, 테스트

• Repository에서는 개발에 가까운 용어를 사용
• Service에서는 비즈니스에 가까운 용어를 사용
• 테스트는 한글로 적어도 무방함. 빌드될 때 테스트 코드는 빌드되지 않음
• given: 뭔가가 주어졌을 때
• when: 이렇게 했더니
• then: 이렇게 되었다
• 테스트는 정상 플로우도 중요하지만 예외 플로우도 중요. 예외에 대한 테스트도 생성
• assertThrows(A, B): B로직을 실행하면 A에러가 터져야 해!
• control + R : 이전에 실행했던 테스트 재실행

DI (Dependency Injection)

• MemberService와 MemberServiceTest에서 각각 memberRepository 인스턴스를 생성하면 서로 다른 repository 인스턴스를 사용하게 됨
• 같은 인스턴스를 사용하도록 해줘야 함

class MemberServiceTest {

    MemberService memberService;
    MemoryMemberRepository memberRepository;

    @BeforeEach
    public void beforeEach() {
        memberRepository = new MemoryMemberRepository();
        memberService = new MemberService(memberRepository);
    }
    ...
}

public class MemberService {
    private final MemberRepository memberRepository;

    public MemberService(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    ...
}

• MemberService에서 new로 직접 memberRepository를 생성하는 것이 아니라 외부에서 넣어주도록 변경
• @BeforeEach로 매 테스트 직전에 repository를 new로 생성하고,
• new로 service를 생성할 때 인자로 방금 생성한 repository를 넣어줌 -> service에서는 주입받은 repository를 사용하게 됨
• memberService 입장에서 보면 직접 new로 repository를 생성하지 않고 외부에서 주입받음 -> 의존성 주입(Dependency Injection)이라고 함

의존성 주입

• 스프링 빈 등록 방법
  • 컴포넌트 스캔 방식
    • @Controller, @Service, @Repository에는 모두 @Component가 붙어 있음
    • @Component을 포함하는 어노테이션은 스프링 빈으로 자동 등록됨
    • hello.hellospring 패키지에 포함된 파일들에 한해서 컴포너트 스캔이 이루어짐
    • 스프링은 스프링 빈을 등록할 때 싱글톤으로 등록함. 하나만 등록하고 공유함.
  • 스프링 빈 직접 등록
    • 상황에 따라 구현 클래스를 변경해야 할 경우 사용
    • 예를 들어, 아직 데이터 저장소가 선정되지 않아 우선 인터페이스로 구현 클래스를 변경할 수 있도록 설계했을 경우에 스프링 빈을 직접 등록하는 것이 유용함

      @Bean
      public MemberSevice memberService() {
          return new MemberService(memberRepository());
      };
      
      
      /*
        "MemoryMemberRepository" -> "DbMemberRepository"
        위와 같이 수정하면 다른 코드 수정 없이 구현체를 변경할 수 있음
      */
      @Bean
      public MemberRepository memberRepository() {
          return new MemoryMemberRepository();
      };

    • @Autowired는 Spring이 관리해주는 객체에서만 동작 (Spring Bean으로 등록되어있지 않으면 @Autowired 동작하지 않음)

회원 관련 기능

리턴 우선 순위

• http 요청 시 먼저는 스프링 컨테이너 내부에 매핑되어 있는 Controller를 찾음
• 없으면 static 폴더의 파일을 찾음
• 해당 컨트롤러를 제거하면 static 폴더의 index.html를 잦음

등록 관련

• post 요청 시 input 태그에서 name에 해당하는 값이 서버로 전달되는 key

Spring

• 스프링을 쓰는 이유: 객체지향적 설계를 극대화히기 위해
• 하나의 거대한 프로젝트를 단순히 코드의 목록으로 생각항 것이 아니라, 객체 간의 상호작용을 통한 유기체로 설계하기 위함.
• 다형성을 가짐으로써 클라이언트에 아무런 영향 없이 프로젝트를 확장 및 개선할 수 있음