본문 바로가기
Backend/인프런 강의: 김영한 스프링

스프링 입문: 섹션 5부터 7까지

by ccooll 2023. 11. 17.

섹션 5: 회원 관리 예제 - 웹 MVC 개발

 

1. 회원 웹 기능 - 홈 화면 추가

main/java/hello.hello-spring/controller/HomeController.java

@Controller
public class HomeController {

    @GetMapping("/")
    public String home(){
        return "Home";
    }

}

 

사용자가 URL ("/")에 액세스하면 이 컨트롤러의 home 메서드가 호출되어 "Home"이라는 뷰 이름을 반환한다.

뷰 리졸버가 실제 렌더링을 위한 뷰 템플릿으로 해석한다. (Thymeleaf를 사용하는 경우 "Home.html" 파일 )

 

 

 

main/resources/templates/Home.html

<!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>

 

>> 컨트롤러가 정적 파일보다 우선순위가 높다

 

 

 

2. 회원 웹 기능 - 등록

①  회원 등록 폼 개발

main/java/hello.hellospring/controller/MemberController.java

@Controller
public class MemberController {
    private final MemberService memberService;

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

    @GetMapping("/members/new")
    public String creatForm(){
        return "members/createMemberForm";
    }
}

 

 

main/resources/templates/members/createMemberForm.html

<!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>

 

 

 

② 회원 등록 컨트롤러

 

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

main/java/hello.hellospring/controller/MemberForm.java

public class MemberForm {
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

 

 

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

main/java/hello.hellospring/controller/MemberController.java

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

 

 

 

3. 회원 웹 기능 - 조회

// 회원 컨트롤러에서 조회 기능

main/java/hello.hellospring/controller/MemberController.java

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

 

 

// 회원 리스트 HTML

main/resources/templates/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>

 

 

 


 

섹션 6: 스프링 DB 접근 기술

 

1. H2 데이터베이스 설치

① H2 실행

cmd 창

cd C:\Program Files (x86)\H2\bin

h2.bat

 

 

② H2 연결

JDBC URL : jdbc:h2:tcp://localhost/~/test

SELECT * FROM MEMBER 로 저장된 회원 볼 수 있음

 

// 테이블 생성

sql/ddl.sql

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

 

 

 

 

2. 순수 JDBC

① 환경설정

 

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

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

 

 

// 스프링 부트 데이터베이스 연결 설정 추가

main/resources/application.properties

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

 

 

② Jdbc 리포지토리 구현

 

// Jdbc 회원 리포지토리

참고하고 넘어가기

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);
    }
}

 

 

 

// 스프링 설정 변경

@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);
    }
}

 

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

 

 

 

3. 스프링 통합 테스트

스프링 컨테이너와 DB까지 연결한 통합 테스트

 

@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {

    @Autowired MemberService memberService;
    @Autowired
    MemberRepository memberRepository;

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

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

        // then
        Member findMember = memberService.findOne(saveId).get();
        Assertions.assertThat(member.getName()).isEqualTo(findMember.getName());
    }

    @Test
    public void 중복_회원_예외() {
        // 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에 데이터가 남지 않으므로 다음 테스트에 영향을 주지
않는다.

 

 

 

 

 

4. 스프링 JdbcTemplate

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

 

public class JdbcTemplateMemberRepository implements MemberRepository {

    private final JdbcTemplate jdbcTemplate;

    public JdbcTemplateMemberRepository(DataSource dataSource) {
        jdbcTemplate = new JdbcTemplate(dataSource);
    }   // 생성자가 딱 하나면 @AutoWired 생략 가능

    @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 Optional<Member> findByName(String name) {
        List<Member> result = jdbcTemplate.query("select * from member where name = ?", memberRowMapper(), name);
        return result.stream().findAny();
    }

    @Override
    public List<Member> findAll() {
        return jdbcTemplate.query("select * from member", memberRowMapper());
    }

    private RowMapper<Member> memberRowMapper(){
        return (rs, rowNum) -> {
            Member member = new Member();
            member.setId(rs.getLong("id"));
            member.setName(rs.getString("name"));

            return member;
        };
    }
}

 

 

- private final JdbcTemplate jdbcTemplate;

: JdbcTemplate을 사용하여 데이터베이스와 상호 작용할 수 있도록 하는 멤버 변수

 

- public JdbcTemplateMemberRepository(DataSource dataSource) 생성자:

: 데이터베이스와의 상호 작용을 위한 JdbcTemplate을 생성하는 생성자. 생성자에는 DataSource가 주입되어야 한다.

 이 생성자를 통해 JdbcTemplate이 초기화되고 데이터베이스와의 상호 작용을 수행할 수 있다.

 

- @Override public Member save(Member member) 메서드

: 회원 정보를 데이터베이스에 저장한다. SimpleJdbcInsert을 사용하여 회원 테이블에 데이터를 삽입하고 생성된 키를 이용하여 회원 객체의 ID를 설정한다

.

- @Override public Optional<Member> findById(Long id) 메서드:

: 주어진 ID로 회원을 검색한다. jdbcTemplate.query 메서드를 사용하여 SQL 쿼리를 실행하고, memberRowMapper()를 사용하여 결과를 객체로 매핑한다.

 

- @Override public Optional<Member> findByName(String name) 메서드:

: 주어진 이름으로 회원을 검색한다. 마찬가지로 jdbcTemplate.query 메서드를 사용하여 SQL 쿼리를 실행하고, memberRowMapper()를 사용하여 결과를 객체로 매핑한다.

 

- @Override public List<Member> findAll() 메서드:

: 모든 회원을 검색한다. jdbcTemplate.query 메서드를 사용하여 SQL 쿼리를 실행하고, memberRowMapper()를 사용하여 결과를 객체의 리스트로 매핑한다.

 

- private RowMapper<Member> memberRowMapper() 메서드:

: RowMapper를 반환하는 메서드로, 각 행을 회원 객체로 매핑하는 역할을 한다.

 

 

 

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

@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);
    }
}

 

 

5. JPA

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

 

 

// 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'
    }
}

 

 

 

// 스프링 부트에 JPA 설정 추가

main/resources/application.properties

spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none

 

 

 

// JPA 회원 리포지토리

main/java/hello.hellospring/repository/JpaMemberRepository.java

public class JpaMemberRepository implements MemberRepository{

    private final EntityManager em;

    public JpaMemberRepository(EntityManager em) {
        this.em = em;
    }

    @Override
    public Member save(Member member) {
        em.persist(member);
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        Member member = em.find(Member.class, id);
        return Optional.ofNullable(member);
    }

    @Override
    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();
    }

    @Override
    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class)
                .getResultList();
    }
}

 

 

- private final EntityManager em;

: JPA의 핵심 컴포넌트인 EntityManager를 사용하여 영속성 관리를 수행하는 데 필요한 멤버 변수이다

 

- public JpaMemberRepository(EntityManager em) 생성자:

: EntityManager를 주입받아서 초기화하는 생성자. 이를 통해 JPA를 사용하여 데이터베이스와 상호 작용할 수 있다.

 

- @Override public Member save(Member member) 메서드:

: 주어진 회원 객체를 데이터베이스에 저장한다. em.persist(member)를 호출하여 JPA의 영속성 컨텍스트에 해당 객체를 추가하고 데이터베이스에 적용한다.

 

- @Override public Optional<Member> findById(Long id) 메서드:

: 주어진 ID로 회원을 검색한다. em.find(Member.class, id)를 사용하여 JPA를 통해 해당 ID의 회원을 검색하고, Optional.ofNullable을 사용하여 결과를 Optional로 감싸서 반환한다.

 

- @Override public Optional<Member> findByName(String name) 메서드:

: 주어진 이름으로 회원을 검색한다. JPQL(Query)을 사용하여 이름에 해당하는 회원을 조회하고, 결과를 리스트로 받은 후 stream().findAny()를 사용하여 임의의 회원을 Optional로 반환한다.

 

- @Override public List<Member> findAll() 메서드:

: 모든 회원을 검색한다. JPQL을 사용하여 모든 회원을 조회하고, 결과를 리스트로 반환한다.

 

 

// 서비스 계층에 트랜잭션 추가

@Transactional
public class MemberService {
}

 

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

 

 

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

main/java/hello.hellospring/controller/SpringConfig.java

@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);
    }
}

 

 

 

6. 스프링 데이터 JPA

- 스프링 데이터 JPA를 사용하면, 기존의 한계를 넘어 마치 마법처럼, 리포지토리에 구현 클래스 없이
인터페이스 만으로 개발을 완료할 수 있다.

- 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공합니다.

 

 

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

main/java/hello.hellospring/repository/SpringDataMemberRepository.java

public interface SpringDataJpaMemberRepository extends JpaRepository<Member,Long>, MemberRepository {
    Optional<Member> findByName(String name);
}

 

 

 

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

@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 를 스프링 빈으로 자동 등록해준다.

 

 


 

섹션 7: AOP

 

1. AOP가 필요한 상황

 

// MemberService 회원 조회 시간 측정 추가

@Transactional
public class MemberService {
    private final MemberRepository memberRepository;

    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");
        }
    }

    /** 전체 회원 조회 **/
    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");
        }
    }

    private void validateDuplicateMember(Member member) {
        memberRepository.findByName(member.getName())
            .ifPresent(m -> {
                throw new IllegalStateException("이미 존재하는 회원입니다.");
            });
    }
}

 

문제?

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

 

 

 

 

2. AOP 적용

AOP: Aspect Oriented Programming
공통 관심 사항(cross-cutting concern) vs 핵심 관심 사항(core concern) 분리

 

 

main/java/hello.hellospring/aop/TimeTraceAop.java

@Aspect
@Component
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");

        }
    }
}

 

- @Aspect 어노테이션은 이 클래스가 Aspect임을 나타낸다.

- @Component 어노테이션은 Spring에서 이 클래스를 빈으로 등록하도록 지시한다.

 

- @Around("execution(* hello.hellospring..*(..))"):

: 이 어노테이션은 대상 메서드를 지정하는데, 여기서는 hello.hellospring 패키지와 그 하위 패키지에 속한 모든 메서드들을 대상으로 한다.

 

- joinPoint.proceed():

: proceed() 메서드는 실제 대상 메서드를 실행하는데 사용된다. 이 메서드 호출 이전과 이후에 특정 동작을 수행할 수 있도록 제어를 제공한다.

 

- long start = System.currentTimeMillis();:

: 대상 메서드 실행 전에 현재 시간을 기록한다.

 

- long finish = System.currentTimeMillis(); long timeMs = finish - start;

: 대상 메서드 실행 후에 현재 시간을 기록하고 걸린 시간을 계산한다.

 

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

: 대상 메서드 실행 전에 시작 메시지를 출력합니다.

 

- System.out.println("END : " + joinPoint.toString() + " " + timeMs + "ms");:

: 대상 메서드 실행 후에 종료 메시지와 소요된 시간을 출력합니다.

 

 

 

 

해결!

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