어플리케이션을 실행시키려는데 이런 에러가 났습니다.

8080포트가 이미 사용중이어서 다른 포트번호로 설정하여 사용하라는 에러인데요.

properties나 yml 설정파일에서 서버 포트번호를 바꾸는 방법도 있지만 윈도우 cmd에서 해당 포트번호로 실행중인 작업을 멈추는 방법을 알려드리려고 합니다.

1. cmd에서 해당 포트번호 사용상태 확인하기

netstat -ano | findstr 8080

cmd에 치면 현재 사용하고 있는 8080 포트를 사용하는 네트워크 통계 정보를 출력합니다.

2. 서버 죽이기

taskkill /F /pid [process_id]

위 명령어를 통해 출력된 목록의 process_id를 입력하여 강제 종료시킵니다.

lombok, querydsl 관련 에러가 나서 같이 다뤄보려고 합니다 !!!

1. https://gradle.org/releases/

Gradle 공식홈페이지에서 원하는 버전을 다운받습니다.

저는 binary-only 로 다운받았습니다.

2. 환경변수 설정

JDK와 동일하게 Gradle도 환경변수 설정을 해야합니다.

[시스템 속성] -> [환경 변수]

1. 시스템 변수
   • 변수 이름 : GRADLE_HOME
     • 변수 값 : GRADLE 압축해제 한 경로 예) C:\gradle-6.8.3
2. 사용자 변수
   • 변수 이름 : Path
   • 변수 값 : %GRADLE_HOME%\bin

3. cmd에 gradle -v 쳐서 Gradle 설정 확인하기

위와 같이 나온다면 정상적으로 Gradle이 설정완료가 된 겁니다.

4. pom.xml이 위치해있는 원하는 프로젝트로 경로 이동 후, gradle init --type pom 쳐서 Gradle init 해주기

gradle init --type pom 을 치면

Select build script DSL: 1: Groovy 2: Kotlin Enter selection (default: Groovy) [1..2]

빌드에 사용할 DSL을 선택하라는 질문이 나옵니다.

기본으로 groovy로 선택되어서 groovy로 진행했습니다. (Enter 누르기)

Generate build using new APIs and behavior (some features may change in the next minor release)? (default: no)

새로운 API 를 사용해서 build 를 생성하겠냐는 질문에 기본 값(no)을 선택해 줍니다.

5. Spring boot build.gradle에서 Querydsl, lombok 다시 설정하기

인텔리제이에서 프로젝트를 열었을 때 gradle 파일이 들어갔습니다. (저는 pom.xml을 지웠습니다.)

하지만 gradle 파일이 들어갔다고 해서 바로 실행되지 않았습니다.

• Querydsl 설정하기

plugins

/*
 * This file was generated by the Gradle 'init' task.
 */

plugins {
    id 'java'
    id 'maven-publish'
    // querydsl plugins 추가
    id "com.ewerk.gradle.plugins.querydsl" version "1.0.10"
}

dependencies

dependencies {
    implementation 'com.querydsl:querydsl-jpa:5.0.0'
    implementation 'com.querydsl:querydsl-apt:5.0.0'
}

추가 설정

test {
    useJUnitPlatform()
}

/*
 * queryDSL 설정 추가
 */
// querydsl에서 사용할 경로 설정
def querydslDir = "$buildDir/generated/querydsl"
// JPA 사용 여부와 사용할 경로를 설정
querydsl {
    jpa = true
    querydslSourcesDir = querydslDir
}
// build 시 사용할 sourceSet 추가
sourceSets {
    main.java.srcDir querydslDir
}
// querydsl 컴파일시 사용할 옵션 설정
compileQuerydsl{
    options.annotationProcessorPath = configurations.querydsl
}
// querydsl 이 compileClassPath 를 상속하도록 설정
configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
    querydsl.extendsFrom compileClasspath
}

다 설정한 후 마지막으로 Gradle을 ReImport 해줍니다.

ReImport 해준 후 compileQuerydsl을 더블클릭해주면 Qdomain이 생깁니다.

• lombok 설정하기

저는 기존에 lombok dependency가 있었음에도 불구하고 lombok이 인식이 안되어 에러가 났습니다.

dependencies {
    annotationProcessor 'org.projectlombok:lombok:1.18.22'
}

dependencies에 annotationProcessor을 넣으니 해결되었습니다.

번외로, repository에서 @Query의 jpql에 쓰이는 변수들을 @Param으로 바인딩 해줬습니다.

Reference https://www.inflearn.com/questions/367372 https://data-make.tistory.com/728 https://shanepark.tistory.com/360

*자바 엔터프라이즈 개발을 편하게 해주는 오픈 소스 경량급 애플리케이션 프레임워크 *라고 소개되어 있습니다.

여기서 단어별로 끊으면서 Spring Framework가 정확히 어떤 프레임워크인지 설명하겠습니다.

1. 엔터프라이즈 개발

뜻을 풀이하면 기업을 대상으로 하는 개발이라는 말입니다.

즉, 대규모 데이터 처리와 트랜잭션이 동시에 여러 사용자로부터 행해지는 매우 큰 규모의 환경을 엔터프라이즈 환경이라고 합니다.

2. 오픈소스 경량급

여기서 경량급은 툴의 도움 없이는 다루기 힘든 난해한 설정파일과 불편한 서버 배치 등으로 인한 부담을 없애고, 쉽게 해당 기능들을 사용할 수 있게 되었음을 의미합니다.

오픈 소스는 소스가 공개되어 있어서, 언제든 수정이 가능하고 이슈를 보내 해결할 수 있는 소스를 말합니다.

3. 애플리케이션 프레임워크

애플리케이션 프레임워크는 특정 계층이나, 기술, 업무 분야에 국한되지 않고 애플리케이션의 전 영역을 포괄하는 범용적인 프레임워크를 말합니다.

즉, 애플리케이션 프레임워크는 애플리케이션 개발의 전 과정을 빠르고 편리하며 효율적으로 진행하는데 일차적인 목표를 두는 프레임워크입니다.

Spring Framework의 특징

1. 경량 컨테이너

Spirng Framework는 경량 컨테이너로 자바 객체를 담고 직접 관리합니다. 객체의 생성 및 소멸 그리고 라이프 사이클을관리하며 언제든 Spring 컨테이너로 부터 필요한 객체를 가져와 사용할 수 있습니다.

이는 Spirng이 IOC 기반의 Framework임을 의미합니다.

2. POJO(Plain Old Java Object) 기반의 구성

평범한 자바 객체를 뜻합니다.

POJO는 gettet/setter를 가진 단순 자바 오브젝트로 정의를 하고 있습니다. 이러한 단순 오브젝트는 의존성이 없고 코드가심플하여 추후 테스트 및 유지보수가 편리한 유연성의 장점을 가집니다. 이러한 장점들로 인해 객체지향적인 다양한 설계와 구현이 가능합니다.

3. DI(Dependency Injection)

앞에서 말했다시피 스프링은 IOC(Inversion of Control) 기반의 Framework입니다.

IOC란 스프링 그 자체가 구조를 설계할 수 있어서 개발자가 직접 부품을 조립하는 형태의 개발이 가능합니다.

이렇게 조립된 코드의 최종 호출은 개발자가 결정하는 것이 아니라 스프링 프레임워크 내부에서 이루어지는 것을, 제어의 역행(IOC)라고 합니다.

의존성 주입(DI)은 제어의 역행이 일어나는 것을 전제로 하여 스프링 객체가 서로 의존하는 관계가 되게끔 의존성을 주입하는 것입니다.
IOC에서 DI란 각 클래스 사이에 필요로 하는 의존관계를 빈 설정 정보를 바탕으로 컨테이너가 자동으로 연결해주는 것입니다.

4. AOP(Aspect Oriented Programming) 지원

AOP란 말 그대로 풀이하자면 관점 지향 프로그래밍이란 뜻입니다.

대부분의 시스템에서 비즈니스 로직은 아니지만 보안, 로그, 트랜잭션과 같이 반드시 처리가 필요한 부분을 횡단 관심사라고 합니다.

AOP는 비즈니스 로직과 횡단 관심사를 분리시켜 비즈니스 로직에 영향을 끼치지 않게 횡단 관심사를 끼워 넣는 개발 형태이며 이로 인해 많은 장점들이 생깁니다.

1. 무분별하게 중복되는 코드를 한 곳에 모아 중복 코드 제거 가능

2. 공통기능을 한 곳에 보관함으로써 공통 기능 하나의 수정으로 모든 핵심기능들의 공통기능을 수정 가능

3. 그로 인해 효율적인 유지보수가 가능하며 재활용성이 극대화

5. 독립적인 개발 환경

스프링은 가장 단순한 서버환경인 톰캣(Tomcat)이나 제티(Jetty)에서 완벽하게 동작합니다.

단순한 개발툴과 기본적인 개발환경으로도 엔터프라이즈 개발에서 필요로 하는 주요한 기능을 갖춘 애플리케이션을 개발하기에 충분합니다.

AOP: Aspect Oriented Programming

AOP가 필요한 상황

• 모든 메소드의 호출 시간을 측정하고 싶을 때
• 공통 관심 사항(cross-cutting concern) vs 핵심 관심 사항(core concern)
• 회원 가입 시간, 회원 조회 시간을 측정하고 싶을 때

[ MemberService 회원 조회 시간 측정 추가 ]

package hello.hellospring.service;

import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;
import java.util.Optional;

// @Service
@Transactional
public class MemberService {
    private final MemberRepository memberRepository;

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

    /**
     * 회원가입
     */
    public Long join(Member member) {

        long start = System.currentTimeMillis();

        try {
            validateDuplicateMember(member); //중복 회원 검증
            memberRepository.save(member);
            return member.getId();
        } finally {
            long finish = System.currentTimeMillis();
            long timeMs = finish - start;
            System.out.println("join " + timeMs + "ms");
        }
    }
    private void validateDuplicateMember(Member member) {
        memberRepository.findByName(member.getName()).ifPresent(m -> {
                    throw new IllegalStateException("이미 존재하는 회원입니다.");
                });
    }

    /**
     * 전체 회원 조회
     */
    public List<Member> findMembers() {
        long start = System.currentTimeMillis();

        try {
            return memberRepository.findAll();
        } finally {
            long finish = System.currentTimeMillis();
            long timeMs = finish - start;
            System.out.println("findMembers " + timeMs + "ms");
        }
    }

    public Optional<Member> findOne(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

다음과 같이 조회 시간이 측정되는 것을 확인할 수 있습니다.

문제

• 회원가입, 회원 조회에 시간을 측정하는 기능은 핵심 관심 사항이 아닙니다.
• 시간을 측정하는 로직은 공통 관심 사항입니다.
• 시간을 측정하는 로직과 핵심 비즈니스의 로직이 섞여서 유지보수가 어렵습니다.
• 시간을 측정하는 로직을 별도의 공통 로직으로 만들기 매우 어렵습니다.
• 시간을 측정하는 로직을 변경할 때 모든 로직을 찾아가면서 변경해야 합니다.

AOP 적용

공통 관심 사항(cross-cutting concern) vs 핵심 관심 사항(core concern) 분리

[ 시간 측정 AOP 등록 ]

package hello.hellospring.aop;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;

import org.springframework.stereotype.Component;@Component

@Aspect
public class TimeTraceAop {
    @Around("execution(* hello.hellospring..*(..))")
    public Object execute(ProceedingJoinPoint joinPoint) throws Throwable {
        long start = System.currentTimeMillis();

        System.out.println("START: " + joinPoint.toString());

        try {
            return joinPoint.proceed();
        } finally {
            long finish = System.currentTimeMillis();
            long timeMs = finish - start;
            System.out.println("END: " + joinPoint.toString()+ " " + timeMs + "ms");
        }
    }
}

해결

• 회원가입, 회원 조회등 핵심 관심사항과 시간을 측정하는 공통 관심 사항을 분리합니다.
• 시간을 측정하는 로직을 별도의 공통 로직으로 만들었습니다.
• 핵심 관심 사항을 깔끔하게 유지할 수 있습니다.
• 변경이 필요하면 이 로직만 변경하면 됩니다.
• 원하는 적용 대상을 선택할 수 있습니다.

스프링의 AOP 동작 방식 설명

[ AOP 적용 전 의존관계 ]

[ AOP 적용 후 의존관계 ]

[ AOP 적용 전 전체 그림 ]

[ AOP 적용 후 전체 그림 ]

학습중인 스프링 강의 : https://inf.run/pcut 스프링 실습 코드 저장소 : https://github.com/0pyaq0/Spring_Study.git

본 글은 2022년도에 작성한 기존 티스토리 블로그 글을 재업로드한 글입니다 기존 티스토리 블로그 : https://develop-about-leejin.tistory.com/

• 기존의 반복 코드는 물론이고, 기본적인 SQL도 JPA가 직접 만들어서 실행함
• SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환을 할 수 있음
• 개발 생산성을 크게 높일 수 있음

[ build.gradle 파일에 JPA, h2 데이터베이스 관련 라이브러리 추가 ]

dependencies {
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
implementation 'org.springframework.boot:spring-boot-starter-web'
//implementation 'org.springframework.boot:spring-boot-starter-jdbc'
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
runtimeOnly 'com.h2database:h2'
testImplementation('org.springframework.boot:spring-boot-starter-test') {
exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
}
}

추가한 후 코끼리 아이콘을 눌러 라이브러리 다운받는 것을 꼭 잊지마세요!

*spring-boot-starter-data-jpa *는 내부에 jdbc 관련 라이브러리를 포함하므로 jdbc는 제거해도 됩니다.

[ 스프링 부트에 JPA 설정 추가 ]

spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none

show-sql : JPA가 생성하는 SQL을 출력함 ddl-auto : JPA는 테이블을 자동으로 생성하는 기능을 제공하는데 none 를 사용하면 해당 기능을 끔 create 메소드를 사용하면 엔티티 정보를 바탕으로 테이블도 직접 생성함

[ JPA 엔티티 매핑 ]

package hello.hellospring.domain;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Member {
    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }}

[ JPA 회원 리포지토리 ]

package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import javax.persistence.EntityManager;
import java.util.List;
import java.util.Optional;
public class JpaMemberRepository implements MemberRepository {
 private final EntityManager em;
 public JpaMemberRepository(EntityManager em) {
 this.em = em;
 }
 public Member save(Member member) {
 em.persist(member);
 return member;
 }
 public Optional<Member> findById(Long id) {
 Member member = em.find(Member.class, id);
 return Optional.ofNullable(member);
 }
 public List<Member> findAll() {
 return em.createQuery("select m from Member m", Member.class)
 .getResultList();
 }
 public Optional<Member> findByName(String name) { List<Member> result = em.createQuery("select m from Member m where 
m.name = :name", Member.class)
 .setParameter("name", name)
 .getResultList();
 return result.stream().findAny();
 }
}

[ 서비스 계층에 @Transactional 추가 ]

import org.springframework.transaction.annotation.Transactional
@Transactional
public class MemberService {}

스프링은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고, 메서드가 정상 종료되면 @Transactional을 커밋합니다. 만약 런타임 예외가 발생하면 롤백합니다. JPA를 통한 모든 데이터 변경은 @Transactional 안에서 실행해야 합니다.

[ JPA를 사용하도록 스프링 설정 변경 ]

package hello.hellospring;

import hello.hellospring.repository.*;
import hello.hellospring.service.MemberService;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.persistence.EntityManager;
import javax.sql.DataSource;

@Configuration
public class SpringConfig {
    private final DataSource dataSource;
    private final EntityManager em;

    public SpringConfig(DataSource dataSource, EntityManager em) {
        this.dataSource = dataSource;
        this.em = em;
    }

    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
// return new MemoryMemberRepository();
// return new JdbcMemberRepository(dataSource);
// return new JdbcTemplateMemberRepository(dataSource);
        return new JpaMemberRepository(em);
    }
}

이후 통합테스트를 진행하면 성공적으로 잘 돌아가는 것을 볼 수 있습니다.

스프링 데이터 JPA

스프링 부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고, 개발해야할 코드도 확연히 줄어듭니다. 여기에 스프링 데이터 JPA를 사용하면, 기존의 한계를 넘어 마치 마법처럼, 리포지토리에 구현 클래스 없이 인터페이스 만으로 개발을 완료할 수 있습니다.

그리고 반복 개발해온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공합니다. 스프링 부트와 JPA라는 기반 위에, 스프링 데이터 JPA라는 환상적인 프레임워크를 더하면 개발이 정말 즐거워집니다.

지금까지 조금이라도 단순하고 반복이라 생각했던 개발 코드들이 확연하게 줄어듭니다.

따라서 개발자는 핵심 비즈니스 로직을 개발하는데, 집중할 수 있습니다. 실무에서 관계형 데이터베이스를 사용한다면 스프링 데이터 JPA는 이제 선택이 아니라 필수입니다.

스프링 데이터 JPA는 JPA를 편리하게 사용하도록 도와주는 기술입니다. 따라서 JPA를 먼저 학습한 후에 스프링 데이터 JPA를 학습해야 합니다.

[ 스프링 데이터 JPA 회원 리포지토리 ]

package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.Optional;
public interface SpringDataJpaMemberRepository extends JpaRepository<Member,Long>, MemberRepository {
 Optional<Member> findByName(String name);
}

[ 스프링 데이터 JPA 회원 리포지토리를 사용하도록 스프링 설정 변경 ]

package hello.hellospring;
import hello.hellospring.repository.*;
import hello.hellospring.service.MemberService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SpringConfig {
 private final MemberRepository memberRepository; public SpringConfig(MemberRepository memberRepository) {
 this.memberRepository = memberRepository;
 }
 @Bean
 public MemberService memberService() {
 return new MemberService(memberRepository);
 }
}

스프링 데이터 JPA가 SpringDataJpaMemberRepository 를 스프링 빈으로 자동 등록해줍니다.

[ 스프링 데이터 JPA 제공 클래스 이미지 ]

[ 스프링 데이터 JPA ]

스프링 데이터 JPA 제공 기능

• 인터페이스를 통한 기본적인 CRUD
• findByName() , findByEmail() 처럼 메서드 이름 만으로 조회 기능 제공
• 페이징 기능 자동 제공

실무에서는 JPA와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리는 Querydsl이라는 라이브러리를 사용하면 됩니다. Querydsl을 사용하면 쿼리도 자바 코드로 안전하게 작성할 수 있고, 동적 쿼리도 편리하게 작성할 수 있습니다. 이 조합으로 해결하기 어려운 쿼리는 JPA가 제공하는 네이티브 쿼리를 사용하거나, 앞서 학습한 스프링 JdbcTemplate를 사용하면 됩니다.

학습중인 스프링 강의 : https://inf.run/pcut 스프링 실습 코드 저장소 : https://github.com/0pyaq0/Spring_Study.git

본 글은 2022년도에 작성한 기존 티스토리 블로그 글을 재업로드한 글입니다 기존 티스토리 블로그 : https://develop-about-leejin.tistory.com/

스프링 컨테이너와 DB까지 연결한 통합 테스트를 진행해봅시다.

[ 회원 서비스 스프링 통합 테스트 ]

package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.transaction.annotation.Transactional;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {
 @Autowired MemberService memberService;
 @Autowired MemberRepository memberRepository;
 @Test
 public void 회원가입() throws Exception { //Given
 Member member = new Member();
 member.setName("hello");
 //When
 Long saveId = memberService.join(member);
 //Then
 Member findMember = memberRepository.findById(saveId).get();
 assertEquals(member.getName(), findMember.getName());
 }
 @Test
 public void 중복_회원_예외() throws Exception {
 //Given
 Member member1 = new Member();
 member1.setName("spring");
 Member member2 = new Member();
 member2.setName("spring");
 //When
 memberService.join(member1);
 IllegalStateException e = assertThrows(IllegalStateException.class,
 () -> memberService.join(member2));//예외가 발생해야 한다.
 assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
 }
}

@SpringBootTest : 스프링 컨테이너와 테스트를 함께 실행합니다.

@Transactional : 테스트 케이스에 이 애노테이션이 있으면 테스트 시작 전에 트랜잭션을 시작하고, 테스트 완료 후에 항상 롤백합니다. 이렇게 하면 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않습니다.

테스트를 바로 실행하면 이미 spring이라는 데이터가 존재하므로 다음과 같은 메세지가 출력됩니다.

H2 콘솔에서 delete from member 로 데이터를 지워주고 실행해봅시다.

이전에 테스트를 많이 해서 다음과 같은 결과로 나왔습니다.

삭제 유무 관계없이 ID 번호가 올라간다고 하니 DB마다 결과가 다를 수 있습니다.

스프링 JdbcTemplate

순수 Jdbc와 동일한 환경설정을 하면 됩니다. 스프링 JdbcTemplate과 MyBatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해주지만 SQL은 직접 작성해야 합니다.

[ 스프링 JdbcTemplate 회원 리포지토리 ]

package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
import org.springframework.jdbc.core.simple.SimpleJdbcInsert;
import javax.sql.DataSource;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
public class JdbcTemplateMemberRepository implements MemberRepository {
 private final JdbcTemplate jdbcTemplate;
 public JdbcTemplateMemberRepository(DataSource dataSource) {
 jdbcTemplate = new JdbcTemplate(dataSource);
 }
 @Override
 public Member save(Member member) {
 SimpleJdbcInsert jdbcInsert = new SimpleJdbcInsert(jdbcTemplate);
 jdbcInsert.withTableName("member").usingGeneratedKeyColumns("id"); Map<String, Object> parameters = new HashMap<>();
 parameters.put("name", member.getName());
 Number key = jdbcInsert.executeAndReturnKey(new
MapSqlParameterSource(parameters));
 member.setId(key.longValue());
 return member;
 }
 @Override
 public Optional<Member> findById(Long id) {
 List<Member> result = jdbcTemplate.query("select * from member where id 
= ?", memberRowMapper(), id);
 return result.stream().findAny();
 }
 @Override
 public List<Member> findAll() {
 return jdbcTemplate.query("select * from member", memberRowMapper());
 }
 @Override
 public Optional<Member> findByName(String name) {
 List<Member> result = jdbcTemplate.query("select * from member where 
name = ?", memberRowMapper(), name);
 return result.stream().findAny();
 }
 private RowMapper<Member> memberRowMapper() {
 return (rs, rowNum) -> {
 Member member = new Member();
 member.setId(rs.getLong("id"));
 member.setName(rs.getString("name"));
 return member;
 };
 }
}

[ JdbcTemplate을 사용하도록 스프링 설정 변경 ]

package hello.hellospring;
import hello.hellospring.repository.JdbcMemberRepository;
import hello.hellospring.repository.JdbcTemplateMemberRepository;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import hello.hellospring.service.MemberService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;
@Configuration
public class SpringConfig {
 private final DataSource dataSource;
 public SpringConfig(DataSource dataSource) {
 this.dataSource = dataSource;
 }
 @Bean
 public MemberService memberService() {
 return new MemberService(memberRepository());
 }
 @Bean
 public MemberRepository memberRepository() {
// return new MemoryMemberRepository();
// return new JdbcMemberRepository(dataSource);
 return new JdbcTemplateMemberRepository(dataSource);
 }
}

성공적으로 테스트를 마쳤습니다.

학습중인 스프링 강의 : https://inf.run/pcut 스프링 실습 코드 저장소 : https://github.com/0pyaq0/Spring_Study.git

본 글은 2022년도에 작성한 기존 티스토리 블로그 글을 재업로드한 글입니다 기존 티스토리 블로그 : https://develop-about-leejin.tistory.com/

H2 데이터베이스 설치

개발이나 테스트 용도로 가볍고 편리한 DB, 웹 화면 제공

h2 데이터베이스는 꼭 다음 링크에 들어가서 1.4.200 버전을 설치해주세요. 최근에 나온 2.0.206 버전을 설치하면 일부 기능이 정상 동작하지 않습니다.

https://www.h2database.com/html/download-archive.html

저는 윈도우 사용자이기 때문에 Windows Installer를 다운로드 했습니다.

다운로드 후 설치까지 진행하면 H2 콘솔로 이동할 수 있습니다.

데이터베이스 최초 파일을 생성하기 위해 그대로 연결을 한 번 시켜줍니다. 에러가 나신 분들은 IP를 localhost로 변경하시면 생성이 됩니다.

하지만 저는 생성이 되지 않아서 다음 링크를 보고 참고하여 직접 test.mv.db 파일을 생성하여 진행했습니다.

https://kmhan.tistory.com/581

한 번 최초 실행을 했으면 그 후로부터는 jdbc:h2:tcp://localhost/~/test 로 연결해줍니다.

성공적으로 연결되면 이런 화면이 나타납니다.

H2 데이터베이스에 접근하여 테이블 생성하기

create table member
(
 id bigint generated by default as identity,
 name varchar(255),
 primary key (id)
);

id bigint generated by default as identity : id 값이 null로 들어왔을 때 자동으로 채워줍니다.

sql문을 작성한 후 '실행'을 누르면 테이블이 생성됩니다.

이제 데이터를 삽입해 봅시다.

insert into member(name) values('spring');

삽입 후 다시 조회해보면 잘 삽입한 것을 확인할 수 있습니다.

순수 JDBC

이제 회원 가입 웹과 연결을 해보겠습니다.

1. 환경 설정

[ build.gradle 파일에 jdbc, h2 데이터베이스 관련 라이브러리 추가 ]

implementation 'org.springframework.boot:spring-boot-starter-jdbc'
runtimeOnly 'com.h2database:h2'

각각 JDBC 드라이버와 데이터베이스 클라이언트입니다.

[ 스프링 부트 데이터베이스 연결 설정 추가 ( resources/application.properties ) ]

spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa

추가한 후, 다시 gradle 파일로 가서

코끼리 아이콘을 눌러줍니다.

😺 : 스프링부트 2.4부터는 spring.datasource.username=sa 를 꼭 추가해주어야 합니다.

인텔리J 커뮤니티(무료) 버전의 경우 application.properties 파일의 왼쪽이 다음 그림과 같이 회색으로 나옵니다.

실제로 동작하는 데 문제 없습니다.

2. Jdbc 리포지토리 구현

[ Jdbc 회원 리포지토리 ]

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.springframework.jdbc.datasource.DataSourceUtils;
import javax.sql.DataSource;
import java.sql.*;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

public class JdbcMemberRepository implements MemberRepository {
    private final DataSource dataSource;

    public JdbcMemberRepository(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    @Override
    public Member save(Member member) {
        String sql = "insert into member(name) values(?)";
        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql,
                    Statement.RETURN_GENERATED_KEYS);
            pstmt.setString(1, member.getName());
            pstmt.executeUpdate();
            rs = pstmt.getGeneratedKeys();
            if (rs.next()) {
                member.setId(rs.getLong(1));
            } else {
                throw new SQLException("id 조회 실패");
            }
            return member;
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    @Override
    public Optional<Member> findById(Long id) {
        String sql = "select * from member where id = ?";
        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);
            pstmt.setLong(1, id);
            rs = pstmt.executeQuery();
            if(rs.next()) {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                return Optional.of(member);
            } else {
                return Optional.empty();
            }
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    @Override
    public List<Member> findAll() {
        String sql = "select * from member";
        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);
            rs = pstmt.executeQuery(); List<Member> members = new ArrayList<>();
            while(rs.next()) {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                members.add(member);
            }
            return members;
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    @Override
    public Optional<Member> findByName(String name) {
        String sql = "select * from member where name = ?";
        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);
            pstmt.setString(1, name);
            rs = pstmt.executeQuery();
            if(rs.next()) {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                return Optional.of(member);
            } return Optional.empty();
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    private Connection getConnection() {
        return DataSourceUtils.getConnection(dataSource);
    }

    private void close(Connection conn, PreparedStatement pstmt, ResultSet rs)
    {
        try {
            if (rs != null) {
                rs.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
        try {
            if (pstmt != null) {
                pstmt.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
        try {
            if (conn != null) {
                close(conn);
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }

    private void close(Connection conn) throws SQLException {
        DataSourceUtils.releaseConnection(conn, dataSource);
    }
}

DataSource 데이터베이스 커넥션을 획득할 때 사용하는 객체입니다. 스프링 부트는 데이터베이스 커넥션 정보를 바탕으로 DataSource를 생성하고 스프링 빈으로 만들어둡니다. 그래서 DI를 받을 수 있습니다.

[ SpringConfig 수정 ]

package hello.hellospring;

import hello.hellospring.repository.JdbcMemberRepository;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import hello.hellospring.service.MemberService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
public class SpringConfig {

    @Autowired
    DataSource dataSource;

    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        return new JdbcMemberRepository(dataSource);
       // return new MemoryMemberRepository();
    }

}

[ 구현 클래스 이미지 ]

[ 스프링 설정 이미지 ]

개방-폐쇄 원칙(OCP, Open-Closed Principle) : 확장에는 열려있고, 수정, 변경에는 닫혀있다. 스프링의 DI (Dependencies Injection)을 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있습니다.

이제 회원을 등록하고 DB에 결과가 잘 입력되는지 확인하겠습니다.

😺 : 꼭 H2 콘솔 열어둔 상태로 실행하셔야 합니다!

[ 결과 ]

아까 넣었던 spring이 잘 출력되어 있습니다.

데이터를 DB에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장됩니다.

학습중인 스프링 강의 : https://inf.run/pcut 스프링 실습 코드 저장소 : https://github.com/0pyaq0/Spring_Study.git

본 글은 2022년도에 작성한 기존 티스토리 블로그 글을 재업로드한 글입니다 기존 티스토리 블로그 : https://develop-about-leejin.tistory.com/

1. 회원 웹 기능 - 홈 화면

[ 홈 컨트롤러 추가 ]

package hello.hellospring.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class HomeController {
 @GetMapping("/")
 public String home() {
 return "home";
 }
}

[ 회원 관리용 홈 ]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<body>
<div class="container">
    <div>
        <h1>Hello Spring</h1>
        <p>회원 기능</p>
        <p>
            <a href="/members/new">회원 가입</a>
            <a href="/members">회원 목록</a>
        </p>
    </div></div> <!-- /container -->
</body>
</html>

[ 결과 ]

기존에 index.html이 있어도 컨트롤러 안에 "/"가 맵핑되었기 때문에 home.html을 호출합니다.

😺 : 컨트롤러가 정적 파일보다 우선순위가 높음.

2. 회원 웹 기능 - 등록

• 회원 등록 폼 개발

[ 회원 등록 폼 컨트롤러 ]

@Controller
public class MemberController {
 private final MemberService memberService;
 @Autowired
 public MemberController(MemberService memberService) {
 this.memberService = memberService;
 }
 @GetMapping(value = "/members/new")
 public String createForm() {
 return "members/createMemberForm";
 }
}

[ 회원 등록 폼 HTML ( resources/templates/members/createMemberForm ) ]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org"><body>
<div class="container">
    <form action="/members/new" method="post">
        <div class="form-group">
            <label for="name">이름</label>
            <input type="text" id="name" name="name" placeholder="이름을 입력하세요">
        </div>
        <button type="submit">등록</button>
    </form>
</div> <!-- /container -->
</body>
</html>

form 태그로 이름을 입력 하면 /members/new에 POST 방식으로 넘어옵니다.

• 회원 등록 컨트롤러

[ 웹 등록 화면에서 데이터를 전달 받을 폼 객체 ]

package hello.hellospring.controller;
public class MemberForm {
 private String name;
 public String getName() {
 return name;
 }
 public void setName(String name) {
 this.name = name;
 }
}

[ 회원 컨트롤러에서 회원을 실제 등록하는 기능 ]

@PostMapping(value = "/members/new")
public String create(MemberForm form) {
 Member member = new Member();
 member.setName(form.getName());
 memberService.join(member);
 return "redirect:/";
}

이름을 입력하여 members/new에 POST 방식으로 넘어오면 @GetMapping이 아닌 @PostMapping으로 이동합니다.

그 후 MemberForm을 create 메소드로 호출합니다.

Memberform의 name에 입력받은 이름이 setname메소드를 통해 들어옵니다.

그 다음 @PostMapping에서 getName으로 이름을 꺼내 join으로 가입 완료 처리를 합니다.

😺 : @PostMapping은 데이터를 폼에 넣어서 전달할 때 쓰이고 @GetMapping은 주로 조회할 때 쓰입니다.

3. 회원 웹 기능 - 조회

[ 회원 컨트롤러에서 조회 기능 ]

@GetMapping(value = "/members")
public String list(Model model) {
 List<Member> members = memberService.findMembers();
 model.addAttribute("members", members);
 return "members/memberList";
}

[ 회원 리스트 HTML ]

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<body>
<div class="container">
    <div>
        <table>
            <thead> <tr>
                <th>#</th>
                <th>이름</th>
            </tr>
            </thead>
            <tbody>
            <tr th:each="member : ${members}">
                <td th:text="${member.id}"></td>
                <td th:text="${member.name}"></td>
            </tr>
            </tbody>
        </table>
    </div>
</div> <!-- /container -->
</body>
</html>

이 html에서 thymeleaf 엔진이 본격적으로 사용됩니다.

템플릿 언어로 모델 안에 있는 ${members} 값을 읽어들입니다.

컨트롤러에서 addAttribute로 조회 리스트인 members를 담아놨기 때문에 th:each로 루프를 돌면서 실행합니다.

😺 : th:each는 thymeleaf 문법으로 for이나 while와 유사한 반복 처리를 할 때 쓰임

그 후 member.id, member.name에 접근하여 출력해줍니다.

[ 결과 ]

학습중인 스프링 강의 : https://inf.run/pcut 스프링 실습 코드 저장소 : https://github.com/0pyaq0/Spring_Study.git

본 글은 2022년도에 작성한 기존 티스토리 블로그 글을 재업로드한 글입니다 기존 티스토리 블로그 : https://develop-about-leejin.tistory.com/

컴포넌트 스캔과 자동 의존관계 설정

회원 컨트롤러가 회원 서비스와 회원 리포지토리를 사용할 수 있게 의존관계를 준비해야 합니다. ( = 회원 컨트롤러가 회원 서비스를 의존한다)

회원 컨트롤러에 의존관계 추가

package hello.hellospring.controller;

import hello.hellospring.service.MemberService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;

@Controller
public class MemberController {

    private final MemberService memberService; //스프링 컨테이너에 등록

    @Autowired
    public MemberController(MemberService memberService) {
        this.memberService = memberService;
    }
}

@Autowired

스프링이 연관된 객체를 스프링 컨테이너에서 찾아서 넣어줍니다. = DI (의존성 주입) 이전 테스트에서는 개발자가 직접 주입했고, 여기서는 @Autowired에 의해 스프링이 주입해줍니다.

오류 발생

Consider defining a bean of type 'hello.hellospring.service.MemberService' in your configuration.

이유

memberService가 스프링 빈으로 등록되어 있지 않음

helloController는 스프링이 제공하는 컨트롤러여서 스프링 빈으로 자동 등록됩니다. (@Controller 가 있으면 자동 등록)

하지만 MemberService는 순수 자바 클래스이기 때문에 자동 등록 X

스프링 빈 등록 방법

1. 컴포넌트 스캔과 자동 의존관계 설정
2. 자바 코드로 직접 스프링 빈 등록

컴포넌트 스캔 원리

• @Component 애노테이션이 있으면 스프링 빈으로 자동 등록됨
• @Component 포함하는 다음 애노테이션도 자동 등록이 된다. (@Controller, @Service, @Repository)
• @Controller 컨트롤러가 스프링 빈으로 자동 등록된 이유도 컴포넌트 스캔 때문

1. 컴포넌트 스캔과 자동 의존관계 설정

회원 서비스 스프링 빈 등록

MemberService : @Service, @Autowired 추가

생성자에 @Autowired 를 사용하면 객체 생성 시점에 스프링 컨테이너에서 해당 스프링 빈을 찾아서 주입합니다.

생성자가 1개만 있으면 @Autowired 는 생략 가능!

회원 리포지토리 스프링 빈 등록

MemoryMemberRepository : @Repository 추가

스프링 빈 등록 이미지

현재 memberService 와 memberRepository 가 스프링 컨테이너에 스프링 빈으로 등록된 상태입니다.

스프링은 스프링 컨테이너에 스프링 빈을 등록할 때, 특별한 경우가 아니면 기본적으로 싱글톤으로 등록합니다. ( = 유일하게 하나만 등록해서 공유)

따라서 같은 스프링 빈이면 모두 같은 인스턴스입니다.

2. 자바 코드로 직접 스프링 빈 등록

위에서 추가했던 @Service, @Autowired, @Repository 제거 후 진행합니다.

package hello.hellospring;

import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import hello.hellospring.service.MemberService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SpringConfig {

    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository());
    }
    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

}

여기서는 향후 메모리 리포지토리를 다른 리포지토리로 변경할 예정이므로, 자바 코드로 스프링 빈을 설정하겠습니다.

XML로 설정하는 방식도 있지만 최근에는 잘 사용하지 않으므로 생략합니다.

DI 방식

1. 필드 주입
2. setter 주입
3. 생성자 주입 <= Best!!

의존관계가 실행중에 동적으로 변하는 경우는 거의 없으므로 생성자 주입을 권장합니다.

실무에서는 주로 정형화된 코드는 컴포넌트 스캔을 사용하지만, 정형화 되지 않거나 상황에 따라 구현 클래스를 변경해야 하면 설정을 통해 스프링 빈으로 등록합니다.

※ @Autowired 를 통한 DI는 helloConroller , memberService 등과 같이 스프링이 관리하는 객체에서만 동작합니다. 스프링 빈으로 등록하지 않고 내가 직접 생성한 객체에서는 동작 X

학습중인 스프링 강의 : https://inf.run/pcut 스프링 실습 코드 저장소 : https://github.com/0pyaq0/Spring_Study.git

본 글은 2022년도에 작성한 기존 티스토리 블로그 글을 재업로드한 글입니다 기존 티스토리 블로그 : https://develop-about-leejin.tistory.com/

package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import java.util.List;import java.util.Optional;
public class MemberService {
 private final MemberRepository memberRepository = new
MemoryMemberRepository();
 /**
 * 회원가입
 */
 public Long join(Member member) {
 validateDuplicateMember(member); //중복 회원 검증
 memberRepository.save(member);
 return member.getId();
 }
 private void validateDuplicateMember(Member member) {
 memberRepository.findByName(member.getName())
 .ifPresent(m -> {
 throw new IllegalStateException("이미 존재하는 회원입니다.");
 });
 }
 /**
 * 전체 회원 조회
 */
 public List<Member> findMembers() {
 return memberRepository.findAll();
 }
 public Optional<Member> findOne(Long memberId) {
 return memberRepository.findById(memberId);
 }
}

회원 서비스 테스트

package hello.hellospring.service;

import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemoryMemberRepository;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;

class MemberServiceTest { 
 MemberService memberService;
 MemoryMemberRepository memberRepository;

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

 @AfterEach
 public void afterEach() {
 memberRepository.clearStore();
 }

 @Test
 public void 회원가입() throws Exception {
 //Given
 Member member = new Member();
 member.setName("hello");

 //When
 Long saveId = memberService.join(member);

 //Then
 Member findMember = memberRepository.findById(saveId).get();
 assertEquals(member.getName(), findMember.getName());
 }

 @Test
 public void 중복_회원_예외() throws Exception {
 //Given
 Member member1 = new Member();
 member1.setName("spring");
 Member member2 = new Member();
 member2.setName("spring"); 

 //When
 memberService.join(member1);
 IllegalStateException e = assertThrows(IllegalStateException.class,
 () -> memberService.join(member2));//예외가 발생해야 한다.
 assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
 }
}

테스트 코드 작성할 시 고려할 점

Given : 주어진 상황 또는 검증할 것 When : 실행 Then : 결과

기존에는 회원 서비스가 메모리 회원 리포지토리를 직접 생성함

public class MemberService {
 private final MemberRepository memberRepository = 
 new MemoryMemberRepository();
}

회원 리포지토리의 코드가 회원 서비스 코드를 DI 가능하게 변경함

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

• DI ( Dependency Injection, 의존성 주입 ) : 두 객체 간의 관계를 맺어주는 것

@BeforeEach

각 테스트 실행 전에 호출되며 테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존관계도 새로 맺어줌.

학습중인 스프링 강의 : https://inf.run/pcut 스프링 실습 코드 저장소 : https://github.com/0pyaq0/Spring_Study.git

본 글은 2022년도에 작성한 기존 티스토리 블로그 글을 재업로드한 글입니다 기존 티스토리 블로그 : https://develop-about-leejin.tistory.com/

기본 사항들로만 구성된 단순한 구조로 개발할 예정입니다.

데이터 : 회원 ID, 이름 기능 : 회원 등록, 조회 아직 데이터 저장소 선정 X

일반 웹 애플리케이션 계층 구조

• 컨트롤러: 웹 MVC의 API 또는 컨트롤러 역할
• 서비스: 핵심 비즈니스 로직 구현 (ex. 회원 중복 가입 예외처리)
• 리포지토리: 데이터베이스에 접근, 도메인 객체를 DB에 저장하고 관리
• 도메인: 비즈니스 도메인 객체 (ex. 회원, 주문, 쿠폰 등등 주로 데이터베이스에 저장하고 관리됨)

클래스 의존관계

• 아직 데이터 저장소가 선정되지 않아서, 우선 인터페이스로 단순한 메모리 구현 클래스를 변경할 수 있도록 설계
• 데이터 저장소는 RDB, NoSQL 등등 다양한 저장소를 고민중인 상황으로 가정
• 을 진행하기 위해서 초기 개발 단계에서는 구현체로 가벼운 메모리 기반의 데이터 저장소 사용

데이터 저장소가 선정이 안된 상황에서는, 나중에 구체적인 기술이 선정이 된 후 바꿔 끼우기 위해 인터페이스가 필요합니다.

회원 도메인과 리포지토리 만들기

회원 객체

package hello.hellospring.domain;
public class Member {

 private Long id;
 private String name;
 public Long getId() {
 return id;
 }
 public void setId(Long id) {
 this.id = id;
 }
 public String getName() {
 return name;
 }
 public void setName(String name) {
 this.name = name;
 }
}

회원 리포지토리 인터페이스

package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import java.util.List;
import java.util.Optional;
public interface MemberRepository {
 Member save(Member member); Optional<Member> findById(Long id);
 Optional<Member> findByName(String name);
 List<Member> findAll();
}

회원 리포지토리 메모리 구현체

package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import java.util.*;
/**
 * 동시성 문제가 고려되어 있지 않음, 실무에서는 ConcurrentHashMap, AtomicLong 사용 고려
 */
public class MemoryMemberRepository implements MemberRepository {
 private static Map<Long, Member> store = new HashMap<>();
 private static long sequence = 0L;
 @Override
 public Member save(Member member) {
 member.setId(++sequence);
 store.put(member.getId(), member);
 return member;
 }
 @Override
 public Optional<Member> findById(Long id) {
 return Optional.ofNullable(store.get(id));
 }
 @Override
 public List<Member> findAll() {
 return new ArrayList<>(store.values()); }
 @Override
 public Optional<Member> findByName(String name) {
 return store.values().stream()
 .filter(member -> member.getName().equals(name))
 .findAny();
 }
 public void clearStore() {
 store.clear();
 }
}

회원 리포지토리 테스트 케이스 작성

자바는 어떻게 테스트 할까 개발한 기능을 실행해서 테스트 할 때 자바의 main 메서드를 통해서 실행하거나, 웹 애플리케이션의 컨트롤러를 통해서 해당 기능을 실행한다.

하지만

• 준비하고 실행하는데 오래 걸리고, 반복 실행하기 어려움
• 여러 테스트를 한번에 실행하기 어려움

자바는 JUnit이라는 프레임워크로 테스트를 실행해서 이러한 문제를 해결한다.

회원 리포지토리 메모리 구현체 테스트

package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import java.util.List;
import java.util.Optional;
import static org.assertj.core.api.Assertions.*;class MemoryMemberRepositoryTest {
 MemoryMemberRepository repository = new MemoryMemberRepository();
 @AfterEach
 public void afterEach() {
 repository.clearStore();
 }
 @Test
 public void save() {
 //given
 Member member = new Member();
 member.setName("spring");
 //when
 repository.save(member);
 //then
 Member result = repository.findById(member.getId()).get();
 assertThat(result).isEqualTo(member);
 }
 @Test
 public void findByName() {
 //given
 Member member1 = new Member();
 member1.setName("spring1");
 repository.save(member1);
 Member member2 = new Member();
 member2.setName("spring2");
 repository.save(member2);
 //when
 Member result = repository.findByName("spring1").get();
 //then assertThat(result).isEqualTo(member1);
 }
 @Test
 public void findAll() {
 //given
 Member member1 = new Member();
 member1.setName("spring1");
 repository.save(member1);
 Member member2 = new Member();
 member2.setName("spring2");
 repository.save(member2);
 //when
 List<Member> result = repository.findAll();
 //then
 assertThat(result.size()).isEqualTo(2);
 }
}

@AfterEach

한 번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있어서 이전 테스트 때문에 다음 테스트가 실패할 가능성이 높습니다.

@AfterEach 를 사용하면 각 테스트가 종료될 때 마다 이 기능을 실행하여 메모리 DB에 저장된 데이터를 삭제합니다.

학습중인 스프링 강의 : https://inf.run/pcut 스프링 실습 코드 저장소 : https://github.com/0pyaq0/Spring_Study.git

본 글은 2022년도에 작성한 기존 티스토리 블로그 글을 재업로드한 글입니다 기존 티스토리 블로그 : https://develop-about-leejin.tistory.com/

정적 컨텐츠란 ?

서버를 거치지 않고 파일을 웹 브라우저에 그대로 내려주는 것

예시를 들어봅시다.

static 폴더에 hello-static.html 파일을 생성해 줍니다.

<!DOCTYPE HTML>
<html>
<head>
 <title>static content</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
정적 컨텐츠 입니다.
</body>
</html>

http://localhost:8080/hello-static.html 로 접속하면 다음과 같은 결과가 나옵니다.

static 폴더에 원하는 파일을 넣으면 정적 파일로 반환됩니다.

하지만 이 파일에 그 어떤 프로그래밍도 할 수 없습니다.

정적 컨텐츠 동작 과정

Reference : https://docs.spring.io/spring-boot/docs/2.3.1.RELEASE/reference/html/spring-bootfeatures.html#boot-features-spring-mvc-static-content

MVC와 템플릿 엔진

MVC : Model, View, Controller의 줄임말이다.

Controller

@Controller
public class HelloController {
 @GetMapping("hello-mvc")
 public String helloMvc(@RequestParam("name") String name, Model model) {
 model.addAttribute("name", name);
 return "hello-template";
 }
}

resources/template/hello-template.html

<html xmlns:th="http://www.thymeleaf.org">
<body>
<p th:text="'hello ' + ${name}">hello! empty</p>
</body></html>

이렇게 코드를 작성한 후 실행해보면 다음과 같이 나옵니다.

@RequestParam의 name을 통해 Model이 담겨지기 때문입니다.

thymeleaf 템플릿은 주소창에 파일 경로로 이동해도 그대로 결과가 나옵니다.

MVC, 템플릿 엔진 동작 과정

viewResolver

• View를 찾아주고 템플릿을 연결시키는 해결자
• 변환한 html을 웹브라우저에 변환

API

@ResponseBody 문자 반환

@GetMapping("hello-string")
 @ResponseBody
 public String helloString(@RequestParam("name") String name) {
 return "hello " + name;
 }

• @ResponseBody 를 사용하면 뷰 리졸버( viewResolver )를 사용 X
• 대신에 HTTP의 BODY에 문자 내용을 직접 반환(HTML BODY TAG 아님)

@ResponseBody 객체 반환

@Controller
public class HelloController {
 @GetMapping("hello-api")
 @ResponseBody
 public Hello helloApi(@RequestParam("name") String name) {
 Hello hello = new Hello();
 hello.setName(name);
 return hello;
 }
 static class Hello {
 private String name;
 public String getName() {
 return name;
 }
 public void setName(String name) {
 this.name = name;
 }
 }
}

• @ResponseBody 를 사용하고, 객체를 반환하면 객체가 JSON으로 변환

@ResponseBody 사용 원리

• HTTP의 BODY에 문자 내용을 직접 반환
• viewResolver 대신에 HttpMessageConverter 가 동작
• 기본 문자처리: StringHttpMessageConverter
• 기본 객체처리: MappingJackson2HttpMessageConverter
• byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

객체로 넘겨주었다면 디폴트로 JSON 형식으로 만들어서 HTTP에 반환합니다.

학습중인 스프링 강의 : https://inf.run/pcut 스프링 실습 코드 저장소 : https://github.com/0pyaq0/Spring_Study.git

본 글은 2022년도에 작성한 기존 티스토리 블로그 글을 재업로드한 글입니다 기존 티스토리 블로그 : https://develop-about-leejin.tistory.com/

먼저 실습을 하기 위해서 아래와 같은 환경을 만들어야 합니다.

1. JDK 11 설치
2. IDE: IntelliJ 또는 Eclipse 설치

저는 IntelliJ Community로 진행하였습니다.

https://start.spring.io

위 사이트를 통해 프로젝트 생성 후 다운받아 IntelliJ에서 열었습니다.

main 메소드를 실행시키면 정상적으로 작동됩니다.
Gradle을 통하지 않고 바로 결과를 확인하기 위해 setting에 들어가 설정해주었습니다.

라이브러리

Gradle은 의존관계가 있는 라이브러리를 함께 다운로드 합니다.

Spring Boot 라이브러리

spring-boot-starter-web ㄴ spring-boot-starter-tomcat: 톰캣 (웹서버) ㄴ spring-webmvc: 스프링 웹 MVC spring-boot-starter-thymeleaf: 타임리프 템플릿 엔진(View) spring-boot-starter(공통): 스프링 부트 + 스프링 코어 + 로깅 ㄴ spring-boot ㄴ spring-core ㄴ spring-boot-starter-logging ㄴ logback, slf4j

테스트 라이브러리

spring-boot-starter-test ㄴ junit: 테스트 프레임워크 ㄴ mockito: 목 라이브러리 ㄴ assertj: 테스트 코드를 좀 더 편하게 작성하게 도와주는 라이브러리 ㄴ spring-test: 스프링 통합 테스트 지원

View 환경 설정

- Spring Boot에서 제공하는 Welcome Page 기능

static/index.html 을 올려두면 Welcome page 기능을 제공합니다.

index.html에 hello가 출력되게끔 간단한 코드를 작성합니다.

<!DOCTYPE HTML>
<html>
<head>
 <title>Hello</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
Hello
<a href="/hello">hello</a>
</body>
</html>

http://localhost:8080/

서버를 멈추고 다시 실행해주면 에러 페이지에서 welcome page로 바뀝니다.

Reference : https://docs.spring.io/spring-boot/docs/2.3.1.RELEASE/reference/html/spring-boot-features.html#boot-features-spring-mvc-welcome-page

thymeleaf 템플릿 엔진

controller 패키지를 만들어서 HelloController 클래스를, templates 폴더에 hello.html을 생성합니다.

< HelloController 코드 >

@Controller
public class HelloController {
 @GetMapping("hello")
 public String hello(Model model) {
 model.addAttribute("data", "hello!!");
 return "hello";
 }
}

< hello 코드 >

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>Hello</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
<p th:text="'안녕하세요. ' + ${data}" >안녕하세요. 손님</p>
</body>
</html>

그런 다음 http://localhost:8080/hello 로 접속하면 다음과 같이 결과가 나옵니다.

attributeValue 값이 html의 ${data}에 치환되기 때문입니다.

동작 환경 그림

컨트롤러에서 리턴 값으로 문자를 반환하면 뷰 리졸버( viewResolver )가 화면을 찾아서 처리합니다. ㄴ 스프링 부트 템플릿엔진 기본 viewName 매핑 ㄴ resources:templates/ +{ViewName}+ .html

◆ 참고: spring-boot-devtools 라이브러리를 추가하면, html 파일을 컴파일만 해주면 서버 재시작 없이 View 파일 변경이 가능합니다.

인텔리J 컴파일 방법: 메뉴 build Recompile

Reference : thymeleaf 공식 사이트: https://www.thymeleaf.org/ 스프링 공식 튜토리얼: https://spring.io/guides/gs/serving-web-content/ 스프링부트 메뉴얼: https://docs.spring.io/spring-boot/docs/2.3.1.RELEASE/reference/html/spring-boot-features.html#boot-features-spring-mvc-template-engines

빌드하고 실행하기

콘솔 이동

./gradlew build cd build/libs java -jar hello-spring-0.0.1-SNAPSHOT.jar 실행 확인

윈도우 유저 Tip

콘솔 ➡️ 이동 명령 프롬프트(cmd)로 이동 ./gradlew ➡️ gradlew.bat 를 실행 명령 프롬프트에서 gradlew.bat 를 실행하려면 gradlew 하고 엔터 gradlew build 폴더 목록 확인 ls ➡️ dir

학습중인 스프링 강의 : https://inf.run/pcut 스프링 실습 코드 저장소 : https://github.com/0pyaq0/Spring_Study.git

본 글은 2022년도에 작성한 기존 티스토리 블로그 글을 재업로드한 글입니다 기존 티스토리 블로그 : https://develop-about-leejin.tistory.com/