[스프링 입문] 스프링 DB 접근 기술

JYC·2024년 1월 4일
스프링자바

[SPRING STUDY]

목록 보기
7/39

데이터베이스

순수 Jdbc

  • 약 20년 전 사용하던 기술이다.

먼저 build.gradle 파일에 jdbc, h2 관련 라이브러리를 추가한다.

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

application.propertie에 연결 설정을 추가한다.

spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa //스프링 2.4부터는 꼭 추가해야 함.

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

앞서 말했듯 jdbc는 20년 전에나 직접 코딩하던 것이므로 완전히 이해하는 것보다는 참고만 한다고 생각하고 넘기는게 좋다.

SpringConfig를 수정해준다.

@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를 받을 수 있다.

이제 실행해보면 데이터베이스 서버에 저장할 수 있게 된다.

지금까지의 구조

하지만 이젠 Config만 설정,수정해줌으로서 새롭게 구현해줄 수 있게 되었다.

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

JdbcTemplate 회원 리포지토리

  • jdbc에서의 반복 코드를 제거하기 위해서 만들어준다.
  • 하지만 SQL은 직접 작성해야 하는 번거로움이 있다.
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;
   		};
   	}
}

이에 맞게 Config도 수정해준다.

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

이로서 20년 전의 Jdbc 방식을 끝냈다.

JPA

  • JPA는 기존 반복 코드는 물론, 기본적인 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'
	}
}

application.properties도 JPA 설정을 추가해준다.

spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none
  • show-sql : JPA가 생성하는 SQL을 출력해준다.
  • ddl-auto : JPA는 테이블을 자동으로 생성하는 기능을 제공하는데 none 를 사용하면 해당 기능을 끈다.

Member class에 JPA를 추가해준다.

public class Member {
    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    }

JPA 회원 리포지토리를 추가해준다.

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

Config를 수정해주면 끝이다.

	private final EntityManager em;
 	public SpringConfig(DataSource dataSource, EntityManager em) {
 	this.dataSource = dataSource;
 	this.em = em;
 }
   @Bean
   public MemberRepository memberRepository() {
  // return new MemoryMemberRepository();
  // return new JdbcMemberRepository(dataSource);
  // return new JdbcTemplateMemberRepository(dataSource);
   return new JpaMemberRepository(em);
  }

스프링 데이터 JPA

  • 스프링 데이터 JPA 사용시, 리포지토리에 구현 클래스 없이 인터페이스 만으로 개발 완료 가능함.
  • 반복 개발해온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공함.
  • 핵심 비즈니스 로직 개발에 집중 가능해짐.

스프링 데이터 JPA 회원 리포지토리를 만들어준다.

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

Config를 수정해준다.

public class SpringConfig {
    private final MemberRepository memberRepository;

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

    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository);
    }
    //@Bean
    //public MemberRepository memberRepository() {
		//return new MemoryMemberRepository();
        //return new JpaMemberRepository(em);
    //}
}
  • 스프링 데이터 JPA가 SpringDataJpaMemberRepository 를 스프링 빈으로 자동 등록해준다.

스프링 데이터 JPA 제공 클래스

  • 스프링 데이터 JPA 제공 기능
    • 인터페이스를 통한 기본적인 CRUD
    • findByName() 처럼 메소드 이름 만으로 조회 기능 제공
    • 페이징 기능 자동 제공
profile
JYC
열심히 하기 1일차
이전 포스트

[스프링 입문] 회원 관리 예제 - 웹 MVC 개발

다음 포스트

[스프링 입문] AOP

0개의 댓글